avn vpc
The list of commands for project VPCs (avn vpc) and organization VPCs (avn organization vpc)
Manage VPCs
Create VPCs
- Project VPC
- Organization VPC
Command: avn vpc create
| Parameter | Information |
|---|---|
--project | The project where to create the VPC |
--cloud | The cloud and region where to host the VPC. See the list of available cloud regions using the avn cloud list command. |
--network-cidr | The network range in the Aiven project VPC in CIDR format (a.b.c.d/e) (required) |
Example: Create a VPC in the aws-us-west-1 cloud region with network range
10.1.2.0/24:
avn vpc create \
--cloud aws-us-west-1 \
--network-cidr 10.1.2.0/24
The command output is similar to:
PROJECT_VPC_ID STATE CLOUD_NAME NETWORK_CIDR
==================================== ======== ============= ============
123abc45-1234-abcd-1234-123abc456def APPROVED aws-us-west-1 10.1.2.0/24
Command: avn organization vpc create
| Parameter | Information |
|---|---|
--organization-id | The organization where to create the VPC |
--cloud | The cloud and region where to host the VPC. See the list of available cloud regions using the avn cloud list command. |
--network-cidr | The network range in the Aiven organization VPC in CIDR format (a.b.c.d/e) (required) |
Example: Create a VPC in the aws-us-west-1 cloud region with network range
10.1.2.0/24:
avn organization vpc create \
--organization-id org123abc456de \
--cloud aws-us-west-1 \
--network-cidr 10.1.2.0/24
The command output is similar to:
CLOUDS CREATE_TIME ORGANIZATION_ID ORGANIZATION_VPC_ID PEERING_CONNECTIONS PENDING_BUILD_ONLY_PEERING_CONNECTIONS STATE UPDATE_TIME
============================================================== ==================== =============== ==================================== =================== ====================================== ======== ====================
{"cloud_name": "aws-us-west-1", "network_cidr": "10.1.2.0/24"} YYYY-MM-DDTHH:MM:SSZ org123abc456de 123abc45-1234-abcd-1234-123abc456def null APPROVED YYYY-MM-DDTHH:MM:SSZ
Get VPCs
Command: avn organization vpc get
| Parameter | Information |
|---|---|
--organization-id | The ID of the organization where the organization VPC runs |
--organization-vpc-id | The ID of the organization VPC to fetch details for |
Example: Retrieve information about the organization VPC with ID
abcd1234-abcd-1234-abcd-abcd1234 in organization org123abc:
avn organization vpc get \
--organization-id org123abc \
--organization-vpc-id abcd1234-abcd-1234-abcd-abcd1234
The command output is similar to:
ORGANIZATION_VPC_ID CLOUDS STATE
================================ =============================================================== ======
abcd1234-abcd-1234-abcd-abcd1234 {"cloud_name": "cloud-region-n", "network_cidr": "NN.N.N.N/NN"} ACTIVE
Delete VPCs
- Project VPC
- Organization VPC
Command: avn vpc delete
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--project-vpc-id | The project VPC ID. To get the list of VPC IDs execute avn vpc list (required) |
Example: Delete the VPC with id abcd1234-abcd-1234-abcd-abcd1234:
avn vpc delete \
--project-vpc-id abcd1234-abcd-1234-abcd-abcd1234
The command output is similar to:
PROJECT_VPC_ID STATE CLOUD_NAME NETWORK_CIDR
================================ ======== ============= ============
abcd1234-abcd-1234-abcd-abcd1234 DELETING aws-us-west-1 10.1.2.0/24
Command: avn organization vpc delete
| Parameter | Information |
|---|---|
--organization-id | The ID of the organization hosting the VPC to be deleted (required) |
--organization-vpc-id | The ID of the organization VPC to be deleted (required). To get the list of VPC IDs, run avn organization vpc list. |
Example: Delete the VPC with id abcd1234-abcd-1234-abcd-abcd1234 in organization
org123abc:
avn organization vpc delete \
--organization-id org123abc \
--organization-vpc-id abcd1234-abcd-1234-abcd-abcd1234
The command output is similar to:
CLOUDS CREATE_TIME ORGANIZATION_ID ORGANIZATION_VPC_ID PEERING_CONNECTIONS PENDING_BUILD_ONLY_PEERING_CONNECTIONS STATE UPDATE_TIME
==================================================================== ==================== =============== ================================ =================== ====================================== ======== ====================
{"cloud_name": "provider-region-n", "network_cidr": "NNN.NN.N.N/NN"} YYYY-MM-DDTHH:MM:SSZ org123abc abcd1234-abcd-1234-abcd-abcd1234 null DELETING YYYY-MM-DDTHH:MM:SSZ
List VPCs
- Project VPC
- Organization VPC
Command: avn vpc list
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--json | Retrieve the output in JSON format |
--verbose | Retrieve the verbose output |
Example: List all project's VPCs:
avn vpc list
The command output is similar to:
PROJECT_VPC_ID CLOUD_NAME NETWORK_CIDR STATE
==================================== ================== ============= ======
b132dfbf-b035-4cf5-8b15-b7cd6a68aqqd aws-us-east-1 10.2.1.0/24 ACTIVE
c36a0a6a-6cfb-4718-93ce-ec043ae94qq5 aws-us-west-2 10.13.4.0/24 ACTIVE
d7a984bf-6ebf-4503-bbbd-e7950c49bqqb azure-eastus 10.213.2.0/24 ACTIVE
f99601f3-4b00-44d6-b4d9-6f16e9f55qq8 google-us-central1 10.1.13.0/24 ACTIVE
8af49368-3125-48a8-b94e-3d1a3d601qqf google-us-east1 10.50.8.0/24 ACTIVE
6ba650ce-cc08-4e0a-a386-5a354c327qq6 google-us-east4 10.1.17.0/24 ACTIVE
c4bc3a59-87da-4dce-9243-c197edb43qq2 google-us-west3 10.1.13.0/24 ACTIVE
Command: avn organization vpc list
| Parameter | Information |
|---|---|
--organization-id | The ID of the organization hosting VPCs to be listed (required) |
--json | Retrieve the output in JSON format |
--verbose | Retrieve the verbose output |
Example: List all organization VPCs for an organization:
avn organization vpc list \
--organization-id org123abc
The command output is similar to:
ORGANIZATION_VPC_ID CLOUD_NAME NETWORK_CIDR STATE
==================================== ================== ============= ======
b132dfbf-b035-4cf5-8b15-b7cd6a68aqqd aws-us-east-1 10.2.1.0/24 ACTIVE
c36a0a6a-6cfb-4718-93ce-ec043ae94qq5 aws-us-west-2 10.13.4.0/24 ACTIVE
d7a984bf-6ebf-4503-bbbd-e7950c49bqqb azure-eastus 10.213.2.0/24 ACTIVE
f99601f3-4b00-44d6-b4d9-6f16e9f55qq8 google-us-central1 10.1.13.0/24 ACTIVE
8af49368-3125-48a8-b94e-3d1a3d601qqf google-us-east1 10.50.8.0/24 ACTIVE
6ba650ce-cc08-4e0a-a386-5a354c327qq6 google-us-east4 10.1.17.0/24 ACTIVE
c4bc3a59-87da-4dce-9243-c197edb43qq2 google-us-west3 10.1.13.0/24 ACTIVE
Manage VPC peering connections
Create peering connections
- Project VPC
- Organization VPC
Command: avn vpc peering-connection create
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--project-vpc-id | Aiven project VPC ID. To get the list of VPC IDs execute avn vpc list (required) |
--peer-cloud-account | AWS account ID, Google project ID, or Azure subscription ID (required) |
--peer-vpc | AWS VPC ID, Google VPC network name, or Azure VNet name (required) |
--peer-region | AWS region of peer VPC, if different than the region defined in the Aiven project VPC |
--peer-resource-group | Azure resource group name (required for Azure) |
--peer-azure-app-id | Azure app object ID (required for Azure) |
--peer-azure-tenant-id | Azure AD tenant ID (required for Azure) |
--user-peer-network-cidr | User-defined peer network IP range for routing/firewall |
Example: Create a peering connection for AWS.
avn vpc peering-connection create \
--project-vpc-id b032dfbf-b035-4cf5-8b15-b7cd6a68aqqd \
--peer-cloud-account 012345678901 \
--peer-vpc vpc-abcdef01234567890
The command output is:
CREATE_TIME PEER_AZURE_APP_ID PEER_AZURE_TENANT_ID PEER_CLOUD_ACCOUNT PEER_RESOURCE_GROUP PEER_VPC STATE STATE_INFO UPDATE_TIME USER_PEER_NETWORK_CIDRS VPC_PEERING_CONNECTION_TYPE
==================== ================= ==================== ================== =================== ===================== ======== ========== ==================== ======================= ===========================
2022-06-15T14:50:54Z null null 012345678901 null vpc-abcdef01234567890 APPROVED null 2022-06-15T14:50:54Z
Command: avn organization vpc peering-connection create
| Parameter | Information |
|---|---|
--organization-id | The ID of the Aiven organization hosting the VPC to be peered (required) |
--organization-vpc-id | The ID of the Aiven organization VPC to be peered (required). To get the list of VPC IDs, run avn organization vpc list. |
--peer-cloud-account | AWS account ID, Google project ID, Azure subscription ID, or the upcloud string for UpCloud (required) |
--peer-vpc | AWS VPC ID, Google VPC network name, Azure VNet name, or UpCloud private network UUID (required) |
--peer-region | AWS region of peer VPC, if different than the region defined in the Aiven organization VPC |
--peer-resource-group | Azure resource group name (required for Azure) |
--peer-azure-app-id | Azure app object ID (required for Azure) |
--peer-azure-tenant-id | Azure AD tenant ID (required for Azure) |
--user-peer-network-cidr | User-defined peer network IP range for routing/firewall |
Example: Create a peering connection for UpCloud:
avn organization vpc peering-connection create \
--organization-id org123abc456de \
--organization-vpc-id 123abc45-abcd-1234-abcd-123abc456def \
--peer-cloud-account upcloud \
--peer-vpc abcd1234-abcd-1234-abcd-abcd1234abcd
The command output is similar to:
PEER_CLOUD_ACCOUNT PEER_RESOURCE_GROUP PEER_VPC PEER_REGION STATE
================== =================== ==================================== =========== ========
upcloud null abcd1234-abcd-1234-abcd-abcd1234abcd null APPROVED
Delete peering connections
- Project VPC
- Organization VPC
Command: avn vpc peering-connection delete
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--project-vpc-id | Aiven project VPC ID. To get the list of VPC IDs execute avn vpc list (required) |
--peer-cloud-account | AWS account ID, Google project ID, or Azure subscription ID (required) |
--peer-vpc | AWS VPC ID, Google VPC network name, or Azure VNet name (required) |
--peer-region | AWS region of peer VPC, if different than the region defined in the Aiven project VPC |
--peer-resource-group | Azure resource group name (required for Azure) |
Example: Delete the VPC peering connection between the
b032dfbf-b035-4cf5-8b15-b7cd6a68aqqd Aiven VPC and the
vpc-abcdef01234567890 AWS VPC.
avn vpc peering-connection delete \
--project-vpc-id b032dfbf-b035-4cf5-8b15-b7cd6a68aqqd \
--peer-cloud-account 012345678901 \
--peer-vpc vpc-abcdef01234567890
The command output is:
CREATE_TIME PEER_AZURE_APP_ID PEER_AZURE_TENANT_ID PEER_CLOUD_ACCOUNT PEER_REGION PEER_RESOURCE_GROUP PEER_VPC STATE STATE_INFO UPDATE_TIME USER_PEER_NETWORK_CIDRS VPC_PEERING_CONNECTION_TYPE
==================== ================= ==================== ================== =========== =================== ===================== ======== ========== ==================== ======================= ===========================
2022-06-15T14:50:54Z null null 012345678901 us-east-1 null vpc-abcdef01234567890 DELETING null 2022-06-15T15:02:12Z
Command: avn organization vpc peering-connection delete
| Parameter | Information |
|---|---|
--organization-id | The ID of the Aiven organization hosting the peered VPC |
--organization-vpc-id | The ID of the Aiven organization VPC with the peering to be deleted (required). To get the list of VPC IDs, run avn organization vpc list. |
--peering-connection-id | The ID of the peering connection to be deleted (required). To get the list of peering connection IDs, run avn organization vpc peering-connection list. |
Example: Delete the VPC peering connection between the
123abc45-abcd-1234-abcd-123abc456def Aiven VPC and the
abc123ab-1234-abcd-1234-456def123abc UpCloud network:
avn organization vpc peering-connection delete \
--organization-id org123abc456de \
--organization-vpc-id 123abc45-abcd-1234-abcd-123abc456def \
--peering-connection
The command output is similar to:
CREATE_TIME PEER_AZURE_APP_ID PEER_AZURE_TENANT_ID PEER_CLOUD_ACCOUNT PEER_REGION PEER_RESOURCE_GROUP PEER_VPC STATE STATE_INFO UPDATE_TIME USER_PEER_NETWORK_CIDRS VPC_PEERING_CONNECTION_TYPE
==================== ================= ==================== ================== =========== =================== ===================== ======== ========== ==================== ======================= ===========================
2022-06-15T14:50:54Z null null 012345678901 us-east-1 null vpc-abcdef01234567890 DELETING null 2022-06-15T15:02:12Z
Get peering connections
Command: avn vpc peering-connection get
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--project-vpc-id | Aiven project VPC ID. To get the list of VPC IDs execute avn vpc list (required) |
--peer-cloud-account | AWS account ID, Google project ID, or Azure subscription ID (required) |
--peer-vpc | AWS VPC ID, Google VPC network name, or Azure VNet name (required) |
--json | Retrieve the output in JSON format |
--verbose | Retrieve the verbose output |
Example: Fetch VPC peering connection details.
avn vpc peering-connection get \
--project-vpc-id b032dfbf-b035-4cf5-8b15-b7cd6a68aabd \
--peer-cloud-account 012345678901 \
--peer-vpc vpc-abcdef01234567890
The command output is:
State: ACTIVE
Message: Peering connection active
AWS_VPC_PEERING_CONNECTION_ID TYPE
============================= =================================
pcx-abcdef01234567890 aws-vpc-peering-connection-active
List peering connections
- Project VPC
- Organization VPC
Command: avn vpc peering-connection list
| Parameter | Information |
|---|---|
--project | The project to use when a project isn't specified for an avn command |
--project-vpc-id | Aiven project VPC ID. To get the list of VPC IDs execute avn vpc list (required) |
Example: List VPC peering connections for the VPC with id
b032dfbf-b035-4cf5-8b15-b7cd6a68aabd.
avn vpc peering-connection list --project-vpc-id b032dfbf-b035-4cf5-8b15-b7cd6a68aabd
The command output is:
PEER_CLOUD_ACCOUNT PEER_RESOURCE_GROUP PEER_VPC PEER_REGION STATE
================== =================== ===================== =========== ======
012345678901 null vpc-abcdef01234567890 us-east-1 ACTIVE
Command: avn organization vpc peering-connection list
| Parameter | Information |
|---|---|
--organization-id | The organization where the peered VPC resides |
--organization-vpc-id | The ID of the peered VPC obtainable with the avn organization vpc list command (required) |
Example: List VPC peering connections for the VPC with id
b032dfbf-b035-4cf5-8b15-b7cd6a68aabd in the org123abc456de organization.
avn organization vpc peering-connection list \
--organization-id org123abc456de \
--organization-vpc-id b032dfbf-b035-4cf5-8b15-b7cd6a68aabd
The command output is similar to:
PEERING_CONNECTION_ID PEER_CLOUD_ACCOUNT PEER_RESOURCE_GROUP PEER_VPC PEER_REGION STATE
==================================== ==================================== =================== ======== =========== ============
123abc45-abcd-1234-abcd-123abc456def 123abc45-1234-abcd-1234-123abc456def test_resource_group test_net null PENDING_PEER