community.general.opendj_backendprop module – Update the backend configuration of OpenDJ using the dsconfig set-backend-prop command

Note

This module is part of the community.general collection (version 12.6.1).

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 community.general.

To use it in a playbook, specify: community.general.opendj_backendprop.

Synopsis
Parameters
Attributes
Examples

Synopsis

This module updates settings for OpenDJ with the command set-backend-prop.
It checks first using get-backend-prop if configuration needs to be applied.

Parameters

Parameter	Comments
backend string / required	The name of the backend on which the property needs to be updated.
hostname string / required	The hostname of the OpenDJ server.
name string / required	The configuration setting to update.
opendj_bindir path	The path to the bin directory of OpenDJ. Default: `"/opt/opendj/bin"`
password string	The password for `username`. Either `password` or `passwordfile` is needed.
passwordfile path	Location to the password file which holds the password for `username`. Either `password` or `passwordfile` is needed.
port string / required	The Admin port on which the OpenDJ instance is available.
state string	If configuration needs to be added/updated. Default: `"present"`
username string	The username to connect with. Default: `"cn=Directory Manager"`
value string / required	The value for the configuration item.

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Returns details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Examples

- name: Add or update OpenDJ backend properties
  opendj_backendprop:
    hostname: localhost
    port: 4444
    username: "cn=Directory Manager"
    password: password
    backend: userRoot
    name: index-entry-limit
    value: 5000

Authors

Werner Dijkerman (@dj-wasabi)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/opendj_backendprop_module.html