Skip to content
Docs

Networking

NetworkingVPCs

Create VPC
$ nirvana networking:vpcs create
POST/v1/networking/vpcs
Get VPC Details
$ nirvana networking:vpcs get
GET/v1/networking/vpcs/{vpc_id}
Update VPC
$ nirvana networking:vpcs update
PATCH/v1/networking/vpcs/{vpc_id}
Delete VPC
$ nirvana networking:vpcs delete
DELETE/v1/networking/vpcs/{vpc_id}
List VPCs
$ nirvana networking:vpcs list
GET/v1/networking/vpcs
ModelsExpand Collapse
subnet: object { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

name: string

Name of the Subnet.

updated_at: string

When the Subnet was updated.

vpc: object { id, created_at, firewall_rule_ids, 7 more }

VPC details.

id: string

Unique identifier for the VPC.

created_at: string

When the VPC was created.

firewall_rule_ids: array of string

IDs of the Firewall Rules associated with the VPC.

name: string

Name of the VPC.

project_id: string

Project ID the VPC belongs to.

region: "us-sva-2"

Region the resource is in.

"us-sva-2"
status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
subnet: object { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

name: string

Name of the Subnet.

updated_at: string

When the Subnet was updated.

tags: array of string

Tags to attach to the VPC.

updated_at: string

When the VPC was updated.

vpc_list: object { items, pagination }
items: array of VPC { id, created_at, firewall_rule_ids, 7 more }
id: string

Unique identifier for the VPC.

created_at: string

When the VPC was created.

firewall_rule_ids: array of string

IDs of the Firewall Rules associated with the VPC.

name: string

Name of the VPC.

project_id: string

Project ID the VPC belongs to.

region: "us-sva-2"

Region the resource is in.

"us-sva-2"
status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
subnet: object { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

name: string

Name of the Subnet.

updated_at: string

When the Subnet was updated.

tags: array of string

Tags to attach to the VPC.

updated_at: string

When the VPC was updated.

NetworkingVPCsAvailability

Check Create VPC Availability
$ nirvana networking:vpcs:availability create
POST/v1/networking/vpcs/availability
Check Update VPC Availability
$ nirvana networking:vpcs:availability update
PATCH/v1/networking/vpcs/{vpc_id}/availability

NetworkingFirewall Rules

Create Firewall Rule
$ nirvana networking:firewall-rules create
POST/v1/networking/vpcs/{vpc_id}/firewall_rules
Firewall Rule Details
$ nirvana networking:firewall-rules get
GET/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
Update Firewall Rule
$ nirvana networking:firewall-rules update
PATCH/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
Delete Firewall Rule
$ nirvana networking:firewall-rules delete
DELETE/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
List Firewall Rules
$ nirvana networking:firewall-rules list
GET/v1/networking/vpcs/{vpc_id}/firewall_rules
ModelsExpand Collapse
firewall_rule: object { id, created_at, destination_address, 8 more }

Firewall rule details.

id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

name: string

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

"tcp"
"udp"
source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

vpc_id: string

ID of the VPC the Firewall Rule belongs to.

firewall_rule_list: object { items, pagination }
items: array of FirewallRule { id, created_at, destination_address, 8 more }
id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

name: string

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

"tcp"
"udp"
source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

vpc_id: string

ID of the VPC the Firewall Rule belongs to.

NetworkingConnect

ModelsExpand Collapse
connect_bandwidth_mbps: 50 or 200 or 500 or 2 more

Connect Connection speed in Mbps

50
200
500
1000
2000
connect_connection: object { id, asn, aws, 13 more }

Connect Connection details.

id: string

Unique identifier for the Connect Connection

asn: number

ASN

aws: object { region }

AWS provider configuration

region: string

AWS region where the connection is established

bandwidth_mbps: 50 or 200 or 500 or 2 more

Connect Connection speed in Mbps

50
200
500
1000
2000
cidrs: array of string

CIDRs for the Connect Connection

created_at: string

When the Connect Connection was created

name: string

Name of the Connect Connection

project_id: string

Project ID the Connect Connection belongs to

provider_asn: number

Provider ASN

provider_cidrs: array of string

Provider CIDRs for the Connect Connection

provider_router_ip: string

Provider Router IP for the Connect Connection

region: "us-sva-2"

Region the resource is in.

"us-sva-2"
router_ip: string

Router IP

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Connect Connection

updated_at: string

When the Connect Connection was updated

connect_connection_aws_config: object { region }

AWS provider configuration

region: string

AWS region where the connection is established

connect_connection_aws_config_request: object { account_id, region }

AWS provider configuration

account_id: string

AWS account id

region: string

AWS region where the connection will be established

connect_connection_list: object { items, pagination }
items: array of ConnectConnection { id, asn, aws, 13 more }
id: string

Unique identifier for the Connect Connection

asn: number

ASN

aws: object { region }

AWS provider configuration

region: string

AWS region where the connection is established

bandwidth_mbps: 50 or 200 or 500 or 2 more

Connect Connection speed in Mbps

50
200
500
1000
2000
cidrs: array of string

CIDRs for the Connect Connection

created_at: string

When the Connect Connection was created

name: string

Name of the Connect Connection

project_id: string

Project ID the Connect Connection belongs to

provider_asn: number

Provider ASN

provider_cidrs: array of string

Provider CIDRs for the Connect Connection

provider_router_ip: string

Provider Router IP for the Connect Connection

region: "us-sva-2"

Region the resource is in.

"us-sva-2"
router_ip: string

Router IP

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Connect Connection

updated_at: string

When the Connect Connection was updated

connect_route: object { nirvana_region, provider, provider_region }

Routes supported for Connect.

nirvana_region: "us-sva-2"

Region the resource is in.

"us-sva-2"
provider: string

Provider name.

provider_region: string

Provider region name.

connect_route_list: object { items, pagination }
items: array of ConnectRoute { nirvana_region, provider, provider_region }
nirvana_region: "us-sva-2"

Region the resource is in.

"us-sva-2"
provider: string

Provider name.

provider_region: string

Provider region name.

NetworkingConnectConnections

Create Connect Connection
$ nirvana networking:connect:connections create
POST/v1/networking/connect/connections
Get Connect Connection
$ nirvana networking:connect:connections get
GET/v1/networking/connect/connections/{connection_id}
Update Connect Connection
$ nirvana networking:connect:connections update
PATCH/v1/networking/connect/connections/{connection_id}
Delete Connect Connection
$ nirvana networking:connect:connections delete
DELETE/v1/networking/connect/connections/{connection_id}
List Connect Connection
$ nirvana networking:connect:connections list
GET/v1/networking/connect/connections

NetworkingConnectRoutes

List Connect Supported Routes
$ nirvana networking:connect:routes list
GET/v1/networking/connect/routes