Add Oracle Database Listener Cluster

You can add individual Oracle Database Listener Cluster entities using the cloud agent command line interface (omcli) with the appropriate JSON files.


Oracle Management Cloud allows you to add all database components (DB, ASM, listener, etc.) as a single composite entity via the Oracle database system entity type. See Add Oracle Database Systems.

Step 1: Add the Oracle Database Listener Cluster 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 Database Listener Cluster JSON Files and Properties

    Definition File: omc_oracle_db_listener_cluster_sample.json

    • displayName: This is Oracle Database Listener Cluster Entity Display Name which is displayed on Infrastructure Monitoring UItimezoneRegion: Time Zone Example: PDT, GMT
    • host_name: : Fully-qualified Host Name where the Oracle Database Listener Cluster is installed.
    • lsnr_alias : Oracle Database Listener Cluster Alias
    • crs_home : Absolute Path of the CRS HOME / GRID HOME

    Credential Files



    • sshdPort: SSHD Port on Remote host to Listen to Remote Cluster Listener
    • SSHUserName: SSH Host User Name
    • SSHUserPassword: SSH Host User Password
    • SSH_PVT_KEY : Location of the SSH private key copied from the remote machine where Cluster Listener is installed.
    • SSH_PUB_KEY : Location of the SSH public key copied from the remote machine where Cluster Listener is installed.
    • sshdHost : Host Name where Oracle Database Listener Cluster is installed.
  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 2: (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 Database Listener Cluster, see the following: