Skip to main content

volume snapshot policy modify

Contributors
Suggest changes
PDFs

Modify a snapshot policy

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

Description

The volume snapshot policy modify command enables you to modify the description associated with a Snapshot policy and whether the policy is enabled or disabled.

Parameters

-vserver <vserver name> - Vserver Name

This specifies the Vserver on which the Snapshot policy is to be modified.

-policy <snapshot policy> - Snapshot Policy Name

This specifies the Snapshot policy that is to be modified.

[-enabled {true|false}] - Snapshot Policy Enabled

This optionally specifies whether the Snapshot policy is enabled.

[-comment <text>] - Comment

This specifies the comment text for the Snapshot policy.

[-snapmirror-labels <text>,…​] - Label for SnapMirror Operations

This optionally specifies a comma separated list of SnapMirror labels that are applied to the schedules in the Snapshot policy. Each label in the list applies to only one schedule in the Snapshot policy (maximum of 5 SnapMirror labels), the first label applying to the first schedule, the second label applying to the second schedule, and so on. You can have a maximum of five SnapMirror labels, which corresponds to the maximum number of schedules a Snapshot policy can have. If an empty string ("") is specified, the existing labels will be deleted from all the schedules.

Examples

The following example changes the description of a Snapshot policy named snappolicy_wknd on Vserver vs0 to "Runs only on weekends":

cluster1::> volume snapshot policy modify -vserver vs0 -policy snappolicy_wknd -comment "Runs only on weekends"