vm-snapshot

vm-snapshot count

Usage

  usage: symp vm-snapshot count
[-f {adaptive_table,csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
                                [--project-ids [PROJECT_IDS [PROJECT_IDS ...]]]
                                [--user-ids [USER_IDS [USER_IDS ...]]]
                                [--names [NAMES [NAMES ...]]]
                                [--statuses [STATUSES [STATUSES ...]]]
                                [--source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]]
                                [--protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]]
                                [--vm-snapshot-ids [VM_SNAPSHOT_IDS [VM_SNAPSHOT_IDS ...]]]
                                [--snapshot-type SNAPSHOT_TYPE]
                                [--endpoint-ids [ENDPOINT_IDS [ENDPOINT_IDS ...]]]
                                [--has-protection-group HAS_PROTECTION_GROUP]

Description

Returns the number of VM snapshots.

Returns

Returns list: Number of VM snapshots

Optional

optional arguments:
  -h, --help            show this help message and exit
  --account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]
                        Returns number of VM snapshots with any of the specified account IDs
  --project-ids [PROJECT_IDS [PROJECT_IDS ...]]
                        Returns number of VM snapshots with any of the specified project IDs
  --user-ids [USER_IDS [USER_IDS ...]]
                        Returns number of VM snapshots with any of the specified user IDs
  --names [NAMES [NAMES ...]]
                        Returns number of VM snapshots with any of the specified names
  --statuses [STATUSES [STATUSES ...]]
                        Returns number of VM snapshots with any of the specified statuses
  --source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]
                        Returns number of VM snapshots with any of the specified source VM IDs
  --protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]
                        Returns number of VM snapshots created by any of the specified protection group IDs
  --vm-snapshot-ids [VM_SNAPSHOT_IDS [VM_SNAPSHOT_IDS ...]]
                        Returns number of VM snapshots with any of the specified ID
  --snapshot-type SNAPSHOT_TYPE
                        Returns number of items of the specified snapshot type, either 'local' or 'remote'
  --endpoint-ids [ENDPOINT_IDS [ENDPOINT_IDS ...]]
                        Returns number of items of snapshots with the specified endpoint IDs
  --has-protection-group HAS_PROTECTION_GROUP
                        Filter by snapshots that have or don't have a protection group

vm-snapshot create

Usage

  usage: symp vm-snapshot create
[-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]
                                 [--tags [TAGS [TAGS ...]]]
                                 name vm_id

Description

Create a VM snapshot.

Returns

Returns dict: Details of the new VM snapshot

Mandatory

positional arguments:
  name                  Name for the VM snapshot
  vm_id                 VM ID to snapshot

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        Description for the VM snapshot
  --project-id PROJECT_ID
                        Project id to create the snapshot in
  --tags [TAGS [TAGS ...]]
                        Tags to apply during snapshot creation

vm-snapshot delete

Usage

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

Description

Delete local VM snapshot.

Mandatory

positional arguments:
  vm_snapshot_id        The ID of the VM snapshot

Optional

optional arguments:
  -h, --help            show this help message and exit
  --force               If True, will delete also if the VM-snapshot is in creating state
  --skip-external       If True, will pass the flag top Volume VSC
  --override-protection
                        If True, will override the protection

vm-snapshot get

Usage

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

Description

Retrieve VM snapshot metadata.

Returns

Returns dict: Details of the VM snapshot

Mandatory

positional arguments:
  vm_snapshot_id        The ID of the VM snapshot

Optional

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

vm-snapshot list

Usage

  usage: symp vm-snapshot 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 ...]]]
                               [--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
                               [--project-ids [PROJECT_IDS [PROJECT_IDS ...]]]
                               [--user-ids [USER_IDS [USER_IDS ...]]]
                               [--names [NAMES [NAMES ...]]]
                               [--statuses [STATUSES [STATUSES ...]]]
                               [--source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]]
                               [--protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]]
                               [--ids [IDS [IDS ...]]]
                               [--endpoint-ids [ENDPOINT_IDS [ENDPOINT_IDS ...]]]
                               [--detailed]
                               [--paginate-by-date PAGINATE_BY_DATE]
                               [--per-page PER_PAGE]
                               [--snapshot-type SNAPSHOT_TYPE]
                               [--sort-by SORT_BY] [--sort-order SORT_ORDER]
                               [--has-protection-group HAS_PROTECTION_GROUP]

Description

List VM snapshots.

Returns

Returns list: List of VM snapshots

Optional

optional arguments:
  -h, --help            show this help message and exit
  --account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]
                        Return VM snapshots with the specified account IDs
  --project-ids [PROJECT_IDS [PROJECT_IDS ...]]
                        Return VM snapshots with the specified project IDs
  --user-ids [USER_IDS [USER_IDS ...]]
                        Return VM snapshots with the specified user IDs
  --names [NAMES [NAMES ...]]
                        Return VM snapshots with the specified names
  --statuses [STATUSES [STATUSES ...]]
                        Return VM snapshots with the specified statuses
  --source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]
                        Return VM snapshots with  the specified source VM IDs
  --protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]
                        Return VM snapshots created by the specified protection group IDs
  --ids [IDS [IDS ...]]
                        Return VM snapshots with the specified ID
  --endpoint-ids [ENDPOINT_IDS [ENDPOINT_IDS ...]]
                        Return VM snapshots with the specified endpoint-ids
  --detailed            Also return the parameters of the VM itself
  --paginate-by-date PAGINATE_BY_DATE
                        Date of the previously synced page
  --per-page PER_PAGE   Number of items to return per page
  --snapshot-type SNAPSHOT_TYPE
                        Type of snapshot to return, either 'local' or 'remote'
  --sort-by SORT_BY     Field to sort by
  --sort-order SORT_ORDER
                        Sort order
  --has-protection-group HAS_PROTECTION_GROUP
                        Filter by snapshots that have or don't have a protection group

vm-snapshot stats

Usage

  usage: symp vm-snapshot stats
[-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-by GROUP_BY]
                                [--has-protection-group HAS_PROTECTION_GROUP]
                                [--snapshot-type SNAPSHOT_TYPE]

Description

Returns the number of VM snapshots based on the grouped by column.

Returns

Returns list: List of VM snapshots stats

Optional

optional arguments:
  -h, --help            show this help message and exit
  --group-by GROUP_BY   Returns VM snapshots amounts grouped by the specified column
  --has-protection-group HAS_PROTECTION_GROUP
                        Filter by snapshots that have or don't have a protection group
  --snapshot-type SNAPSHOT_TYPE
                        Type of snapshot to return, either 'local' or 'remote'

vm-snapshot update

Usage

  usage: symp vm-snapshot 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]
                                 vm_snapshot_id

Description

Update the VM snapshot.

Returns

Returns dict: Details of the new VM snapshot

Mandatory

positional arguments:
  vm_snapshot_id        The ID of the VM snapshot

Optional

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