netapp.elementsw.na_elementsw_cluster – NetApp Element Software Create Cluster

Note

This plugin is part of the netapp.elementsw collection (version 21.6.1).

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.elementsw.

To use it in a playbook, specify: netapp.elementsw.na_elementsw_cluster.

New in version 2.7.0: of netapp.elementsw

Synopsis

  • Initialize Element Software node ownership to form a cluster.
  • If the cluster does not exist, username/password are still required but ignored for initial creation.
  • username/password are used as the node credentials to see if the cluster already exists.
  • username/password can also be used to set the cluster credentials.
  • If the cluster already exists, no error is returned, but changed is set to false.
  • Cluster modifications are not supported and are ignored.

Requirements

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

  • The modules were developed with SolidFire 10.1
  • solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’

Parameters

Parameter Choices/Defaults Comments
accept_eula
boolean
    Choices:
  • no
  • yes
Required to indicate your acceptance of the End User License Agreement when creating this cluster.
To accept the EULA, set this parameter to true.
attributes
dictionary
List of name-value pairs in JSON object format.
cluster_admin_password
string
Initial password for the cluster admin account.
If not provided, default to password.
cluster_admin_username
string
Username for the cluster admin.
If not provided, default to username.
encryption
boolean
added in 20.10.0 of netapp.elementsw
    Choices:
  • no
  • yes
to enable or disable encryption at rest
fail_if_cluster_already_exists_with_larger_ensemble
boolean
added in 20.8.0 of netapp.elementsw
    Choices:
  • no
  • yes ←
If the cluster exists, the default is to verify that nodes is a superset of the existing ensemble.
A superset is accepted because some nodes may have a different role.
But the module reports an error if the existing ensemble contains a node not listed in nodes.
This checker is disabled when this option is set to false.
hostname
string / required
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
management_virtual_ip
string / required
Floating (virtual) IP address for the cluster on the management network.
nodes
list / elements=string / required
Storage IP (SIP) addresses of the initial set of nodes making up the cluster.
nodes IP must be in the list.
order_number
string
added in 20.10.0 of netapp.elementsw
(experimental) order number as provided by NetApp
password
string / required
Password for the specified user.

aliases: pass
replica_count
integer
Default:
2
Number of replicas of each piece of data to store in the cluster.
serial_number
string
added in 20.10.0 of netapp.elementsw
(experimental) serial number as provided by NetApp
storage_virtual_ip
string / required
Floating (virtual) IP address for the cluster on the storage (iSCSI) network.
timeout
integer
added in 20.8.0 of netapp.elementsw
Default:
100
Time to wait for cluster creation to complete.
username
string / required
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.

aliases: user

Notes

Note

  • The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.

Examples

- name: Initialize new cluster
  tags:
  - elementsw_cluster
  na_elementsw_cluster:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    management_virtual_ip: 10.226.108.32
    storage_virtual_ip: 10.226.109.68
    replica_count: 2
    accept_eula: true
    nodes:
    - 10.226.109.72
    - 10.226.109.74

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
success
Success message


Authors

© 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/elementsw/na_elementsw_cluster_module.html