vpc

vpc add-tags

Usage

  usage: symp vpc add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                           [--force] [--system-tag]
                           --vpc_ids [--vpc_ids ...] --tags [--tags ...]

Description

Add tags to VPCs.

Mandatory

positional arguments:
  --vpc_ids             IDs of the DHCP options to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc admin edge-network add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                                              [--force] [--system-tag]
                                              --network_id [--network_id ...]
                                              --tags [--tags ...]

Description

Add tags to Edge networks.

Mandatory

positional arguments:
  --network_id          The ID of the edge network to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc admin edge-network create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            [--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]
                                            [--disable-edge-router-public-ip]
                                            [--edge-router-public-ip EDGE_ROUTER_PUBLIC_IP]

Description

Return the network object.

Returns

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
  --disable-edge-router-public-ip
                        Whether to allocate a public IP for the edge router
  --edge-router-public-ip EDGE_ROUTER_PUBLIC_IP
                        Requested public IP address for the edge router
                        If not provided, then a random available IP address will be allocated from the IP pool

vpc admin edge-network delete

Usage

  usage: symp vpc admin edge-network delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            network_id

Description

Deletes a single edge network by network ID.

Mandatory

positional arguments:
  network_id            Id of the network to delete

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network get

Usage

  usage: symp vpc admin edge-network get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         network_id

Description

Returns an edge network based on ID.

Returns

Returns dict: Edge network response

Mandatory

positional arguments:
  network_id            ID of the edge network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network list

Usage

  usage: symp vpc admin edge-network list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--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 edge networks.

Returns

Returns list: Edge network objects

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: symp vpc admin edge-network list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all Edge networks tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network remove-tags

Usage

  usage: symp vpc admin edge-network remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent] [--prefix PREFIX]
                                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                 [--force] [--system-tag]
                                                 --network_id [--network_id ...]
                                                 --tags [--tags ...]

Description

Delete tags from edge networks.

Mandatory

positional arguments:
  --network_id          The ID of the edge network to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc admin edge-network set
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--name NAME]
                                         [--description DESCRIPTION]
                                         [--no-shared NO_SHARED]
                                         [--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]]
                                         [--force] [--subnet-infos SUBNET_INFOS]
                                         [--disable-edge-router-public-ip DISABLE_EDGE_ROUTER_PUBLIC_IP]
                                         [--edge-router-public-ip EDGE_ROUTER_PUBLIC_IP]
                                         [--mtu MTU]
                                         network_id

Description

Set all parameters with new values, return the updated network object.

Returns

Returns dict: EdgeNetwork response

Mandatory

positional arguments:
  network_id            The ID of the network to set

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]}]
  --disable-edge-router-public-ip DISABLE_EDGE_ROUTER_PUBLIC_IP
                        Whether to free the allocated public IP of the edge router
  --edge-router-public-ip EDGE_ROUTER_PUBLIC_IP
                        Requested public IP address for the edge router
  --mtu MTU             The MTU of the network

vpc admin edge-network unused-ranges

Usage

  usage: symp vpc admin edge-network unused-ranges
[-f {adaptive_table,csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--noindent]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                   network_id

Description

Utility method listing the unused ranges in edge network.

Returns

Returns list: List of IpRanges dicts

Mandatory

positional arguments:
  network_id            ID of the edge network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network update

Usage

  usage: symp vpc admin edge-network update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            [--name NAME]
                                            [--description DESCRIPTION]
                                            [--no-shared NO_SHARED]
                                            [--assigned-projects [ASSIGNED_PROJECTS [ASSIGNED_PROJECTS ...]]]
                                            [--force]
                                            [--subnet-infos SUBNET_INFOS]
                                            [--disable-edge-router-public-ip DISABLE_EDGE_ROUTER_PUBLIC_IP]
                                            [--edge-router-public-ip EDGE_ROUTER_PUBLIC_IP]
                                            [--mtu MTU]
                                            network_id

Description

Update parameters that are present in the request, return the updated network object.

Returns

Returns dict: EdgeNetwork response

Mandatory

positional arguments:
  network_id            The ID of the network to update

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]}]
  --disable-edge-router-public-ip DISABLE_EDGE_ROUTER_PUBLIC_IP
                        Whether to free the allocated public IP of the edge router
  --edge-router-public-ip EDGE_ROUTER_PUBLIC_IP
                        Requested public IP address for the edge router
  --mtu MTU             The MTU of the network

vpc admin edge-network upgrade

Usage

  usage: symp vpc admin edge-network upgrade
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--disable-edge-router-public-ip]
                                             [--edge-router-public-ip EDGE_ROUTER_PUBLIC_IP]
                                             network_id

Description

Upgrade the edge network.

Mandatory

positional arguments:
  network_id            ID of the edge network to upgrade

Optional

optional arguments:
  -h, --help            show this help message and exit
  --disable-edge-router-public-ip
                        Whether to allocate a public IP for the edge router
  --edge-router-public-ip EDGE_ROUTER_PUBLIC_IP
                        Requested public IP address for the edge router
                        If not provided, then a random available IP address will be allocated from the IP pool

vpc admin edge-network-ip-pool add-accounts

Usage

  usage: symp vpc admin edge-network-ip-pool add-accounts
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                          [-c COLUMN]
                                                          [--max-width <integer>]
                                                          [--noindent]
                                                          [--prefix PREFIX]
                                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                          [--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
                                                          pool_id

Description

Add account to pool_id.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

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: symp vpc admin edge-network-ip-pool add-ip-ranges
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                           [-c COLUMN]
                                                           [--max-width <integer>]
                                                           [--noindent]
                                                           [--prefix PREFIX]
                                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                           [--ip-ranges IP_RANGES]
                                                           pool_id

Description

Update parameters that are present in the request, return the updated pool object.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

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: symp vpc admin edge-network-ip-pool add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                      [--force] [--system-tag]
                                                      --pool_id [--pool_id ...]
                                                      --tags [--tags ...]

Description

Add tags to Edge networks ip pools.

Mandatory

positional arguments:
  --pool_id             The ID of the edge network ip pool to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc admin edge-network-ip-pool create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                    [--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]
                                                    [--pool-type POOL_TYPE]
                                                    edge_network_id

Description

Return the pool object.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  edge_network_id       Physical edge network id

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  Deprecated. Whether this IP pool is used for legacy mode
  --pool-type POOL_TYPE
                        The IP pool type to create.
                        Possible values: vpc_ip_pool, legacy_ip_pool, routers_ip_pool

vpc admin edge-network-ip-pool delete

Usage

  usage: symp vpc admin edge-network-ip-pool delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                    pool_id

Description

Return the object name according to type and uuid.

Mandatory

positional arguments:
  pool_id               Id of the pool to delete

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network-ip-pool get

Usage

  usage: symp vpc admin edge-network-ip-pool get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent] [--prefix PREFIX]
                                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                 pool_id

