ibm.storage_virtualize.ibm_svc_vol_map (2.3.1) — module

This module manages volume mapping on IBM Storage Virtualize family systems

| "added in version" 1.0.0 of ibm.storage_virtualize"

Authors: Peng Wang(@wangpww)

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1


Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage volume mapping commands 'mkvdiskhostmap', 'rmvdiskhostmap', 'mkvolumehostclustermap', and 'rmvolumehostclustermap'.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Map a volume to a host
  ibm.storage_virtualize.ibm_svc_vol_map:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    volname: volume0
    host: host4test
    scsi: 1
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Unmap a volume from a host
  ibm.storage_virtualize.ibm_svc_vol_map:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    volname: volume0
    host: host4test
    state: absent

Inputs

    
host:
    description:
    - Specifies the host name for host mapping.
    - This parameter is required to create or delete a volume-to-host mapping.
    type: str

scsi:
    description:
    - Specifies the SCSI logical unit number (LUN) ID to assign to a volume on the specified
      host or host cluster.
    - Applies when I(state=present).
    type: int

state:
    choices:
    - absent
    - present
    description:
    - Creates (C(present)) or removes (C(absent)) a volume mapping.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the ibm_svc_auth module.
    type: str
    version_added: 1.5.0
    version_added_collection: ibm.storage_virtualize

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

volname:
    description:
    - Specifies the volume name for host or hostcluster mapping.
    required: true
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

hostcluster:
    description:
    - Specifies the name of the host cluster for host mapping.
    - This parameter is required to create or delete a volume-to-hostcluster mapping.
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool