community.general.ibm_sa_vol_map (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module maps volumes to or unmaps them from the hosts on IBM Spectrum Accelerate Family storage systems.

Requirements

• pyxcli

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Unmap volume.
  community.general.ibm_sa_vol_map:
    host: host_name
    username: admin
    password: secret
    endpoints: hostdev-system
    state: absent

Inputs

    
lun:
    description:
    - The LUN identifier.
    required: false
    type: str

vol:
    description:
    - Volume name.
    required: true
    type: str

host:
    description:
    - Maps the volume to a host.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When the state is present the volume is mapped. When the state is absent, the volume
      is meant to be unmapped.
    type: str

cluster:
    description:
    - Maps the volume to a cluster.
    required: false
    type: str

override:
    description:
    - Overrides the existing volume mapping.
    required: false
    type: str

password:
    description:
    - Password for username on the spectrum accelerate storage system.
    required: true
    type: str

username:
    description:
    - Management user on the spectrum accelerate storage system.
    required: true
    type: str

endpoints:
    description:
    - The hostname or management IP of Spectrum Accelerate storage system.
    required: true
    type: str