lbcli list snapshots-policies (2.2 and above)

AI Tools

Lists snapshot policies.

Synopsis

Lists snapshot policies.

lbcli list snapshots-policies [flags]

Examples:

# List snapshots policies. lbcli -J $JWT list snapshots-policies --project-name=project1 --uuid=11117341-7283-4b45-84f5-1460f4c96127 lbcli -J $JWT list snapshots-policies --project-name=project1 --volume-uuid=4c027341-7283-4b45-84f5-1460f4c96127

Flag

Short

Type

Default

Description

--help

-h

bool


Help for snapshots-policies.

--project-name


string


The project name (required).

--UUID


string


Policy UUID (required if volume UUID not provided).

--volume-UUID


string


Volume UUID (required if UUID not provided).

This command returns the following fields for each snapshot policy. 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

Description

String

Resource Description

State

String

Resource policy state:

  • Creating

  • Active

  • Deleting

  • Failed

Name

String

Policy Name

UUID

String

Policy UUID

Resource UUID

String

Snapshot UUID which the policy relates to.

Resource Name

String

snapshot name which the policy relates to.

Schedule Policy

struct

See snapshot schedule policy table:

Schedule policy table:

Field

Type

Description

Schedule Policies

String

The following schedule policies are supported:

  • Hourly Snapshot Schedule Policy

  • Daily Snapshot Schedule Policy

See tables below.

Retention

duration

Policy retention duration.

Hourly snapshot schedule policy:

Field

Type

Description

Start time

Time

Policy start time.

Hours in Cycle


Hours between snapshot creation cycles.

Daily snapshot schedule policy:

Field

Type

Description

Start Time

Time

Policy start time.

Days in Cycle

integer

Days between snapshot creation cycles.