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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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	Choices/Defaults	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	Choices: present ← absent	The desired state of the domain.
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: 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)

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