netapp.ontap.na_ontap_vserver_peer module – NetApp ONTAP Vserver peering
Note
This module is part of the netapp.ontap collection (version 21.20.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_vserver_peer.
New in version 2.7.0: of netapp.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 |
Comments |
|---|---|
List of applications which can make use of the peering relationship. FlexCache supported from ONTAP 9.5 onwards. |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
DEPRECATED - please use Destination hostname or IP address. Required for creating the vserver peer relationship with a remote cluster. |
|
DEPRECATED - please use Destination password. Optional if this is same as source password. |
|
DEPRECATED - please use Destination username. Optional if this is same as source username. |
|
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. |
|
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:
|
|
path to SSL client key file. |
|
Specifies local name of the peer Vserver in the relationship. Use this if you see “Error creating vserver peer … Vserver name conflicts with one of the following”. |
|
Specifies local name of the source Vserver in the relationship. Use this if you see “Error accepting vserver peer … System generated a name for the peer Vserver because of a naming conflict”. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Specifies name of the peer Cluster. Required for creating the vserver peer relationship with a remote cluster |
|
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). |
|
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:
|
|
Specifies name of the peer Vserver in the relationship. |
|
Whether the specified vserver 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: “auto” |
|
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:
|
|
Specifies name of the source Vserver in the relationship. |
Examples
- name: Source vserver peer create
netapp.ontap.na_ontap_vserver_peer:
state: present
peer_vserver: ansible2
peer_cluster: ansibleCluster
local_name_for_peer: peername
local_name_for_source: sourcename
vserver: ansible
applications: ['snapmirror']
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
peer_options:
hostname: "{{ netapp_dest_hostname }}"
- name: vserver peer delete
netapp.ontap.na_ontap_vserver_peer:
state: absent
peer_vserver: ansible2
vserver: ansible
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Source vserver peer create - different credentials
netapp.ontap.na_ontap_vserver_peer:
state: present
peer_vserver: ansible2
peer_cluster: ansibleCluster
local_name_for_peer: peername
local_name_for_source: sourcename
vserver: ansible
applications: ['snapmirror']
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
peer_options:
hostname: "{{ netapp_dest_hostname }}"
cert_filepath: "{{ cert_filepath }}"
key_filepath: "{{ key_filepath }}"
Authors
NetApp Ansible Team (@carchi8py)