W3cubDocs

community.general.opendj_backendprop – Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command.

Note

This plugin is part of the community.general collection (version 3.8.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
Examples

Synopsis

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.

Parameters

Parameter	Choices/Defaults	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	Default: "/opt/opendj/bin"	The path to the bin directory of OpenDJ.
password string		The password for the cn=Directory Manager user. Either password or passwordfile is needed.
passwordfile path		Location to the password file which holds the password for the cn=Directory Manager user. Either password or passwordfile is needed.
port string / required		The Admin port on which the OpenDJ instance is available.
state string	Default: "present"	If configuration needs to be added/updated
username string	Default: "cn=Directory Manager"	The username to connect to.
value string / required		The value for the configuration item.

Examples

- 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

Authors

Werner Dijkerman (@dj-wasabi)

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