W3cubDocs

/Ansible 2.10

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

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

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.

  • python >= 2.7
  • pyxcli

Parameters

Parameter Choices/Defaults 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 / required
    Choices:
  • present ←
  • absent
Host ports state.
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: 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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ibm_sa_host_ports_module.html