netapp.ontap.na_ontap_metrocluster – NetApp ONTAP set up a MetroCluster

Note

This plugin is part of the netapp.ontap collection (version 20.12.0).

To install it use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_metrocluster.

New in version 20.9.0: of netapp.ontap

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Configure MetroCluster.

Requirements

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

A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
Ansible 2.6
Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
ONTAP >= 9.8
Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
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;’
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.

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.
dr_pairs list / elements=dictionary / required			disaster recovery pair
	node_name string / required		the name of the main node
	partner_node_name string / required		the name of the main partner node
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		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.
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
partner_cluster_name string / required			The name of the partner Cluster
password string			Password for the specified user. aliases: pass
state string		present ←	Present to set up a MetroCluster
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		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: Manage MetroCluster
  hosts: localhost
  collections:
    - netapp.ontap
  vars:
    login: &login
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      https: True
      validate_certs: False
  tasks:
    - name: Create MetroCluster
      na_ontap_metrocluster:
        <<: *login
        dr_pairs:
          - partner_node_name: rha17-a2
            node_name: rha17-b2
        partner_cluster_name: rha2-b2b1_siteB

Authors

NetApp Ansible Team (@carchi8py) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_metrocluster_module.html