community.general.ibm_sa_vol – Handle volumes on IBM Spectrum Accelerate Family storage systems.
Note
This plugin is part of the community.general collection (version 3.8.1).
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.
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.
- python >= 2.7
- pyxcli
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| endpoints
string / required
|
The hostname or management IP of Spectrum Accelerate storage system.
|
|
| password
string / required
|
Password for username on the spectrum accelerate storage system.
|
|
| pool
string
|
Volume pool.
|
|
| size
string
|
Volume size.
|
|
| state
string
|
|
Volume state.
|
| username
string / required
|
Management user on the spectrum accelerate storage system.
|
|
| vol
string / required
|
Volume name.
|
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
Authors
- Tzur Eliyahu (@tzure)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ibm_sa_vol_module.html