Conductor Documentation

snapshots

The cfy snapshots command is used to manage data snapshots of the Conductor Manager. You must have admin credentials to create and restore snapshots.

You can use the command to create, upload, download, delete and list snapshots and also to restore a Manager using a snapshot archive.

For more about working with snapshots, go to: snapshots.

Optional flags

These commands support the common CLI flags.

Commands

create

Usage

cfy snapshots create [OPTIONS] [SNAPSHOT_ID]

Create a snapshot of the Conductor Manager.

The snapshot will contain the relevant data to restore a Conductor Manager to its previous state.

SNAPSHOT_ID is the ID to attach to the snapshot.

Optional flags

 

Example

$ cfy snapshots create
...

Creating snapshot snapshot_XLHCNV...
Started workflow execution. The execution's id is 2219928b-69fd-49f1-8982-c42da5f82a63

...

delete

Usage

cfy snapshots delete [OPTIONS] SNAPSHOT_ID

Delete a snapshot from the Conductor Manager.

SNAPSHOT_ID is the ID of the snapshot to delete.

Optional flags

 

Example

$ cfy snapshots delete snapshot_XLHCNV
...

Deleting snapshot snapshot_XLHCNV...
Snapshot deleted successfully

...

download

Usage

cfy snapshots download [OPTIONS] SNAPSHOT_ID

Download a snapshot from the Conductor Manager.

SNAPSHOT_ID is the ID of the snapshot to download.

Optional flags

 

Example

$ cfy snapshots download snapshot_XLHCNV
...

Downloading snapshot snapshot_XLHCNV...
 snapshot_XLHCNV |#####################################################| 100.0%
Snapshot downloaded as snapshot_XLHCNV.zip

...

list

Usage

cfy snapshots list [OPTIONS]

List all snapshots on Conductor Manager.

Optional flags

 

Example

$ cfy snapshots list
...

Listing snapshots...

Snapshots:
+-----------------+--------------------------+---------+-------+------------+----------------+------------+
|        id       |        created_at        |  status | error | visibility |  tenant_name   | created_by |
+-----------------+--------------------------+---------+-------+------------+----------------+------------+
| snapshot_XLHCNV | 2017-04-04 09:33:39.315  | created |       |  tenant    | default_tenant |   admin    |
+-----------------+--------------------------+---------+-------+------------+----------------+------------+

Showing 1 of 1 snapshots

restore

Usage

cfy snapshots restore [OPTIONS] SNAPSHOT_ID

Restore the Conductor Manager to its previous state, or upgrade it to a newer version.

SNAPSHOT_ID is the ID of the snapshot to use for restoration

More detailed description of a snapshot-restore procedure for scheduled executions is available at Conductor Backup and Restore Guide.

Optional flags

 

Example

$ cfy snapshots restore snapshot_CAMWZ5
...

Restoring snapshot snapshot_XLHCNV...
Started workflow execution. The execution's id is 53921762-2b72-430b-b6fe-d6f1faced8e1

...

upload

Usage

cfy snapshots upload [OPTIONS] SNAPSHOT_PATH

Upload a snapshot to the Conductor Manager.

SNAPSHOT_PATH is the path of the snapshot to upload.

Optional flags

 

Example

$ cfy snapshots upload snapshot_XLHCNV.zip
...

Uploading snapshot snapshot_XLHCNV.zip...
 snapshot_XLHCNV.zip |#################################################| 100.0%
Snapshot uploaded. The snapshot's id is snapshot_76E7LB

...

status

Usage

cfy snapshots status

return the status of the restore_snapshot workflow (whether or not it’s in progress).

 

Example

$ cfy snapshots status
...

Retrieving snapshot restore status...
No `restore_snapshot` workflow currently running.

...