W3cubDocs

/Ansible 2.9

ibm_sa_vol – Handle volumes on IBM Spectrum Accelerate Family storage systems

New in version 2.7.

Synopsis
Requirements
Parameters
Notes
Examples
Status

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 -		Volume pool.
size -		Volume size.
state - / required	Choices: present ← absent	Volume state.
username string / required		Management user on the spectrum accelerate storage system.
vol - / 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.
  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.
  ibm_sa_vol:
    vol: volume_name
    state: absent
    username: admin
    password: secret
    endpoints: hostdev-system

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Tzur Eliyahu (@tzure)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ibm_sa_vol_module.html