na_ontap_cluster – NetApp ONTAP cluster - create, join, add license¶
New in version 2.6.
Synopsis¶
- Create or join or apply licenses to ONTAP clusters
- Cluster join can be performed using only one of the parameters, either cluster_name or cluster_ip_address
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
- 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’
- 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 | 
|---|---|---|
| cluster_ip_address 
                    -
                                                                 | IP address of cluster to be joined | |
| cluster_name 
                    -
                                                                 | The name of the cluster to manage. | |
| 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 | 
| license_code 
                    -
                                                                 | License code to be applied to the cluster | |
| license_package 
                    -
                                                                 | License package name of the license to be removed | |
| node_serial_number 
                    -
                                                                 | Serial number of the cluster node | |
| ontapi 
                    integer
                                                                 | The ontap api version to use | |
| password 
                    string
                                             / required                     | Password for the specified user. aliases: pass | |
| state 
                    -
                                                                 | 
 | Whether the specified cluster should exist or not. | 
| 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
                                             / 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 
                    boolean
                                                                 | 
 | If set to  no, the SSL certificates will not be validated.This should only set to  Falseused on personally controlled sites using self-signed certificates. | 
Examples¶
- name: Create cluster
  na_ontap_cluster:
    state: present
    cluster_name: new_cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Add license from cluster
  na_ontap_cluster:
    state: present
    cluster_name: FPaaS-A300-01
    license_code: SGHLQDBBVAAAAAAAAAAAAAAAAAAA
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Join cluster
  na_ontap_cluster:
    state: present
    cluster_ip_address: 10.61.184.181
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Join cluster
  na_ontap_cluster:
    state: present
    cluster_name: FPaaS-A300-01
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors¶
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
