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 6.6.2).

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.

  • python >= 2.7

  • pyxcli

Parameters

Parameter

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.

Choices:

  • "present" ← (default)

  • "absent"

username

string / required

Management user on the spectrum accelerate storage system.

vol

string / required

Volume name.

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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)