Description

Returns a VPC based on a VPC ID.

Returns

Returns dict: ElasticIp response

Mandatory

positional arguments:
  pool_id               ID of the pool to get

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network-ip-pool list

Usage

  usage: symp vpc admin edge-network-ip-pool list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  [--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 ...]]]
                                                  [--pool-types [POOL_TYPES [POOL_TYPES ...]]]

Description

Returns all Elastic IPs.

Returns

Returns list: Edge pools

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
                        Deprecated. Whether this ip pool is used for legacy mode
  --tag-values [TAG_VALUES [TAG_VALUES ...]]
                        List of value of tags to filter by
  --pool-types [POOL_TYPES [POOL_TYPES ...]]
                        The IP pool types to filter by
                        Possible values: vpc_ip_pool, legacy_ip_pool, routers_ip_pool

vpc admin edge-network-ip-pool list-tags

Usage

  usage: symp vpc admin edge-network-ip-pool list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--noindent]
                                                       [--quote {all,minimal,none,nonnumeric}]
                                                       [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all Edge networks tags ip pools.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network-ip-pool remove-accounts

Usage

  usage: symp vpc admin edge-network-ip-pool remove-accounts
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                             [-c COLUMN]
                                                             [--max-width <integer>]
                                                             [--noindent]
                                                             [--prefix PREFIX]
                                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                             [--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
                                                             pool_id

Description

Remove account to pool_id.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

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: symp vpc admin edge-network-ip-pool remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                         [--force]
                                                         [--system-tag]
                                                         --pool_id
                                                         [--pool_id ...] --tags
                                                         [--tags ...]

Description

Delete tags from edge network IP pools.

Mandatory

positional arguments:
  --pool_id             The ID of the edge network ip pool to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc admin edge-network-ip-pool set
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent] [--prefix PREFIX]
                                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                 [--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.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

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 set-default

Usage

  usage: symp vpc admin edge-network-ip-pool set-default
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                         pool_id

Description

Sets an IP pool as the VPC default IP Pool and unsets the previous VPC default pool.

Mandatory

positional arguments:
  pool_id               The ID of the edge network IP pool to set as VPC default

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network-ip-pool sync-allocated-ips

Usage

usage: symp vpc admin edge-network-ip-pool sync-allocated-ips
       [-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
       [--max-width <integer>] [--noindent] [--prefix PREFIX]
       [-m [NAME=VALUE [NAME=VALUE ...]]]
       pool_id

Description

Add account to pool_id.

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc admin edge-network-ip-pool update

Usage

  usage: symp vpc admin edge-network-ip-pool update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                    [--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.

Returns

Returns dict: Pool edge response

Mandatory

positional arguments:
  pool_id               The ID of the pool to update

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: symp vpc associate-cidr-block
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--cidr-block CIDR_BLOCK]
                                       vpc_id

Description

Associate a cidr_block with a VPC object based on the IDs supplied.

Returns

Returns dict: Cidr_block Association - can be used for removing the cidr_block from the VPC

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

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: symp vpc associate-dhcp-options
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         vpc_id dhcp_options_id

Description

Associate a dhcp_option with a VPC object based on the IDs supplied.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object
  dhcp_options_id       ID of the requested dhcp_option set. use None to remove

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc create

Usage

usage: symp vpc create

                       [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                          [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                       [--is-default] [--name NAME]
                       [--description DESCRIPTION] [--project-id PROJECT_ID]
                       cidr_block

Description

Creates a new VPC object.

Returns

Returns dict: Vpc response

Mandatory

positional arguments:
  cidr_block            The IPv4 CIDR block of the VPC. Example - 10.45.0.0/16

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: symp vpc create-default
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--project-id PROJECT_ID]

Description

Recreates the default VPC object.

Returns

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: symp vpc delete

                       [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                          [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                       [--force]
                       vpc_id

Description

Deletes a single VPC object based on the ID supplied.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

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: symp vpc dhcp-options add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--force] [--system-tag]
                                        --dhcp_options_id
                                        [--dhcp_options_id ...] --tags
                                        [--tags ...]

Description

Add tags to DHCP options.

Mandatory

positional arguments:
  --dhcp_options_id     IDs of the DHCP options to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc dhcp-options create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--name NAME] [--description DESCRIPTION]
                                      [--dhcp-options DHCP_OPTIONS]
                                      [--project-id PROJECT_ID]

Description

Creates a new DHCP Options set.

Returns

Returns dict: DHCP Options set

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Name of the DHCP Options set
  --description DESCRIPTION
                        Description of the DHCP Options set
  --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 VPC project

vpc dhcp-options create-default

Usage

  usage: symp vpc dhcp-options create-default
[-f {adaptive_table,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                                              [--project-id PROJECT_ID]
                                              [--name NAME]

Description

Creates the default VPC project DHCP Options set.

Returns

Returns dict: DHCP Options set

Optional

optional arguments:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID
                        UUID of the project
  --name NAME           Name of the DHCP Options set

vpc dhcp-options delete

Usage

  usage: symp vpc dhcp-options delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      dhcp_options_id

Description

Delete a VPC DHCP Options set.

Mandatory

positional arguments:
  dhcp_options_id       UUID of the dhcp_options to delete

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dhcp-options get

Usage

  usage: symp vpc dhcp-options get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   dhcp_options_id

Description

Get the DHCP Options set.

Returns

Returns dict: DhcpOption set

Mandatory

positional arguments:
  dhcp_options_id       UUID of the dhcp_option set

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dhcp-options list

Usage

  usage: symp vpc dhcp-options list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--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 DHCP Options sets.

Returns

Returns list: DhcpOptions objects

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: symp vpc dhcp-options list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all DHCP options tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dhcp-options remove-tags

Usage

  usage: symp vpc dhcp-options remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--force] [--system-tag]
                                           --dhcp_options_id
                                           [--dhcp_options_id ...] --tags
                                           [--tags ...]

Description

Delete tags from DHCP-options.

Mandatory

positional arguments:
  --dhcp_options_id     IDs of the DHCP options to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc dhcp-options update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--name NAME] [--description DESCRIPTION]
                                      dhcp_options_id

Description

Update a single VPC DHCP Options set based on the ID supplied and the parameters.

Mandatory

positional arguments:
  dhcp_options_id       ID of the requested dhcp_options

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The name of the DHCP Options set
  --description DESCRIPTION
                        The description of the DHCP Options set

vpc direct-network add-tags

Usage

  usage: symp vpc direct-network add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--force] [--system-tag]
                                          --networks_id [--networks_id ...]
                                          --tags [--tags ...]

Description

Add tags to direct-networks.

Mandatory

positional arguments:
  --networks_id         IDs of the DHCP options to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc direct-network attach
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        network_id vpc_id

Description

Attaches a direct network to a VPC, enabling connectivity between the VPC and private external resources.

Mandatory

positional arguments:
  network_id            The UUID of the direct network to attach
  vpc_id                The UUID of the vpc to which this network will be attached

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc direct-network create

Usage

  usage: symp vpc direct-network create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--vpc-id VPC_ID] [--name NAME]
                                        [--description DESCRIPTION]
                                        [--external-router-ip EXTERNAL_ROUTER_IP]
                                        project_id vn_group_id vlan cidr_block
                                        gateway_ip allocation_pools

Description

Creates a direct-network.

Returns

Returns dict: Direct-Network

Mandatory

positional arguments:
  project_id            ID of the project
  vn_group_id           Guest network pool id
  vlan                  Physical network vlan tag for direct network creation
  cidr_block            Required cidr of subnet
  gateway_ip            The direct subnet gateway IP address
  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

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
  --external-router-ip EXTERNAL_ROUTER_IP
                        The external router IP address

vpc direct-network delete

Usage

  usage: symp vpc direct-network delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        network_id

Description

Deletes a single direct-network by network ID.

Mandatory

positional arguments:
  network_id            ID of the requested network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc direct-network detach

Usage

  usage: symp vpc direct-network detach
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        network_id

Description

Detaches a direct-network from a VPC, disabling connectivity between the VPC and private external resources on it.

Mandatory

positional arguments:
  network_id            The UUID of the direct network to attach

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc direct-network get

Usage

  usage: symp vpc direct-network get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     network_id

Description

Returns a direct-network by network ID.

Returns

Returns dict: Direct-Network

Mandatory

positional arguments:
  network_id            ID of the requested network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc direct-network list

Usage

  usage: symp vpc direct-network list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--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 ...]]]
                                      [--is-default IS_DEFAULT]
                                      [--tags [TAGS [TAGS ...]]]
                                      [--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
                                      [--tag-values [TAG_VALUES [TAG_VALUES ...]]]

Description

Returns list of direct-networks.

Returns

Returns list: Direct-networks

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
  --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

vpc direct-network list-tags

Usage

  usage: symp vpc direct-network list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all direct-network tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc direct-network remove-tags

Usage

  usage: symp vpc direct-network remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--force] [--system-tag]
                                             --networks_id [--networks_id ...]
                                             --tags [--tags ...]

