ibm.storage_virtualize.ibm_svc_manage_usergroup (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 'mkusergrp', 'rmusergrp', and 'chusergrp' commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a user group
  ibm.storage_virtualize.ibm_svc_manage_usergroup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    name: user-group-name
    role: Monitor
    ownershipgroup: ownershipgroup-name

Scanned by Steampunk Spotter

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

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

Inputs

    
name:
    description:
    - Specifies the name of the user group.
    required: true
    type: str

role:
    choices:
    - Monitor
    - CopyOperator
    - Service
    - FlashCopyAdmin
    - Administrator
    - SecurityAdmin
    - VasaProvider
    - RestrictedAdmin
    - 3SiteAdmin
    description:
    - Specifies the role associated with all users that belong to this user group.
    - Required when I(state=present).
    type: str

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

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

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

ownershipgroup:
    description:
    - Specifies the name of the ownership group.
    - Applies when I(state=present).
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    type: str

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

noownershipgroup:
    description:
    - Specifies that the usergroup is removed from the ownership group it belonged to.
    - Applies when I(state=present), to modify a user group.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    type: bool