Skip to main content

volume snapshot policy add-schedule

Contributors
Suggest changes
PDFs

Add a schedule to snapshot policy

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The volume snapshot policy add-schedule command adds a schedule to a Snapshot policy. You can create a schedule by using the job schedule cron create or job schedule interval create commands.

Parameters

-vserver <vserver name> - Vserver Name

This specifies the Vserver on which a Snapshot policy schedule is to be added.

-policy <snapshot policy> - Snapshot Policy Name

This specifies the Snapshot policy to which a schedule is to be added.

-schedule <text> - Schedule Name

This specifies the schedule that is to be added to the Snapshot policy.

-count <integer> - Maximum Snapshot Copies for Schedule

This specifies the maximum number of Snapshot copies that can be taken by the specified schedule. The total count of all the Snapshot copies to be retained for the policy cannot be more than 1023.

[-prefix <text>] - Snapshot Copy Name Prefix for Schedule

This option specifies the prefix with which Snapshot copies will be created for the added schedule. Every schedule has only one prefix. Once a prefix gets associated with a schedule, you cannot update the prefix. If some prefix is already associated with the schedule and you do not specify this parameter, then the previously defined prefix is used. The command fails if you try to update an existing prefix for a schedule. If no prefix is associated with the schedule and you do not specify this parameter, then schedule name is be used as the prefix.

[-snapmirror-label <text>] - Label for SnapMirror Operations

This specifies the SnapMirror Label identified with a Snapshot copy when it is created for the added schedule. The SnapMirror Label is used by the Vaulting subsystem when you back up Snapshot copies to the Vault Destination.

[-retention-period <snaplock minmax period>] - SnapLock Retention Period

This specifies the retention period for Snapshot copies created by the schedule.

Examples

The following example adds a schedule named midnight to the Snapshot policy named snappolicy_nightly on Vserver vs0. The schedule can take a maximum of five Snapshot copies.

cluster1::> volume snapshot policy add-schedule -vserver vs0 -policy snappolicy_nightly -schedule midnight -count 5 -retention-period "7 days"