netapp.elementsw.na_elementsw_initiators – Manage Element SW initiators

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

New in version 2.8.0: of netapp.elementsw

Synopsis

  • Manage Element Software initiators that allow external clients access to volumes.

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
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.
initiators
list / elements=dictionary
A list of objects containing characteristics of each initiator.
alias
string
The friendly name assigned to this initiator.
attributes
dictionary
A set of JSON attributes to assign to this initiator.
initiator_id
integer
The numeric ID of the initiator.
name
string / required
The name of the initiator.
volume_access_group_id
integer
volumeAccessGroupID to which this initiator belongs.
password
string / required
Password for the specified user.

aliases: pass
state
string
    Choices:
  • present ←
  • absent
Whether the specified initiator should exist or not.
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: Manage initiators
  tags:
  - na_elementsw_initiators
  na_elementsw_initiators:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    initiators:
    - name: a
      alias: a1
      initiator_id: 1
      volume_access_group_id: 1
      attributes: {"key": "value"}
    - name: b
      alias: b2
      initiator_id: 2
      volume_access_group_id: 2
  state: present

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