W3cubDocs

/Ansible 2.11

inspur.sm.user_group – Manage user group.

Note

This plugin is part of the inspur.sm collection (version 1.1.2).

To install it use: ansible-galaxy collection install inspur.sm.

To use it in a playbook, specify: inspur.sm.user_group.

New in version 1.1.0: of inspur.sm

Synopsis

  • Manage user group 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.
name
string / required
Group name.
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.
pri
string
    Choices:
  • administrator
  • operator
  • user
  • oem
  • none
Group privilege.
Required when state=present.
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.
state
string
    Choices:
  • present
  • absent
Whether the user group should exist or not, taking action if the state is different from what is stated.
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: User group test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Add user group"
    inspur.sm.user_group:
      state: "present"
      name: "test"
      pri: "administrator"
      provider: "{{ ism }}"

  - name: "Set user group"
    inspur.sm.user_group:
      state: "present"
      name: "test"
      pri: "user"
      provider: "{{ ism }}"

  - name: "Delete user group"
    inspur.sm.user_group:
      state: "absent"
      name: "test"
      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.



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/2.11/collections/inspur/sm/user_group_module.html