ieisystem.inmanage.edit_ldap (1.1.1) — module

Set ldap information

| "added in version" 1.0.0 of ieisystem.inmanage"

Authors: WangBaoshan (@ieisystem)

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

Set ldap information on ieisystem Server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ldap test
  hosts: inmanage
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ldap information"
    ieisystem.inmanage.edit_ldap:
      enable: "disable"
      provider: "{{ inmanage }}"

  - name: "Set ldap information"
    ieisystem.inmanage.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: "{{ inmanage }}"

Inputs

    
ca:
    description:
    - CA certificate file path.
    - Required when I(encry=StartTLS).
    type: str

ce:
    description:
    - Certificate file path.
    - Required when I(encry=StartTLS).
    type: str

cn:
    choices:
    - ip
    - fqdn
    description:
    - Common name type.
    - Required when I(encry=StartTLS).
    type: str

dn:
    description:
    - Bind DN. The Bind DN is used in bind operations, which authenticates the client
      to the server.
    - Bind DN is a string of 4 to 64 alphanumeric characters.
    - It must start with an alphabetical character.
    - Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are
      allowed.
    type: str

pk:
    description:
    - Private Key file path.
    - Required when I(encry=StartTLS).
    type: str

attr:
    choices:
    - cn
    - uid
    description:
    - Attribute of User Login.
    - The Attribute of User Login field indicates to the LDAP/E-Directory server which
      attribute should be used to identify the user.
    type: str

base:
    description:
    - Search Base.
    - The Search Base allows the LDAP/E-Directory server to find which part of the external
      directory tree is to be searched.
    - This search base may be equivalent to the organization or the group of the external
      directory.
    - Search base is a string of 4 to 64 alphanumeric characters.
    - It must start with an alphabetical character.
    - Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are
      allowed.
    type: str

code:
    description:
    - Password. The Bind password is also used in the bind authentication operations between
      client and server.
    - Required when I(enable=enable).
    type: str

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

encry:
    choices:
    - 'no'
    - SSL
    - StartTLS
    description:
    - Encryption Type.
    type: str

enable:
    choices:
    - enable
    - disable
    description:
    - LDAP/E-Directory Authentication Status.
    type: str

address:
    description:
    - Server Address.
    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

server_port:
    description:
    - Server Port. Specify the LDAP/E-Directory Port.
    type: int

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