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 2.5.1).
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¶
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 | Returned | Description |
---|---|---|
msg
string
|
as needed |
module return status.
Sample:
domain 'domain_name' created successfully.
|
Authors¶
Tzur Eliyahu (@tzure)