ibm.storage_virtualize.ibm_svc_auth (2.3.1) — module

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 generate the authentication token. The token is used to make REST API calls to the storage system.

Usage examples

Scanned by Steampunk Spotter

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

- name: Obtain an authentication token
  register: result
  ibm.storage_virtualize.ibm_svc_auth:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"

Scanned by Steampunk Spotter

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

- 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

Inputs

    
token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - This field is not required for ibm_svc_auth module.
    type: str

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

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

password:
    description:
    - REST API password for the Storage Virtualize system.
    - This parameter is required in this module to generate the token.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - This parameter is required in this module to generate the token.
    type: str

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

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

Outputs

token:
  description: Authentication token for a user.
  returned: success
  type: str
  version_added: 1.5.0
  version_added_collection: ibm.storage_virtualize