snapmirror policy modify-rule
Modify an existing rule in SnapMirror policy
Availability: This command is available to cluster and Vserver administrators at the admin privilege level.
Description
The
snapmirror policy modify-rule command can be used to modify the retention count, preserve setting, and warning threshold count for a rule in a SnapMirror policy. Reducing the retention count or disabling the preserve setting for a rule in a SnapMirror policy might result in the deletion of Snapshot copies on the vault destination when the next transfer by the
snapmirror update command occurs.
Note:
The rules in SnapMirror policies of type async-mirror cannot be modified.
Parameters
-vserver <vserver name> - Vserver Name
Specifies the Vserver for the SnapMirror policy.
-policy <sm_policy> - SnapMirror Policy Name
Specifies the SnapMirror policy name.
-snapmirror-label <text> - Snapshot Copy Label
This parameter specifies the rule that is to be modified in a SnapMirror policy.
[-keep <text>] - Snapshot Copy Retention Count
Specifies the maximum number of Snapshot copies that are retained on the SnapMirror destination volume for a rule. The total number of Snapshot copies retained for all the rules in a policy cannot exceed 251. For all the rules in SnapMirror policies of type async-mirror, this parameter must be set to value 1.
[-preserve {true|false}] - Snapshot Copy Preserve Enabled
Specifies the behavior when the Snapshot copy retention count is reached on the SnapMirror vault destination for the rule. The default value is false, which means that the oldest Snapshot copy will be deleted to make room for new ones only if the number of Snapshot copies has exceeded the retention count specified in the "keep" parameter. When set to true, an incremental SnapMirror vault update will fail when the Snapshot copies have reached the retention count. For all the rules in SnapMirror policies of type async-mirror this parameter must be set to value false.
[-warn <integer>] - Warning Threshold Count
Specifies the warning threshold count for the rule. The default value is 0. When set to a value greater than zero, an event is generated after the number of Snapshot copies (for the particular rule) retained on a SnapMirror vault destination reaches the specified warn limit. The preserve parameter for the rule must be true to set the warn parameter to a value greater than zero.
Examples
The following example changes the retention count for
nightly Snapshot copies to
6 for a rule named
nightly on a SnapMirror policy named
TieredBackup on Vserver
vs0.example.com:
vs0.example.com::> snapmirror policy modify-rule -vserver vs0.example.com
-policy TieredBackup -snapmirror-label nightly -keep 6
