community.general.ibm_sa_domain – Manages domains on IBM Spectrum Accelerate Family storage systems
Note
This plugin is part of the community.general collection (version 3.8.3).
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_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.
python >= 2.7
pyxcli
Parameters
Parameter |
Comments |
---|---|
Name of the domain to be managed. |
|
The hostname or management IP of Spectrum Accelerate storage system. |
|
Hard capacity of the domain. |
|
ldap id to add to the domain. |
|
Number of max cgs. |
|
Number of max dms. |
|
Number of max_mirrors. |
|
Number of max_pools. |
|
Number of max_volumes. |
|
Password for username on the spectrum accelerate storage system. |
|
Add the domain to a performance class. |
|
Size of the domain. |
|
Soft capacity of the domain. |
|
The desired state of the domain. Choices:
|
|
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: 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 |
---|---|
module return status. Returned: as needed Sample: “domain \u0027domain_name\u0027 created successfully.” |
Authors
Tzur Eliyahu (@tzure)