netapp.ontap.na_ontap_cluster_peer module – NetApp ONTAP Manage Cluster peering
Note
This module is part of the netapp.ontap collection (version 22.13.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_cluster_peer.
New in netapp.ontap 2.7.0
Synopsis
Create/Delete cluster peer relations on ONTAP
Modify remote intercluster addresses in cluster peer relation on ONTAP
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, 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.
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
The name of the destination cluster name in the peer relation to be modified or deleted. Required for deleting peer relation and for modifying dest_intercluster_lifs. |
|
DEPRECATED - please use Destination cluster IP or hostname which needs to be peered. Required to complete the peering process at destination cluster. |
|
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. |
|
DEPRECATED - please use Destination password. Optional if this is same as source password or if a certificate is used.. |
|
DEPRECATED - please use Destination username. Optional if this is same as source username or if a certificate is used. |
|
Encryption protocol to be used for inter-cluster communication. Only available on ONTAP 9.5 or later. Choices:
|
|
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. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
IPspace of the local intercluster LIFs. Assumes Default IPspace if not provided. |
|
path to SSL client key file. |
|
The ontap api version to use |
|
The arbitrary passphrase that matches the one given to the peer cluster. |
|
Password for the specified user. |
|
IP address and connection options for the peer system. If any if these options is not specified, the corresponding source option is used. |
|
path to SSL client cert file (.pem). |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Choices:
|
|
path to SSL client key file. |
|
The ontap api version to use |
|
Password for the specified user. |
|
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 when using basic authentication. |
|
If set to This should only set to Choices:
|
|
The name of the source cluster name in the peer relation to be modified or deleted. Required for deleting peer relation and for modifying source_intercluster_lifs. |
|
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. |
|
Whether the specified cluster peer should exist or not. Choices:
|
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
Notes
Note
Modify remote intercluster addresses operation is supported only with REST.
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
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
- name: Modify cluster peer - destination intercluster addresses
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.8
dest_cluster_name: test-dest-cluster
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
peer_options:
hostname: "{{ dest_netapp_hostname }}"