ieisystem.inmanage.user_group – Manage user group

Note

This plugin is part of the ieisystem.inmanage collection.

To install it use: ansible-galaxy collection install ieisystem.inmanage.

To use it in a playbook, specify: ieisystem.inmanage.user_group.

New in version 1.0.0: of ieisystem.inmanage

Synopsis

  • Manage user group on ieisystem Server.

Requirements

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

Parameters

Parameter Choices/Defaults Comments
debug
string
    Choices:
  • enable
  • disable
Debug diagnose privilege.
Required when state=present.
Only the M6 model supports this parameter.
general
string
    Choices:
  • enable
  • disable
General configuration privilege.
Required when state=present.
Only the M6 model supports this parameter.
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.
kvm
string
    Choices:
  • enable
  • disable
Remote KVM configuration privilege.
Required when state=present.
Only the M6 model supports this parameter.
media
string
    Choices:
  • enable
  • disable
Remote media configuration privilege.
Required when state=present.
Only the M6 model supports this parameter.
name
string / required
Group name.
The range of group name for M6 model is OEM1,OEM2,OEM3,OEM4.
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.
power
string
    Choices:
  • enable
  • disable
Power control privilege.
Required when state=present.
Only the M6 model supports this parameter.
pri
string
    Choices:
  • administrator
  • operator
  • user
  • oem
  • none
Group privilege.
Required when state=present.
Only the M5 model supports this parameter.
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.
security
string
    Choices:
  • enable
  • disable
Security configuration privilege.
Required when state=present.
Only the M6 model supports this parameter.
self
string
    Choices:
  • enable
  • disable
Itself configuration privilege.
Required when state=present.
Only the M6 model supports this parameter.
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.

Notes

Note

  • Does not support check_mode.

Examples

- name: User group test
  hosts: inmanage
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Add user group"
    ieisystem.inmanage.user_group:
      state: "present"
      name: "test"
      pri: "administrator"
      provider: "{{ inmanage }}"

  - name: "Set user group"
    ieisystem.inmanage.user_group:
      state: "present"
      name: "test"
      pri: "user"
      provider: "{{ inmanage }}"

  - name: "Set m6 user group"
    ieisystem.inmanage.user_group:
      state: "present"
      name: "OEM1"
      general: "enable"
      kvm: "enable"
      provider: "{{ inmanage }}"

  - name: "Delete user group"
    ieisystem.inmanage.user_group:
      state: "absent"
      name: "test"
      provider: "{{ inmanage }}"

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 (@ieisystem)