W3cubDocs

/Ansible

community.general.ibm_sa_vol_map module – Handles volume mapping on IBM Spectrum Accelerate Family storage systems

Note

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

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

  • pyxcli

Parameters

Parameter

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

When the state is present the volume is mapped. When the state is absent, the volume is meant to be unmapped.

Choices:

  • "present" ← (default)
  • "absent"

username

string / required

Management user on the Spectrum Accelerate storage system.

vol

string / required

Volume name.

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: 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ibm_sa_vol_map_module.html