Skip to main content

snapmirror policy modify

Modify a SnapMirror policy

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

Description​

The snapmirror policy modify command can be used to modify the policy attributes.

Note
Use the snapmirror policy modify-rule command to modify a rule in a SnapMirror policy.

Parameters​

-vserver <vserver name> - Vserver Name
Specifies the Vserver for the SnapMirror policy.
-policy <sm_policy> - SnapMirror Policy Name
Specifies the SnapMirror policy name.
[-comment <text>] - Comment
Specifies a text comment for the SnapMirror policy. If the comment contains spaces, it must be enclosed within quotes.
[-tries <unsigned32_or_unlimited>] - Tries Limit
Determines the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The value of this parameter must be a positive integer or unlimited. The default value is 8.
[-transfer-priority {low|normal}] - Transfer Scheduling Priority
Specifies the priority at which a transfer runs. The supported values are normal or low. The normal transfers are scheduled before the low priority transfers. The default is normal.
[-ignore-atime {true|false}] - Ignore File Access Time
This parameter applies only to extended data protection (XDP) relationships. It specifies whether incremental transfers will ignore files which have only their access time changed. The supported values are true or false. The default is false.
[-restart {always|never|default}] - Restart Behavior
This parameter applies only to data protection relationships. It defines the behavior of SnapMirror if an interrupted transfer exists. The supported values are always, never, or default. If the value is set to always, an interrupted SnapMirror transfer always restarts provided it has a restart checkpoint and the conditions are the same as they were before the transfer was interrupted. In addition, a new SnapMirror Snapshot copy is created which will then be transferred. If the value is set to never, an interrupted SnapMirror transfer will never restart, even if a restart checkpoint exists. A new SnapMirror Snapshot copy will still be created and transferred. Data ONTAP version 8.2 will interpret a value of default as being the same as always. Vault transfers will always resume based on a restart checkpoint, provided the Snapshot copy still exists on the source volume.
[-is-network-compression-enabled {true|false}] - Is Network Compression Enabled
Specifies whether network compression is enabled for transfers. The supported values are true or false. The default is false.
[-common-snapshot-schedule <text>] - Common Snapshot Copy Creation Schedule for SnapMirror Synchronous (privilege: advanced)
Specifies the common Snapshot creating schedule. This parameter is only supported for Snapmirror Synchronous relationships.
[-discard-configs <network>, ...] - Configurations Not Replicated During Identity Preserve Vserver DR
Specifies the configuration to be dropped during replication. The supported values are:

  • network - Drops network interfaces, routes, and kerberos configuration.

This parameter is supported only for policies of type async-mirror and applicable only for identity-preserve Vserver SnapMirror relationships.

Examples​

The following example changes the "transfer-priority" and the "comment" text of a snapmirror policy named TieredBackup on Vserver vs0.example.com: 

vs0.example.com::> snapmirror policy modify -vserver vs0.example.com -policy 
TieredBackup -transfer-priority low -comment "Use for tiered backups"