netapp.elementsw.na_elementsw_initiators module – Manage Element SW initiators
Note
This module is part of the netapp.elementsw collection (version 21.7.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.elementsw.na_elementsw_initiators
.
Note
The netapp.elementsw collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.
New in netapp.elementsw 2.8.0
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 |
Comments |
---|---|
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. |
|
A list of objects containing characteristics of each initiator. |
|
The friendly name assigned to this initiator. |
|
A set of JSON attributes to assign to this initiator. |
|
The numeric ID of the initiator. |
|
The name of the initiator. |
|
volumeAccessGroupID to which this initiator belongs. |
|
Password for the specified user. |
|
Whether the specified initiator should exist or not. Choices:
|
|
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. |
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 |
Description |
---|---|
Success message Returned: success |