community.general.ibm_sa_vol_map module – Handles volume mapping on IBM Spectrum Accelerate Family storage systems
Note
This module is part of the community.general collection (version 8.6.4).
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 community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.ibm_sa_vol_map
.
Synopsis
This module maps volumes to or unmaps them from the hosts on IBM Spectrum Accelerate Family storage systems.
Aliases: storage.ibm.ibm_sa_vol_map
Requirements
The below requirements are needed on the host that executes this module.
pyxcli
Parameters
Parameter |
Comments |
---|---|
Maps the volume to a cluster. |
|
The hostname or management IP of Spectrum Accelerate storage system. |
|
Maps the volume to a host. |
|
The LUN identifier. |
|
Overrides the existing volume mapping. |
|
Password for username on the spectrum accelerate storage system. |
|
When the state is present the volume is mapped. When the state is absent, the volume is meant to be unmapped. Choices:
|
|
Management user on the spectrum accelerate storage system. |
|
Volume name. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
This module requires pyxcli python library. Use
pip install pyxcli
in order to get pyxcli.
Examples
- name: Map volume to host.
community.general.ibm_sa_vol_map:
vol: volume_name
lun: 1
host: host_name
username: admin
password: secret
endpoints: hostdev-system
state: present
- name: Map volume to cluster.
community.general.ibm_sa_vol_map:
vol: volume_name
lun: 1
cluster: cluster_name
username: admin
password: secret
endpoints: hostdev-system
state: present
- name: Unmap volume.
community.general.ibm_sa_vol_map:
host: host_name
username: admin
password: secret
endpoints: hostdev-system
state: absent