lbcli get snapshot

AI Tools

Gets snapshot information.

Synopsis

Gets snapshot information.

lbcli get snapshot [flags]

Examples:

# Get information of snapshot by uuid: lbcli -J $JWT get snapshot --project-name=proj-1 --uuid=32e7b7ab-4e6d-4b6c-8c4e-92710bcd9301 # Get information of snapshot by name: lbcli -J $JWT get snapshot --project-name=proj-1 --name=snapshot_name

Flag

Short

Type

Default

Description

--help

-h

bool


Help for snapshot.

--name


string


Snapshot name. Either UUID or name must be specified, but not both.

--project-name


string


Project name.

--UUID


string


Snapshot UUID. Either UUID or name must be specified, but not both.

This command returns the following fields for each snapshot. The default output format is human-readable. The human-readable output only shows some of these fields. The json/yaml output format is also supported and includes additional fields.

Field

Type

Description

State

String

The current volume state:

  • Creating

  • Available

  • Deleting

  • Failed

Name

String

Snapshot name.

Description

String

Snapshot description.

Creation Time

Timestamp

Snapshot creation time.

Retention Time

Duration

Snapshot retention time. when this time expires the snapshot will be deleted. Setting this value to nil will retain the snapshot until it is explicitly deleted.

Source Volume UUID

String

The source volume UUID which the snapshot was taken from.

Source Volume Name

String

The source volume name which the snapshot was taken from.

Replica Count

Integer

Total replicas count.

Node List

list of strings

Node UUIDs on which the snapshot is stored (only in json/yaml).

Compression

boolean

  • False: Compression disabled

  • True: Compression enabled

Note: This represents the value of the field in the origin volume at the time of snapshot creation.

ACL

list of strings

Access Control List of source volume.

Note: This represents the value of the field in the origin volume at the time of snapshot creation.

NSID

Integer

Source volume NSID.

Size

Integer

Maximal logical capacity of the snapshot in bytes.

Note: This represents the value of the field in the origin volume at the time of snapshot creation.

Sector Size

Integer

The snapshot sector size:

  • 0 (default = 4096)

  • 512

  • 4096

Note: This represents the value of the field in the origin volume at the time of snapshot creation.

Etag

String

Deprecated in v2.2.1.

Statistics

Struct

See Appendix A: Common Statistics.

Note

For examples and a full list of snapshots metrics, see lbcli list snapshots (2.2 and above).