ibm.storage_virtualize.ibm_svc_auth module – This module generates an authentication token for a user on IBM Storage Virtualize family system

Note

This module is part of the ibm.storage_virtualize collection (version 2.2.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.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_svc_auth.

New in ibm.storage_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

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

log_path

string

Path of debug log file.

password

string

REST API password for the Storage Virtualize system.

This parameter is required in this module to generate the token.

token

string

The authentication token to verify a user on the Storage Virtualize system.

This field is not required for ibm_svc_auth module.

username

string

REST API username for the Storage Virtualize system.

This parameter is required in this module to generate the token.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

Notes

Note

  • This module supports check_mode.

Examples

- name: Obtain an authentication token
  register: result
  ibm.storage_virtualize.ibm_svc_auth:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
- name: Create a volume
  ibm.storage_virtualize.ibm_svc_manage_volume:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    token: "{{result.token}}"
    name: volume0
    state: present
    pool: Pool0
    size: "4294967296"
    unit: b

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

token

string

added in ibm.storage_virtualize 1.5.0

Authentication token for a user.

Returned: success

Authors

  • Shilpi Jain(@Shilpi-J)