ibm.storage_virtualize.ibm_svc_manage_user (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 manage 'mkuser', 'rmuser', and 'chuser' commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a user
  ibm.storage_virtualize.ibm_svc_manage_user:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    name: user-name
    user_password: user-password
    auth_type: usergrp
    usergroup: usergroup-name

Scanned by Steampunk Spotter

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

- name: Remove a user
  ibm.storage_virtualize.ibm_svc_manage_user:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: absent
    name: user-name

Inputs

    
lock:
    description:
    - Specifies to lock the account indefinitely. The user cannot log in unless unlocked
      again with the parameter I(unlock).
    - Applies when I(state=present), to modify a user.
    - Parameters I(lock) and I(unlock) are mutually exclusive.
    type: bool

name:
    description:
    - Specifies the unique username.
    required: true
    type: str

nokey:
    description:
    - Specifies that the user's SSH key is to be deleted.
    - Applies when I(state=present), to modify a user.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Creates or updates (C(present)) or removes (C(absent)) a user.
    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

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

unlock:
    description:
    - Specifies to unlock the account so it can be logged in to again.
    - Applies when I(state=present), to modify a user.
    - Parameters I(lock) and I(unlock) are mutually exclusive.
    type: bool

keyfile:
    description:
    - Specifies the name of the file containing the Secure Shell (SSH) public key.
    - Applies when I(state=present).
    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

auth_type:
    choices:
    - usergrp
    description:
    - Specifies whether the user authenticates to the system using a remote authentication
      service or system authentication methods.
    - Only supported value is 'usergrp'.
    - Required when I(state=present), to create a user.
    type: str

usergroup:
    description:
    - Specifies the name of the user group with which the local user is to be associated.
    - Applies when I(state=present) and I(auth_type=usergrp).
    type: str

nopassword:
    description:
    - Specifies that the user's password is to be deleted.
    - Applies when I(state=present), to modify a user.
    type: bool

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

user_password:
    description:
    - Specifies the password associated with the user.
    - Applies when I(state=present).
    type: str

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

forcepasswordchange:
    description:
    - Specifies that the password is to be changed on next login.
    - Applies when I(state=present), to modify a user.
    type: bool