vpc¶
vpc add-tags¶
Usage
usage: -c vpc add-tags [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--force] [--system-tag]
--vpc_ids [--vpc_ids ...] --tags [--tags ...]
Description
Add tags to VPCs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc admin edge-network add-tags¶
Usage
usage: -c vpc admin edge-network add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--network_id [--network_id ...]
--tags [--tags ...]
Description
Add tags to Edge networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc admin edge-network create¶
Usage
usage: -c vpc admin edge-network create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--no-shared]
[--project-id PROJECT_ID]
[--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]]
[--vn-group-id VN_GROUP_ID]
[--physical-network PHYSICAL_NETWORK]
[--vlan VLAN] [--mtu MTU] [--force]
[--subnet-infos SUBNET_INFOS]
[--without-vpc-default-ip-pool]
Description
Return the network object.
Return
Returns dict: EdgeNetwork response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
--no-shared Whether to share this edge network
--project-id PROJECT_ID
Project ID to create the network in
--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]
List of project to assign this edge network to
--vn-group-id VN_GROUP_ID
Guest network pool id (L2) for edge network creation - only one of
vn_group_id and physical_network can appear
--physical-network PHYSICAL_NETWORK
Physical network name (L2) for edge network creation - only one of
vn_group_id and physical_network can appear
--vlan VLAN Physical network vlan tag for edge network creation
--mtu MTU MTU to be used in this network
--force Skip host networking validation
--subnet-infos SUBNET_INFOS
Array of JSON subnet info for this edge network in the format
[{"cidr_block": <cidr_block>,
"gateway_ip": <gateway_ip>,
"allocation_pools": [{"start": <start_ip>, "end": <end_ip>},...],
"dns_nameservers": [ip, ip]}]
--without-vpc-default-ip-pool
Whether to create a default pool for this edgenet
vpc admin edge-network delete¶
Usage
usage: -c vpc admin edge-network delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Return the object name according to type and uuid.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network get¶
Usage
usage: -c vpc admin edge-network get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Returns a VPC based on a VPC ID.
Return
Returns dict: ElasticIp response
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network list¶
Usage
usage: -c vpc admin edge-network list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--network-id [NETWORK_ID [NETWORK_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--physical-network [PHYSICAL_NETWORK [PHYSICAL_NETWORK ...]]]
[--vlan [VLAN [VLAN ...]]]
[--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]]
[--gateway-ip [GATEWAY_IP [GATEWAY_IP ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all Elastic IPs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--network-id [NETWORK_ID [NETWORK_ID ...]]
The ID of the edge network_id
--project-id [PROJECT_ID [PROJECT_ID ...]]
ID of a project
--name [NAME [NAME ...]]
Name of network to filter by
--description [DESCRIPTION [DESCRIPTION ...]]
Description of network to filter by
--physical-network [PHYSICAL_NETWORK [PHYSICAL_NETWORK ...]]
Physical network name to filter by
--vlan [VLAN [VLAN ...]]
VLAN tag of network to filter by
--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]
CIDR block of network to filter by
--gateway-ip [GATEWAY_IP [GATEWAY_IP ...]]
Gateway IP of network to filter by
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc admin edge-network list-tags¶
Usage
usage: -c vpc admin edge-network list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all Edge networks tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network remove-tags¶
Usage
usage: -c vpc admin edge-network remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--force] [--system-tag]
--network_id [--network_id ...]
--tags [--tags ...]
Description
Add tags to Edge networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc admin edge-network set¶
Usage
usage: -c vpc admin edge-network set [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--no-shared NO_SHARED]
[--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]]
[--force] [--subnet-infos SUBNET_INFOS]
network_id
Description
Set all parameters with new values, return the updated network object.
Return
Returns dict: EdgeNetwork response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
--no-shared NO_SHARED
Whether to share this edge network
--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]
List of project to assign this edge network to
--force Skip host networking validation
--subnet-infos SUBNET_INFOS
Array of JSON subnet info for this edge network in the format
[{"id": <subnet_id if exists>,
"cidr_block": <cidr_block>,
"gateway_ip": <gateway_ip>,
"allocation_pools": [{"start": <start_ip>, "end": <end_ip>},...],
"dns_nameservers": [ip, ip]}]
vpc admin edge-network unused-ranges¶
Usage
usage: -c vpc admin edge-network unused-ranges [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
network_id
Description
Utility method listing the unused ranges in edge network.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network update¶
Usage
usage: -c vpc admin edge-network update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--no-shared NO_SHARED]
[--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]]
[--force]
[--subnet-infos SUBNET_INFOS]
network_id
Description
Update parameters that are present in the request, return the updated network object.
Return
Returns dict: EdgeNetwork response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
--no-shared NO_SHARED
Whether to share this edge network
--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]
List of project to assign this edge network to
--force Skip host networking validation
--subnet-infos SUBNET_INFOS
Array of JSON subnet info for this edge network in the format
[{"id": <subnet_id if exists>,
"cidr_block": <cidr_block>,
"gateway_ip": <gateway_ip>,
"allocation_pools": [{"start": <start_ip>, "end": <end_ip>},...],
"dns_nameservers": [ip, ip]}]
vpc admin edge-network-ip-pool add-accounts¶
Usage
usage: -c vpc admin edge-network-ip-pool add-accounts [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
pool_id
Description
Add account to pool_id.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]
The account id
vpc admin edge-network-ip-pool add-ip-ranges¶
Usage
usage: -c vpc admin edge-network-ip-pool add-ip-ranges [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--ip-ranges IP_RANGES]
pool_id
Description
Update parameters that are present in the request, return the updated pool object.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--ip-ranges IP_RANGES
Array of ranges [{"start": <start_ip>, "end": <end_ip>},...]}]
vpc admin edge-network-ip-pool add-tags¶
Usage
usage: -c vpc admin edge-network-ip-pool add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--pool_id [--pool_id ...]
--tags [--tags ...]
Description
Add tags to Edge networks ip pools.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc admin edge-network-ip-pool create¶
Usage
usage: -c vpc admin edge-network-ip-pool create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-ranges IP_RANGES]
[--name NAME]
[--description DESCRIPTION]
[--shared SHARED]
[--assigned-accounts [ASSIGNED_ACCOUNTS [ASSIGNED_ACCOUNTS ...]]]
[--is-vpc-default-ip-pool]
[--is-neutron-ip-pool]
edge_network_id
Description
Return the pool object.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--ip-ranges IP_RANGES
Array of ranges [{"start": <start_ip>, "end": <end_ip>},...]}]
--name NAME The name of the edge network ip pool
--description DESCRIPTION
The description of the pedge network ip pool
--shared SHARED Whether to share this edge network ip pool
--assigned-accounts [ASSIGNED_ACCOUNTS [ASSIGNED_ACCOUNTS ...]]
List of accounts to assign this edge network ip pool
--is-vpc-default-ip-pool
Whether this ip pool is used as default for vpc mode
--is-neutron-ip-pool Whether this ip pool is used for legacy mode
vpc admin edge-network-ip-pool delete¶
Usage
usage: -c vpc admin edge-network-ip-pool delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
pool_id
Description
Return the object name according to type and uuid.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network-ip-pool get¶
Usage
usage: -c vpc admin edge-network-ip-pool get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
pool_id
Description
Returns a VPC based on a VPC ID.
Return
Returns dict: ElasticIp response
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network-ip-pool list¶
Usage
usage: -c vpc admin edge-network-ip-pool list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--pool-id [POOL_ID [POOL_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--shared SHARED]
[--is-vpc-default-ip-pool IS_VPC_DEFAULT_IP_POOL]
[--is-neutron-ip-pool IS_NEUTRON_IP_POOL]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all Elastic IPs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--pool-id [POOL_ID [POOL_ID ...]]
ID of a pool
--project-id [PROJECT_ID [PROJECT_ID ...]]
ID of a project
--name [NAME [NAME ...]]
Name of network to filter by
--description [DESCRIPTION [DESCRIPTION ...]]
Description of network to filter by
--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]
Edge network id to filter by
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--shared SHARED Whether to share this edge network ip pool
--is-vpc-default-ip-pool IS_VPC_DEFAULT_IP_POOL
Whether this ip pool is used as default for vpc mode
--is-neutron-ip-pool IS_NEUTRON_IP_POOL
Whether this ip pool is used for legacy mode
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc admin edge-network-ip-pool list-tags¶
Usage
usage: -c vpc admin edge-network-ip-pool list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all Edge networks tags ip pools.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network-ip-pool remove-accounts¶
Usage
usage: -c vpc admin edge-network-ip-pool remove-accounts [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
pool_id
Description
Remove account to pool_id.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]
The account ids to remove from pool
vpc admin edge-network-ip-pool remove-tags¶
Usage
usage: -c vpc admin edge-network-ip-pool remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--force] [--system-tag]
--pool_id [--pool_id ...]
--tags [--tags ...]
Description
Add tags to Edge networks ip pools.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc admin edge-network-ip-pool set¶
Usage
usage: -c vpc admin edge-network-ip-pool set [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name NAME]
[--description DESCRIPTION]
[--ip-ranges IP_RANGES]
[--shared SHARED]
[--assigned-accounts [ASSIGNED_ACCOUNTS [ASSIGNED_ACCOUNTS ...]]]
[--fill-ratio FILL_RATIO]
pool_id
Description
Set parameters with new values, return the updated network object.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the pool edge
--description DESCRIPTION
The description of the pool edge
--ip-ranges IP_RANGES
Array of ranges [{"start": <start_ip>, "end": <end_ip>},...]}]
--shared SHARED Whether to share this edge network
--assigned-accounts [ASSIGNED_ACCOUNTS [ASSIGNED_ACCOUNTS ...]]
List of accounts to assign this edge network ip pool
--fill-ratio FILL_RATIO
Fill ratio between 0 to 1 to limit the number of allocated ips from ip pool
vpc admin edge-network-ip-pool sync-allocated-ips¶
Usage
usage: -c vpc admin edge-network-ip-pool sync-allocated-ips
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
pool_id
Description
Add account to pool_id.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc admin edge-network-ip-pool update¶
Usage
usage: -c vpc admin edge-network-ip-pool update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name NAME]
[--description DESCRIPTION]
[--shared SHARED]
[--fill-ratio FILL_RATIO]
pool_id
Description
Update parameters that are present in the request, return the updated network object.
Return
Returns dict: Pool edge response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the pool edge
--description DESCRIPTION
The description of the pool edge
--shared SHARED Whether to share this edge network
--fill-ratio FILL_RATIO
Fill ratio between 0 to 1 to limit the number of allocated ips from ip pool
vpc associate-cidr-block¶
Usage
usage: -c vpc associate-cidr-block [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--cidr-block CIDR_BLOCK]
vpc_id
Description
Associate a cidr_block with a VPC object based on the IDs supplied.
Return
Returns dict: Cidr_block Association - can be used for removing the cidr_block from the VPC
Optional
optional arguments:
-h, --help show this help message and exit
--cidr-block CIDR_BLOCK
IPv4 CIDR block to add to the VPC
vpc associate-dhcp-options¶
Usage
usage: -c vpc associate-dhcp-options [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vpc_id dhcp_options_id
Description
Associate a dhcp_option with a VPC object based on the IDs supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc create¶
Usage
usage: -c vpc create [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--is-default] [--name NAME] [--description DESCRIPTION]
[--project-id PROJECT_ID]
cidr_block
Description
Creates a new VPC object.
Return
Returns dict: Vpc response
Optional
optional arguments:
-h, --help show this help message and exit
--is-default Create a default VPC
--name NAME The name for this VPC
--description DESCRIPTION
The description for this VPC
--project-id PROJECT_ID
ID of the project
vpc create-default¶
Usage
usage: -c vpc create-default [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project-id PROJECT_ID]
Description
Recreates the default VPC object.
Return
Returns dict: Vpc response
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
ID of the project
vpc delete¶
Usage
usage: -c vpc delete [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--force]
vpc_id
Description
Deletes a single VPC object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to delete non-default-created resources
vpc dhcp-options add-tags¶
Usage
usage: -c vpc dhcp-options add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--dhcp_options_id [--dhcp_options_id ...]
--tags [--tags ...]
Description
Add tags to DHCP options.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc dhcp-options create¶
Usage
usage: -c vpc dhcp-options create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--dhcp-options DHCP_OPTIONS]
[--project-id PROJECT_ID]
Description
Creates a new VPC project config object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Domain name to use within the associated VPC/s
--description DESCRIPTION
Domain name to use within the associated VPC/s
--dhcp-options DHCP_OPTIONS
List of dhcp_option objects in the form:
[{"key": "<key_name>", "value": "<value>"}, {"key": "<key_name>", "value": "<value>"}...]
e.g. [{"key": "domain-name-servers", "value": "8.8.8.8"}, {"key": "domain-name-servers", "value": "8.8.4.4"}
, {"key": "domain-name", "value": "stratoscale.com"}...]
where key_name is one of the enums:
- domain-name-servers
- domain-name
- ntp-servers
- netbios-name-servers
- netbios-node-type
--project-id PROJECT_ID
UUID of the project
vpc dhcp-options create-default¶
Usage
usage: -c vpc dhcp-options create-default [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--project-id PROJECT_ID]
Description
Creates the default VPC project config object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
UUID of the project
vpc dhcp-options delete¶
Usage
usage: -c vpc dhcp-options delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
dhcp_options_id
Description
Delete a VPC project config object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc dhcp-options get¶
Usage
usage: -c vpc dhcp-options get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
dhcp_options_id
Description
Get the VPC project config object.
Return
Returns dict: DhcpOption object
Optional
optional arguments:
-h, --help show this help message and exit
vpc dhcp-options list¶
Usage
usage: -c vpc dhcp-options list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--dhcp-options-id [DHCP_OPTIONS_ID [DHCP_OPTIONS_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--domain-name-server [DOMAIN_NAME_SERVER [DOMAIN_NAME_SERVER ...]]]
[--domain-name [DOMAIN_NAME [DOMAIN_NAME ...]]]
[--ntp-server [NTP_SERVER [NTP_SERVER ...]]]
[--netbios-name-server [NETBIOS_NAME_SERVER [NETBIOS_NAME_SERVER ...]]]
[--netbios-node-type [NETBIOS_NODE_TYPE [NETBIOS_NODE_TYPE ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all VPC project config objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--dhcp-options-id [DHCP_OPTIONS_ID [DHCP_OPTIONS_ID ...]]
Filter by UUIDs of the dhcp_option
--name [NAME [NAME ...]]
Filter by name of the dhcp_option
--description [DESCRIPTION [DESCRIPTION ...]]
Filter by description of the dhcp_option
--project-id [PROJECT_ID [PROJECT_ID ...]]
Filter by list of project_ids
--domain-name-server [DOMAIN_NAME_SERVER [DOMAIN_NAME_SERVER ...]]
Filter by domain name servers IP addresses
--domain-name [DOMAIN_NAME [DOMAIN_NAME ...]]
Filter by domain names
--ntp-server [NTP_SERVER [NTP_SERVER ...]]
Filter by ntp servers
--netbios-name-server [NETBIOS_NAME_SERVER [NETBIOS_NAME_SERVER ...]]
Filter by netbios name servers
--netbios-node-type [NETBIOS_NODE_TYPE [NETBIOS_NODE_TYPE ...]]
Filter by by netbios node types
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc dhcp-options list-tags¶
Usage
usage: -c vpc dhcp-options list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all DHCP options tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc dhcp-options remove-tags¶
Usage
usage: -c vpc dhcp-options remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--dhcp_options_id
[--dhcp_options_id ...] --tags
[--tags ...]
Description
Add tags to DHCP options.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc dhcp-options update¶
Usage
usage: -c vpc dhcp-options update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
dhcp_options_id
Description
Update a single dhcp_options object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the dhcp_options
--description DESCRIPTION
The description of the dhcp_options
vpc direct-network add-tags¶
Usage
usage: -c vpc direct-network add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--networks_id [--networks_id ...] --tags
[--tags ...]
Description
Add tags to direct-networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc direct-network attach¶
Usage
usage: -c vpc direct-network attach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id vpc_id
Description
Attaches a direct network to a VPC, enabling connectivity between the VPC and private external resources.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc direct-network create¶
Usage
usage: -c vpc direct-network create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--vpc-id VPC_ID]
[--name NAME] [--description DESCRIPTION]
project_id vn_group_id vlan cidr_block
gateway_ip allocation_pools
Description
Creates a direct-network.
Return
Returns dict: Direct-Network
Optional
optional arguments:
-h, --help show this help message and exit
--vpc-id VPC_ID ID of subnet VPC
--name NAME The name of the network
--description DESCRIPTION
The description of the network
vpc direct-network delete¶
Usage
usage: -c vpc direct-network delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Deletes a single direct-network by network ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc direct-network detach¶
Usage
usage: -c vpc direct-network detach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Detaches a direct-network from a VPC, disabling connectivity between the VPC and private external resources on it.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc direct-network get¶
Usage
usage: -c vpc direct-network get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Returns a direct-network by network ID.
Return
Returns dict: Direct-Network
Optional
optional arguments:
-h, --help show this help message and exit
vpc direct-network list¶
Usage
usage: -c vpc direct-network list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--name [NAME [NAME ...]]]
[--network-id [NETWORK_ID [NETWORK_ID ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]]
[--vn-group-id [VN_GROUP_ID [VN_GROUP_ID ...]]]
[--vlan [VLAN [VLAN ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns list of direct-networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--project-id [PROJECT_ID [PROJECT_ID ...]]
List of project IDs to filter by. Maps to AWS ownerId
--name [NAME [NAME ...]]
List of network names to filter by
--network-id [NETWORK_ID [NETWORK_ID ...]]
List of network IDs to filter by
--vpc-id [VPC_ID [VPC_ID ...]]
List of VPC IDs to filter by
--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]
List of IPv4 CIDR blocks of the network to filter by
--vn-group-id [VN_GROUP_ID [VN_GROUP_ID ...]]
List of guest network pool ids to filter by
--vlan [VLAN [VLAN ...]]
List of vlan tags to filter by
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc direct-network list-tags¶
Usage
usage: -c vpc direct-network list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all direct-network tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc direct-network remove-tags¶
Usage
usage: -c vpc direct-network remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--networks_id [--networks_id ...]
--tags [--tags ...]
Description
Remove tags from direct-networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc direct-network update¶
Usage
usage: -c vpc direct-network update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--gateway-ip GATEWAY_IP]
[--allocation-pools ALLOCATION_POOLS]
network_id
Description
Update a single direct-network by network ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
--gateway-ip GATEWAY_IP
The gateway IP of the direct network subnet
--allocation-pools ALLOCATION_POOLS
List of allocation pools in subnet for vpc resources in the format:
[{"start": <start_ip_address>, "end": <end_ip_address>},...]
Note 1: Allocation pools must contain at least 5 ip addresses
Note 2: Allocation pools must not contain the gateway ip or the first or last ip addresses of the CIDR block
vpc disassociate-cidr-block¶
Usage
usage: -c vpc disassociate-cidr-block [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
cidr_assoc_id
Description
Disassociate a cidr_block from a VPC object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc disassociate-dhcp-options¶
Usage
usage: -c vpc disassociate-dhcp-options [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vpc_id
Description
Disassociate a dhcp_option from a VPC object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc dns add¶
Usage
usage: -c vpc dns add [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
vpc_id ip_address record_type dns_domain dns_name
Description
Creates a DNS record within a VPC context.
Return
Returns dict: The DNS record
Optional
optional arguments:
-h, --help show this help message and exit
vpc dns delete¶
Usage
usage: -c vpc dns delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
record_id
Description
Deletes the specified DNS record from the VPC context.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc dns get¶
Usage
usage: -c vpc dns get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
record_id
Description
Returns all DNS records according to filter.
Return
Returns dict: List of DNS records for this ID
Optional
optional arguments:
-h, --help show this help message and exit
vpc dns get-single¶
Usage
usage: -c vpc dns get-single [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
record_id ip_address
Description
Returns all DNS records according to filter.
Return
Returns dict: List of DNS records for this ID
Optional
optional arguments:
-h, --help show this help message and exit
vpc dns list¶
Usage
usage: -c vpc dns list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--record-id [RECORD_ID [RECORD_ID ...]]]
[--ip-address [IP_ADDRESS [IP_ADDRESS ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]] [--only-eni]
[--record-type [RECORD_TYPE [RECORD_TYPE ...]]]
[--dns-domain [DNS_DOMAIN [DNS_DOMAIN ...]]]
[--dns-name [DNS_NAME [DNS_NAME ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
Description
Returns all DNS records according to filter.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--record-id [RECORD_ID [RECORD_ID ...]]
The record type to filter on
--ip-address [IP_ADDRESS [IP_ADDRESS ...]]
The IP address to filter on
--vpc-id [VPC_ID [VPC_ID ...]]
The ID of the VPCs to filter on
--only-eni Filter out non-network-interface DNS records
--record-type [RECORD_TYPE [RECORD_TYPE ...]]
The record type to filter on - for now only A is supported
--dns-domain [DNS_DOMAIN [DNS_DOMAIN ...]]
The DNS domain part of the records
--dns-name [DNS_NAME [DNS_NAME ...]]
The DNS name part of the records
--project-id [PROJECT_ID [PROJECT_ID ...]]
The ID of a VPC to create the record in
vpc dns update¶
Usage
usage: -c vpc dns update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--ip-address IP_ADDRESS]
[--dns-domain DNS_DOMAIN] [--dns-name DNS_NAME]
record_id
Description
Creates a DNS record within a VPC context.
Return
Returns dict: The DNS record
Optional
optional arguments:
-h, --help show this help message and exit
--ip-address IP_ADDRESS
The IP address to resolve to
--dns-domain DNS_DOMAIN
The DNS domain part of this record
--dns-name DNS_NAME The DNS name part of this record
vpc elastic-ip add-tags¶
Usage
usage: -c vpc elastic-ip add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--eip_id [--eip_id ...] --tags [--tags ...]
Description
Add tags to elastic IPs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc elastic-ip associate-elastic-ip¶
Usage
usage: -c vpc elastic-ip associate-elastic-ip [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--network-interface-id NETWORK_INTERFACE_ID]
[--instance-id INSTANCE_ID]
[--private-ip-address PRIVATE_IP_ADDRESS]
[--prevent-reassociation]
[--allow-port-reassociation]
eip_id
Description
Associate a elastic_ip address with an instance or a network interface.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--network-interface-id NETWORK_INTERFACE_ID
ID of the network_interface_id to associate the elastic_ip with
--instance-id INSTANCE_ID
ID of the instance to associate the elastic_ip with
--private-ip-address PRIVATE_IP_ADDRESS
Private IP Address to associate the elastic_ip with
--prevent-reassociation
Prevent reassociation of the elastic_ip is already associated
--allow-port-reassociation
Allow reassociation to a port that is already associated
vpc elastic-ip create¶
Usage
usage: -c vpc elastic-ip create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--address ADDRESS]
[--project-id PROJECT_ID] [--pool-id POOL_ID]
Description
Creates a new network interface object.
Return
Returns dict: ElasticIp response
Optional
optional arguments:
-h, --help show this help message and exit
--address ADDRESS The requested IPv4 address, may not be
--project-id PROJECT_ID
UUID of the project
--pool-id POOL_ID UUID of the pool to allocate from
vpc elastic-ip delete¶
Usage
usage: -c vpc elastic-ip delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--override-protection]
eip_id
Description
Deletes a single network interface object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the EIP is protected from deletion
e.g. an internal resource. Allowed only for admins
vpc elastic-ip disassociate-elastic-ip¶
Usage
usage: -c vpc elastic-ip disassociate-elastic-ip [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
eip_id
Description
Disassociate an elastic from address from the instance or network interface it’s associated with.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc elastic-ip get¶
Usage
usage: -c vpc elastic-ip get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
eip_id
Description
Returns a VPC based on a VPC ID.
Return
Returns dict: ElasticIp response
Optional
optional arguments:
-h, --help show this help message and exit
vpc elastic-ip list¶
Usage
usage: -c vpc elastic-ip list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--eip-id [EIP_ID [EIP_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--association-id [ASSOCIATION_ID [ASSOCIATION_ID ...]]]
[--instance-id [INSTANCE_ID [INSTANCE_ID ...]]]
[--network-interface-id [NETWORK_INTERFACE_ID [NETWORK_INTERFACE_ID ...]]]
[--network-interface-owner-id [NETWORK_INTERFACE_OWNER_ID [NETWORK_INTERFACE_OWNER_ID ...]]]
[--private-ip-address [PRIVATE_IP_ADDRESS [PRIVATE_IP_ADDRESS ...]]]
[--public-ip [PUBLIC_IP [PUBLIC_IP ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all Elastic IPs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--eip-id [EIP_ID [EIP_ID ...]]
The ID of the elastic IP
--project-id [PROJECT_ID [PROJECT_ID ...]]
ID of a project
--association-id [ASSOCIATION_ID [ASSOCIATION_ID ...]]
The ID of an association with a elastic IP
--instance-id [INSTANCE_ID [INSTANCE_ID ...]]
The ID of the instance to which the elastic IP is attached to
--network-interface-id [NETWORK_INTERFACE_ID [NETWORK_INTERFACE_ID ...]]
The ID of the network interface to which the elastic IP is attached to
--network-interface-owner-id [NETWORK_INTERFACE_OWNER_ID [NETWORK_INTERFACE_OWNER_ID ...]]
The ID of the network interface owner to which the elastic IP is attached to
--private-ip-address [PRIVATE_IP_ADDRESS [PRIVATE_IP_ADDRESS ...]]
Private IPv4 address associated with the elastic IP
--public-ip [PUBLIC_IP [PUBLIC_IP ...]]
The public IPv4 address of the elastic IP
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc elastic-ip list-tags¶
Usage
usage: -c vpc elastic-ip list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all elastic IP tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc elastic-ip remove-tags¶
Usage
usage: -c vpc elastic-ip remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--eip_id [--eip_id ...] --tags
[--tags ...]
Description
Add tags to elastic IPs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc engine get¶
Usage
usage: -c vpc engine get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
engine_id
Description
Returns a engine based on a engine ID.
Return
Returns dict: Engine response
Optional
optional arguments:
-h, --help show this help message and exit
vpc engine list¶
Usage
usage: -c vpc engine list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--full-details] [--service-name SERVICE_NAME]
[--include-all]
Description
Returns all engine objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--include-all (Optional) Whether to include unusable engines
vpc engine revision create¶
Usage
usage: -c vpc engine revision create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--storage-pool-id STORAGE_POOL_ID]
[--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID]
[--name NAME] [--description DESCRIPTION]
[--engine-name ENGINE_NAME]
[--engine-description ENGINE_DESCRIPTION]
[--version-name VERSION_NAME]
[--version-description VERSION_DESCRIPTION]
[--gcm-role-states GCM_ROLE_STATES]
[--gcm-state-file-details GCM_STATE_FILE_DETAILS]
[--file-details FILE_DETAILS]
[--service-info SERVICE_INFO]
[--vm-constraints VM_CONSTRAINTS]
[--service-constraints SERVICE_CONSTRAINTS]
[--service-capabilities SERVICE_CAPABILITIES]
[--gcm-info GCM_INFO]
service_name engine_family version_family
sequence logo_variant logo_contents
vm_image_details
Description
Creates new revision.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
--storage-pool-id STORAGE_POOL_ID
(Optional) The id of the storage pool on which to store the image
--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
--name NAME (Optional) The name of the revision
--description DESCRIPTION
(Optional) The description of the revision
--engine-name ENGINE_NAME
(Optional) The name of the engine
--engine-description ENGINE_DESCRIPTION
(Optional) The description of the engine
--version-name VERSION_NAME
(Optional) The name of the version
--version-description VERSION_DESCRIPTION
(Optional) The description of the version
--gcm-role-states GCM_ROLE_STATES
(Optional) GCM states to use in role
--gcm-state-file-details GCM_STATE_FILE_DETAILS
(Optional) GCM state files to register
--file-details FILE_DETAILS
(Optional) File information
--service-info SERVICE_INFO
(Optional) Service specific information
--vm-constraints VM_CONSTRAINTS
(Optional) Constraints for creating the VM
--service-constraints SERVICE_CONSTRAINTS
(Optional) Service specific constraints
--service-capabilities SERVICE_CAPABILITIES
(Optional) Service specific capabilities
--gcm-info GCM_INFO (Optional) GCM specific information
vpc engine revision delete¶
Usage
usage: -c vpc engine revision delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
revision_id
Description
Deletes a single revision object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc engine revision get¶
Usage
usage: -c vpc engine revision get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
revision_id
Description
Returns a revision based on a revision ID.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
vpc engine revision list¶
Usage
usage: -c vpc engine revision list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--full-details]
[--service-name SERVICE_NAME]
[--engine-id ENGINE_ID]
[--version-id VERSION_ID] [--include-all]
Description
Returns all revision objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--engine-id ENGINE_ID
(Optional) Engine ID to filter on
--version-id VERSION_ID
(Optional) Version ID to filter on
--include-all (Optional) Whether to include unusable revisions
vpc engine revision update¶
Usage
usage: -c vpc engine revision update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--enabled ENABLED]
[--storage-pool-id STORAGE_POOL_ID]
revision_id
Description
Modify an engine.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The version name
--description DESCRIPTION
(Optional) Description of the version
--enabled ENABLED (Optional) False if not to be presented for creation
--storage-pool-id STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
vpc engine update¶
Usage
usage: -c vpc engine update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION] [--enabled ENABLED]
[--default-version-id DEFAULT_VERSION_ID]
[--logo-variant LOGO_VARIANT]
[--logo-contents LOGO_CONTENTS]
engine_id
Description
Modify an engine.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The engine name
--description DESCRIPTION
(Optional) Description of the engine
--enabled ENABLED (Optional) False if not to be presented for creation
--default-version-id DEFAULT_VERSION_ID
(Optional) The default version ID
--logo-variant LOGO_VARIANT
'Version' of the logo
--logo-contents LOGO_CONTENTS
Contents of the logo in SVG format
vpc engine version get¶
Usage
usage: -c vpc engine version get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
version_id
Description
Returns a version based on a version ID.
Return
Returns dict: Version response
Optional
optional arguments:
-h, --help show this help message and exit
vpc engine version list¶
Usage
usage: -c vpc engine version list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--full-details]
[--service-name SERVICE_NAME]
[--engine-id ENGINE_ID] [--include-all]
Description
Returns all version objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--engine-id ENGINE_ID
(Optional) Engine ID to filter on
--include-all (Optional) Whether to include unusable versions
vpc engine version revisions¶
Usage
usage: -c vpc engine version revisions [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--include-all]
version_id
Description
List all revisions for a specified version.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--include-all (Optional) Whether to include unusable versions
vpc engine version update¶
Usage
usage: -c vpc engine version update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--enabled ENABLED]
[--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID]
version_id
Description
Modify an engine.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The version name
--description DESCRIPTION
(Optional) Description of the version
--enabled ENABLED (Optional) False if not to be presented for creation
--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
vpc engine version validate-enabled-revision¶
Usage
usage: -c vpc engine version validate-enabled-revision [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
version_id
Description
Validate and return the enabled_revision of the specified version.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
vpc get¶
Usage
usage: -c vpc get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--with-tags]
vpc_id
Description
Returns a VPC based on a VPC ID.
Return
Returns dict: VPC response
Optional
optional arguments:
-h, --help show this help message and exit
--with-tags Flag that indicates if list should get ports-tags or not
vpc internet-gateway add-tags¶
Usage
usage: -c vpc internet-gateway add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--internet_gateway_id
[--internet_gateway_id ...] --tags
[--tags ...]
Description
Add tags to internet gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc internet-gateway attach¶
Usage
usage: -c vpc internet-gateway attach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
internet_gateway_id vpc_id
Description
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc internet-gateway create¶
Usage
usage: -c vpc internet-gateway create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--project-id PROJECT_ID]
Description
Create internet gateway.
Return
Returns dict: The newly created internet gateway id
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the internet gateway
--description DESCRIPTION
The description of the internet gateway
--project-id PROJECT_ID
UUID of the project
vpc internet-gateway delete¶
Usage
usage: -c vpc internet-gateway delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
internet_gateway_id
Description
Remove internet gateway.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc internet-gateway detach¶
Usage
usage: -c vpc internet-gateway detach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
internet_gateway_id vpc_id
Description
Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc internet-gateway get¶
Usage
usage: -c vpc internet-gateway get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
internet_gateway_id
Description
Get internet gateway.
Return
Returns dict: The internet gateway
Optional
optional arguments:
-h, --help show this help message and exit
vpc internet-gateway list¶
Usage
usage: -c vpc internet-gateway list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--attachment-state [ATTACHMENT_STATE [ATTACHMENT_STATE ...]]]
[--attachment-vpc-id [ATTACHMENT_VPC_ID [ATTACHMENT_VPC_ID ...]]]
[--internet-gateway-id [INTERNET_GATEWAY_ID [INTERNET_GATEWAY_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
Description
Describe internet gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--attachment-state [ATTACHMENT_STATE [ATTACHMENT_STATE ...]]
The current state of the attachment between the gateway and the VPC (available)
--attachment-vpc-id [ATTACHMENT_VPC_ID [ATTACHMENT_VPC_ID ...]]
The ID of an attached VPC
--internet-gateway-id [INTERNET_GATEWAY_ID [INTERNET_GATEWAY_ID ...]]
The ID of the Internet gateway
--name [NAME [NAME ...]]
The NAME of an internet gateway
--description [DESCRIPTION [DESCRIPTION ...]]
The Description of the internet gateway
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
--project-id [PROJECT_ID [PROJECT_ID ...]]
The project_id of the Internet gateway
vpc internet-gateway list-tags¶
Usage
usage: -c vpc internet-gateway list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all internet gateway tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc internet-gateway remove-tags¶
Usage
usage: -c vpc internet-gateway remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--force] [--system-tag]
--internet_gateway_id
[--internet_gateway_id ...] --tags
[--tags ...]
Description
Add tags to internet gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc internet-gateway update¶
Usage
usage: -c vpc internet-gateway update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
internet_gateway_id
Description
Update a single internet_gateway object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the internet_gateway
--description DESCRIPTION
The description of the internet_gateway
vpc list¶
Usage
usage: -c vpc list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--vpc-id [VPC_ID [VPC_ID ...]]] [--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--cidr [CIDR [CIDR ...]]]
[--dhcp-options-id [DHCP_OPTIONS_ID [DHCP_OPTIONS_ID ...]]]
[--state [STATE [STATE ...]]]
[--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]]
[--is-default IS_DEFAULT] [--skip-deleting]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all VPC objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--vpc-id [VPC_ID [VPC_ID ...]]
List of VPC IDs to filter by
--name [NAME [NAME ...]]
List of VPC names to filter by
--description [DESCRIPTION [DESCRIPTION ...]]
List of VPC description to filter by
--project-id [PROJECT_ID [PROJECT_ID ...]]
List of projects IDs to filter by
--cidr [CIDR [CIDR ...]]
List of primary IPv4 CIDR blocks of the VPC to filter by
--dhcp-options-id [DHCP_OPTIONS_ID [DHCP_OPTIONS_ID ...]]
List of DHCP options IDs set to filter by
--state [STATE [STATE ...]]
List of states of the VPC (pending | available) to filter by
--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]
List of edge networks IDs to filter by
--is-default IS_DEFAULT
Filter by default VPCs
--skip-deleting Filter VPC in deleting state
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc list-tags¶
Usage
usage: -c vpc list-tags [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all VPC tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc mode get-cluster-mode¶
Usage
usage: -c vpc mode get-cluster-mode [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Return the object name according to type and uuid.
Return
Returns dict: {“mode”: (legacy|vpc)}
Optional
optional arguments:
-h, --help show this help message and exit
vpc mode get-project-mode¶
Usage
usage: -c vpc mode get-project-mode [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--project-id PROJECT_ID]
Description
Return the object name according to type and uuid.
Return
Returns dict: {“mode”: (legacy|vpc)}
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
Id of the project to get its network mode
vpc nat-gateway add-tags¶
Usage
usage: -c vpc nat-gateway add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
--nat_gateway_id [--nat_gateway_id ...]
--tags [--tags ...]
Description
Add tags to nat gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
vpc nat-gateway create¶
Usage
usage: -c vpc nat-gateway create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
network_id allocation_id
Description
Create nat gateway.
Return
Returns dict: The newly created nat gateway id
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the nat gateway
--description DESCRIPTION
The description of the nat gateway
vpc nat-gateway delete¶
Usage
usage: -c vpc nat-gateway delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
nat_gateway_id
Description
Remove nat gateway.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc nat-gateway get¶
Usage
usage: -c vpc nat-gateway get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
nat_gateway_id
Description
Get nat gateway.
Return
Returns dict: The nat gateway
Optional
optional arguments:
-h, --help show this help message and exit
vpc nat-gateway list¶
Usage
usage: -c vpc nat-gateway list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--nat-gateway-id [NAT_GATEWAY_ID [NAT_GATEWAY_ID ...]]]
[--state [STATE [STATE ...]]]
[--network-id [NETWORK_ID [NETWORK_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--user-id [USER_ID [USER_ID ...]]]
Description
Describe nat gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--nat-gateway-id [NAT_GATEWAY_ID [NAT_GATEWAY_ID ...]]
The ID of the Nat gateway
--state [STATE [STATE ...]]
The state pf the Nat gateway
--network-id [NETWORK_ID [NETWORK_ID ...]]
The network of the Nat gateway
--project-id [PROJECT_ID [PROJECT_ID ...]]
The project of the Nat gateway
--vpc-id [VPC_ID [VPC_ID ...]]
The id of the vpc of the nat gateway
--name [NAME [NAME ...]]
The name of an nat gateway
--description [DESCRIPTION [DESCRIPTION ...]]
The description of an nat gateway
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
--user-id [USER_ID [USER_ID ...]]
List of user ids of the Nat gateway
vpc nat-gateway remove-tags¶
Usage
usage: -c vpc nat-gateway remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
--nat_gateway_id [--nat_gateway_id ...]
--tags [--tags ...]
Description
Add tags to nat gateways.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
vpc nat-gateway update¶
Usage
usage: -c vpc nat-gateway update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
nat_gateway_id
Description
Update a single nat_gateway object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the nat_gateway
--description DESCRIPTION
The description of the nat_gateway
vpc network add-tags¶
Usage
usage: -c vpc network add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--networks_id [--networks_id ...] --tags
[--tags ...]
Description
Add tags to networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc network create¶
Usage
usage: -c vpc network create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
vpc_id cidr_block
Description
Creates a network.
Return
Returns dict: Network response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
vpc network delete¶
Usage
usage: -c vpc network delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Deletes a single network object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc network get¶
Usage
usage: -c vpc network get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Returns a network based on a network ID.
Return
Returns dict: Networks response
Optional
optional arguments:
-h, --help show this help message and exit
vpc network get-default-network-id¶
Usage
usage: -c vpc network get-default-network-id [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
project_id
Description
Return the default network id of the default VPC of a project.
Return
Returns dict: A dictionary containing the result
Optional
optional arguments:
-h, --help show this help message and exit
vpc network list¶
Usage
usage: -c vpc network list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--network-id [NETWORK_ID [NETWORK_ID ...]]]
[--name [NAME [NAME ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]]
[--is-default IS_DEFAULT]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--allow-non-vpc-direct-networks]
Description
Returns all networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--network-id [NETWORK_ID [NETWORK_ID ...]]
List of network IDs to filter by
--name [NAME [NAME ...]]
List of network names to filter by
--vpc-id [VPC_ID [VPC_ID ...]]
List of VPC IDs to filter by
--project-id [PROJECT_ID [PROJECT_ID ...]]
List of project IDs to filter by. Maps to AWS ownerId
--cidr-block [CIDR_BLOCK [CIDR_BLOCK ...]]
List of IPv4 CIDR blocks of the network to filter by
--is-default IS_DEFAULT
Whether the subnet is the default subnet of the vpc
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
--allow-non-vpc-direct-networks
Whether to include detached direct-networks
vpc network list-tags¶
Usage
usage: -c vpc network list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all network tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc network remove-tags¶
Usage
usage: -c vpc network remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--networks_id [--networks_id ...] --tags
[--tags ...]
Description
Add tags to networks.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc network set-default¶
Usage
usage: -c vpc network set-default [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
network_id
Description
Set the network as default subnet in VPC.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc network update¶
Usage
usage: -c vpc network update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
network_id
Description
Update a single network object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network
--description DESCRIPTION
The description of the network
vpc network-interface add-tags¶
Usage
usage: -c vpc network-interface add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--network_interface_ids
[--network_interface_ids ...] --tags
[--tags ...]
Description
Add tags to network interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc network-interface create¶
Usage
usage: -c vpc network-interface create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--secondary-ip-address-count SECONDARY_IP_ADDRESS_COUNT]
[--private-ip-addresses PRIVATE_IP_ADDRESSES]
[--project-id PROJECT_ID]
[--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
network_id
Description
Creates a new network interface object.
Return
Returns dict: NetworkInterfaces response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the network interface
--description DESCRIPTION
A description provided by the user
--secondary-ip-address-count SECONDARY_IP_ADDRESS_COUNT
The number of secondary private IPv4 addresses to assign
--private-ip-addresses PRIVATE_IP_ADDRESSES
One or more private IPv4 addresses in the format
[{"private_ip_address": "1.2.3.4", "primary": true}]
--project-id PROJECT_ID
The UUID of the project to which this network interface belongs
--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
One or more security group IDs
vpc network-interface delete¶
Usage
usage: -c vpc network-interface delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--override-protection]
network_interface_id
Description
Deletes a single network interface object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the eni is protected from deletion
e.g. an internal resource. Allowed only for admins
vpc network-interface get¶
Usage
usage: -c vpc network-interface get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--with-tags]
network_interface_id
Description
Returns a VPC based on a VPC ID.
Return
Returns dict: NetworkInterfaces response
Optional
optional arguments:
-h, --help show this help message and exit
--with-tags Flag that indicates if list should get ports-tags or not
vpc network-interface list¶
Usage
usage: -c vpc network-interface list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--network-interface-id [NETWORK_INTERFACE_ID [NETWORK_INTERFACE_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--network-id [NETWORK_ID [NETWORK_ID ...]]]
[--private-ip-address [PRIVATE_IP_ADDRESS [PRIVATE_IP_ADDRESS ...]]]
[--public-ip-address [PUBLIC_IP_ADDRESS [PUBLIC_IP_ADDRESS ...]]]
[--association-id [ASSOCIATION_ID [ASSOCIATION_ID ...]]]
[--instance-id [INSTANCE_ID [INSTANCE_ID ...]]]
[--attachment-ids [ATTACHMENT_IDS [ATTACHMENT_IDS ...]]]
[--attachment-status [ATTACHMENT_STATUS [ATTACHMENT_STATUS ...]]]
[--security-group-id [SECURITY_GROUP_ID [SECURITY_GROUP_ID ...]]]
[--security-group-name [SECURITY_GROUP_NAME [SECURITY_GROUP_NAME ...]]]
[--private-dns-name [PRIVATE_DNS_NAME [PRIVATE_DNS_NAME ...]]]
[--delete-on-termination DELETE_ON_TERMINATION]
[--source-dest-check SOURCE_DEST_CHECK]
[--port-security-enabled PORT_SECURITY_ENABLED]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--with-tags]
Description
Returns all network interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--network-interface-id [NETWORK_INTERFACE_ID [NETWORK_INTERFACE_ID ...]]
IDs to filter by
--name [NAME [NAME ...]]
The name of a particular element
--description [DESCRIPTION [DESCRIPTION ...]]
The description of a particular element
--vpc-id [VPC_ID [VPC_ID ...]]
The IDs of the VPC to filter by
--project-id [PROJECT_ID [PROJECT_ID ...]]
ID of a project
--network-id [NETWORK_ID [NETWORK_ID ...]]
The UUID of a network. This maps to subnet-id in AWS
--private-ip-address [PRIVATE_IP_ADDRESS [PRIVATE_IP_ADDRESS ...]]
Private IPv4 addresses associated with the network interface
--public-ip-address [PUBLIC_IP_ADDRESS [PUBLIC_IP_ADDRESS ...]]
The public IPv4 addresses associated with a private IP of the network interface
--association-id [ASSOCIATION_ID [ASSOCIATION_ID ...]]
The ID of an association with a floating IP
--instance-id [INSTANCE_ID [INSTANCE_ID ...]]
The ID of the instance to which the network interface is attached
--attachment-ids [ATTACHMENT_IDS [ATTACHMENT_IDS ...]]
The attachment IDs
--attachment-status [ATTACHMENT_STATUS [ATTACHMENT_STATUS ...]]
Attachment status
--security-group-id [SECURITY_GROUP_ID [SECURITY_GROUP_ID ...]]
The ID of a security group associated with the network interface
--security-group-name [SECURITY_GROUP_NAME [SECURITY_GROUP_NAME ...]]
The name of a security group associated with the network interface
--private-dns-name [PRIVATE_DNS_NAME [PRIVATE_DNS_NAME ...]]
The private DNS name of the network interface (IPv4)
--delete-on-termination DELETE_ON_TERMINATION
Indicates whether the attachment is deleted when an instance is terminated
--source-dest-check SOURCE_DEST_CHECK
Indicates whether to performs IP Addresses source/destination checking
--port-security-enabled PORT_SECURITY_ENABLED
Indicates whether to enable/disable anti-spoofing checks (MAC level)
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
--with-tags Flag that indicates if list should get ports-tags or not
vpc network-interface list-tags¶
Usage
usage: -c vpc network-interface list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all network interface tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc network-interface remove-tags¶
Usage
usage: -c vpc network-interface remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--force] [--system-tag]
--network_interface_ids
[--network_interface_ids ...]
--tags [--tags ...]
Description
Add tags to network interfaces.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc network-interface update¶
Usage
usage: -c vpc network-interface update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--description DESCRIPTION]
[--name NAME]
[--private-dns-name PRIVATE_DNS_NAME]
[--src-dst-check SRC_DST_CHECK]
[--security-group-id [SECURITY_GROUP_ID [SECURITY_GROUP_ID ...]]]
[--delete-on-termination DELETE_ON_TERMINATION]
[--port-security-enabled PORT_SECURITY_ENABLED]
network_interface_id
Description
Update a single network interface object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
A description provided by the user
--name NAME The name of the network interface
--private-dns-name PRIVATE_DNS_NAME
Indicates whether the network interface performs source/destination checking
--src-dst-check SRC_DST_CHECK
Indicates whether the network interface performs source/destination checking
--security-group-id [SECURITY_GROUP_ID [SECURITY_GROUP_ID ...]]
The ID of a security group associated with the network interface
--delete-on-termination DELETE_ON_TERMINATION
Indicates whether the attachment is deleted when an instance is terminated
--port-security-enabled PORT_SECURITY_ENABLED
Indicates whether to enable/disable anti-spoofing checks (MAC level)
vpc peering accept¶
Usage
usage: -c vpc peering accept [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
peering_id
Description
Accept a requested vpc peering connection.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc peering add-tags¶
Usage
usage: -c vpc peering add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
--peering_id [--peering_id ...] --tags
[--tags ...]
Description
Add tags to vpc peering.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
vpc peering create¶
Usage
usage: -c vpc peering create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
requester_vpc_id accepter_vpc_id
Description
Create a new vpc peering connection.
Return
Returns dict: The create result
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name of vpc peering connection
--description DESCRIPTION
Description of vpc peering connection
vpc peering delete¶
Usage
usage: -c vpc peering delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
peering_id
Description
Delete an existing vpc peering connection.
Return
Returns dict: The delete result
Optional
optional arguments:
-h, --help show this help message and exit
vpc peering list¶
Usage
usage: -c vpc peering list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--accepter-vpc-info-cidr-block [ACCEPTER_VPC_INFO_CIDR_BLOCK [ACCEPTER_VPC_INFO_CIDR_BLOCK ...]]]
[--accepter-vpc-info-project-id [ACCEPTER_VPC_INFO_PROJECT_ID [ACCEPTER_VPC_INFO_PROJECT_ID ...]]]
[--accepter-vpc-info-vpc-id [ACCEPTER_VPC_INFO_VPC_ID [ACCEPTER_VPC_INFO_VPC_ID ...]]]
[--requester-vpc-info-cidr-block [REQUESTER_VPC_INFO_CIDR_BLOCK [REQUESTER_VPC_INFO_CIDR_BLOCK ...]]]
[--requester-vpc-info-project-id [REQUESTER_VPC_INFO_PROJECT_ID [REQUESTER_VPC_INFO_PROJECT_ID ...]]]
[--requester-vpc-info-vpc-id [REQUESTER_VPC_INFO_VPC_ID [REQUESTER_VPC_INFO_VPC_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--status-code [STATUS_CODE [STATUS_CODE ...]]]
[--ids [IDS [IDS ...]]] [--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Describes one or more of your VPC peering connections.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--accepter-vpc-info-cidr-block [ACCEPTER_VPC_INFO_CIDR_BLOCK [ACCEPTER_VPC_INFO_CIDR_BLOCK ...]]
The IPv4 CIDR block of the accepter VPC
--accepter-vpc-info-project-id [ACCEPTER_VPC_INFO_PROJECT_ID [ACCEPTER_VPC_INFO_PROJECT_ID ...]]
The project id of the accepter vpc
--accepter-vpc-info-vpc-id [ACCEPTER_VPC_INFO_VPC_ID [ACCEPTER_VPC_INFO_VPC_ID ...]]
The ID of the accepter VPC
--requester-vpc-info-cidr-block [REQUESTER_VPC_INFO_CIDR_BLOCK [REQUESTER_VPC_INFO_CIDR_BLOCK ...]]
The IPv4 CIDR block of the requester VPC
--requester-vpc-info-project-id [REQUESTER_VPC_INFO_PROJECT_ID [REQUESTER_VPC_INFO_PROJECT_ID ...]]
The project id of the requester VPC
--requester-vpc-info-vpc-id [REQUESTER_VPC_INFO_VPC_ID [REQUESTER_VPC_INFO_VPC_ID ...]]
The ID of the requester VPC
--name [NAME [NAME ...]]
The name of the VPC peering connection
--description [DESCRIPTION [DESCRIPTION ...]]
The description of the VPC peering connection
--status-code [STATUS_CODE [STATUS_CODE ...]]
The status of the VPC peering connection
--ids [IDS [IDS ...]]
The ID of the VPC peering connection
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc peering reject¶
Usage
usage: -c vpc peering reject [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
peering_id
Description
Reject a requested vpc peering connection.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc peering remove-tags¶
Usage
usage: -c vpc peering remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
--peering_id [--peering_id ...] --tags
[--tags ...]
Description
Add tags to vpc peering.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
vpc peering update¶
Usage
usage: -c vpc peering update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--accepter-name ACCEPTER_NAME]
[--accepter-description ACCEPTER_DESCRIPTION]
peering_id
Description
Update a single network object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the peering connection
--description DESCRIPTION
The description of the peering connection
--accepter-name ACCEPTER_NAME
The name seen by the accepter (admin only)
--accepter-description ACCEPTER_DESCRIPTION
The description seen by the accepter (admin only)
vpc project action¶
Usage
usage: -c vpc project action [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
project_id action
Description
Delete a vpc project config object.
Return
Returns dict: Result: true/false + entity-type: count remaining
Optional
optional arguments:
-h, --help show this help message and exit
vpc project delete¶
Usage
usage: -c vpc project delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
project_id
Description
Delete a vpc project config object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc project get¶
Usage
usage: -c vpc project get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
project_id
Description
Get the vpc project config object.
Return
Returns dict: Project config object
Optional
optional arguments:
-h, --help show this help message and exit
vpc project list¶
Usage
usage: -c vpc project list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]]
[--edgenet-ip-pool-id [EDGENET_IP_POOL_ID [EDGENET_IP_POOL_ID ...]]]
[--flowlogs-enabled FLOWLOGS_ENABLED]
Description
Returns all vpc project config objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--project-id [PROJECT_ID [PROJECT_ID ...]]
Filter by UUID of the project
--edge-network-id [EDGE_NETWORK_ID [EDGE_NETWORK_ID ...]]
Filter by UUID of the neutron edge network
--edgenet-ip-pool-id [EDGENET_IP_POOL_ID [EDGENET_IP_POOL_ID ...]]
Filter by UUID of the edge network ip pool
--flowlogs-enabled FLOWLOGS_ENABLED
Whether to enabled flowlogsfor this project
vpc project provision¶
Usage
usage: -c vpc project provision [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--edge-network-id EDGE_NETWORK_ID]
[--edgenet-ip-pool-id EDGENET_IP_POOL_ID]
[--edge-subnet-id EDGE_SUBNET_ID]
[--without-default-vpc]
project_id
Description
Creates a new vpc project config object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--edge-network-id EDGE_NETWORK_ID
UUID of the neutron edge network
--edgenet-ip-pool-id EDGENET_IP_POOL_ID
UUID of the edge network ip pool
--edge-subnet-id EDGE_SUBNET_ID
UUID of the neutron subnet on the selected end network
--without-default-vpc
Whether to create a default VPC for this project
vpc project reset-edge-network¶
Usage
usage: -c vpc project reset-edge-network [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
project_id
Description
Set the edge network if no other edge network is already attached.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Will force deletion of all resources
vpc project set-edge-network¶
Usage
usage: -c vpc project set-edge-network [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--edge-network-id EDGE_NETWORK_ID]
[--edgenet-ip-pool-id EDGENET_IP_POOL_ID]
[--edge-subnet-id EDGE_SUBNET_ID]
project_id
Description
Set the edge network if no other edge network is already attached.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--edge-network-id EDGE_NETWORK_ID
UUID of the neutron edge network
--edgenet-ip-pool-id EDGENET_IP_POOL_ID
UUID of the edge network ip pool
--edge-subnet-id EDGE_SUBNET_ID
UUID of the neutron subnet on the selected end network
vpc remove-tags¶
Usage
usage: -c vpc remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--vpc_ids [--vpc_ids ...] --tags [--tags ...]
Description
Add tags to VPCs.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc route add¶
Usage
usage: -c vpc route add [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--gateway-id GATEWAY_ID] [--instance-id INSTANCE_ID]
[--nat-gateway-id NAT_GATEWAY_ID]
[--network-interface-id NETWORK_INTERFACE_ID]
[--vpc-connection-id VPC_CONNECTION_ID]
destination_cidr_block route_table_id
Description
Creates a route in a route table within a VPC.
Return
Returns dict: The create result
Optional
optional arguments:
-h, --help show this help message and exit
--gateway-id GATEWAY_ID
The ID of an Internet gateway or virtual private gateway attached to your VPC
--instance-id INSTANCE_ID
The ID of a NAT instance in your VPC
--nat-gateway-id NAT_GATEWAY_ID
(IPv4 traffic only) The ID of a NAT gateway
--network-interface-id NETWORK_INTERFACE_ID
The ID of a network interface
--vpc-connection-id VPC_CONNECTION_ID
The ID of a VPC peering connection
vpc route remove¶
Usage
usage: -c vpc route remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
destination_cidr_block route_table_id
Description
Deletes the specified route from the specified route table.
Return
Returns dict: The remove result
Optional
optional arguments:
-h, --help show this help message and exit
vpc route-table add-tags¶
Usage
usage: -c vpc route-table add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force] [--system-tag]
--route_table_id [--route_table_id ...]
--tags [--tags ...]
Description
Add tags to route tables.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc route-table associate¶
Usage
usage: -c vpc route-table associate [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--network-id NETWORK_ID]
[--association-id ASSOCIATION_ID]
route_table_id
Description
Associate a network with a route table or replace association.
Return
Returns dict: New association ID
Optional
optional arguments:
-h, --help show this help message and exit
--network-id NETWORK_ID
ID of the network to associate the route table with
(optional - either this or association_id must be defined)
--association-id ASSOCIATION_ID
ID of the association to replace
(optional - either this or network_id must be defined)
vpc route-table create¶
Usage
usage: -c vpc route-table create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
vpc_id
Description
Creates a route table.
Return
Returns dict: Route Table response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name of route table
--description DESCRIPTION
Description of route table
vpc route-table delete¶
Usage
usage: -c vpc route-table delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
route_table_id
Description
Delete a route table.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc route-table disassociate¶
Usage
usage: -c vpc route-table disassociate [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
association_id
Description
Delete a network association.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc route-table get¶
Usage
usage: -c vpc route-table get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--with-implicit-associations]
route_table_id
Description
Returns a route table based on a route table ID.
Return
Returns dict: RouteTables response
Optional
optional arguments:
-h, --help show this help message and exit
--with-implicit-associations
Include implicit associations
vpc route-table list¶
Usage
usage: -c vpc route-table list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--route-table-id [ROUTE_TABLE_ID [ROUTE_TABLE_ID ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--name [NAME [NAME ...]]]
[--association-route-table-association-id [ASSOCIATION_ROUTE_TABLE_ASSOCIATION_ID [ASSOCIATION_ROUTE_TABLE_ASSOCIATION_ID ...]]]
[--association-route-table-id [ASSOCIATION_ROUTE_TABLE_ID [ASSOCIATION_ROUTE_TABLE_ID ...]]]
[--association-network-id [ASSOCIATION_NETWORK_ID [ASSOCIATION_NETWORK_ID ...]]]
[--association-main [ASSOCIATION_MAIN [ASSOCIATION_MAIN ...]]]
[--route-destination-cidr-block [ROUTE_DESTINATION_CIDR_BLOCK [ROUTE_DESTINATION_CIDR_BLOCK ...]]]
[--route-destination-prefix-list-id [ROUTE_DESTINATION_PREFIX_LIST_ID [ROUTE_DESTINATION_PREFIX_LIST_ID ...]]]
[--route-gateway-id [ROUTE_GATEWAY_ID [ROUTE_GATEWAY_ID ...]]]
[--route-network-interface-id [ROUTE_NETWORK_INTERFACE_ID [ROUTE_NETWORK_INTERFACE_ID ...]]]
[--route-nat-gateway-id [ROUTE_NAT_GATEWAY_ID [ROUTE_NAT_GATEWAY_ID ...]]]
[--route-vpc-peering-connection-id [ROUTE_VPC_PEERING_CONNECTION_ID [ROUTE_VPC_PEERING_CONNECTION_ID ...]]]
[--route-origin [ROUTE_ORIGIN [ROUTE_ORIGIN ...]]]
[--route-state [ROUTE_STATE [ROUTE_STATE ...]]]
[--with-implicit-associations]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Describes one or more of your route tables.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--route-table-id [ROUTE_TABLE_ID [ROUTE_TABLE_ID ...]]
The ID of the route table
--vpc-id [VPC_ID [VPC_ID ...]]
The ID of the VPC for the route table
--project-id [PROJECT_ID [PROJECT_ID ...]]
The ID of the project
--name [NAME [NAME ...]]
The name of the route table
--association-route-table-association-id [ASSOCIATION_ROUTE_TABLE_ASSOCIATION_ID [ASSOCIATION_ROUTE_TABLE_ASSOCIATION_ID ...]]
The ID of an association ID for the route table
--association-route-table-id [ASSOCIATION_ROUTE_TABLE_ID [ASSOCIATION_ROUTE_TABLE_ID ...]]
The ID of the route table involved in the association
--association-network-id [ASSOCIATION_NETWORK_ID [ASSOCIATION_NETWORK_ID ...]]
The ID of the network involved in the association
--association-main [ASSOCIATION_MAIN [ASSOCIATION_MAIN ...]]
Indicates whether the route table is the main route table for the VPC (true | false)
--route-destination-cidr-block [ROUTE_DESTINATION_CIDR_BLOCK [ROUTE_DESTINATION_CIDR_BLOCK ...]]
The IPv4 CIDR range specified in a route in the table
--route-destination-prefix-list-id [ROUTE_DESTINATION_PREFIX_LIST_ID [ROUTE_DESTINATION_PREFIX_LIST_ID ...]]
The ID (prefix) of the AWS service specified in a route in the table
--route-gateway-id [ROUTE_GATEWAY_ID [ROUTE_GATEWAY_ID ...]]
The ID of a gateway specified in a route in the table
--route-network-interface-id [ROUTE_NETWORK_INTERFACE_ID [ROUTE_NETWORK_INTERFACE_ID ...]]
The ID of an eni specified in a route in the table
--route-nat-gateway-id [ROUTE_NAT_GATEWAY_ID [ROUTE_NAT_GATEWAY_ID ...]]
The ID of a NAT gateway
--route-vpc-peering-connection-id [ROUTE_VPC_PEERING_CONNECTION_ID [ROUTE_VPC_PEERING_CONNECTION_ID ...]]
The ID of a VPC peering connection
--route-origin [ROUTE_ORIGIN [ROUTE_ORIGIN ...]]
Describes how the route was created
--route-state [ROUTE_STATE [ROUTE_STATE ...]]
The state of a route in the route table (active | blackhole)
--with-implicit-associations
Include implicit associations
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
vpc route-table list-tags¶
Usage
usage: -c vpc route-table list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all route table tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc route-table remove-tags¶
Usage
usage: -c vpc route-table remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--route_table_id [--route_table_id ...]
--tags [--tags ...]
Description
Add tags to route tables.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc route-table update¶
Usage
usage: -c vpc route-table update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
route_table_id
Description
Update a single route table object based on the ID supplied and the parameters.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name of the route table
--description DESCRIPTION
The description of the route table
vpc security-group add-tags¶
Usage
usage: -c vpc security-group add-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--security_group_id
[--security_group_id ...] --tags
[--tags ...]
Description
Add tags to security groups.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to add a system tag (available only for admin)
vpc security-group authorize-egress¶
Usage
usage: -c vpc security-group authorize-egress [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-permissions IP_PERMISSIONS]
group_id
Description
Adds one or more egress rules to a security group for use with a VPC.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to authorize
vpc security-group authorize-ingress¶
Usage
usage: -c vpc security-group authorize-ingress [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-permissions IP_PERMISSIONS]
group_id
Description
Adds one or more ingress rules to a security group.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to authorize
vpc security-group create¶
Usage
usage: -c vpc security-group create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--description DESCRIPTION] [--hidden]
name vpc_id
Description
Creates a security group.
Return
Returns dict: The security group return result
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
The description of the security groups
--hidden Create a hidden security group
vpc security-group delete¶
Usage
usage: -c vpc security-group delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--group-id GROUP_ID]
[--name NAME] [--override-protection]
Description
Deletes the specified Security Group. You must detach or delete all resources that are associated with the security group before you can delete it.
Return
Returns dict: The delete operation result
Optional
optional arguments:
-h, --help show this help message and exit
--group-id GROUP_ID The security group ID
--name NAME The security group name
--override-protection
If True, will delete even if the EIP is protected from deletion
e.g. an internal resource. Allowed only for admins
vpc security-group delete-by-id¶
Usage
usage: -c vpc security-group delete-by-id [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--override-protection]
group_id
Description
Deletes the specified Security Group. You must detach or delete all resources that are associated with the security group before you can delete it.
Return
Returns dict: The delete operation result
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the EIP is protected from deletion
e.g. an internal resource. Allowed only for admins
vpc security-group get¶
Usage
usage: -c vpc security-group get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
group_id
Description
Returns all the security groups that satisfy the filter to which the requester has access permissions.
Return
Returns dict: Security group object
Optional
optional arguments:
-h, --help show this help message and exit
vpc security-group list¶
Usage
usage: -c vpc security-group list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--group-id [GROUP_ID [GROUP_ID ...]]]
[--name [NAME [NAME ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--vpc-id [VPC_ID [VPC_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--egress-permissions-cidr [EGRESS_PERMISSIONS_CIDR [EGRESS_PERMISSIONS_CIDR ...]]]
[--egress-permissions-from-port [EGRESS_PERMISSIONS_FROM_PORT [EGRESS_PERMISSIONS_FROM_PORT ...]]]
[--egress-permissions-group-id [EGRESS_PERMISSIONS_GROUP_ID [EGRESS_PERMISSIONS_GROUP_ID ...]]]
[--egress-permissions-group-name [EGRESS_PERMISSIONS_GROUP_NAME [EGRESS_PERMISSIONS_GROUP_NAME ...]]]
[--egress-permissions-ipv6-cidr [EGRESS_PERMISSIONS_IPV6_CIDR [EGRESS_PERMISSIONS_IPV6_CIDR ...]]]
[--egress-permissions-protocol [EGRESS_PERMISSIONS_PROTOCOL [EGRESS_PERMISSIONS_PROTOCOL ...]]]
[--egress-permissions-to-port [EGRESS_PERMISSIONS_TO_PORT [EGRESS_PERMISSIONS_TO_PORT ...]]]
[--egress-permissions-project-id [EGRESS_PERMISSIONS_PROJECT_ID [EGRESS_PERMISSIONS_PROJECT_ID ...]]]
[--ingress-permissions-cidr [INGRESS_PERMISSIONS_CIDR [INGRESS_PERMISSIONS_CIDR ...]]]
[--ingress-permissions-from-port [INGRESS_PERMISSIONS_FROM_PORT [INGRESS_PERMISSIONS_FROM_PORT ...]]]
[--ingress-permissions-group-id [INGRESS_PERMISSIONS_GROUP_ID [INGRESS_PERMISSIONS_GROUP_ID ...]]]
[--ingress-permissions-group-name [INGRESS_PERMISSIONS_GROUP_NAME [INGRESS_PERMISSIONS_GROUP_NAME ...]]]
[--ingress-permissions-ipv6-cidr [INGRESS_PERMISSIONS_IPV6_CIDR [INGRESS_PERMISSIONS_IPV6_CIDR ...]]]
[--ingress-permissions-protocol [INGRESS_PERMISSIONS_PROTOCOL [INGRESS_PERMISSIONS_PROTOCOL ...]]]
[--ingress-permissions-to-port [INGRESS_PERMISSIONS_TO_PORT [INGRESS_PERMISSIONS_TO_PORT ...]]]
[--ingress-permissions-project-id [INGRESS_PERMISSIONS_PROJECT_ID [INGRESS_PERMISSIONS_PROJECT_ID ...]]]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--show-hidden]
Description
Returns all the security groups that satisfy the filter to which the requester has access permissions.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--group-id [GROUP_ID [GROUP_ID ...]]
The ID of the security group
--name [NAME [NAME ...]]
The name of the security group
--description [DESCRIPTION [DESCRIPTION ...]]
The description of the security groups
--vpc-id [VPC_ID [VPC_ID ...]]
The ID of the VPC specified when the security group was created
--project-id [PROJECT_ID [PROJECT_ID ...]]
The Symphony project ID of the owner of the security group
--egress-permissions-cidr [EGRESS_PERMISSIONS_CIDR [EGRESS_PERMISSIONS_CIDR ...]]
An IPv4 CIDR block for an outbound security group rule
--egress-permissions-from-port [EGRESS_PERMISSIONS_FROM_PORT [EGRESS_PERMISSIONS_FROM_PORT ...]]
For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number
--egress-permissions-group-id [EGRESS_PERMISSIONS_GROUP_ID [EGRESS_PERMISSIONS_GROUP_ID ...]]
The ID of a security group that has been referenced in an outbound security group rule
--egress-permissions-group-name [EGRESS_PERMISSIONS_GROUP_NAME [EGRESS_PERMISSIONS_GROUP_NAME ...]]
The name of a security group that has been referenced in an outbound security group rule
--egress-permissions-ipv6-cidr [EGRESS_PERMISSIONS_IPV6_CIDR [EGRESS_PERMISSIONS_IPV6_CIDR ...]]
An IPv6 CIDR block for an outbound security group rule
--egress-permissions-protocol [EGRESS_PERMISSIONS_PROTOCOL [EGRESS_PERMISSIONS_PROTOCOL ...]]
The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number)
--egress-permissions-to-port [EGRESS_PERMISSIONS_TO_PORT [EGRESS_PERMISSIONS_TO_PORT ...]]
For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code
--egress-permissions-project-id [EGRESS_PERMISSIONS_PROJECT_ID [EGRESS_PERMISSIONS_PROJECT_ID ...]]
The ID of a Symphony project that has been referenced in an outbound security group rule
--ingress-permissions-cidr [INGRESS_PERMISSIONS_CIDR [INGRESS_PERMISSIONS_CIDR ...]]
An IPv4 CIDR block for an inbound security group rule
--ingress-permissions-from-port [INGRESS_PERMISSIONS_FROM_PORT [INGRESS_PERMISSIONS_FROM_PORT ...]]
For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number
--ingress-permissions-group-id [INGRESS_PERMISSIONS_GROUP_ID [INGRESS_PERMISSIONS_GROUP_ID ...]]
The ID of a security group that has been referenced in an inbound security group rule
--ingress-permissions-group-name [INGRESS_PERMISSIONS_GROUP_NAME [INGRESS_PERMISSIONS_GROUP_NAME ...]]
The name of a security group that has been referenced in an inbound security group rule
--ingress-permissions-ipv6-cidr [INGRESS_PERMISSIONS_IPV6_CIDR [INGRESS_PERMISSIONS_IPV6_CIDR ...]]
An IPv6 CIDR block for an inbound security group rule
--ingress-permissions-protocol [INGRESS_PERMISSIONS_PROTOCOL [INGRESS_PERMISSIONS_PROTOCOL ...]]
The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number)
--ingress-permissions-to-port [INGRESS_PERMISSIONS_TO_PORT [INGRESS_PERMISSIONS_TO_PORT ...]]
For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code
--ingress-permissions-project-id [INGRESS_PERMISSIONS_PROJECT_ID [INGRESS_PERMISSIONS_PROJECT_ID ...]]
The ID of a Symphony project that has been referenced in an inbound security group rule
--tags [TAGS [TAGS ...]]
List of tag strings to filter by in 'key=value' format
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
List of keys of tags to filter by
--tag-values [TAG_VALUES [TAG_VALUES ...]]
List of value of tags to filter by
--show-hidden Flag indicating if to show hidden security groups
vpc security-group list-tags¶
Usage
usage: -c vpc security-group list-tags [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all security groups tags.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc security-group remove-tags¶
Usage
usage: -c vpc security-group remove-tags [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
[--system-tag]
--security_group_id
[--security_group_id ...] --tags
[--tags ...]
Description
Add tags to security groups.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
vpc security-group revoke-egress¶
Usage
usage: -c vpc security-group revoke-egress [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-permissions IP_PERMISSIONS]
group_id
Description
Removes one or more egress rules from a security group for VPC.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to revoke
vpc security-group revoke-ingress¶
Usage
usage: -c vpc security-group revoke-ingress [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-permissions IP_PERMISSIONS]
group_id
Description
Removes one or more ingress rules from a security group.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to revoke
vpc security-group set-rules¶
Usage
usage: -c vpc security-group set-rules [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--permissions PERMISSIONS]
group_id
Description
Synchronizes the rules with the provided permiossions.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--permissions PERMISSIONS
The IP permissions to revoke
vpc security-group update-security-group-rule-descriptions-egress¶
Usage
usage: -c vpc security-group update-security-group-rule-descriptions-egress
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--ip-permissions IP_PERMISSIONS]
group_id
Description
Removes one or more ingress rules from a security group.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to update
vpc security-group update-security-group-rule-descriptions-ingress¶
Usage
usage: -c vpc security-group update-security-group-rule-descriptions-ingress
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--ip-permissions IP_PERMISSIONS]
group_id
Description
Removes one or more ingress rules from a security group.
Return
Returns dict: The result of the operation
Optional
optional arguments:
-h, --help show this help message and exit
--ip-permissions IP_PERMISSIONS
The IP permissions to update
vpc set-default¶
Usage
usage: -c vpc set-default [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
vpc_id
Description
Sets VPC to be the default VPC of the project.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
vpc update¶
Usage
usage: -c vpc update [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--name NAME] [--description DESCRIPTION]
[--enable-dns-support ENABLE_DNS_SUPPORT]
[--enable-dns-hostnames ENABLE_DNS_HOSTNAMES]
vpc_id
Description
Updates a single VPC object.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The name for this VPC
--description DESCRIPTION
The description for this VPC
--enable-dns-support ENABLE_DNS_SUPPORT
Enable DNS support in VPC (noop)
--enable-dns-hostnames ENABLE_DNS_HOSTNAMES
Enable DNS hostnames in VPC (noop)