ibm.spectrum_virtualize.ibm_svc_manage_user module – This module manages user on IBM Spectrum Virtualize family storage systems
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_manage_user
.
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.7.0
Synopsis
Ansible interface to manage ‘mkuser’, ‘rmuser’, and ‘chuser’ commands.
Parameters
Parameter |
Comments |
---|---|
Specifies whether the user authenticates to the system using a remote authentication service or system authentication methods. Only supported value is ‘usergrp’. Required when state=present, to create a user. Choices:
|
|
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. |
|
Specifies that the password is to be changed on next login. Applies when state=present, to modify a user. Choices:
|
|
Specifies the name of the file containing the Secure Shell (SSH) public key. Applies when state=present. |
|
Specifies to lock the account indefinitely. The user cannot log in unless unlocked again with the parameter unlock. Applies when state=present, to modify a user. Parameters lock and unlock are mutually exclusive. Choices:
|
|
Path of debug log file. |
|
Specifies the unique username. |
|
Specifies that the user’s SSH key is to be deleted. Applies when state=present, to modify a user. Choices:
|
|
Specifies that the user’s password is to be deleted. Applies when state=present, to modify a user. Choices:
|
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Creates or updates ( Choices:
|
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm_svc_auth module. |
|
Specifies to unlock the account so it can be logged in to again. Applies when state=present, to modify a user. Parameters lock and unlock are mutually exclusive. Choices:
|
|
Specifies the password associated with the user. Applies when state=present. |
|
Specifies the name of the user group with which the local user is to be associated. Applies when state=present and auth_type=usergrp. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Create a user
ibm.spectrum_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
- name: Remove a user
ibm.spectrum_virtualize.ibm_svc_manage_user:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
state: absent
name: user-name