na_ontap_snapmirror – NetApp ONTAP Manage SnapMirror

New in version 2.7.

Synopsis

• Create/Delete/Initialize SnapMirror volume/vserver relationships

• Modify schedule for a SnapMirror relationship

Requirements

The below requirements are needed on the host that executes this module.

• A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward

• Ansible 2.6

• Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’

• Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’

• 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
destination_path -		Specifies the destination endpoint of the SnapMirror relationship.
destination_volume -		Specifies the name of the destination volume for the SnapMirror.
destination_vserver -		Name of the destination vserver for the SnapMirror.
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
ontapi integer		The ontap api version to use
password string / required		Password for the specified user. aliases: pass
policy - added in 2.8		Specify the name of the SnapMirror policy that applies to this relationship.
relationship_type -	Choices: data_protection load_sharing vault restore transition_data_protection extended_data_protection	Specify the type of SnapMirror relationship.
schedule -		Specify the name of the current schedule, which is used to update the SnapMirror relationship. Optional for create, modifiable.
source_hostname -		Source hostname or IP address. Required for SnapMirror delete
source_password -		Source password. Optional if this is same as destination password.
source_path -		Specifies the source endpoint of the SnapMirror relationship.
source_username -		Source username. Optional if this is same as destination username.
source_volume -		Specifies the name of the source volume for the SnapMirror.
source_vserver -		Name of the source vserver for the SnapMirror.
state -	Choices: present ← absent	Whether the specified relationship should exist or not.
username string / required		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/. 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.

Notes

Note

• The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create SnapMirror
  na_ontap_snapmirror:
    state: present
    source_volume: test_src
    destination_volume: test_dest
    source_vserver: ansible_src
    destination_vserver: ansible_dest
    schedule: hourly
    policy: MirrorAllSnapshots
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SnapMirror
  na_ontap_snapmirror:
    state: absent
    destination_path: <path>
    source_hostname: "{{ source_hostname }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Set schedule to NULL
  na_ontap_snapmirror:
    state: present
    destination_path: <path>
    schedule: ""
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Release SnapMirror
  na_ontap_snapmirror:
    state: release
    destination_path: <path>
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by an Ansible Partner. [certified]

Authors

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.