You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

New in version 2.2.

Synopsis
Options
Examples
- Status

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.

Options ¶

parameter	required	default	choices	comments
backend	yes			The name of the backend on which the property needs to be updated.
hostname	yes			The hostname of the OpenDJ server.
name	yes			The configuration setting to update.
opendj_bindir	no	/opt/opendj/bin		The path to the bin directory of OpenDJ.
password	no			The password for the cn=Directory Manager user. Either password or passwordfile is needed.
passwordfile	no			Location to the password file which holds the password for the cn=Directory Manager user. Either password or passwordfile is needed.
port	yes			The Admin port on which the OpenDJ instance is available.
state	no	present		If configuration needs to be added/updated
username	no	cn=Directory Manager		The username to connect to.
value	yes			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

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.