kaytus.ksmanage.user_group module – Manage user group
Note
This module is part of the kaytus.ksmanage collection (version 1.2.2).
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_group
.
New in kaytus.ksmanage 1.0.0
Synopsis
Manage user group on kaytus Server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inManage
Parameters
Parameter |
Comments |
---|---|
Debug diagnose privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
General configuration privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
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. |
|
Remote KVM configuration privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
Remote media configuration privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
Group name. The range of group name for M6 model is OEM1, OEM2, OEM3, OEM4. |
|
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 |
|
Power control privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
Group privilege. Required when state=present. Only the M5 model supports this parameter. Choices:
|
|
A dict object containing connection details. |
|
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. |
|
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 |
|
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 |
|
Security configuration privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
Itself configuration privilege. Required when state=present. Only the M6 model supports this parameter. Choices:
|
|
Whether the user group should exist or not, taking action if the state is different from what is stated. Choices:
|
|
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 |
Notes
Note
Does not support
check_mode
.
Examples
- name: User group test
hosts: ksmanage
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Add user group"
kaytus.ksmanage.user_group:
state: "present"
name: "test"
pri: "administrator"
provider: "{{ ksmanage }}"
- name: "Set user group"
kaytus.ksmanage.user_group:
state: "present"
name: "test"
pri: "user"
provider: "{{ ksmanage }}"
- name: "Set m6 user group"
kaytus.ksmanage.user_group:
state: "present"
name: "OEM1"
general: "enable"
kvm: "enable"
provider: "{{ ksmanage }}"
- name: "Delete user group"
kaytus.ksmanage.user_group:
state: "absent"
name: "test"
provider: "{{ ksmanage }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |