Add Oracle Unified Directory

You can add Oracle Unified Directory entities using the Add Entity UI or using the cloud agent command line interface (omcli) with the appropriate JSON files.

Step 1: Prepare Oracle Unified Directory for monitoring.


i) OUD Gateway

ii) OUD Replication

iii) OUD Proxy

LDAP username and LDAP passwords are used to connect to the OUD LDAP server.

OUD Credentials:

Directory Server Username and Password: The username and password that will be used by the agent to bind to the server instance. Ensure the password is in the appropriate field.

The following credential JSON sample illustrates how the properties should be entered.

{ "entities":[
                "host_name":{"displayName":"Directory Server Host","value":""},
                "omc_ldap_port":{"displayName":"Administration Port","value":"4444"},
                "omc_trust_all":{"displayName":"Trust ALL Server SSL certificates","value":"true"},

         "id":"OudCreds","name":"OUD Credentials","credType":"MonitorCreds",
         "properties":[{"name":"authUser", "value":"CLEAR[cn=Directory Manager]"},
                       {"name":"authPasswd", "value":"CLEAR[mypassword]"}]

Step 2: Add the Oracle Unified Directory using omcli and the Appropriate JSON Files

  1. Download and extract the required JSON file(s) from the master JSON zip file. See the table below for the specific JSON files you'll need.
  2. Edit the file(s) and specify the requisite properties shown below.
    Oracle Unified Directory JSON Files and Properties

    i) OUD Server

    ii) OUD Proxy Server

    Definition Files



    Credential File: omc_oud_creds.json

    Replace any text inside brackets <> excluding these brackets with your values according the legend inside <>

    • Administration Port: The administration port of the target server instance.
    • Directory Server Host: The fully qualified domain name of the target server instance. For replicated servers, you must provide the same host name that was used when replication was configured.
    • Trust All : Set to true by default. This implies that all the certificates that are presented by the server (or servers, in the case of replication) will be accepted automatically. Change this setting if you want to specify different behavior. (Optional)

      If you have changed the default setting for the Trust All field, enter a path in the Trust Store Path field..

      The agent will use the trust store located in this path to validate the certificates of the administration connector that are presented by the server(s). This path must be readable by the agent (and thus located in a file system that is accessible by the agent). The trust store must contain the public keys of the administration connector certificates. It must be in JKS format and must not be password protected.

  3. Add the entity using omcli.
    omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]] 
  4. Verify the status of the newly added entity.
    omcli status_entity agent DEFINITION_FILE

See step 4. Adding Entities to Your Service of Add Entities Using JSON Files for more information.

Step 3: (Optional but recommended) Set up alerts.

To enable lights-out monitoring, you can set up alert rules to generate alerts and send notifications if your entities have performance issues.

See Set Up Alert Rules and Set Up Alert Thresholds and Notifications.


If you run into any issues regarding discovery or monitoring of Oracle Unified Directory, see the following: