inspur.sm.del_user – Delete user.
Note
This plugin is part of the inspur.sm collection (version 1.3.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 inspur.sm
.
To use it in a playbook, specify: inspur.sm.del_user
.
New in version 0.1.0: of inspur.sm
DEPRECATED
- Removed in
version 3.0.0
- Why
Merge functions into the inspur.sm.user module.
- Alternative
Use inspur.sm.user instead.
Parameters
Parameter |
Comments |
---|---|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
A dict object containing connection details. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
User name. |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
Examples
- name: Delete user test
hosts: ism
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Delete user"
inspur.sm.del_user:
uname: "wbs"
provider: "{{ ism }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.
Authors
WangBaoshan (@ISIB-group)