Description

Delete tags from direct networks.

Mandatory

positional arguments:
  --networks_id         IDs of the networks to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc direct-network update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--name NAME]
                                        [--description DESCRIPTION]
                                        [--gateway-ip GATEWAY_IP]
                                        [--allocation-pools ALLOCATION_POOLS]
                                        [--mtu MTU]
                                        [--external-router-ip EXTERNAL_ROUTER_IP]
                                        network_id

Description

Update a single direct-network by network ID.

Mandatory

positional arguments:
  network_id            ID of the requested network

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 direct subnet gateway IP address
  --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
  --mtu MTU             The MTU of the network
  --external-router-ip EXTERNAL_ROUTER_IP
                        The external router IP address

vpc disassociate-cidr-block

Usage

  usage: symp vpc disassociate-cidr-block
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          cidr_assoc_id

Description

Disassociate a cidr_block from a VPC object.

Mandatory

positional arguments:
  cidr_assoc_id         ID of the IPv4 CIDR block to to remove from the VPC

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc disassociate-dhcp-options

Usage

  usage: symp vpc disassociate-dhcp-options
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            vpc_id

Description

Disassociate a dhcp_option from a VPC object.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dns add

Usage

usage: symp vpc dns add

                        [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                           [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                        vpc_id ip_address record_type dns_domain dns_name

Description

Creates a DNS record within a VPC context.

Returns

Returns dict: The DNS record

Mandatory

positional arguments:
  vpc_id                The ID of a VPC to create the record in
  ip_address            The IP address to resolve to
  record_type           The record type to create - for now only A and AAAA are supported
  dns_domain            The DNS domain part of this record
  dns_name              The DNS name part of this record

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dns delete

Usage

  usage: symp vpc dns delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                             record_id

Description

Deletes the specified DNS record from the VPC context.

Mandatory

positional arguments:
  record_id             The ID of the route table for the route

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dns get

Usage

usage: symp vpc dns get

                        [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                           [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                        record_id

Description

Returns all DNS records according to filter.

Returns

Returns dict: List of DNS records for this ID

Mandatory

positional arguments:
  record_id             The record ID to filter on

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dns get-single

Usage

  usage: symp vpc dns get-single
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 record_id ip_address

Description

Returns all DNS records according to filter.

Returns

Returns dict: List of DNS records for this ID

Mandatory

positional arguments:
  record_id             The record type to filter on
  ip_address            The IP address to filter on

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc dns list

Usage

usage: symp vpc dns list

                         [-h] [-f {adaptive_table,csv,json,table,value,yaml}]                            [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                         [--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.

Returns

Returns list: List of DNS records

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: symp vpc dns update
[-f {adaptive_table,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                             [--ip-address IP_ADDRESS] [--dns-domain DNS_DOMAIN]
                             [--dns-name DNS_NAME]
                             record_id

Description

Creates a DNS record within a VPC context.

Returns

Returns dict: The DNS record

Mandatory

positional arguments:
  record_id             The IP address to resolve to

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: symp vpc elastic-ip add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--force] [--system-tag]
                                      --eip_id [--eip_id ...] --tags
                                      [--tags ...]

Description

Add tags to elastic IPs.

Mandatory

positional arguments:
  --eip_id              The ID of the elastic IP to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc elastic-ip associate-elastic-ip
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  [--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.

Returns

Returns str: Association ID

Mandatory

positional arguments:
  eip_id                ID of the requested elastic_ip

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: symp vpc elastic-ip create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--address ADDRESS]
                                    [--project-id PROJECT_ID]
                                    [--pool-id POOL_ID]

Description

Creates a new network interface object.

Returns

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: symp vpc elastic-ip delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--override-protection]
                                    eip_id

Description

Deletes a single network interface object based on the ID supplied.

Mandatory

positional arguments:
  eip_id                ID of the requested elastic ip

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: symp vpc elastic-ip disassociate-elastic-ip
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--noindent]
                                                     [--prefix PREFIX]
                                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                     eip_id

Description

Disassociate an elastic from address from the instance or network interface it’s associated with.

Mandatory

positional arguments:
  eip_id                ID of the elastic_ip association

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc elastic-ip get

Usage

  usage: symp vpc elastic-ip get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 eip_id

Description

Returns a VPC based on a VPC ID.

Returns

Returns dict: ElasticIp response

Mandatory

positional arguments:
  eip_id                ID of the elastic IP allocation

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc elastic-ip list

Usage

  usage: symp vpc elastic-ip list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--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 ...]]]
                                  [--is-managed-resource IS_MANAGED_RESOURCE]

Description

Returns all Elastic IPs.

Returns

Returns list: ElasticIp objects

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
  --is-managed-resource IS_MANAGED_RESOURCE
                        List only managed or not managed resources, or all if None (default)

vpc elastic-ip list-tags

Usage

  usage: symp vpc elastic-ip list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all elastic IP tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc elastic-ip remove-tags

Usage

  usage: symp vpc elastic-ip remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--force] [--system-tag]
                                         --eip_id [--eip_id ...] --tags
                                         [--tags ...]

Description

Delete tags from elastic IPs.

Mandatory

positional arguments:
  --eip_id              The ID of the elastic IP to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc engine get
[-f {adaptive_table,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                             engine_id

Description

Returns a engine based on a engine ID.

Returns

Returns dict: Engine response

Mandatory

positional arguments:
  engine_id             ID of the requested engine object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc engine list

Usage

  usage: symp vpc engine list
[-f {adaptive_table,csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              [--full-details] [--service-name SERVICE_NAME]
                              [--include-all]

Description

Returns all engine objects.

Returns

Returns list: Engine objects

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: symp vpc engine revision create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--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.

Returns

Returns dict: Revision response

Mandatory

positional arguments:
  service_name          The name of the service the engine belongs to
  engine_family         The family the engine belongs to
  version_family        The family the version belongs to
  sequence              The sequence of the revision
  logo_variant          'Version' of the logo
  logo_contents         Contents of the logo in SVG format
  vm_image_details      Information describing the stored images

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: symp vpc engine revision delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         revision_id

Description

Deletes a single revision object based on the ID supplied.

Mandatory

positional arguments:
  revision_id           ID of the requested revision object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc engine revision get

Usage

  usage: symp vpc engine revision get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      revision_id

Description

Returns a revision based on a revision ID.

Returns

Returns dict: Revision response

Mandatory

positional arguments:
  revision_id           ID of the requested revision object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc engine revision list

Usage

  usage: symp vpc engine revision list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--full-details]
                                       [--service-name SERVICE_NAME]
                                       [--engine-id ENGINE_ID]
                                       [--version-id VERSION_ID] [--include-all]

Description

Returns all revision objects.

Returns

Returns list: Version objects

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: symp vpc engine revision update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--name NAME]
                                         [--description DESCRIPTION]
                                         [--enabled ENABLED]
                                         [--storage-pool-id STORAGE_POOL_ID]
                                         revision_id

Description

Modify an engine.

Returns

Returns dict: Revision response

Mandatory

positional arguments:
  revision_id           The revision ID

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: symp vpc engine update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]] [--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.

Mandatory

positional arguments:
  engine_id             The engine ID

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: symp vpc engine version get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     version_id

Description

Returns a version based on a version ID.

Returns

Returns dict: Version response

Mandatory

positional arguments:
  version_id            ID of the requested version object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc engine version list

Usage

  usage: symp vpc engine version list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--full-details]
                                      [--service-name SERVICE_NAME]
                                      [--engine-id ENGINE_ID] [--include-all]

Description

Returns all version objects.

Returns

Returns list: Version objects

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: symp vpc engine version revisions
[-f {adaptive_table,csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--include-all]
                                           version_id

Description

List all revisions for a specified version.

Returns

Returns list: List of revisions in the system

Mandatory

positional arguments:
  version_id            The id of the version to retrieve revisions from

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: symp vpc engine version update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--name NAME]
                                        [--description DESCRIPTION]
                                        [--enabled ENABLED]
                                        [--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID]
                                        version_id

Description

Modify an engine.

Mandatory

positional arguments:
  version_id            The version ID

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: symp vpc engine version validate-enabled-revision
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                           [-c COLUMN]
                                                           [--max-width <integer>]
                                                           [--noindent]
                                                           [--prefix PREFIX]
                                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                           version_id

Description

Validate and return the enabled_revision of the specified version.

Returns

Returns dict: Revision response

Mandatory

positional arguments:
  version_id            The id of the version to retrieve the enabled_revision from

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc get

Usage

usage: symp vpc get

                    [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                       [-c COLUMN] [--max-width <integer>] [--noindent]
                    [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                    [--with-tags]
                    vpc_id

Description

Returns a VPC based on a VPC ID.

Returns

Returns dict: VPC response

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

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: symp vpc internet-gateway add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            [--force] [--system-tag]
                                            --internet_gateway_id
                                            [--internet_gateway_id ...] --tags
                                            [--tags ...]

Description

Add tags to internet gateways.

Mandatory

positional arguments:
  --internet_gateway_id
                        IDs of the internet gateway to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc internet-gateway attach
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          internet_gateway_id vpc_id

Description

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.

Mandatory

positional arguments:
  internet_gateway_id   The ID of the Internet gateway
  vpc_id                The ID of an attached VPC

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc internet-gateway create

Usage

  usage: symp vpc internet-gateway create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--name NAME]
                                          [--description DESCRIPTION]
                                          [--project-id PROJECT_ID]

Description

Create internet gateway.

Returns

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: symp vpc internet-gateway delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          internet_gateway_id

Description

Remove internet gateway.

Mandatory

positional arguments:
  internet_gateway_id   The ID of the Internet gateway

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc internet-gateway detach

Usage

  usage: symp vpc internet-gateway detach
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          internet_gateway_id vpc_id

Description

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.

Mandatory

positional arguments:
  internet_gateway_id   The ID of the Internet gateway
  vpc_id                The ID of an attached VPC

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc internet-gateway get

Usage

  usage: symp vpc internet-gateway get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       internet_gateway_id

Description

Get internet gateway.

Returns

Returns dict: The internet gateway

Mandatory

positional arguments:
  internet_gateway_id   The id of the internet gateway

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc internet-gateway list

Usage

  usage: symp vpc internet-gateway list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--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.

Returns

Returns list: Internet gateway objects

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: symp vpc internet-gateway list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all internet gateway tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc internet-gateway remove-tags

Usage

  usage: symp vpc internet-gateway remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                                               [--force] [--system-tag]
                                               --internet_gateway_id
                                               [--internet_gateway_id ...]
                                               --tags [--tags ...]

Description

Delete tags from internet gateways.

Mandatory

positional arguments:
  --internet_gateway_id
                        IDs of the internet gateway to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc internet-gateway update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--name NAME]
                                          [--description DESCRIPTION]
                                          internet_gateway_id

Description

Update a single internet_gateway object based on the ID supplied and the parameters.

Mandatory

positional arguments:
  internet_gateway_id   ID of the requested internet_gateway

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: symp vpc list

                     [-h] [-f {adaptive_table,csv,json,table,value,yaml}]                        [-c COLUMN] [--max-width <integer>] [--noindent]
                     [--quote {all,minimal,none,nonnumeric}]
                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                     [--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.

Returns

Returns list: Vpc objects

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: symp vpc list-tags

                          [-h] [-f {adaptive_table,csv,json,table,value,yaml}]                             [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all VPC tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc mode get-cluster-mode

Usage

  usage: symp vpc mode get-cluster-mode
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

Return the object name according to type and uuid.

Returns

Returns dict: {“mode”: (legacy|vpc)}

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc mode get-project-mode

Usage

  usage: symp vpc mode get-project-mode
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--project-id PROJECT_ID]

Description

Return the object name according to type and uuid.

Returns

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: symp vpc nat-gateway add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--force]
                                       --nat_gateway_id [--nat_gateway_id ...]
                                       --tags [--tags ...]

Description

Add tags to nat gateways.

Mandatory

positional arguments:
  --nat_gateway_id      IDs of the nat gateway to add to
  --tags                List of tag strings to add in 'key=value' format

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               Whether to ignore non-existing resources

vpc nat-gateway create

Usage

  usage: symp vpc nat-gateway create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--name NAME] [--description DESCRIPTION]
                                     network_id allocation_id

