snapshot¶
snapshot copy-to-pool¶
Usage
usage: -c snapshot copy-to-pool [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
pool_id snapshot_id
Description
Create a physical representation of the of the snapshot on a specific pool
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
snapshot create¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project-id PROJECT_ID]
[--description DESCRIPTION]
[--tags [TAGS [TAGS ...]]]
[--protection-group-id PROTECTION_GROUP_ID]
[--label LABEL] [--create-bitmap]
[--enable-incremental-backup]
volume_id name
Description
Create a new snapshot from the specified volume
Return
Returns dict: New snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
The project ID of this snapshot (admin-only)
--description DESCRIPTION
Description for the snapshot
--tags [TAGS [TAGS ...]]
Tags to apply during snapshot creation
--protection-group-id PROTECTION_GROUP_ID
The ID of the protection group responsible for creating this snapshot. for internal usage.
--label LABEL The label related to the snapshot
--create-bitmap Create bitmap for the snapshot, for derivative backups.
--enable-incremental-backup
Enable incremental backup for this snapshot.
snapshot_v4 create Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--description DESCRIPTION]
[--project-id PROJECT_ID]
[--tags [TAGS [TAGS ...]]]
[--protection-group-id PROTECTION_GROUP_ID]
volume_id name
Create a new snapshot from the specified volume
Description
Create a new snapshot from the specified volume
Return
Returns dict: New snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
Description for the snapshot
--project-id PROJECT_ID
The project ID of this snapshot (admin-only)
--tags [TAGS [TAGS ...]]
Tags to apply during snapshot creation
--protection-group-id PROTECTION_GROUP_ID
The ID of the protection group responsible for creating this snapshot. for internal usage.
snapshot create-from-remote-snapshot¶
Usage
usage: -c snapshot create-from-remote-snapshot [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
remote_snapshot_id pool_id
Description
Create snapshot from remote-snapshot
Return
Returns dict: New snapshot
Optional
optional arguments:
-h, --help show this help message and exit
snapshot delete¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
snapshot_id
Description
Delete the snapshot
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
snapshot_v4 delete Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
snapshot_id
Description
Delete the snapshot
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
snapshot export¶
Usage
usage: -c snapshot export [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
object_name endpoint_id snapshot_id
Description
Export a snapshot to designated location in S3
Return
Returns dict: Snapshot export URL
Optional
optional arguments:
-h, --help show this help message and exit
snapshot get¶
Usage
usage: -c snapshot get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
snapshot_id
Description
Retrieve snapshot metadata
Return
Returns dict: Snapshot metadata
Optional
optional arguments:
-h, --help show this help message and exit
snapshot_v4 get Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
snapshot_id
Description
Retrieve snapshot metadata
Return
Returns dict: Snapshot metadata
Optional
optional arguments:
-h, --help show this help message and exit
snapshot list¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--sort SORT]
[--health-eq [HEALTH_EQ [HEALTH_EQ ...]]]
[--label-eq LABEL_EQ]
[--account-id-eq [ACCOUNT_ID_EQ [ACCOUNT_ID_EQ ...]]]
[--tags [TAGS [TAGS ...]]]
[--reference-resource-id-eq REFERENCE_RESOURCE_ID_EQ]
[--source-volume-id-eq [SOURCE_VOLUME_ID_EQ [SOURCE_VOLUME_ID_EQ ...]]]
[--user-id-eq [USER_ID_EQ [USER_ID_EQ ...]]]
[--reference-resource-type-eq REFERENCE_RESOURCE_TYPE_EQ]
[--name-eq [NAME_EQ [NAME_EQ ...]]] [--limit LIMIT]
[--offset OFFSET]
[--state-eq [STATE_EQ [STATE_EQ ...]]]
[--created-at-eq [CREATED_AT_EQ [CREATED_AT_EQ ...]]]
[--id-eq [ID_EQ [ID_EQ ...]]]
[--protection-group-id-eq [PROTECTION_GROUP_ID_EQ [PROTECTION_GROUP_ID_EQ ...]]]
[--project-id-eq [PROJECT_ID_EQ [PROJECT_ID_EQ ...]]]
Description
Retrieves all snapshots
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--sort SORT The fields to sort by (can provide multiple values). Use "-" to reverse the order.
--health-eq [HEALTH_EQ [HEALTH_EQ ...]]
Return snapshots with the specified health.
--label-eq LABEL_EQ Return snapshots which match specified label
--account-id-eq [ACCOUNT_ID_EQ [ACCOUNT_ID_EQ ...]]
Return snapshots with the specified account ID.
--tags [TAGS [TAGS ...]]
Tags to filter by.
--reference-resource-id-eq REFERENCE_RESOURCE_ID_EQ
Return snapshots which referenced by the specified resource_id
--source-volume-id-eq [SOURCE_VOLUME_ID_EQ [SOURCE_VOLUME_ID_EQ ...]]
Return snapshots with the specified source volume ID (multiple values possible).
--user-id-eq [USER_ID_EQ [USER_ID_EQ ...]]
Return snapshots with the specified user ID.
--reference-resource-type-eq REFERENCE_RESOURCE_TYPE_EQ
Return snapshots which referenced by the specified resource_type
--name-eq [NAME_EQ [NAME_EQ ...]]
Return snapshots with the specified name.
--limit LIMIT Specify the number of entities that you want to retrieve.
--offset OFFSET Specify the first entity that you wan to retrieve.
--state-eq [STATE_EQ [STATE_EQ ...]]
Return snapshots with the specified state.
--created-at-eq [CREATED_AT_EQ [CREATED_AT_EQ ...]]
Return snapshots with the specified creation time.
--id-eq [ID_EQ [ID_EQ ...]]
Return snapshots with the specified ID (multiple values possible).
--protection-group-id-eq [PROTECTION_GROUP_ID_EQ [PROTECTION_GROUP_ID_EQ ...]]
Return snapshots created by the specified protection group ID (multiple values possible).
--project-id-eq [PROJECT_ID_EQ [PROJECT_ID_EQ ...]]
Return snapshots with the specified project ID.
snapshot_v4 list Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort SORT] [--tag-key [TAG_KEY [TAG_KEY ...]]]
[--description [DESCRIPTION [DESCRIPTION ...]]]
[--tags [TAGS [TAGS ...]]]
[--source-volume-id [SOURCE_VOLUME_ID [SOURCE_VOLUME_ID ...]]]
[--created-at [CREATED_AT [CREATED_AT ...]]]
[--state [STATE [STATE ...]]] [--limit LIMIT]
[--offset OFFSET]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--protection-group-id [PROTECTION_GROUP_ID [PROTECTION_GROUP_ID ...]]]
[--id [ID [ID ...]]]
Description
Retrieves all snapshots
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--sort SORT The fields to sort by (can provide multiple values). Use "-" to reverse the order.
--tag-key [TAG_KEY [TAG_KEY ...]]
Return snapshots with the specified tag key regardless of the tag value (multiple values possible).
--description [DESCRIPTION [DESCRIPTION ...]]
Return snapshots with the specified description (multiple values possible).
--tags [TAGS [TAGS ...]]
Tags to filter by.
--source-volume-id [SOURCE_VOLUME_ID [SOURCE_VOLUME_ID ...]]
Return snapshots with the specified source volume ID (multiple values possible).
--created-at [CREATED_AT [CREATED_AT ...]]
Return snapshots with the specified created at time (multiple values possible).
--state [STATE [STATE ...]]
Return snapshots with the specified state (multiple values possible).
--limit LIMIT Specify the number of entities that you want to retrieve.
--offset OFFSET Specify the first entity that you wan to retrieve.
--project-id [PROJECT_ID [PROJECT_ID ...]]
Return snapshots with the specified project ID (multiple values possible).
--protection-group-id [PROTECTION_GROUP_ID [PROTECTION_GROUP_ID ...]]
Return snapshots with the specified snapshot protection group ID (multiple values possible).
--id [ID [ID ...]] Return snapshots with the specified snapshot ID (multiple values possible).
snapshot transform¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot transform [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project-id PROJECT_ID]
[--description DESCRIPTION]
[--tags [TAGS [TAGS ...]]] [--name NAME]
resource_id resource_type
Description
Transform a resource (physical snapshot / volume) into a new snapshot (the original resource will be hidden)
Return
Returns dict: New snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
The project ID of this snapshot (admin-only)
--description DESCRIPTION
Description for the snapshot
--tags [TAGS [TAGS ...]]
Tags to apply during snapshot creation
--name NAME Name for the snapshot
snapshot_v4 transform Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 transform [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--description DESCRIPTION]
[--project-id PROJECT_ID]
[--tags [TAGS [TAGS ...]]]
resource_id name resource_type
Description
Transform a resource (physical snapshot / volume) into a new snapshot (the original resource will be hidden)
Return
Returns dict: New snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
Description for the snapshot
--project-id PROJECT_ID
The project ID of this snapshot (admin-only)
--tags [TAGS [TAGS ...]]
Tags to apply during snapshot creation
snapshot update¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
snapshot_id
Description
Update snapshot properties
Return
Returns dict: Updated snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name for the snapshot
--description DESCRIPTION
Description for the snapshot
snapshot_v4 update Volume type¶
Note
On clusters configured for volume type support (zCompute 23.08 and later), use the Volume type variant of the command.
On clusters without volume type support, use the generic variant of the command.
Usage
usage: -c snapshot_v4 update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
snapshot_id
Description
Update metadata of an existing snapshot
Return
Returns dict: Snapshot info
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name for the volume
--description DESCRIPTION
Description for the volume