ieisystem.inmanage.user (1.1.1) — module

Install collection

Install with ansible-galaxy collection install ieisystem.inmanage:==1.1.1

Add to requirements.yml

  collections:
    - name: ieisystem.inmanage
      version: 1.1.1

Description

Manage user on ieisystem Server.

Requirements

• Python 3.7+
• inManage

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

  tasks:

  - name: "Add user"
    ieisystem.inmanage.user:
      state: "present"
      uname: "wbs"
      upass: "admin"
      role_id: "Administrator"
      priv: "kvm,sol"
      email: "wbs@ieisystem.com"
      provider: "{{ inmanage }}"

  - name: "Set user"
    ieisystem.inmanage.user:
      state: "present"
      uname: "wbs"
      upass: "12345678"
      role_id: "user"
      priv: "kvm,sol"
      provider: "{{ inmanage }}"

Inputs

    
uid:
    description:
    - User id, The range is 1 to 16.
    type: int

host:
    description:
    - 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.
    type: str

priv:
    choices:
    - kvm
    - vmm
    - sol
    - none
    description:
    - Other user permissions, select one or more from None/KVM/VMM/SOL.
    elements: str
    type: list

email:
    description:
    - User email.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the user should exist or not, taking action if the state is different from
      what is stated.
    type: str

uname:
    description:
    - User name, Required when uid is None.
    type: str

upass:
    description:
    - User password.
    type: str

access:
    choices:
    - enable
    - disable
    description:
    - User access.
    type: str

role_id:
    description:
    - User group.
    - Default user group 'Administrator', 'Operator', 'User'.
    - Use command C(user_group_info) can get all group information.
    type: str

password:
    description:
    - 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 C(ANSIBLE_NET_PASSWORD)
      will be used instead.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - 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.
        type: str
      password:
        description:
        - 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
          C(ANSIBLE_NET_PASSWORD) will be used instead.
        type: str
      username:
        description:
        - 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 C(ANSIBLE_NET_USERNAME) will be used instead.
        type: str
    type: dict

username:
    description:
    - 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 C(ANSIBLE_NET_USERNAME)
      will be used instead.
    type: str

Outputs

changed:
  description: Check to see if a change was made on the device.
  returned: always
  type: bool
message:
  description: Messages returned after module execution.
  returned: always
  type: str
state:
  description: Status after module execution.
  returned: always
  type: str