inspur.sm.add_user – Create 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.add_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.

Synopsis

Create user on Inspur server.

Parameters

Parameter		Choices/Defaults	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		Choices: kvm vmm sol none	User access, select one or more from None/KVM/VMM/SOL.
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	Returned	Description
changed boolean	always	Check to see if a change was made on the device.
message string	always	Messages returned after module execution.
state string	always	Status after module execution.

Status

This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.

Authors

WangBaoshan (@ISIB-group)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/inspur/sm/add_user_module.html

Docs

Docs4dev

Title here