ibm.spectrum_virtualize.ibm_svc_auth module – This module generates an authentication token for a user on IBM Spectrum Virtualize family storage system
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_auth
.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will be removed from Ansible 12. The content of ibm.spectrum_virtualize will be replaced by redirects to ibm.storage_virtualize in Ansible 10. 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.5.0
Synopsis
Ansible interface to generate the authentication token. The token is used to make REST API calls to the storage system.
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. |
|
Path of debug log file. |
|
REST API password for the Spectrum Virtualize storage system. This parameter is required in this module to generate the token. |
|
The authentication token to verify a user on the Spectrum Virtualize storage system. This field is not required for ibm_svc_auth module. |
|
REST API username for the Spectrum Virtualize storage system. This parameter is required in this module to generate the token. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Obtain an authentication token
register: result
ibm.spectrum_virtualize.ibm_svc_auth:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
- name: Create a volume
ibm.spectrum_virtualize.ibm_svc_vdisk:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
token: "{{result.token}}"
name: volume0
state: present
mdiskgrp: Pool0
easytier: 'off'
size: "4294967296"
unit: b
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Authentication token for a user. Returned: success |