Docs4dev
Docs
ansible / 2.6 / modules / na_ontap_cluster_module.html

na_ontap_cluster - Create/Join ONTAP cluster. Apply license to cluster

New in version 2.6.

Synopsis

  • Create or join or apply licenses to ONTAP clusters

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
cluster_ip_address
IP address of cluster to be joined
cluster_name
The name of the cluster to manage.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled 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
password
required
Password for the specified user.

aliases: pass
state
    Choices:
  • present ←
Whether the specified cluster 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://goo.gl/BRu78Z.

aliases: user

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

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_name: FPaaS-A300
    cluster_ip_address: 10.61.184.181
    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 community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

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

Author

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/na_ontap_cluster_module.html