community.general.ibm_sa_domain (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module can be used to add domains to or removes them from IBM Spectrum Accelerate Family storage systems.

Requirements

• pyxcli

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Define new domain.
  community.general.ibm_sa_domain:
    domain: domain_name
    size: domain_size
    state: present
    username: admin
    password: secret
    endpoints: hostdev-system

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
size:
    description:
    - Size of the domain.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The desired state of the domain.
    type: str

domain:
    description:
    - Name of the domain to be managed.
    required: true
    type: str

ldap_id:
    description:
    - ldap id to add to the domain.
    required: false
    type: str

max_cgs:
    description:
    - Number of max cgs.
    required: false
    type: str

max_dms:
    description:
    - Number of max dms.
    required: false
    type: str

password:
    description:
    - Password for username on the spectrum accelerate storage system.
    required: true
    type: str

username:
    description:
    - Management user on the spectrum accelerate storage system.
    required: true
    type: str

endpoints:
    description:
    - The hostname or management IP of Spectrum Accelerate storage system.
    required: true
    type: str

max_pools:
    description:
    - Number of max_pools.
    required: false
    type: str

perf_class:
    description:
    - Add the domain to a performance class.
    required: false
    type: str

max_mirrors:
    description:
    - Number of max_mirrors.
    required: false
    type: str

max_volumes:
    description:
    - Number of max_volumes.
    required: false
    type: str

hard_capacity:
    description:
    - Hard capacity of the domain.
    required: false
    type: str

soft_capacity:
    description:
    - Soft capacity of the domain.
    required: false
    type: str

Outputs

msg:
  description: module return status.
  returned: as needed
  sample: domain 'domain_name' created successfully.
  type: str