W3cubDocs

/Ansible

community.general.ibm_sa_pool – Handles pools 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_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.

  • python >= 2.7
  • pyxcli

Parameters

Parameter Choices/Defaults 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
    Choices:
  • present ←
  • absent
Pool state.
username
string / required
Management user on the spectrum accelerate storage system.

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)

© 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_pool_module.html