lbcli get snapshots-policy (2.2 and above)
Gets a snapshot policy.
lbcli get snapshots-policy [flags]Examples:
# Get a snapshots policy.lbcli -J $JWT get snapshots-policy --project-name=project1 --uuid=4c027341-7283-4b45-84f5-1460f4c96127"| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
| --help | -h | bool | Help for snapshots-policy. | |
| --project-name | string | The project name (required). | ||
| --UUID | string | Policy UUID. |
This command returns the following fields for the 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:
|
| Name | string | Policy name. |
| UUID | string | Policy UUID. |
| Resource UUID | string | Volume UUID that the policy relates to. |
| Resource Name | string | Volume name that the policy relates to. |
| Schedule Policy | struct | See the snapshot schedule policy table. |
Schedule policy table:
| Field | Type | Description |
|---|---|---|
| Schedule Policies | struct | The following schedule policies are supported:
See tables below. |
| Retention | duration | Snapshot retention duration. |
Hourly snapshot schedule policy:
| Field | Type | Description |
|---|---|---|
| Start Time | timestamp | Policy start time. |
| Hours in Cycle | integer | Hourly interval for new snapshot creation. |
Daily snapshot schedule policy:
| Field | Type | Description |
|---|---|---|
| Start Time | timestamp | Policy start time. |
| Days in Cycle | integer | Daily interval for new snapshot creation. |
Was this page helpful?