Search the docs

Snapshots and Cloning

file-snapshot-create

file-snapshot-create [options]

Create file snapshot

Example
file-snapshot-create --filename /test/VM2/*.vmdk --now

Options

--filename

Source file path. The filename in the path may include wild-card characters (for example, /share/dir/file*.txt) (Required)

--help

Display this help and exit

--now

Create immediate snapshot of the file. Required unless "--schedule-name" is specified

--retention-name

The name of the snapshot retention policy.

--schedule-name

The name of the schedule policy. Required unless "--now" is specified

file-snapshot-delete

file-snapshot-delete [options]

Delete file snapshots

Options

--all

Deletes all existing snapshots. Required unless "--time" is specified

--filename

Source file path. The filename in the path may include wild-card characters (for example: /share/dir/file*.txt) (Required)

--help

Display this help and exit

--time

Date-time expression in format yyyy-MM-ddThh-mm-ss. The expression may contain wild-card characters (for example: 2000-01-30*). Required unless "--all" is specified

file-snapshot-list

file-snapshot-list [options]

List file snapshots

Options

--filename

Source file path. The filename in the path may include wild-card characters (for example: /share/dir/file*.txt) (Required)

--help

Display this help and exit

file-snapshot-restore

file-snapshot-restore [options]

Restore files from snapshots

Options

--filename

Source file path. The filename in the path may include wild-card characters (for example: /share/dir/file*.txt) (Required)

--help

Display this help and exit

--time

Date-time expression in format yyyy-MM-ddThh-mm-ss. The expression may contain wild-card characters (for example: 2000-01-30*) (Required)

file-snapshot-schedule-list

file-snapshot-schedule-list [options]

List scheduled file snapshots

Options

--filename

Source file path. The filename in the path may include wild-card characters (for example: /share/dir/file*.txt)

--help

Display this help and exit

--id

The ID of the file snapshot schedule to list

file-snapshot-update

file-snapshot-update [options]

Update file snapshot schedule

Options

--filename

Source file path. The filename in the path may include wild-card characters (for example: /share/dir/file*.txt) (Required)

--help

Display this help and exit

--remove-retention

Remove the retention policy from file snapshots. Required unless any of the following is specified: --remove-schedule, --retention-name, --schedule-name

--remove-schedule

Remove both schedule and retention from file snapshots. Required unless any of the following is specified: --retention-name, --schedule-name, --remove-retention

--retention-name

The name of the snapshot retention policy. Required unless any of the following is specified: --remove-schedule, --schedule-name, --remove-retention

--schedule-name

The name of the schedule policy. Required unless any of the following is specified: --remove-schedule, --retention-name, --remove-retention

snapshot-retention-create

snapshot-retention-create [options]

Create a snapshot retention policy

Options

--help

Display this help and exit

--name

The name of the snapshot retention policy (Required)

--number-of-copies

The number of copies the policy should create. Required unless "--retention-time" is specified

--retention-time

The time interval to retain snapshots, from the time of the last snapshot, in the format: dd:HH:mm. Required unless "--number-of-copies" is specified

snapshot-retention-delete

snapshot-retention-delete [options]

Delete snapshot retention policy

Options

--help

Display this help and exit

--id

The ID of the snapshot policy to delete. Required unless "--name" is specified

--name

The name of the snapshot policy to delete. Required unless "--id" is specified

snapshot-retention-list

snapshot-retention-list [options]

List snapshot retention policies

Options

--full

Print extra information for each element

--help

Display this help and exit

--id

The ID of the snapshot retention policy to list

--name

The name of the snapshot retention policy to list

snapshot-retention-update

snapshot-retention-update [options]

Update snapshot retention policy

Options

--help

Display this help and exit

--id

The name of the snapshot retention policy to list. Required unless "--name" is specified

--name

The ID of the snapshot retention policy to list. Required unless "--id" is specified

--number-of-copies

The number of copies the policy should create. Required unless "--retention-time" is specified

--retention-time

The time interval to retain snapshots, from the time of the last snapshot, in the format: dd:HH:mm. Required unless "--number-of-copies" is specified