icmcli get snapshot

AI Tools

Gets an existing snapshot.

Synopsis

Gets an existing snapshot. Specify either --name or --uuid, but not both.

icmcli get snapshot [flags]

Examples

#get a snapshot in project: "proj" with snapshot name: "snap": icmcli get snapshot --project-name proj --name snap #get a snapshot in project: "proj" with snapshot uuid: "u-u-i-d": icmcli get snapshot --project-name proj --uuid u-u-i-d

Flag

Short

Type

Default

Description

--help

-h

bool


Help for snapshot.

--name


string


Snapshot name.

--project-name


string


The project this snapshot belongs to.

--uuid


string


Snapshot UUID.

Response Type

Returns a single Snapshot object with the following fields:

Field

Type

Description

state

StateEnum


UUID

string


name

string


description

string


creationTime

string


retentionTime

string


sourceVolumeUUID

string


sourceVolumeName

string


replicaCount

integer


nodeList

array


nsid

integer


acl

StringList


compression

boolean


size

string


IPAcl

StringList


sectorSize

integer


statistics

SnapshotStatisticsApi


ETag

string


projectName

string


primaryNodeUUID

string


labels

array

Once a snapshot is taken, the volume's labels are copied to the snapshot. Once a clone is created, if the user does not pass new labels on clone creation, the cloned volume labels are copied from the source snapshot labels.

clusterId

string

The ID of the cluster where the snapshot resides.