community.general.ibm_sa_host module – Adds hosts to or removes them from IBM Spectrum Accelerate Family storage systems

Note

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

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

Synopsis

  • This module adds hosts 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

cluster

string

The name of the cluster to include the host.

domain

string

The domains the cluster will be attached to. To include more than one domain, separate domain names with commas. To include all existing domains, use an asterisk (”*”).

endpoints

string / required

The hostname or management IP of Spectrum Accelerate storage system.

host

string / required

Host name.

iscsi_chap_name

string

The host’s CHAP name identifier

iscsi_chap_secret

string

The password of the initiator used to authenticate to the system when CHAP is enable

password

string / required

Password for username on the spectrum accelerate storage system.

state

string

Host state.

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 host.
  community.general.ibm_sa_host:
    host: host_name
    state: present
    username: admin
    password: secret
    endpoints: hostdev-system

- name: Delete host.
  community.general.ibm_sa_host:
    host: host_name
    state: absent
    username: admin
    password: secret
    endpoints: hostdev-system

Authors

  • Tzur Eliyahu (@tzure)