community.general.ibm_sa_pool module – Handles pools on IBM Spectrum Accelerate Family storage systems

Note

This module is part of the community.general collection (version 11.4.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_pool.

Synopsis

  • This module creates or deletes pools 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

domain

string

Adds the pool to the specified domain.

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.

perf_class

string

Assigns a perf_class to the pool.

pool

string / required

Pool name.

size

string

Pool size in GB.

snapshot_size

string

Pool snapshot size in GB.

state

string

Pool state.

Choices:

  • "present" ← (default)

  • "absent"

username

string / required

Management user on the Spectrum Accelerate storage system.

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

Returns 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 new pool.
  community.general.ibm_sa_pool:
    name: pool_name
    size: 300
    state: present
    username: admin
    password: secret
    endpoints: hostdev-system

- name: Delete pool.
  community.general.ibm_sa_pool:
    name: pool_name
    state: absent
    username: admin
    password: secret
    endpoints: hostdev-system

Authors

  • Tzur Eliyahu (@tzure)