snapshot¶
snapshot create¶
Usage
usage: symp 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 ...]]]
[--protection-group-id PROTECTION_GROUP_ID]
volume_id name
Description
Create a new snapshot from the specified volume
Returns
Returns dict: New snapshot
Mandatory
positional arguments:
volume_id Volume ID to snapshot
name Name for the 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 delete¶
Usage
usage: symp snapshot delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
snapshot_id
Description
Delete the snapshot
Mandatory
positional arguments:
snapshot_id The ID of the snapshot
Optional
optional arguments:
-h, --help show this help message and exit
snapshot get¶
Usage
usage: symp snapshot get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
snapshot_id
Description
Retrieve snapshot metadata
Returns
Returns dict: Snapshot metadata
Mandatory
positional arguments:
snapshot_id The ID of the snapshot
Optional
optional arguments:
-h, --help show this help message and exit
snapshot list¶
Usage
usage: symp snapshot 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 ...]]] [--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 ...]]]
[--reference-resource-id [REFERENCE_RESOURCE_ID [REFERENCE_RESOURCE_ID ...]]]
[--state [STATE [STATE ...]]] [--limit LIMIT]
[--endpoint-id [ENDPOINT_ID [ENDPOINT_ID ...]]]
[--offset OFFSET]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--protection-group-id [PROTECTION_GROUP_ID [PROTECTION_GROUP_ID ...]]]
[--id [ID [ID ...]]]
[--reference-resource-type [REFERENCE_RESOURCE_TYPE [REFERENCE_RESOURCE_TYPE ...]]]
[--name [NAME [NAME ...]]]
Description
Retrieves all snapshots
Returns
Returns list: List of snapshots
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).
--reference-resource-id [REFERENCE_RESOURCE_ID [REFERENCE_RESOURCE_ID ...]]
Return snapshots with the specified reference resource ID (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.
--endpoint-id [ENDPOINT_ID [ENDPOINT_ID ...]]
Return snapshots with the specified endpoint ID (multiple values possible).
--offset OFFSET Specify the first entity that you want 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).
--reference-resource-type [REFERENCE_RESOURCE_TYPE [REFERENCE_RESOURCE_TYPE ...]]
Return snapshots with the specified reference resource type (multiple values possible).
--name [NAME [NAME ...]]
Return snapshots with the specified name (multiple values possible).
snapshot stats¶
Usage
usage: symp snapshot stats
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--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 ...]]]
[--reference-resource-id [REFERENCE_RESOURCE_ID [REFERENCE_RESOURCE_ID ...]]]
[--state [STATE [STATE ...]]]
[--endpoint-id [ENDPOINT_ID [ENDPOINT_ID ...]]]
[--project-id [PROJECT_ID [PROJECT_ID ...]]]
[--protection-group-id [PROTECTION_GROUP_ID [PROTECTION_GROUP_ID ...]]]
[--id [ID [ID ...]]]
[--reference-resource-type [REFERENCE_RESOURCE_TYPE [REFERENCE_RESOURCE_TYPE ...]]]
[--name [NAME [NAME ...]]]
Description
Retrieves snapshots stats
Returns
Returns dict: Snapshots stats response
Optional
optional arguments:
-h, --help show this help message and exit
--tag-key [TAG_KEY [TAG_KEY ...]]
Filter stats by a specified tag key regardless of the tag value (multiple values possible).
--description [DESCRIPTION [DESCRIPTION ...]]
Filter stats by a specified description (multiple values possible).
--tags [TAGS [TAGS ...]]
Tags to filter by.
--source-volume-id [SOURCE_VOLUME_ID [SOURCE_VOLUME_ID ...]]
Filter stats by a specified source volume ID (multiple values possible).
--created-at [CREATED_AT [CREATED_AT ...]]
Filter stats by a specified created at time (multiple values possible).
--reference-resource-id [REFERENCE_RESOURCE_ID [REFERENCE_RESOURCE_ID ...]]
Filter stats by a specified reference resource ID (multiple values possible).
--state [STATE [STATE ...]]
Filter stats by a specified state (multiple values possible).
--endpoint-id [ENDPOINT_ID [ENDPOINT_ID ...]]
Filter stats by a specified endpoint ID (multiple values possible).
--project-id [PROJECT_ID [PROJECT_ID ...]]
Filter stats by a specified project ID (multiple values possible).
--protection-group-id [PROTECTION_GROUP_ID [PROTECTION_GROUP_ID ...]]
Filter stats by a specified snapshot protection group ID (multiple values possible).
--id [ID [ID ...]] Filter stats by a specified snapshot ID (multiple values possible).
--reference-resource-type [REFERENCE_RESOURCE_TYPE [REFERENCE_RESOURCE_TYPE ...]]
Filter stats by a specified reference resource type (multiple values possible).
--name [NAME [NAME ...]]
Filter stats by a specified name (multiple values possible).
snapshot transform¶
Usage
usage: symp snapshot transform
[-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 ...]]]
[--snapshot-id SNAPSHOT_ID]
[--created-at CREATED_AT]
resource_id name resource_type
Description
Transform a resource (physical snapshot / volume) into a new snapshot (the original resource will be hidden)
Returns
Returns dict: New snapshot
Mandatory
positional arguments:
resource_id Resource ID to transform to snapshot
name Name for the snapshot
resource_type the resource type to transform
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-id SNAPSHOT_ID
Snapshot ID to set for the snapshot
--created-at CREATED_AT
Optionally override the creation time of the snapshot
snapshot update¶
Usage
usage: symp 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]
snapshot_id
Description
Update metadata of an existing snapshot
Returns
Returns dict: Snapshot info
Mandatory
positional arguments:
snapshot_id The ID of the snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name for the volume
--description DESCRIPTION
Description for the volume