ibm.spectrum_virtualize.ibm_svc_vol_map module – This module manages volume mapping on IBM Spectrum Virtualize family storage systems
Note
This module is part of the ibm.spectrum_virtualize collection (version 2.0.0).
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 ibm.spectrum_virtualize
.
To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_vol_map
.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will eventually be removed from Ansible. If you use content from ibm.spectrum_virtualize, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from ibm.storage_virtualize instead.
New in ibm.spectrum_virtualize 1.0.0
Synopsis
Ansible interface to manage volume mapping commands ‘mkvdiskhostmap’, ‘rmvdiskhostmap’, ‘mkvolumehostclustermap’, and ‘rmvolumehostclustermap’.
Parameters
Parameter |
Comments |
---|---|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Specifies the host name for host mapping. This parameter is required to create or delete a volume-to-host mapping. |
|
Specifies the name of the host cluster for host mapping. This parameter is required to create or delete a volume-to-hostcluster mapping. |
|
Path of debug log file. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specifies the SCSI logical unit number (LUN) ID to assign to a volume on the specified host or host cluster. Applies when state=present. |
|
Creates ( Choices:
|
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm_svc_auth module. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
|
Specifies the volume name for host or hostcluster mapping. |
Notes
Note
This module supports
check_mode
.
Examples
- name: Map a volume to a host
ibm.spectrum_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
- name: Unmap a volume from a host
ibm.spectrum_virtualize.ibm_svc_vol_map:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
volname: volume0
host: host4test
state: absent