netapp.elementsw.na_elementsw_node – NetApp Element Software Node Operation

From Get docs
Ansible/docs/2.11/collections/netapp/elementsw/na elementsw node module


netapp.elementsw.na_elementsw_node – NetApp Element Software Node Operation

Note

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

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

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


New in version 2.7.0: of netapp.elementsw


Synopsis

  • Add, remove cluster node on Element Software Cluster.
  • Set cluster name on node.
  • When using the preset_only option, hostname/username/password are required but not used.

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

cluster_name

string

added in 20.9.0 of netapp.elementsw

If set, the current node configuration is updated with this name before adding the node to the cluster.

This requires the node_ids to be specified as MIPs (Management IP Adresses)

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.

node_ids

list / elements=string / required

List of IDs or Names or IP Addresses of nodes to add or remove.

If cluster_name is set, node MIPs are required.


aliases: node_id

password

string / required

Password for the specified user.


aliases: pass

preset_only

boolean

added in 20.9.0 of netapp.elementsw

  • no

  • yes

If true and state is 'present', set the cluster name for each node in node_ids, but do not add the nodes.

They can be added using na_elementsw_cluster for initial cluster creation.

If false, proceed with addition/removal.

state

string

  • present

  • absent

Element Software Storage Node operation state.

present - To add pending node to participate in cluster data storage.

absent - To remove node from active cluster. A node cannot be removed if active drives are present.

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: Add node from pending to active cluster
  tags:
  - elementsw_add_node
  na_elementsw_node:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    node_id: sf4805-meg-03

- name: Remove active node from cluster
  tags:
  - elementsw_remove_node
  na_elementsw_node:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    node_id: 13

- name: Add node from pending to active cluster using node IP
  tags:
  - elementsw_add_node_ip
  na_elementsw_node:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    node_id: 10.109.48.65
    cluster_name: sfcluster01

- name: Only set cluster name
  tags:
  - elementsw_add_node_ip
  na_elementsw_node:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    node_ids: 10.109.48.65,10.109.48.66
    cluster_name: sfcluster01
    preset_only: true

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/2.11/collections/netapp/elementsw/na_elementsw_node_module.html