Add Oracle Database Listeners

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

Note:

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 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 JSON Files and Properties

   Definition File: omc_oracle_db_listener_sample.json displayName: This is Oracle Database Listener Name displayed in the Oracle Infrastructure Monitoring User Interface. timezoneRegion: Time zone of your entity. It is recommended that you use the long values IANA-maintained TZ database time zones. For example: America/New_York host_name: Fully-qualified Host Name where the Oracle Database Listener is installed. port: Oracle Database Listener port. trace_dir_path: Trace Log Files directory absolute path; optional parameter, define it if you are also using Oracle Log Analytics. log_dir_path: Alert Log Files directory absolute path; optional parameter, define it if you are also using Oracle Log Analytics. lsnr_alias: Oracle Database Listener Alias. Credential Files: omc_oracle_db_listener_local_credless.json omc_oracle_db_listener_remote_ssh_sample.json omc_oracle_db_listener_remote_ssh_sample_creds.json omc_oracle_db_listener_creds.json displayName: This is Oracle Database Listener Name displayed in the Oracle Infrastructure Monitoring User Interface. timezoneRegion: Time zone of your entity. It is recommended that you use the long values IANA-maintained TZ database time zones. For example: America/New_York use_ssh: Use Secure Shell protocol. (true/false). True :- Set to true when performing remote monitoring. False:- Set to false when performing local monitoring (agents 1.30 and lower). For agents 1.31 and greater, the use_ssh property is optional for local monitoring. lsnr_port: Your Oracle Database Listener Port. lsnr_protocol: Your Listener Protocol oracle_home: Your Oracle Listener ORACLE_HOME. log_dir_path: Alert Log Files directory absolute path; optional parameter, define it if you are also using Oracle Log Analytics. trace_dir_path: Trace Files directory absolute path. lsnr_alias: Your Oracle Database Listener Alias. SSHUserName: SSH host user name, on the host where the listener is installed. SSHUserPassword: SSH host user password SSH_PVT_KEY:Path of your private key file - Not required if a password is provided or SSH keys are available in the default location. sshdPort: SSH port. Note: You must use a host user with SSH configured and enabled. Only password-based SSH is supported.

3. Add the entity using omcli.

   Agent Local: Use omc_oracle_db_listener_local_credless.json as a template for the DEFINITION_FILE. No credentials required.

   omcli add_entity agent DEFINITION_FILE 

   Agent Remote: Use omc_oracle_db_listener_remote_ssh_sample.json as a template for the DEFINITION_FILE with one of the credentials template files shown below for CREDENTIAL_FILE.

   omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]]

   The following CREDENTIAL_FILEs can be found in Sample JSON files (zip file)

   • omc_oracle_db_listener_cred_ssh.json: Credentials using SSH password.
   • omc_oracle_db_listener_cred_ssh_pvtkey.json: Credentials using SSH Private key.
   • omc_oracle_db_listener_credless_ssh.json: Credentials using Credless SSH. Note: In order to use this file, you must first set up passwordless SSH between the agent host and the listener host.
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.

Troubleshooting

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

• Lack of Data
• Create an Agent Support Bundle