You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

inspur.sm.add_user module – Create user.

Note

This module is part of the inspur.sm collection (version 2.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.add_user.

New in inspur.sm 0.1.0

DEPRECATED

Removed in:

version 3.0.0

Why:

Merge functions into the inspur.sm.user module.

Alternative:

Use inspur.sm.user instead.

Synopsis

• Create user on Inspur server.

Parameters

Parameter	Comments
host string	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.
password string	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 ANSIBLE_NET_PASSWORD will be used instead.
priv list / elements=string / required	User access, select one or more from None/KVM/VMM/SOL. Choices: "kvm" "vmm" "sol" "none"
provider dictionary	A dict object containing connection details.
host string	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.
password string	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 ANSIBLE_NET_PASSWORD will be used instead.
username string	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 ANSIBLE_NET_USERNAME will be used instead.
role_id string / required	user group, default user group,’Administrator’, ‘Operator’, ‘Commonuser’,’OEM’,’NoAccess’, use command user_group_info can get all group information.
uname string / required	User name of new user.
upass string / required	User password of new user.
username string	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 ANSIBLE_NET_USERNAME will be used instead.

Examples

- name: Add user test
  hosts: ism
  no_log: true
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Add user"
    inspur.sm.add_user:
      uname: "wbs"
      upass: my_password
      role_id: "Administrator"
      priv: "kvm,sol"
      provider: "{{ ism }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Check to see if a change was made on the device. Returned: always
message string	Messages returned after module execution. Returned: always
state string	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)

Collection links

• Issue Tracker
• Repository (Sources)