volume

volume create

Usage

  usage: symp volume create
[-f {adaptive_table,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                            [--size-gib SIZE_GIB] [--source-id SOURCE_ID]
                            [--storage-pool STORAGE_POOL]
                            [--description DESCRIPTION]
                            [--project-id PROJECT_ID] [--tags [TAGS [TAGS ...]]]
                            [--available-immediately]
                            name

Description

Create a new volume

Returns

Returns dict: New volume

Mandatory

positional arguments:
  name                  Name for the volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --size-gib SIZE_GIB   Volume size in GiB
  --source-id SOURCE_ID
                        ID of the source for the new volume (volume or snapshot)
  --storage-pool STORAGE_POOL
                        ID of the storage pool to create the volume in
  --description DESCRIPTION
                        Description for the volume
  --project-id PROJECT_ID
                        ID of the project that the new volume should belong to
  --tags [TAGS [TAGS ...]]
  --available-immediately
                        If True the volume will be available for attachment immediately during restore.
                        The option is only available for clone from object store (remote) snapshots.

volume delete

Usage

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

Description

Delete the volume

Mandatory

positional arguments:
  volume_id             The ID of the volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --override-protection
                        If True and the caller is an admin, allow deleting resource
  --force-detach        If True and the caller is an admin, forcefully detach if attached and delete the volume

volume extend

Usage

  usage: symp volume extend
[-f {adaptive_table,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                            volume_id size_gib

Description

Extend volume size

Returns

Returns dict: Volume info

Mandatory

positional arguments:
  volume_id             The ID of the volume
  size_gib              New volume size in GiB

Optional

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

volume get

Usage

usage: symp volume get

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

Description

Get information on a volume

Returns

Returns dict: Volume info

Mandatory

positional arguments:
  volume_id             The ID of the volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --with-snapshot-count
                        Add remote and local snapshot count of the volume

volume list

Usage

usage: symp volume 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 ...]]]
                        [--external-serial [EXTERNAL_SERIAL [EXTERNAL_SERIAL ...]]]
                        [--attached-at [ATTACHED_AT [ATTACHED_AT ...]]]
                        [--id [ID [ID ...]]] [--with-snapshot-count]
                        [--guest-device-name [GUEST_DEVICE_NAME [GUEST_DEVICE_NAME ...]]]
                        [--state [STATE [STATE ...]]]
                        [--storage-pool [STORAGE_POOL [STORAGE_POOL ...]]]
                        [--health [HEALTH [HEALTH ...]]]
                        [--tag-key [TAG_KEY [TAG_KEY ...]]]
                        [--delete-on-termination DELETE_ON_TERMINATION]
                        [--account-id [ACCOUNT_ID [ACCOUNT_ID ...]]]
                        [--tags [TAGS [TAGS ...]]] [--offset OFFSET]
                        [--device [DEVICE [DEVICE ...]]]
                        [--user-id [USER_ID [USER_ID ...]]]
                        [--project-id [PROJECT_ID [PROJECT_ID ...]]]
                        [--name [NAME [NAME ...]]]
                        [--created-at [CREATED_AT [CREATED_AT ...]]]
                        [--instance-id [INSTANCE_ID [INSTANCE_ID ...]]]
                        [--attached-to-instance ATTACHED_TO_INSTANCE]
                        [--limit LIMIT]
                        [--source-id [SOURCE_ID [SOURCE_ID ...]]]

Description

Retrieves all volumes

Returns

Returns list: List of volumes

Optional

optional arguments:
  -h, --help            show this help message and exit
  --external-serial [EXTERNAL_SERIAL [EXTERNAL_SERIAL ...]]
                        Return volumes matching the provided external serial (multiple values possible).
  --attached-at [ATTACHED_AT [ATTACHED_AT ...]]
                        Return volumes with the specified attachment time.
  --id [ID [ID ...]]    Return volumes with the specified ID.
  --with-snapshot-count
                        Add remote and local snapshot count of the volume
  --guest-device-name [GUEST_DEVICE_NAME [GUEST_DEVICE_NAME ...]]
                        Return volumes with the specified Guest Device Name.
  --state [STATE [STATE ...]]
                        Return volumes with the specified state (multiple values possible).
  --storage-pool [STORAGE_POOL [STORAGE_POOL ...]]
                        Return volumes with the specified source ID (multiple values possible).
  --health [HEALTH [HEALTH ...]]
                        Return volumes with the specified health (multiple values possible).
  --tag-key [TAG_KEY [TAG_KEY ...]]
                        Tag keys to filter by.
  --delete-on-termination DELETE_ON_TERMINATION
                        filter volumes according to delete on termination
  --account-id [ACCOUNT_ID [ACCOUNT_ID ...]]
                        Return volumes with the specified account ID.
  --tags [TAGS [TAGS ...]]
                        Tags to filter by.
  --offset OFFSET       Specify the first entity that you want to retrieve.
  --device [DEVICE [DEVICE ...]]
                        Return volumes with the specified Device.
  --user-id [USER_ID [USER_ID ...]]
                        Return volumes with the specified user ID.
  --project-id [PROJECT_ID [PROJECT_ID ...]]
                        Return volumes with the specified project ID.
  --name [NAME [NAME ...]]
                        Return volumes with the specified Name.
  --created-at [CREATED_AT [CREATED_AT ...]]
                        Return volumes with the specified creation time.
  --instance-id [INSTANCE_ID [INSTANCE_ID ...]]
                        Return volumes attached to the provided compute ID (multiple values possible).
  --attached-to-instance ATTACHED_TO_INSTANCE
                        filter volumes according to whether or not they're attached to an instance
  --limit LIMIT         Specify the number of entities that you want to retrieve.
  --source-id [SOURCE_ID [SOURCE_ID ...]]
                        Return volumes with the specified source ID (multiple values possible).

volume list-manageable

Usage

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

Description

Manage a volume that already exists in a back-end

Returns

Returns list: List of managed volumes

Mandatory

positional arguments:
  storage_pool          The storage pool to list the manageable resources from

Optional

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

volume list-manageable_v4

Usage

  usage: symp volume list-manageable_v4
[-f {adaptive_table,csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--volume-type-id VOLUME_TYPE_ID]

Description

List volumes that exists in a back-end

Returns

Returns list: List of manageable volumes

Optional

optional arguments:
  -h, --help            show this help message and exit
  --volume-type-id VOLUME_TYPE_ID
                        The volume type id to list the manageable resources from

volume manage

Usage

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

Description

Manage a volume that already exists in a back-end

Returns

Returns dict: New Volume

Mandatory

positional arguments:
  name                  Name for the volume
  storage_pool          ID of the storage pool to create the volume in
  reference             Storage-specific reference to the back-end volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        Description for the volume
  --project-id PROJECT_ID
                        ID of the project that the new volume should belong to
  --volume-id VOLUME_ID
                        Specify an ID for the volume rather than using a random one

volume manage_v4

Usage

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

Description

Manage a volume that already exists in a back-end

Returns

Returns dict: New Volume

Mandatory

positional arguments:
  name                  Name for the volume
  volume_type_id        ID of the volume type to create the volume in
  reference             Reference

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        Description for the volume
  --project-id PROJECT_ID
                        ID of the project that the new volume should belong to
  --volume-id VOLUME_ID
                        Specify an ID for the volume rather than using a random one

volume retype

Usage

  usage: symp volume retype
[-f {adaptive_table,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                            [--new-volume-type-id NEW_VOLUME_TYPE_ID]
                            [--vpsa-id VPSA_ID]
                            volume_id

Description

retype the volume

Returns

Returns dict: Volume info

Mandatory

positional arguments:
  volume_id             The ID of the volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --new-volume-type-id NEW_VOLUME_TYPE_ID
                        New volume type id
  --vpsa-id VPSA_ID     New vpsa id

volume tags-remove

Usage

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

Description

Remove tag from volume

Mandatory

positional arguments:
  volume_id             The ID of the volume
  --tags

Optional

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

volume tags-update

Usage

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

Description

Add tag to volume

Mandatory

positional arguments:
  volume_id             The ID of the volume
  --tags

Optional

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

volume unmanage

Usage

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

Description

Unmanage the volume

Mandatory

positional arguments:
  volume_id             The ID of the volume

Optional

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

volume update

Usage

  usage: symp volume 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]
                            volume_id

Description

Update metadata of an existing volume

Returns

Returns dict: Volume info

Mandatory

positional arguments:
  volume_id             The ID of the volume

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Name for the volume
  --description DESCRIPTION
                        Description for the volume

volume volume-types create

Usage

  usage: symp volume volume-types create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--description DESCRIPTION]
                                         [--is-default IS_DEFAULT]
                                         [--alias ALIAS] [--shared SHARED]
                                         [--allowed-accounts [ALLOWED_ACCOUNTS [ALLOWED_ACCOUNTS ...]]]
                                         [--is-provisioning-disabled IS_PROVISIONING_DISABLED]
                                         [--compress COMPRESS] [--dedupe DEDUPE]
                                         [--encrypt ENCRYPT]
                                         [--read-iops-limit READ_IOPS_LIMIT]
                                         [--write-iops-limit WRITE_IOPS_LIMIT]
                                         [--read-bandwidth-limit READ_BANDWIDTH_LIMIT]
                                         [--write-bandwidth-limit WRITE_BANDWIDTH_LIMIT]
                                         name storage_class_id

Description

Create Volume Type in the VSC

Returns

Returns dict: Volume Type created

Mandatory

positional arguments:
  name                  Display name
  storage_class_id      Storage Class ID (immutable)

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        Description
  --is-default IS_DEFAULT
                        Whether this is the default Volume Type or not
  --alias ALIAS         Alias for the Volume Type
  --shared SHARED       Whether this Volume Type is shared or not
  --allowed-accounts [ALLOWED_ACCOUNTS [ALLOWED_ACCOUNTS ...]]
                        List of accounts allowed to use this Volume Type
  --is-provisioning-disabled IS_PROVISIONING_DISABLED
                        Whether provisioning is disabled for this Volume Type or not
  --compress COMPRESS   Enable/disable compression upon volume creation
  --dedupe DEDUPE       Enable/disable dedupe upon volume creation
  --encrypt ENCRYPT     Enable/disable encryption upon volume creation
  --read-iops-limit READ_IOPS_LIMIT
                        Read IOPs rate limit to be set on volume upon its creation
  --write-iops-limit WRITE_IOPS_LIMIT
                        Write IOPs rate limit to be set on volume upon its creation
  --read-bandwidth-limit READ_BANDWIDTH_LIMIT
                        Read Bandwidth rate limit to be set on volume upon its creation
  --write-bandwidth-limit WRITE_BANDWIDTH_LIMIT
                        Write Bandwidth rate limit to be set on volume upon its creation

volume volume-types delete

Usage

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

Description

Delete a specific Volume Type

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               Force deleting even if default

volume volume-types disable-provisioning

Usage

  usage: symp volume volume-types disable-provisioning
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--noindent]
                                                       [--prefix PREFIX]
                                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                       id

Description

Disable provisioning for a Volume Type

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

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

volume volume-types enable-provisioning

Usage

  usage: symp volume volume-types enable-provisioning
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                      id

Description

Enable provisioning for a Volume Type

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

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

volume volume-types get

Usage

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

Description

Get a Volume Type details

Returns

Returns dict: Volume Type details

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

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

volume volume-types list

Usage

  usage: symp volume volume-types 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 ...]]]

Description

List Volume Types

Returns

Returns list: Array of Volume Types

Optional

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

volume volume-types set-as-default

Usage

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

Description

Set Volume Type as default

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

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

volume volume-types update

Usage

  usage: symp volume volume-types update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--name NAME]
                                         [--allowed-accounts [ALLOWED_ACCOUNTS [ALLOWED_ACCOUNTS ...]]]
                                         [--alias ALIAS] [--shared SHARED]
                                         id

Description

Update one or more properties of a Volume Type atomically

Returns

Returns dict: Volume Type updated

Mandatory

positional arguments:
  id                    Volume Type ID

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Updated name of a custom Volume Type
  --allowed-accounts [ALLOWED_ACCOUNTS [ALLOWED_ACCOUNTS ...]]
                        List of accounts allowed to use this Volume Type
  --alias ALIAS         Alias for the Volume Type
  --shared SHARED       Whether this Volume Type is shared or not