kaytus.ksmanage.user module – Manage user

Note

This module is part of the kaytus.ksmanage collection (version 2.0.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 kaytus.ksmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kaytus.ksmanage.user.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Manage user on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

access

string

User access.

Choices:

  • "enable"

  • "disable"

email

string

User email.

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

Other user permissions, 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

User group.

Default user group ‘Administrator’, ‘Operator’, ‘User’.

Use command user_group_info can get all group information.

state

string

Whether the user should exist or not, taking action if the state is different from what is stated.

Choices:

  • "present" ← (default)

  • "absent"

uid

integer

User id, The range is 1 to 16.

uname

string

User name, Required when uid is None.

upass

string

User password.

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 test
  hosts: ksmanage
  no_log: true
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Add user"
    kaytus.ksmanage.user:
      state: "present"
      uname: "wbs"
      upass: "admin"
      role_id: "Administrator"
      priv: "kvm, sol"
      email: "[email protected]"
      provider: "{{ ksmanage }}"

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

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

Authors

  • WangBaoshan (@ieisystem)