W3cubDocs

/Ansible 2.10

community.general.ibm_sa_vol_map – Handles volume mapping 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_vol_map.

Synopsis

  • This module maps volumes to or unmaps 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
cluster
string
Maps the volume to a cluster.
endpoints
string / required
The hostname or management IP of Spectrum Accelerate storage system.
host
string
Maps the volume to a host.
lun
string
The LUN identifier.
override
string
Overrides the existing volume mapping.
password
string / required
Password for username on the spectrum accelerate storage system.
state
string / required
    Choices:
  • present ←
  • absent
When the state is present the volume is mapped. When the state is absent, the volume is meant to be unmapped.
username
string / required
Management user on the spectrum accelerate storage system.
vol
string / required
Volume name.

Notes

Note

  • This module requires pyxcli python library. Use ‘pip install pyxcli’ in order to get pyxcli.

Examples

- name: Map volume to host.
  community.general.ibm_sa_vol_map:
    vol: volume_name
    lun: 1
    host: host_name
    username: admin
    password: secret
    endpoints: hostdev-system
    state: present

- name: Map volume to cluster.
  community.general.ibm_sa_vol_map:
    vol: volume_name
    lun: 1
    cluster: cluster_name
    username: admin
    password: secret
    endpoints: hostdev-system
    state: present

- name: Unmap volume.
  community.general.ibm_sa_vol_map:
    host: host_name
    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_vol_map_module.html