kaytus.ksmanage.ad_group – Manage active directory group information

Note

This plugin is part of the kaytus.ksmanage collection.

To install it use: ansible-galaxy collection install kaytus.ksmanage.

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

New in version 1.0.0: of kaytus.ksmanage

Synopsis

  • Manage active directory group information on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter Choices/Defaults Comments
domain
string
Group domain.
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
Kvm privilege.
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
  • user
  • operator
  • oem
  • none
Group privilege.
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 active directory 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.
vm
string
    Choices:
  • enable
  • disable
Vmedia privilege.

Notes

Note

  • Does not support check_mode.

Examples

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

  tasks:

  - name: "Add active directory group information"
    kaytus.ksmanage.ad_group:
      state: "present"
      name: "wbs"
      domain: "test.com"
      pri: "administrator"
      kvm: "enable"
      vm: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set active directory group information"
    kaytus.ksmanage.ad_group:
      state: "present"
      name: "wbs"
      pri: "user"
      kvm: "disable"
      provider: "{{ ksmanage }}"

  - name: "Delete active directory group information"
    kaytus.ksmanage.ad_group:
      state: "absent"
      name: "wbs"
      provider: "{{ ksmanage }}"

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)