community.general.opendj_backendprop (8.5.0) — module

Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command

Authors: Werner Dijkerman (@dj-wasabi)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0


Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module will update settings for OpenDJ with the command set-backend-prop.

It will check first via de get-backend-prop if configuration needs to be applied.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Add or update OpenDJ backend properties
    action: opendj_backendprop
            hostname=localhost
            port=4444
            username="cn=Directory Manager"
            password=password
            backend=userRoot
            name=index-entry-limit
            value=5000

Inputs

    
name:
    description:
    - The configuration setting to update.
    required: true
    type: str

port:
    description:
    - The Admin port on which the OpenDJ instance is available.
    required: true
    type: str

state:
    default: present
    description:
    - If configuration needs to be added/updated
    required: false
    type: str

value:
    description:
    - The value for the configuration item.
    required: true
    type: str

backend:
    description:
    - The name of the backend on which the property needs to be updated.
    required: true
    type: str

hostname:
    description:
    - The hostname of the OpenDJ server.
    required: true
    type: str

password:
    description:
    - The password for the cn=Directory Manager user.
    - Either password or passwordfile is needed.
    required: false
    type: str

username:
    default: cn=Directory Manager
    description:
    - The username to connect to.
    required: false
    type: str

passwordfile:
    description:
    - Location to the password file which holds the password for the cn=Directory Manager
      user.
    - Either password or passwordfile is needed.
    required: false
    type: path

opendj_bindir:
    default: /opt/opendj/bin
    description:
    - The path to the bin directory of OpenDJ.
    required: false
    type: path