Description

Create nat gateway.

Returns

Returns dict: The newly created nat gateway id

Mandatory

positional arguments:
  network_id            UUID of the network to put nat gateway in
  allocation_id         UUID elastic ip to associate to the nat gateway

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: symp vpc nat-gateway delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     nat_gateway_id

Description

Remove nat gateway.

Mandatory

positional arguments:
  nat_gateway_id        The ID of the Nat gateway

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc nat-gateway get

Usage

  usage: symp vpc nat-gateway get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  nat_gateway_id

Description

Get nat gateway.

Returns

Returns dict: The nat gateway

Mandatory

positional arguments:
  nat_gateway_id        The id of the nat gateway

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc nat-gateway list

Usage

  usage: symp vpc nat-gateway list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--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.

Returns

Returns list: Nat gateway objects

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: symp vpc nat-gateway remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--force]
                                          --nat_gateway_id
                                          [--nat_gateway_id ...] --tags
                                          [--tags ...]

Description

Delete tags from NAT gateways.

Mandatory

positional arguments:
  --nat_gateway_id      IDs of the nat gateway to remove from
  --tags                List of tag strings to remove in 'key=value' format

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               Whether to ignore non-existing resources

vpc nat-gateway update

Usage

  usage: symp vpc nat-gateway update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--name NAME] [--description DESCRIPTION]
                                     nat_gateway_id

