na_ontap_snapmirror – NetApp ONTAP Manage SnapMirror

From Get docs
Ansible/docs/2.7/modules/na ontap snapmirror module


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 were developed with Clustered Data ONTAP 9.3
  • Ansible 2.6
  • netapp-lib (2017.10.30). 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

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

  • no

  • yes

Enable and disable https

password

- / required

Password for the specified user.


aliases: pass

relationship_type

-

  • 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

-

  • present

  • absent

Whether the specified relationship should exist or not.

username

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

  • no
  • yes

If set to False, 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
    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

Authors

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/na_ontap_snapmirror_module.html