Docs4dev
Docs
ansible / latest / collections / netapp / ontap / na_ontap_cluster_peer_module.html

netapp.ontap.na_ontap_cluster_peer – NetApp ONTAP Manage Cluster peering

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_cluster_peer.

New in version 2.7.0: of netapp.ontap

Synopsis

  • Create/Delete cluster peer relations on ONTAP

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.
dest_cluster_name
string
The name of the destination cluster name in the peer relation to be deleted.
Required for delete
dest_hostname
string
DEPRECATED - please use peer_options.
Destination cluster IP or hostname which needs to be peered.
Required to complete the peering process at destination cluster.
dest_intercluster_lifs
list / elements=string
added in 2.8.0 of netapp.ontap
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
string
DEPRECATED - please use peer_options.
Destination password.
Optional if this is same as source password or if a certificate is used..
dest_username
string
DEPRECATED - please use peer_options.
Destination username.
Optional if this is same as source username or if a certificate is used.
encryption_protocol_proposed
string
added in 20.5.0 of netapp.ontap
    Choices:
  • tls_psk
  • none
Encryption protocol to be used for inter-cluster communication.
Only available on ONTAP 9.5 or later.
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.
ipspace
string
added in 20.11.0 of netapp.ontap
IPspace of the local intercluster LIFs.
Assumes Default IPspace if not provided.
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
passphrase
string
The arbitrary passphrase that matches the one given to the peer cluster.
password
string
Password for the specified user.

aliases: pass
peer_options
dictionary
added in 21.8.0 of netapp.ontap
IP address and connection options for the peer system.
If any if these options is not specified, the corresponding source option is used.
cert_filepath
string
path to SSL client cert file (.pem).
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.
key_filepath
string
path to SSL client key file.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
use_rest
string
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
Username when using basic authentication.

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.
source_cluster_name
string
The name of the source cluster name in the peer relation to be deleted.
source_intercluster_lifs
list / elements=string
added in 2.8.0 of netapp.ontap
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
string
    Choices:
  • present ←
  • absent
Whether the specified cluster peer should exist or not.
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.

Notes

Note

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

Examples

- name: Create cluster peer
  netapp.ontap.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 }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"
    encryption_protocol_proposed: tls_psk

- name: Delete cluster peer
  netapp.ontap.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 }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"

- name: Create cluster peer - different credentials
  netapp.ontap.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 }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"
      cert_filepath: "{{ cert_filepath }}"
      key_filepath: "{{ key_filepath }}"
    encryption_protocol_proposed: tls_psk

Authors

© 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_cluster_peer_module.html