na_ontap_vserver_peer - NetApp ONTAP Vserver peering¶

New in version 2.7.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

Create/Delete vserver peer

Requirements ¶

The below requirements are needed on the host that executes this module.

A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
Ansible 2.6
netapp-lib (2017.10.30). 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
applications	Choices: snapmirror file_copy lun_copy	List of applications which can make use of the peering relationship.
dest_hostname		Destination hostname or IP address. Required for creating the vserver peer relationship
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 required		The hostname or IP address of the ONTAP instance.
http_port int		Override the default port (80 or 443) with this port
https bool	Choices: no ← yes	Enable and disable https
password required		Password for the specified user. aliases: pass
peer_cluster		Specifies name of the peer Cluster. If peer Cluster is not given, it considers local Cluster.
peer_vserver		Specifies name of the peer Vserver in the relationship.
state	Choices: present ← absent	Whether the specified vserver peer should exist or not.
username 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 bool	Choices: no yes ←	If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.
vserver		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
  na_ontap_vserver_peer:
    state: present
    peer_vserver: ansible2
    peer_cluster: ansibleCluster
    vserver: ansible
    applications: snapmirror
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    dest_hostname: "{{ netapp_dest_hostname }}"
- name: vserver peer delete
  na_ontap_vserver_peer:
    state: absent
    peer_vserver: ansible2
    vserver: ansible
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author ¶

NetApp Ansible Team (ng-ansibleteam@netapp.com)

Hint

If you notice any issues in this documentation you can edit this document to improve it.