netapp.ontap.na_ontap_snapmirror_policy – NetApp ONTAP create, delete or modify SnapMirror policies

Note

This plugin is part of the netapp.ontap collection (version 21.12.0).

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.

To use it in a playbook, specify: netapp.ontap.na_ontap_snapmirror_policy.

New in version 20.3.0: of netapp.ontap

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
Python3 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.
To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter	Choices/Defaults	Comments
cert_filepath string added in 20.6.0 of netapp.ontap		path to SSL client cert file (.pem). not supported with python 2.6.
comment string		Specifies the SnapMirror policy comment.
common_snapshot_schedule string		Specifies the common Snapshot copy schedule associated with the policy, only required for strict_sync_mirror and sync_mirror.
feature_flags dictionary added in 20.5.0 of netapp.ontap		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.
hostname string / required		The hostname or IP address of the ONTAP instance.
http_port integer		Override the default port (80 or 443) with this port
https boolean	Choices: no ← yes	Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL.
ignore_atime boolean	Choices: no yes	Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only.
is_network_compression_enabled boolean	Choices: no yes	Specifies whether network compression is enabled for transfers.
keep list / elements=integer added in 20.7.0 of netapp.ontap		SnapMirror policy rule retention count for snapshots created. Required when defining policy rules.
key_filepath string added in 20.6.0 of netapp.ontap		path to SSL client key file.
ontapi integer		The ontap api version to use
owner string	Choices: cluster_admin vserver_admin	Specifies the owner of the SnapMirror policy.
password string		Password for the specified user. aliases: pass
policy_name string / required		Specifies the SnapMirror policy name.
policy_type string	Choices: vault async_mirror mirror_vault strict_sync_mirror sync_mirror	Specifies the SnapMirror policy type. Modifying the type of an existing SnapMirror policy is not supported
prefix list / elements=string added in 20.7.0 of netapp.ontap		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.
restart string	Choices: always never default	Defines the behavior of SnapMirror if an interrupted transfer exists, applies to data protection only.
schedule list / elements=string added in 20.7.0 of netapp.ontap		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_label list / elements=string added in 20.7.0 of netapp.ontap		SnapMirror policy rule label. Required when defining policy rules. Use an empty list to remove all user-defined rules.
state string	Choices: present ← absent	Whether the specified SnapMirror policy should exist or not.
transfer_priority string	Choices: low normal	Specifies the priority at which a SnapMirror transfer runs.
tries string		Specifies the number of tries.
use_rest string	Default: "auto"	REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api
username string		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 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. aliases: user
validate_certs boolean	Choices: no yes ←	If set to `no`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.
vserver string / required		Specifies the vserver for the SnapMirror policy.

Notes

Note

The modules prefixed with na_ontap are built to support the ONTAP storage platform.

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"
    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"
    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

Authors

NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_snapmirror_policy_module.html

Docs

Docs4dev

Title here