netapp.ontap.na_ontap_vserver_peer – NetApp ONTAP Vserver 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_vserver_peer
.
New in version 2.7.0: of netapp.ontap
Synopsis
- Create/Delete vserver peer
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 | |
---|---|---|---|
applications list / elements=string | List of applications which can make use of the peering relationship. FlexCache supported from ONTAP 9.5 onwards. | ||
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_hostname string | DEPRECATED - please use peer_options .Destination hostname or IP address. Required for creating the vserver peer relationship with a remote cluster. | ||
dest_password string | DEPRECATED - please use peer_options .Destination password. Optional if this is same as source password. | ||
dest_username string | DEPRECATED - please use peer_options .Destination username. Optional if this is same as source username. | ||
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 |
| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. | |
key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | ||
local_name_for_peer string | 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". | ||
local_name_for_source string | 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". | ||
ontapi integer | The ontap api version to use | ||
password string | Password for the specified user. aliases: pass | ||
peer_cluster string | Specifies name of the peer Cluster. Required for creating the vserver peer relationship with a remote cluster | ||
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 |
| 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 |
| 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. | |
peer_vserver string / required | Specifies name of the peer Vserver in the relationship. | ||
state string |
| Whether the specified vserver 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 |
| 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. | |
vserver string / required | Specifies name of the source Vserver in the relationship. |
Notes
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
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) <ng-ansibleteam@netapp.com>
© 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_vserver_peer_module.html