Upgrade to the latest version of Portworx Enterprise for continued support. Documentation for the latest version of Portworx Enterprise can be found here.
pxctl cloudsnap
pxctl cloudsnap
pxctl cloudsnap
Description
Backup and restore snapshots to/from cloudpxctl cloudsnap backup
pxctl cloudsnap backup <required-argument>
Description
Backup a snapshot to cloudExample
/opt/pwx/bin/pxctl cloudsnap backup [flags] volName
Flags
Flag | Description |
---|---|
|
list of comma-separated name=value `pairs` |
|
Force a full backup |
|
Deletes local snap created for backup after backup is done, also forces next backup to be full |
|
Cloud credentials ID to be used for the backup |
|
Maximum number of incremental cloudsnaps after which full is forced, default 7 |
pxctl cloudsnap backup-group
pxctl cloudsnap backup-group
Description
Backup a group of snapshot for a given list of volumes, group id, or labels to cloudFlags
Flag | Description |
---|---|
|
group id |
|
Force a full backup Default value: false |
|
Deletes local snap created for backup after backup is done, also forces next backup to be full |
|
Cloud credentials ID to be used for the backup |
|
list of comma-separated name=value `pairs` |
|
list of comma-separated volume IDs |
pxctl cloudsnap restore
pxctl cloudsnap restore
Description
Restore volume to a cloud snapshotFlags
Flag | Description |
---|---|
|
Volume name to be created for restore |
|
Cloud-snap id to restore |
|
Cloud credentials ID to be used for the restore |
|
replication factor(If not specified, inherits cloudsnaps repl factor) Default value: 1 |
|
IO Priority(If not specified, inherits cloudsnap's IO Priority) Default value: low |
|
list of comma-separated name=value `pairs` |
|
block device queue depth(If not specified, inherits cloudsnap's queuedepth) Default value: 128 |
|
aggregation level(If not specified, inherits cloudsnap's aggregation level) Default value: 1 |
|
comma-separated Node Ids or Pool Ids |
|
comma-separated Zone names |
|
comma-separated Rack names |
|
provision the restore volume on same pools as the source volume(src volume must exist) |
|
requested nodes, zones, racks are optional |
|
storage policy name(If not specified, inherits cloudsnap's storage policy) |
|
Journal data for this volume(If not specified, inherits cloudsnap's journal option) |
|
Disable discard support for this volume(If not specified, inherits cloudsnap's discard option) |
|
IO Profile((defaults to cloudsnap's IO Profile) Default value: sequential |
|
sticky volumes cannot be deleted until the flag is disabled(if not specified, inherits cloudsnap's sticky option) |
|
group |
|
enforce group during provision |
|
make this a globally shared namespace volume(If not specified, inherits cloudsnap's shared option) |
|
set sharedv4 setting(if not specified, inherits cloudsnap's sharedv4 option) |
|
periodic snapshot interval in `mins,k` (keeps 5 by default), 0 disables all schedule snapshots |
|
daily snapshot at specified `hh:mm,k` (keeps 7 by default) |
|
weekly snapshot at specified `weekday@hh:mm,k` (keeps 5 by default) |
|
monthly snapshot at specified `day@hh:mm,k` (keeps 12 by default) |
|
Enable fastpath IO support for this volume(If not specified, inherits cloudsnap's fastpath option) |
|
secret_key used to decrypt an encrypted volume |
|
Secret options is used to pass specific secret parameters. Usage: --secret_options=k1=v1,k2=v2 |
pxctl cloudsnap list
pxctl cloudsnap list
Description
List snapshot in cloudFlags
Flag | Description |
---|---|
|
Optional source volume to list cloud backups |
|
Cloud credentials ID to be used for the backup |
|
List cloudsnaps of volumes no longer in cluster(deleted source volumes) |
|
Optional Cluster ID or Bucket name to list cloud backups. Current cluster-id is default |
|
Optional, lists migration related cloudbackups |
|
Optional backup status(failed. aborted, stopped) to list cloud backups; Defaults to Done |
|
Optional list of comma-separated name=value `pairs` to match with cloudsnap metadata |
|
Optional number to limit display of backups in each page |
|
List cloud backups of all clusters in cloud |
|
Paginate list with user input to continue |
|
Optional cloudsnap id to list(lists a single entry) |
pxctl cloudsnap status
pxctl cloudsnap status
Description
Report status of active backups/restoresFlags
Flag | Description |
---|---|
|
Optional task name to list status |
|
Optional source volume to list backup/restore task status |
|
Node's local cloud-snaps(not cluster-wide) status |
pxctl cloudsnap history
pxctl cloudsnap history
Description
Show history of cloudsnap operationsFlags
Flag | Description |
---|---|
|
Optional source volume to list history |
pxctl cloudsnap stop
pxctl cloudsnap stop
Description
stop an active backup/restoreFlags
Flag | Description |
---|---|
|
Name of active backup/restore Required: true |
pxctl cloudsnap schedules
pxctl cloudsnap schedules
Description
Manage schedules for cloud-snapspxctl cloudsnap schedules create
pxctl cloudsnap schedules create
Description
Create a cloud-snap schedule for a volumeExample
/opt/pwx/bin/pxctl cloudsnap schedules create [flags] volName
Flags
Flag | Description |
---|---|
|
Maximum number of cloud snaps to maintain, default 7 Default value: 7 |
|
Retention period for cloud snaps in number of days |
|
Force scheduled backups to be full always |
|
Cloudsnap interval in minutes |
|
Daily snapshot at specified hh:mm (UTC) |
|
Weekly snapshot at specified weekday@hh:mm (UTC) |
|
Monthly snapshot at specified day@hh:mm (UTC) |
|
Cloud credentials ID to be used for the backup |
pxctl cloudsnap schedules delete
pxctl cloudsnap schedules delete
Description
Delete a cloud-snap scheduleFlags
Flag | Description |
---|---|
|
UUID of schedule to be deleted |
pxctl cloudsnap schedules list
pxctl cloudsnap schedules list
Description
List the configured cloud-snap schedulespxctl cloudsnap schedules update
pxctl cloudsnap schedules update
Description
update cloud-snap schedule for a volumeExample
/opt/pwx/bin/pxctl cloudsnap schedules update -i <uuid> [flags]
Flags
Flag | Description |
---|---|
|
uuid of the schedule being updated Required: true |
|
Maximum number of cloud snaps to maintain, default 7 Default value: 7 |
|
Retention period for cloud snaps in number of days |
|
Force scheduled backups to be full always |
|
Cloudsnap interval in minutes |
|
Daily snapshot at specified hh:mm (UTC) |
|
Weekly snapshot at specified weekday@hh:mm (UTC) |
|
Monthly snapshot at specified day@hh:mm (UTC) |
|
Cloud credentials ID to be used for the backup |
pxctl cloudsnap catalog
pxctl cloudsnap catalog
Description
Display catalog for the backup in cloudFlags
Flag | Description |
---|---|
|
Cloud Backup ID to display the catalog |
|
Cloud credentials ID to be used for the operation |
pxctl cloudsnap delete
pxctl cloudsnap delete
Description
Delete a cloudsnap from the objectstore. This is not reversible.Flags
Flag | Description |
---|---|
|
ID of cloudsnap |
|
Cloud credentials ID to be used for the operation |
|
Force delete cloudsnap even if there are dependencies |