Description

Update a single nat_gateway object based on the ID supplied and the parameters.

Mandatory

positional arguments:
  nat_gateway_id        The ID of the Nat gateway

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 upgrade

Usage

  usage: symp vpc nat-gateway upgrade
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      nat_gateway_id

Description

Upgrade the NAT Gateway VM.

Mandatory

positional arguments:
  nat_gateway_id        ID of the requested NAT Gateway object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network add-tags

Usage

  usage: symp vpc network add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
                                   [--system-tag]
                                   --networks_id [--networks_id ...] --tags
                                   [--tags ...]

Description

Add tags to networks.

Mandatory

positional arguments:
  --networks_id         IDs of the DHCP options to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc network create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--name NAME] [--description DESCRIPTION]
                                 vpc_id cidr_block

Description

Creates a network.

Returns

Returns dict: Network response

Mandatory

positional arguments:
  vpc_id                ID of subnet VPC
  cidr_block            Required cidr of subnet

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: symp vpc network delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 network_id

Description

Deletes a single network object based on the ID supplied.

Mandatory

positional arguments:
  network_id            ID of the requested network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network get

Usage

  usage: symp vpc network get
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              network_id

Description

Returns a network based on a network ID.

Returns

Returns dict: Networks response

Mandatory

positional arguments:
  network_id            ID of the requested network

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network get-default-network-id

