kaytus.ksmanage.edit_ldap – Set ldap 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.edit_ldap.

New in version 1.0.0: of kaytus.ksmanage

Synopsis

  • Set ldap 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
address
string
Server Address.
attr
string
    Choices:
  • cn
  • uid
Attribute of User Login.
base
string
Search Base.
Search base is a string of 4 to 64 alpha-numeric characters.
It must start with an alphabetical character.
Special Symbols like dot(.), comma(,), hyphen(-), underscore(_), equal-to(=) are allowed.
ca
string
CA certificate file path.
Required when encry=StartTLS.
ce
string
Certificate file path.
Required when encry=StartTLS.
cn
string
    Choices:
  • ip
  • fqdn
Common name type.
Required when encry=StartTLS.
code
string
Password.
Required when enable=enable.
dn
string
Bind DN.
Bind DN is a string of 4 to 64 alpha-numeric characters.
It must start with an alphabetical character.
Special Symbols like dot(.), comma(,), hyphen(-), underscore(_), equal-to(=) are allowed.
enable
string
    Choices:
  • enable
  • disable
LDAP/E-Directory Authentication Status.
encry
string
    Choices:
  • no
  • SSL
  • StartTLS
Encryption Type.
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.
pk
string
Private Key file path.
Required when encry=StartTLS.
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.
server_port
integer
Server Port.
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: Ldap test
  hosts: ksmanage
  connection: local
  gather_facts: no
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ldap information"
    kaytus.ksmanage.edit_ldap:
      enable: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set ldap information"
    kaytus.ksmanage.edit_ldap:
      enable: "enable"
      encry: "SSL"
      address: "100.2.2.2"
      server_port: 389
      dn: "cn=manager,ou=login,dc=domain,dc=com"
      code: "123456"
      base: "cn=manager"
      attr: "uid"
      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)