community.general.ibm_sa_vol module – Handle volumes on IBM Spectrum Accelerate Family storage systems
Note
This module is part of the community.general collection (version 9.5.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 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
.
Synopsis
This module creates or deletes volumes to be used on IBM Spectrum Accelerate Family storage systems.
Requirements
The below requirements are needed on the host that executes this module.
pyxcli
Parameters
Parameter |
Comments |
---|---|
The hostname or management IP of Spectrum Accelerate storage system. |
|
Password for username on the spectrum accelerate storage system. |
|
Volume pool. |
|
Volume size. |
|
Volume state. 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: Create a new volume.
community.general.ibm_sa_vol:
vol: volume_name
pool: pool_name
size: 17
state: present
username: admin
password: secret
endpoints: hostdev-system
- name: Delete an existing volume.
community.general.ibm_sa_vol:
vol: volume_name
state: absent
username: admin
password: secret
endpoints: hostdev-system