community.general.ibm_sa_host_ports module – Add host ports on IBM Spectrum Accelerate Family storage systems

Note

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

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

Synopsis

  • This module adds ports to or removes them from the hosts on IBM Spectrum Accelerate Family storage systems.

Requirements

The below requirements are needed on the host that executes this module.

  • pyxcli

Parameters

Parameter

Comments

endpoints

string / required

The hostname or management IP of Spectrum Accelerate storage system.

fcaddress

string

Fiber channel address.

host

string / required

Host name.

iscsi_name

string

iSCSI initiator name.

num_of_visible_targets

string

Number of visible targets.

password

string / required

Password for username on the spectrum accelerate storage system.

state

string

Host ports 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: Add ports for host.
  community.general.ibm_sa_host_ports:
    host: test_host
    iscsi_name: iqn.1994-05.com***
    username: admin
    password: secret
    endpoints: hostdev-system
    state: present

- name: Remove ports for host.
  community.general.ibm_sa_host_ports:
    host: test_host
    iscsi_name: iqn.1994-05.com***
    username: admin
    password: secret
    endpoints: hostdev-system
    state: absent

Authors

  • Tzur Eliyahu (@tzure)