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.
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 is8
. [-transfer-priority {low|normal}]
- Transfer Scheduling Priority-
Specifies the priority at which a transfer runs. The supported values are
normal
orlow
. Thenormal
transfers are scheduled before thelow
priority transfers. The default isnormal
. [-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
orfalse
. The default isfalse
. [-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
, ordefault
. If the value is set toalways
, 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 tonever
, 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 ofdefault
as being the same asalways
. 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
orfalse
. The default isfalse
. [-rpo <integer>]
- Recovery Point Objective (seconds)-
Specifies the time for recovery point objective, in seconds. This parameter is only supported for a policy of type
continuous
. [-always-replicate-snapshots {true|false}]
- This prioritizes replication of app-consistent snapshots over synchronous replication-
If this parameter is set to true, it specifies that SnapMirror Synchronous relationships will lose the zero RPO protection upon failure in replicating application created snapshots. The default value is false.
[-retention-period {{<integer> days|months|years}}]
- Snapshot Copy Retention Period-
This optional parameter specifies the duration for which the Snapshot copies associated with this rule will be locked. This parameter is only allowed for SnapMirror relationships between ONTAP source endpoints and object store destination endpoints. The parameter is specified as a number followed by a suffix. The valid suffixes are
days
,months
, andyears
. For example, a value of6months
represents a retention period of 6 months. The minimum value of this parameter is30days
and maximum value is100years
. It cannot be specified if the value of thesnapshot-lock-mode
field in the SnapMirror policy is set tonone
. The default value is30days
when the value of thesnapshot-lock-mode
field in the SnapMirror policy is set tocompliance
orenterprise
and the retention period is not specified. [-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.
[-are-data-ops-sequentially-split {true|false}]
- Is Sequential Splitting of Data Operations Enabled? (privilege: advanced)-
This parameter specifies whether I/O, such as write, copy-offload and punch-holes, are split sequentially, rather than being run in parallel on the source and destination. Spliiting the I/O sequentially will make the system more robust, and less prone to I/O errors. Starting 9.11.1, enabling this feature improves the performance when the workload is NAS based and is metadata heavy. However, it will make the IO performance slower for large file workloads like LUNs, databases, virtualization containers, etc. The default value of parameter
-sequential-split-data-ops
isfalse
. The parameter-are-data-ops-sequentially-split
should only be used if frequent I/O timeout or "OutOfSync" has happened. Changes made by thesnapmirror policy modify -sequential-split-data-ops
command do not take effect until the next resync. Changes do not affect resync or initialize operations that have started and have not finished yet. The parameter-are- data-ops-sequentially-split
requires an effective cluster version of Data ONTAP 9.6.0 or later on both the source and destination clusters. [-sequential-split-op-timeout-secs <integer>]
- Sequential Split Op Timeout in Seconds (privilege: advanced)-
This parameter specifies the op timeout value used when the splitting mode is sequential. This parameter is used only for Sync relationships. Supported values are from 15 to 25 seconds. The default value of the parameter
-sequential-split-op-timeout
is15 seconds
. Changes made by thesnapmirror policy modify -sequential-split-op-timeout-secs
command do not take effect until the next resync. Changes do not affect resync or initialize operations that have started and have not finished yet. [-disable-fast-resync {true|false}]
- Disable Fast Resync (privilege: advanced)-
Specifies whether fast resync for a SnapMirror Synchronous relationship is disabled or not. The default value for this parameter when a policy is created is
false
. [-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. -
[-transfer-schedule-name <text>]
- Transfer Schedule Name-
This optional parameter specifies the schedule which is used to update the SnapMirror relationships.
[-throttle <throttleType>]
- Throttle (KB/sec)-
This optional parameter limits the network bandwidth used for transfers. It configures for the relationships the maximum rate (in Kbytes/sec) at which data can be transferred. If no throttle is configured, by default the SnapMirror relationships fully utilize the network bandwidth available. You can also configure the relationships to fully use the network bandwidth available by explicitly setting the throttle to
unlimited
or0
. The minimum effective throttle value is four Kbytes/sec, so if you specify a throttle value between1
and4
, it will be treated as4
. For FlexGroup volume relationships, the throttle value is applied individually to each constituent relationship.
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"