community.general.ibm_sa_domain module – Manages domains on IBM Spectrum Accelerate Family storage systems

Note

This module is part of the community.general collection (version 10.7.5).

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_domain.

Synopsis

  • This module can be used to add domains to or removes them from 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 / required

Name of the domain to be managed.

endpoints

string / required

The hostname or management IP of Spectrum Accelerate storage system.

hard_capacity

string

Hard capacity of the domain.

ldap_id

string

LDAP ID to add to the domain.

max_cgs

string

Number of max cgs.

max_dms

string

Number of max dms.

max_mirrors

string

Number of max_mirrors.

max_pools

string

Number of max_pools.

max_volumes

string

Number of max_volumes.

password

string / required

Password for username on the Spectrum Accelerate storage system.

perf_class

string

Add the domain to a performance class.

size

string

Size of the domain.

soft_capacity

string

Soft capacity of the domain.

state

string

The desired state of the domain.

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

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: Define new domain.
  community.general.ibm_sa_domain:
    domain: domain_name
    size: domain_size
    state: present
    username: admin
    password: secret
    endpoints: hostdev-system

- name: Delete domain.
  community.general.ibm_sa_domain:
    domain: domain_name
    state: absent
    username: admin
    password: secret
    endpoints: hostdev-system

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Module return status.

Returned: as needed

Sample: "domain 'domain_name' created successfully."

Authors

  • Tzur Eliyahu (@tzure)