Articles in this section

snapshotpolicy create

Sara Levy
  • Updated
Follow

This command creates a snapshot policy. A snapshot policy creates snapshots of a directory on a schedule.

Usage
snapshotpolicy create  --name NAME
                       --path PATH
                       --schedule SCHEDULE]
                       --max-created-snapshots MAX_CREATED_SNAPSHOTS]
                       [--prefix PREFIX]
                       [--enabled]
                       [--disabled]
Required Parameters

--name NAME

Specifies the name of the policy.

--path PATH

Sets the path to the directory to snapshot. Each scheduled snapshot will include all files and folders under the specified directory at the time of taking the snapshot.

--schedule SCHEDULE

Sets the snapshot schedule. Specify using cron format and wrap in quotes.

Examples:

  • To schedule a snapshot to be taken at 00:00 on day 12 of the month, type --schedule "0 0 12 * *.

  • To schedule a snapshot to be taken at 10:30 pm every Tuesday, type --schedule "30 22 * * 2"

Note

To check if you specified the schedule as intended, run snapshotpolicy list or snapshotpolicy show and check the Humanize Schedule value, which describes the schedule in human terms.

--max-created-snapshots MAX_CREATED_SNAPSHOTS

The maximum number of snapshots to be retained. Oldest is deleted when needed to maintain limit.
Options

--prefix PREFIX

Specifies a prefix for the snapshots' names. If unspecified, the policy name is used.

--enabled

Enables the policy. (Default: true)

--disabled

Disables the policy.
Example
vcli: admin> snapshotpolicy create --name snapol1 --path / --schedule  "0 0 12 * *" --max-created-snapshots 4

Comments

0 comments

Article is closed for comments.