Usage

  usage: symp vpc network get-default-network-id
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent] [--prefix PREFIX]
                                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                 project_id

Description

Return the default network id of the default VPC of a project.

Returns

Returns dict: A dictionary containing the result

Mandatory

positional arguments:
  project_id            The project id to query

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network list

Usage

  usage: symp vpc network list
[-f {adaptive_table,csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                               [--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.

Returns

Returns list: Networks objects

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: symp vpc network list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all network tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network remove-tags

Usage

  usage: symp vpc network remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--force] [--system-tag]
                                      --networks_id [--networks_id ...] --tags
                                      [--tags ...]

Description

Delete tags from networks.

Mandatory

positional arguments:
  --networks_id         IDs of the networks to remove from
  --tags                List of tag strings to remove in 'key=value' format

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 reset

Usage

  usage: symp vpc network reset
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]] [--hard]
                                network_id

Description

Reset all DHCP servers of a network.

Mandatory

positional arguments:
  network_id            ID of the network

Optional

optional arguments:
  -h, --help            show this help message and exit
  --hard                Do hard reset, this may cause connectivity discontinuity

vpc network set-default

Usage

  usage: symp vpc network set-default
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      network_id

Description

Set the network as default subnet in VPC.

Mandatory

positional arguments:
  network_id            The network ID to set as default subnet

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network update

Usage

  usage: symp vpc network update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--name NAME] [--description DESCRIPTION]
                                 [--mtu MTU]
                                 network_id

Description

Update a single network object based on the ID supplied and the parameters.

Mandatory

positional arguments:
  network_id            ID of the requested network

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
  --mtu MTU             The MTU of the network

vpc network-interface add-tags

Usage

  usage: symp vpc network-interface add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--force] [--system-tag]
                                             --network_interface_ids
                                             [--network_interface_ids ...]
                                             --tags [--tags ...]

Description

Add tags to network interfaces.

Mandatory

positional arguments:
  --network_interface_ids
                        IDs of the network interfaces to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc network-interface create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--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 ...]]]
                                           [--mac-address MAC_ADDRESS]
                                           [--private-dns-name PRIVATE_DNS_NAME]
                                           network_id

Description

Creates a new network interface object.

Returns

Returns dict: NetworkInterface

Mandatory

positional arguments:
  network_id            The UUID of the network to which the interface belongs

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
  --mac-address MAC_ADDRESS
                        The MAC address of the network interface (unicast only)
  --private-dns-name PRIVATE_DNS_NAME
                        Private DNS name

vpc network-interface delete

Usage

  usage: symp vpc network-interface delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--override-protection]
                                           network_interface_id

Description

Deletes a single network interface object based on the ID supplied.

Mandatory

positional arguments:
  network_interface_id  ID of the requested network interface

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: symp vpc network-interface get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--with-tags]
                                        network_interface_id

Description

Returns a Network Interface of a VPC network.

Returns

Returns dict: NetworkInterfaces response

Mandatory

positional arguments:
  network_interface_id  ID of the requested network interface

Optional

optional arguments:
  -h, --help            show this help message and exit
  --with-tags           Flag that indicates if the response should include user tags

vpc network-interface list

Usage

  usage: symp vpc network-interface list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--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]
                                         [--is-managed-resource IS_MANAGED_RESOURCE]

Description

Returns all network interfaces.

Returns

Returns list: NetworkInterfaces objects

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
  --is-managed-resource IS_MANAGED_RESOURCE
                        List only managed or not managed resources, or all if None (default)

vpc network-interface list-tags

Usage

  usage: symp vpc network-interface list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all network interface tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc network-interface remove-tags

Usage

  usage: symp vpc network-interface remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent] [--prefix PREFIX]
                                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                [--force] [--system-tag]
                                                --network_interface_ids
                                                [--network_interface_ids ...]
                                                --tags [--tags ...]

Description

Delete tags from network interfaces.

Mandatory

positional arguments:
  --network_interface_ids
                        IDs of the network interfaces to remove from
  --tags                List of tag strings to remove in 'key=value' format

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 reset

Usage

  usage: symp vpc network-interface reset
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--hard]
                                          instance_id

Description

Reset all network interfaces of an instance.

Mandatory

positional arguments:
  instance_id           ID of the instance to perform network reset on

Optional

optional arguments:
  -h, --help            show this help message and exit
  --hard                Whether to ignore non-existing resources

vpc network-interface update

Usage

  usage: symp vpc network-interface update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--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.

Mandatory

positional arguments:
  network_interface_id  ID of the requested network interface

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: symp vpc peering accept
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 peering_id

Description

Accept a requested vpc peering connection.

Mandatory

positional arguments:
  peering_id            ID of the peering connection

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc peering add-tags

Usage

  usage: symp vpc peering add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
                                   --peering_id [--peering_id ...] --tags
                                   [--tags ...]

Description

Add tags to vpc peering.

Mandatory

positional arguments:
  --peering_id          IDs of the vpc peering to add to
  --tags                List of tag strings to add in 'key=value' format

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               Whether to ignore non-existing resources

vpc peering create

Usage

  usage: symp vpc peering create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--name NAME] [--description DESCRIPTION]
                                 requester_vpc_id accepter_vpc_id

Description

Create a new vpc peering connection.

Returns

Returns dict: The create result

Mandatory

positional arguments:
  requester_vpc_id      The id of the first vpc participating in the vpc connection
  accepter_vpc_id       The id of the second vpc participating in the vpc connection

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: symp vpc peering delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 peering_id

Description

Delete an existing vpc peering connection.

Returns

Returns dict: The delete result

Mandatory

positional arguments:
  peering_id            The id of the first vpc participating in the vpc connection

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc peering list

Usage

  usage: symp vpc peering list
