vlan-pool

vlan-pool account-pool assign-vlans

Usage

  usage: symp vlan-pool account-pool assign-vlans
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  pool_id --vlan_uuids
                                                  [--vlan_uuids ...]

Description

Assign VLANs to account VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the account VLAN pool
  --vlan_uuids          List of VLAN UUIDs to assign to account VLAN pool

Optional

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

vlan-pool account-pool create

Usage

  usage: symp vlan-pool account-pool 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]
                                            account_id

Description

Creates an account VLAN pool.

Returns

Returns dict: The created account VLAN pool

Mandatory

positional arguments:
  account_id            The account ID of the account VLAN pool

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The name of the account VLAN pool
  --description DESCRIPTION
                        The description of the account VLAN pool

vlan-pool account-pool delete

Usage

  usage: symp vlan-pool account-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

Delete account VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the account VLAN pool

Optional

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

vlan-pool account-pool get

Usage

  usage: symp vlan-pool account-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

Get account VLAN pool.

Returns

Returns dict: The account VLAN pool

Mandatory

positional arguments:
  pool_id               The ID of the account VLAN pool

Optional

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

vlan-pool account-pool list

Usage

  usage: symp vlan-pool account-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 ...]]]
                                          [--name [NAME [NAME ...]]]
                                          [--account-id [ACCOUNT_ID [ACCOUNT_ID ...]]]

Description

List all account VLAN pools.

Returns

Returns list: Account VLAN pool objects

Optional

optional arguments:
  -h, --help            show this help message and exit
  --pool-id [POOL_ID [POOL_ID ...]]
                        Filter by the account VLAN pool ID
  --name [NAME [NAME ...]]
                        Filter by the account VLAN pool name
  --account-id [ACCOUNT_ID [ACCOUNT_ID ...]]
                        Filter by the account ID

vlan-pool account-pool update

Usage

  usage: symp vlan-pool account-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]
                                            pool_id

Description

Update an account VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the account VLAN pool

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The new name of the account VLAN pool
  --description DESCRIPTION
                        The new description of the account VLAN pool

vlan-pool project-pool assign-vlans

Usage

  usage: symp vlan-pool project-pool assign-vlans
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  pool_id --vlan_uuids
                                                  [--vlan_uuids ...]

Description

Assign VLANs to project VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the project VLAN pool
  --vlan_uuids          List of VLAN UUIDs to assign to project VLAN pool

Optional

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

vlan-pool project-pool create

Usage

  usage: symp vlan-pool project-pool 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

Description

Creates a project VLAN pool.

Returns

Returns dict: The created project VLAN pool

Mandatory

positional arguments:
  project_id            The project ID of the project VLAN pool

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The name of the project VLAN pool
  --description DESCRIPTION
                        The description of the project VLAN pool

vlan-pool project-pool delete

Usage

  usage: symp vlan-pool project-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

Delete project VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the project VLAN pool

Optional

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

vlan-pool project-pool get

Usage

  usage: symp vlan-pool project-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

Get project VLAN pool.

Returns

Returns dict: The project VLAN pool

Mandatory

positional arguments:
  pool_id               The ID of the project VLAN pool

Optional

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

vlan-pool project-pool list

Usage

  usage: symp vlan-pool project-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 ...]]]
                                          [--project-vlan-pool-id [PROJECT_VLAN_POOL_ID [PROJECT_VLAN_POOL_ID ...]]]
                                          [--name [NAME [NAME ...]]]
                                          [--account-id [ACCOUNT_ID [ACCOUNT_ID ...]]]
                                          [--project-id [PROJECT_ID [PROJECT_ID ...]]]
                                          [--account-vlan-pool-id [ACCOUNT_VLAN_POOL_ID [ACCOUNT_VLAN_POOL_ID ...]]]

Description

List all account VLAN pools.

Returns

Returns list: Project VLAN pool objects

Optional

