na_ontap_cluster_peer – NetApp ONTAP Manage Cluster peering

From Get docs
Ansible/docs/2.8/modules/na ontap cluster peer module


na_ontap_cluster_peer – NetApp ONTAP Manage Cluster peering

New in version 2.7.


Synopsis

  • Create/Delete cluster peer relations on ONTAP

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

dest_cluster_name

-

The name of the destination cluster name in the peer relation to be deleted.

Required for delete

dest_hostname

- / required

Destination cluster IP or hostname which needs to be peered

Required to complete the peering process at destination cluster.

dest_intercluster_lifs

-

added in 2.8

List of intercluster addresses of the destination cluster.

Used as peer-addresses in source cluster.

All these intercluster lifs should belong to the destination cluster.


aliases: dest_intercluster_lif

dest_password

-

Destination password.

Optional if this is same as source password.

dest_username

-

Destination username.

Optional if this is same as source username.

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

  • no

  • yes

Enable and disable https

ontapi

integer

The ontap api version to use

passphrase

-

The arbitrary passphrase that matches the one given to the peer cluster.

password

string / required

Password for the specified user.


aliases: pass

source_cluster_name

-

The name of the source cluster name in the peer relation to be deleted.

source_intercluster_lifs

-

added in 2.8

List of intercluster addresses of the source cluster.

Used as peer-addresses in destination cluster.

All these intercluster lifs should belong to the source cluster.


aliases: source_intercluster_lif

state

-

  • present

  • absent

Whether the specified cluster peer 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

  • 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 cluster peer
  na_ontap_cluster_peer:
    state: present
    source_intercluster_lifs: 1.2.3.4,1.2.3.5
    dest_intercluster_lifs: 1.2.3.6,1.2.3.7
    passphrase: XXXX
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    dest_hostname: "{{ dest_netapp_hostname }}"

- name: Delete cluster peer
  na_ontap_cluster_peer:
    state: absent
    source_cluster_name: test-source-cluster
    dest_cluster_name: test-dest-cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    dest_hostname: "{{ dest_netapp_hostname }}"

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.8/modules/na_ontap_cluster_peer_module.html