[-f {adaptive_table,csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                               [--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.

Returns

Returns list: VPC peering objects

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: symp vpc peering reject
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 peering_id

Description

Reject a requested vpc peering connection.

Mandatory

positional arguments:
  peering_id            ID of the peering connection

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc peering remove-tags

Usage

  usage: symp vpc peering remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--force]
                                      --peering_id [--peering_id ...] --tags
                                      [--tags ...]

Description

Delete tags from route tables.

Mandatory

positional arguments:
  --peering_id          IDs of the vpc peering to remove from
  --tags                List of tag strings to remove in 'key=value' format

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               Whether to ignore non-existing resources

vpc peering update

Usage

  usage: symp vpc peering update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--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.

Mandatory

positional arguments:
  peering_id            ID of the requested peering connection

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: symp vpc project action
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 project_id action

Description

Perform an action on a vpc project.

Returns

Returns dict: Result: true/false + entity-type: count remaining

Mandatory

positional arguments:
  project_id            UUID of the project
  action                The action to perform.
                        Possible values: delete_dry_run, enable_flowlogs, disable_flowlogs

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc project delete

Usage

  usage: symp vpc project delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 project_id

Description

Delete a vpc project config object.

Mandatory

positional arguments:
  project_id            UUID of the project

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc project get

Usage

  usage: symp vpc project get
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              project_id

Description

Get the vpc project config object.

Returns

Returns dict: Project config object

Mandatory

positional arguments:
  project_id            UUID of the project

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc project list

Usage

  usage: symp vpc project list
[-f {adaptive_table,csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                               [--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.

Returns

Returns list: Project objects

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: symp vpc project provision
[-f {adaptive_table,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--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.

Mandatory

positional arguments:
  project_id            UUID of the project

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: symp vpc project reset-edge-network
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--force]
                                             project_id

Description

Set the edge network if no other edge network is already attached.

Mandatory

positional arguments:
  project_id            UUID of the project

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: symp vpc project set-edge-network
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--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.

Mandatory

positional arguments:
  project_id            UUID of the project

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 project upgrade-for-edge

Usage

  usage: symp vpc project upgrade-for-edge
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           project_id

Description

Upgrade project to support the new version of edge network.

Mandatory

positional arguments:
  project_id            UUID of the project

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc remove-tags

Usage

  usage: symp vpc remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
                              [--system-tag]
                              --vpc_ids [--vpc_ids ...] --tags [--tags ...]

Description

Delete tags from VPC objects.

Mandatory

positional arguments:
  --vpc_ids             IDs of the VPCs to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc route add
[-f {adaptive_table,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                            [--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.

Returns

Returns dict: The create result

Mandatory

positional arguments:
  destination_cidr_block
                        The IPv4 CIDR address block used for the destination match
  route_table_id        The ID of the route table for the route

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: symp vpc route remove
[-f {adaptive_table,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>] [--noindent]
                               [--prefix PREFIX]
                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                               destination_cidr_block route_table_id

Description

Deletes the specified route from the specified route table.

Returns

Returns dict: The remove result

Mandatory

positional arguments:
  destination_cidr_block
                        The IPv4 CIDR address block used for the destination match
  route_table_id        The ID of the route table for the route

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc route-table add-tags

Usage

  usage: symp vpc route-table add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--force] [--system-tag]
                                       --route_table_id [--route_table_id ...]
                                       --tags [--tags ...]

Description

Add tags to route tables.

Mandatory

positional arguments:
  --route_table_id      IDs of the route table to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc route-table associate
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--network-id NETWORK_ID]
                                        [--association-id ASSOCIATION_ID]
                                        route_table_id

Description

Associate a network with a route table or replace association.

Returns

Returns dict: New association ID

Mandatory

positional arguments:
  route_table_id        ID of the requested router

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: symp vpc route-table create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--name NAME] [--description DESCRIPTION]
                                     vpc_id

Description

Creates a route table.

Returns

Returns dict: Route Table response

Mandatory

positional arguments:
  vpc_id                ID of route table VPC

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: symp vpc route-table delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     route_table_id

Description

Delete a route table.

Mandatory

positional arguments:
  route_table_id        ID of the requested route table

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc route-table disassociate

Usage

  usage: symp vpc route-table disassociate
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           association_id

Description

Delete a network association.

Mandatory

positional arguments:
  association_id        ID of the network association

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc route-table get

Usage

  usage: symp vpc route-table get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--with-implicit-associations]
                                  route_table_id

Description

Returns a route table based on a route table ID.

Returns

Returns dict: RouteTables response

Mandatory

positional arguments:
  route_table_id        ID of the requested route table

Optional

optional arguments:
  -h, --help            show this help message and exit
  --with-implicit-associations
                        Include implicit associations

vpc route-table list

Usage

  usage: symp vpc route-table list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--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.

Returns

Returns list: The result of the query

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: symp vpc route-table list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all route table tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc route-table remove-tags

Usage

  usage: symp vpc route-table remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--force] [--system-tag]
                                          --route_table_id
                                          [--route_table_id ...] --tags
                                          [--tags ...]

Description

Delete tags from route tables.

Mandatory

positional arguments:
  --route_table_id      IDs of the route table to remove from
  --tags                List of tag strings to remove in 'key=value' format

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 reset

Usage

  usage: symp vpc route-table reset
[-f {adaptive_table,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]] [--hard]
                                    route_table_id

Description

Reset all network interfaces of a route-table.

Mandatory

positional arguments:
  route_table_id        ID of the route_table to reset network interfaces

Optional

optional arguments:
  -h, --help            show this help message and exit
  --hard                Do hard reset, this may cause connectivity discontinuity

vpc route-table update

Usage

  usage: symp vpc route-table update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--name NAME] [--description DESCRIPTION]
                                     route_table_id

Description

Update a single route table object based on the ID supplied and the parameters.

Mandatory

positional arguments:
  route_table_id        ID of the requested route table

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 route-target list

Usage

  usage: symp vpc route-target list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--entity-id [ENTITY_ID [ENTITY_ID ...]]]
                                    [--vpc-id [VPC_ID [VPC_ID ...]]]
                                    [--target-type [TARGET_TYPE [TARGET_TYPE ...]]]
                                    [--ip-address [IP_ADDRESS [IP_ADDRESS ...]]]
                                    [--network-id [NETWORK_ID [NETWORK_ID ...]]]
                                    [--vm-id [VM_ID [VM_ID ...]]]

Description

Returns all route targets objects.

Returns

Returns list: RouteTarget objects

Optional

optional arguments:
  -h, --help            show this help message and exit
  --entity-id [ENTITY_ID [ENTITY_ID ...]]
                        Filter by UUID of the entity
  --vpc-id [VPC_ID [VPC_ID ...]]
                        Filter by UUID of the vpc
  --target-type [TARGET_TYPE [TARGET_TYPE ...]]
                        Filter by UUID of the edge network ip pool
  --ip-address [IP_ADDRESS [IP_ADDRESS ...]]
                        IP address of the entity
  --network-id [NETWORK_ID [NETWORK_ID ...]]
                        ID of the network the entity belongs to
  --vm-id [VM_ID [VM_ID ...]]
                        ID of the vm of the entity

vpc security-group add-tags

Usage

  usage: symp vpc security-group add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--force] [--system-tag]
                                          --security_group_id
                                          [--security_group_id ...] --tags
                                          [--tags ...]

Description

Add tags to security groups.

Mandatory

positional arguments:
  --security_group_id   IDs of the security group to add to
  --tags                List of tag strings to add in 'key=value' format

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: symp vpc security-group authorize-egress
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  [--ip-permissions IP_PERMISSIONS]
                                                  group_id

Description

Adds one or more egress rules to a security group for use with a VPC.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The security group ID

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: symp vpc security-group authorize-ingress
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                   [--ip-permissions IP_PERMISSIONS]
                                                   group_id

Description

Adds one or more ingress rules to a security group.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc security-group create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--description DESCRIPTION]
                                        [--tags [TAGS [TAGS ...]]] [--hidden]
                                        name vpc_id

Description

Creates a security group.

Returns

Returns dict: The security group return result

Mandatory

positional arguments:
  name                  The name of the security group
  vpc_id                The associated VPC ID

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        The description of the security groups
  --tags [TAGS [TAGS ...]]
                        List of tag strings to set in 'key=value' format
  --hidden              This parameter is deprecated and will be ignored
                        Security groups can no longer be hidden

vpc security-group delete

Usage

  usage: symp vpc security-group delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--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.

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: symp vpc security-group delete-by-id
[-f {adaptive_table,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                                              [--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.

Mandatory

positional arguments:
  group_id              The security group ID

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: symp vpc security-group get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     group_id

Description

Return the security group details.

Returns

Returns dict: Security group object

Mandatory

positional arguments:
  group_id              The ID of the security group

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc security-group list

Usage

  usage: symp vpc security-group list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--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]
                                      [--is-managed-resource IS_MANAGED_RESOURCE]

Description

List all security groups.

Returns

Returns list: Security group objects

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         This parameter is deprecated and will be ignored
                        Security groups can no longer be hidden
  --is-managed-resource IS_MANAGED_RESOURCE
                        List only managed or not managed resources, or all if None (default)

vpc security-group list-tags

Usage

  usage: symp vpc security-group list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

List all security groups tags.

Returns

Returns list: Tag objects

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc security-group remove-tags

Usage

  usage: symp vpc security-group remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--force] [--system-tag]
                                             --security_group_id
                                             [--security_group_id ...] --tags
                                             [--tags ...]

Description

Delete tags from security groups.

Mandatory

positional arguments:
  --security_group_id   IDs of the security group to remove from
  --tags                List of tag strings to remove in 'key=value' format

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: symp vpc security-group revoke-egress
[-f {adaptive_table,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                                               [--ip-permissions IP_PERMISSIONS]
                                               group_id

Description

Removes one or more egress rules from a security group for VPC.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc security-group revoke-ingress
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent] [--prefix PREFIX]
                                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                [--ip-permissions IP_PERMISSIONS]
                                                group_id

Description

Removes one or more ingress rules from a security group.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc security-group set-rules
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--permissions PERMISSIONS]
                                           group_id

Description

Synchronizes the rules with the provided permiossions.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc security-group update-security-group-rule-descriptions-egress
       [-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
       [--max-width <integer>] [--noindent] [--prefix PREFIX]
       [-m [NAME=VALUE [NAME=VALUE ...]]] [--ip-permissions IP_PERMISSIONS]
       group_id

Description

Removes one or more ingress rules from a security group.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc security-group update-security-group-rule-descriptions-ingress
       [-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
       [--max-width <integer>] [--noindent] [--prefix PREFIX]
       [-m [NAME=VALUE [NAME=VALUE ...]]] [--ip-permissions IP_PERMISSIONS]
       group_id

Description

Removes one or more ingress rules from a security group.

Returns

Returns dict: The result of the operation

Mandatory

positional arguments:
  group_id              The ID of the security group

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: symp vpc set-default
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              vpc_id

Description

Sets VPC to be the default VPC of the project.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc update

Usage

usage: symp vpc update

                       [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                          [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                       [--name NAME] [--description DESCRIPTION]
                       [--enable-dns-support ENABLE_DNS_SUPPORT]
                       [--enable-dns-hostnames ENABLE_DNS_HOSTNAMES]
                       [--dns-vm-network-id DNS_VM_NETWORK_ID]
                       [--reset-dns-vm-network-id]
                       vpc_id

Description

Updates a single VPC object.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

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)
  --dns-vm-network-id DNS_VM_NETWORK_ID
                        ID of the network in which the internal DNS service VM will be created.
                        If not set, the unroutable default IP address 169.254.64.253 will be used.
                        This network cannot be changed while DNS support is enabled in the VPC
  --reset-dns-vm-network-id
                        Reset the VPC network to create the DNS VM
                        using the default non-routable 169.254.64.253 address

vpc upgrade-dns

Usage

  usage: symp vpc upgrade-dns
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              vpc_id

Description

Upgrade the VPC DNS service VM.

Mandatory

positional arguments:
  vpc_id                ID of the requested VPC object

Optional

optional arguments:
  -h, --help            show this help message and exit

vpc upgrade-for-edge

Usage

  usage: symp vpc upgrade-for-edge
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   vpc_id

Description

Upgrade VPC to support the new version of edge network.

Mandatory

positional arguments:
  vpc_id                ID of the VPC to upgrade

Optional

optional arguments:
  -h, --help            show this help message and exit