optional arguments:
  -h, --help            show this help message and exit
  --project-vlan-pool-id [PROJECT_VLAN_POOL_ID [PROJECT_VLAN_POOL_ID ...]]
                        Filter by the project VLAN pool ID
  --name [NAME [NAME ...]]
                        Filter by the project VLAN pool name
  --account-id [ACCOUNT_ID [ACCOUNT_ID ...]]
                        Filter by the account ID
  --project-id [PROJECT_ID [PROJECT_ID ...]]
                        Filter by the project ID
  --account-vlan-pool-id [ACCOUNT_VLAN_POOL_ID [ACCOUNT_VLAN_POOL_ID ...]]
                        Filter by the account VLAN pool ID

vlan-pool project-pool update

Usage

  usage: symp vlan-pool project-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]
                                            pool_id

Description

Update a project VLAN pool.

Mandatory

positional arguments:
  pool_id               The ID of the project VLAN pool

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The new name of the project VLAN pool
  --description DESCRIPTION
                        The new description of the project VLAN pool

vlan-pool vlan add

Usage

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

Description

Add vlans to system pool.

Mandatory

positional arguments:
  vlan_infos            List of VLAN infos, which will be generated and added to the system pool, in the format:
                        [{"vlan": <vlan>, "guest_network_pool_id": <guest_network_pool_id>, "name": <vlan_name>},...]
                        VLAN mandatory parameters: vlan, guest_network_pool_id
                        VLAN optional parameters: name

Optional

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

vlan-pool vlan get

Usage

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

Description

Get VLAN.

Returns

Returns dict: The VLAN

Mandatory

positional arguments:
  vlan_uuid             The UUID of the VLAN

Optional

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

vlan-pool vlan list

Usage

  usage: symp vlan-pool vlan 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 ...]]]
                                  [--vlan-uuid [VLAN_UUID [VLAN_UUID ...]]]
                                  [--guest-network-pool-id [GUEST_NETWORK_POOL_ID [GUEST_NETWORK_POOL_ID ...]]]
                                  [--vlan [VLAN [VLAN ...]]]
                                  [--name [NAME [NAME ...]]]
                                  [--account-vlan-pool-id [ACCOUNT_VLAN_POOL_ID [ACCOUNT_VLAN_POOL_ID ...]]]
                                  [--account-id [ACCOUNT_ID [ACCOUNT_ID ...]]]
                                  [--project-vlan-pool-id [PROJECT_VLAN_POOL_ID [PROJECT_VLAN_POOL_ID ...]]]
                                  [--project-id [PROJECT_ID [PROJECT_ID ...]]]

Description

List all VLANs.

Returns

Returns list: Account VLAN pool objects

Optional

optional arguments:
  -h, --help            show this help message and exit
  --vlan-uuid [VLAN_UUID [VLAN_UUID ...]]
                        Filter by the VLAN UUID
  --guest-network-pool-id [GUEST_NETWORK_POOL_ID [GUEST_NETWORK_POOL_ID ...]]
                        Filter by the guest network pool ID The VLAN belongs to
  --vlan [VLAN [VLAN ...]]
                        Filter by the VLAN
  --name [NAME [NAME ...]]
                        Filter by the VLAN name
  --account-vlan-pool-id [ACCOUNT_VLAN_POOL_ID [ACCOUNT_VLAN_POOL_ID ...]]
                        Filter by the account VLAN pool ID
  --account-id [ACCOUNT_ID [ACCOUNT_ID ...]]
                        Filter by the account ID
  --project-vlan-pool-id [PROJECT_VLAN_POOL_ID [PROJECT_VLAN_POOL_ID ...]]
                        Filter by the project VLAN pool ID
  --project-id [PROJECT_ID [PROJECT_ID ...]]
                        Filter by the project ID

vlan-pool vlan release-from-account-pool

Usage

  usage: symp vlan-pool vlan release-from-account-pool
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--noindent]
                                                       [--prefix PREFIX]
                                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                       vlan_uuid

Description

Release VLAN from account VLAN pool.

Mandatory

positional arguments:
  vlan_uuid             The UUID of the VLAN

Optional

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

vlan-pool vlan release-from-project-pool

Usage

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

Description

Release VLAN from project VLAN pool.

Mandatory

positional arguments:
  vlan_uuid             The UUID of the VLAN

Optional

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

vlan-pool vlan remove

Usage

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

Description

Remove VLAN from system pool.

Mandatory

positional arguments:
  vlan_uuid             The UUID of the VLAN

Optional

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