netapp.ontap.na_ontap_snapmirror_policy module – NetApp ONTAP create, delete or modify SnapMirror policies
Note
This module is part of the netapp.ontap collection (version 22.8.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_snapmirror_policy.
New in netapp.ontap 20.3.0
Synopsis
NetApp ONTAP create, modify, or destroy the SnapMirror policy
Add, modify and remove SnapMirror policy rules
Following parameters are not supported in REST; ‘owner’, ‘restart’, ‘transfer_priority’, ‘tries’, ‘ignore_atime’, ‘common_snapshot_schedule’
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues
a physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Specifies the SnapMirror policy comment. |
|
Specifies the common Snapshot copy schedule associated with the policy, only required for strict_sync_mirror and sync_mirror. Not supported with REST. |
|
Specifies whether all source Snapshot copies should be copied to the destination on a transfer rather than specifying specific retentions. This property is applicable only to async policies. Property can only be set to ‘true’. Only supported with REST and requires ONTAP 9.10.1 or later. Choices:
|
|
Specifies that the latest source Snapshot copy (created by SnapMirror before the transfer begins) should be copied to the destination on a transfer. Retention properties cannot be specified along with this property. Property can only be set to ‘true’. Only supported with REST and requires ONTAP 9.11.1 or later. Choices:
|
|
Specifies whether a new Snapshot copy should be created on the source at the beginning of an update or resync operation. This property is applicable only to async policies. Property can only be set to ‘false’. Only supported with REST and requires ONTAP 9.11.1 or later. Choices:
|
|
Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Specifies which configuration of the source SVM is replicated to the destination SVM. This property is applicable only for SVM data protection with “async” policy type. Only supported with REST. Choices:
|
|
Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only. Not supported with REST. Choices:
|
|
Specifies whether network compression is enabled for transfers. Choices:
|
|
SnapMirror policy rule retention count for snapshots created. Required when defining policy rules. |
|
path to SSL client key file. |
|
The ontap api version to use |
|
Specifies the owner of the SnapMirror policy. Not supported with REST. Choices:
|
|
Password for the specified user. |
|
Specifies the SnapMirror policy name.
|
|
Specifies the SnapMirror policy type. Modifying the type of an existing SnapMirror policy is not supported. The Policy types ‘sync’ and ‘async’ are only supported in REST. Choices:
|
|
SnapMirror policy rule prefix. Optional when defining policy rules. Set to ‘’ to not set or remove an existing custom prefix. Prefix name should be unique within the policy. When specifying a custom prefix, schedule must also be specified. |
|
Defines the behavior of SnapMirror if an interrupted transfer exists, applies to data protection only. Not supported with REST. Choices:
|
|
SnapMirror policy rule schedule. Optional when defining policy rules. Set to ‘’ to not set or remove a schedule. When specifying a schedule a custom prefix can be set otherwise the prefix will be set to snapmirror_label. |
|
SnapMirror policy rule label. Required when defining policy rules. Use an empty list to remove all user-defined rules. |
|
Whether the specified SnapMirror policy should exist or not. Choices:
|
|
This property is only applicable to sync policy types. If the “sync_type” is “sync” then a write success is returned to the client after writing the data to the primary endpoint and before writing the data to the secondary endpoint. If the “sync_type” is “strict_sync” then a write success is returned to the client after writing the data to the both primary and secondary endpoints. The “sync_type” of “automated_failover” can be associated with a SnapMirror relationship that has Consistency Group as the endpoint and it requires ONTAP 9.7 or later. Only supported with REST. Choices:
|
|
Specifies the priority at which a SnapMirror transfer runs. Not supported with REST. Choices:
|
|
Specifies the name of the schedule used to update asynchronous SnapMirror relationships. Not supported with ZAPI. |
|
Specifies the number of tries. Not supported with REST. |
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
Specifies the vserver for the SnapMirror policy. Required with ZAPI. Name of a data vserver with REST. With current versions of ONTAP, when using REST, this must be set to the cluster name for cluster scoped policies (9.12.1 and older). Current versions of ONTAP fail with “svm.uuid” is required when the vserver field is not set. With newer versions of ONTAP, omit the value, or omit this option for a cluster scoped policy with REST. |
Notes
Note
In REST, policy types ‘mirror_vault’, ‘vault’ and ‘async_mirror’ are mapped to ‘async’ policy_type.
In REST, policy types ‘sync_mirror’ and ‘strict_sync_mirror’ are mapped to ‘sync’ policy_type.
In REST, use policy_type ‘async’ to configure ‘mirror-vault’ in CLI.
In REST, use policy_type ‘async’ with ‘copy_all_source_snapshots’ to configure ‘async-mirror’ with ‘all_source_snapshots’ in CLI.
In REST, use policy_type ‘async’ with ‘copy_latest_source_snapshot’ to configure ‘async-mirror’ without ‘all_source_snapshots’ in CLI.
In REST, use policy_type ‘async’ with ‘create_snapshot_on_source’ to configure ‘vault’ in CLI.
In REST, use policy_type ‘sync’ with sync_type ‘sync’ to configure ‘sync-mirror’ in CLI.
In REST, use policy_type ‘sync’ with sync_type ‘strict_sync’ to configure ‘strict-sync-mirror’ in CLI.
In REST, use policy_type ‘sync’ with sync_type ‘automated_failover’ to configure ‘automated-failover’ in CLI.
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: Create SnapMirror policy
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
comment: "created by ansible"
transfer_schedule: "daily" # when using REST
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "async_mirror"
transfer_priority: "low"
transfer_schedule: "weekly" # when using REST
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Create SnapMirror policy with basic rules
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "async_mirror"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Create SnapMirror policy with rules and schedules (no schedule for daily rule)
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
schedule: ['','weekly','monthly']
prefix: ['','','monthly_mv']
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy with rules, remove existing schedules and prefixes
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
schedule: ['','','']
prefix: ['','','']
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy, delete all rules (excludes builtin rules)
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: []
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Delete SnapMirror policy
na_ontap_snapmirror_policy:
state: absent
vserver: "SVM1"
policy_type: "async_mirror"
policy_name: "ansible_policy"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false