Oracle Listener HD discovery

  • Release version: Australia
  • Updated March 12, 2026
  • 5 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Oracle Listener HD discovery

    ServiceNow Discovery leverages the Oracle Listener HD pattern to detect and map components of Oracle Real Application Clusters (RAC). This enables customers to gain detailed insights into Oracle RAC infrastructures by identifying Oracle Database Listeners, instances, clusters, nodes, and services. To enable this discovery, customers must install the CMDB CI Class Models and Discovery and Service Mapping Patterns plugins from the ServiceNow Store.

    Show full answer Show less

    Oracle RAC clusters multiple servers using Oracle Clusterware, allowing them to function as a unified system, sharing clustered storage accessible by both clustered and non-clustered databases. The Oracle Listener HD pattern collects comprehensive data to populate related CMDB classes, facilitating accurate configuration management and service mapping.

    Prerequisites

    • Install CMDB CI Class Models plugin (version 1.29.0 or later).
    • Install Discovery and Service Mapping Patterns plugin (version 1.0.82 or later).
    • The Discovery user must belong to the Oracle DBA group or have equivalent permissions.
    • The MID Server must have network access to the Oracle target devices.
    • Oracle Clusterware/Grid infrastructure and Oracle RAC database must be installed and configured.
    • The Oracle Listener process must be running on a UNIX OS host.
    • Use Oracle Clusterware minimum version 12.2.X.X (Oracle Database 12c Release 2) or higher.

    Note: The Oracle Listener HD pattern is supported starting with the Paris release, and support for additional UNIX OS types (AIX, Solaris, HP-UX) was introduced from plugin version 1.0.87.

    Discovery Process and Commands

    The pattern executes key Oracle commands to gather relevant information:

    • Sets environment variables TNSADMIN and ORACLEBASE based on Oracle home directories.
    • Runs lsnrctl status to verify Listener status; terminates if no output is received.
    • Uses ps -ef | grep 'd.bin' to locate GRIDHOME paths.
    • Queries cluster nodes and disks with crsctl query cluster site -all.
    • Lists listener services via lsnrctl services.
    • Retrieves database resource status with crsctl stat res -f -w '((TYPE = ora.database.type))'.

    Limitations

    • Oracle Clusterware discovery is only supported on UNIX Operating Systems.
    • The SSH Command-Oracle - Listener Details classifier probe is inactive by default when installing CMDB CI Class Models version 1.29.0 or higher.

    Data Collected and CMDB Impact

    The discovery pattern populates multiple CMDB classes with detailed Oracle RAC data, enabling comprehensive visibility into the Oracle environment:

    • Oracle Database Listener: Name, Oracle Home directory, listener.ora configuration, SCAN listener name, version, and TCP ports.
    • Oracle Instance: SID and instance name (SID@HOSTNAME).
    • Oracle Database: Unique database name, type, operational status, and hosting node.
    • Oracle Cluster: Cluster name, GUID, status, and IP addresses of participating nodes.
    • Oracle Cluster Node: Hostname, IP address, hosting server, and associated cluster.
    • Oracle DB Service: Service name, TCP port, managing Listener name, and version.
    • Host Servers: Hostname information for Linux, AIX, HP-UX, and Solaris servers hosting the Oracle Listener process.

    CI Relationships and Dependency Mapping

    The Oracle Listener HD pattern creates explicit relationships between discovered CIs, illustrating the infrastructure and service dependencies. Key relationships include:

    • Clusters hosting cluster nodes.
    • Cluster nodes hosted on specific UNIX servers (Linux, AIX, Solaris, HP-UX).
    • Oracle Instances running on host servers.
    • Database Listeners managing Oracle Instances and DB Services.
    • Oracle Instances using Oracle Databases.

    This structured relationship mapping supports effective impact analysis, root cause identification, and service management within the ServiceNow platform.

    ServiceNow Discovery uses the Oracle Listener HD pattern to find and map Oracle real application cluster components. To discover these resources, install the CMDB CI Class Models and the Discovery and Service Mapping Patterns from the ServiceNow Store.

    Oracle RAC enables you to cluster an Oracle database. Oracle RAC uses Oracle Clusterware for the infrastructure to bind multiple servers so they operate as a single system. Oracle Clusterware enables you to create a clustered pool of storage that can be used by any combination of non-cluster and Oracle RAC databases. Discovery uses Oracle Listener HD patterns to discover information about the Oracle Database Listener and the components in the Oracle RAC infrastructure, when such a setup is configured.

    Request apps on the Store

    Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Prerequisites

    • Ensure that the following plugins are installed:
      • CMDB CI Class Models plugin (Version 1.29.0 or later). ​
      • Discovery and Service Mapping Patterns plugin (Version 1.0.82 or later).​
    • Ensure that the Discovery User is in the Oracle DBA group or has the correct Permissions.
    • Ensure that the MID Server has access to the target device.
    • Ensure that the Oracle Clusterware/Grid infrastructure is installed and the Oracle RAC Database is configured. If there is an Oracle Clusterware setup.
    • Ensure that the Oracle Listener process is running on a UNIX OS host.​
    • Use Oracle Clusterware minimum version 12.2.X.X (Oracle Database 12c Release 2) or higher, If there is an Oracle Clusterware setup​.
      Note:
      This pattern is supported from the Paris release on. More UNIX OS types (AIX, Solaris, HP-UX) are supported from version 1.0.87 of the Discovery and Service Mapping Patterns plugins.

      The following commands are executed during the pattern execution. Executing the commands enables the pattern to populate allthe relevant CMDB classes with the necessary information:

      • export TNS_ADMIN=<oracle_home_directory>/network/admin: Sets the ORACLE_HOME to the TNS_ADMIN environment variable.

      • export ORACLE_BASE==<oracle_home_directory>: Sets the ORACLE_HOME to the ORACLE_BASE environment variable.

      • lsnrctl status LISTENER_NAME: Checks the Database Listener status​.

      • ps -ef | grep 'd.bin’: Searches for the GRID_HOME path​.

      • crsctl query cluster site -all: Lists the nodes and disks that the sites contain​.

      • lsnrctl services LISTENER_NAME: Lists the services that the listener identifies.

      • crsctl stat res -f -w '((TYPE = ora.database.type))’: Lists the database name, associated node, type, and active status.​

        Note:
        If no output is obtained from the lsnrctl status LISTENER_NAME, then the Oracle Listener HD pattern is terminated.

    Limitations

    The Oracle Clusterware setup is only supported for the UNIX Operating Systems. The base system SSH Command-Oracle - Listener Details classifier probe is inactive (Active is set to False), when installing the CMDB CI Class Models version 1.29.0 or higher.

    Figure 1. Classifier Probes- Oracle Listener Details
    Classifier Probes.
    The Oracle Listener process classification triggers the Oracle Listener HD pattern.
    Figure 2. Classifier Probes- Horizontal Pattern
    Classifier Probes.

    Data collected by Discovery during horizontal discovery

    Discovery populates the data in the CMDB when running the Oracle Listener HD pattern.

    Table 1. Oracle Database Listener [cmdb_ci_db_ora_listener]
    Field Description
    Name [name] The name of the Oracle Database Listener.
    Oracle Home [oracle_home] The Oracle home directory where software is installed.
    Configuration [configuration] The listener.ora network configuration file.
    Scan Listener Name [scan_listener_name] The name of the SCAN LISTENER.
    Version [version] The version of the Oracle product.
    TCP port(s) [tcp_port] The listening port for Oracle client connections.
    Table 2. Oracle Instance [cmdb_ci_db_ora_instance]
    Field Description
    SID [sid] The specific name that specifically identifies the instance.​
    Name [name] The name of the Oracle instance combination of SID@HOST_NAME​.
    Table 3. Oracle Database [cmdb_ci_oracle_database]
    Field Description
    Name [name] The Oracle database unique name.
    Type [type] The Oracle database type.
    Operational status [operational_status] The active status of the Oracle database.
    Node [node] The host name of the node hosting the Oracle database.
    Table 4. Oracle Cluster [cmdb_ci_oracle_cluster]
    Field Description
    Name [name] The name of the Oracle database cluster.
    Cluster ID [cluster_id] The GUID of the Oracle database cluster.
    Cluster Status [cluster_status] The active state of the Oracle database cluster.
    IP Address [ip_address] The IP addresses of the nodes participating in the cluster.
    Table 5. Oracle Cluster Node [cmdb_ci_oracle_cluster_node]
    Field Description
    Name [name] The hostname of the cluster node combination of HOSTNAME@CLUSTER_NAME.​
    IP Address [ip_address] The IP address of the cluster node, if resolvable by DNS.​
    Server [server] The hostname of the host hosting the cluster node.​
    Cluster [cluster] The name of the cluster to which the cluster node is associated.
    Table 6. Oracle DB Service [cmdb_ci_db_ora_service]
    Field Description
    Name [name] The name of the service.
    TCP port(s) [tcp_port] The port of the service.
    Listener name [listener_name] The name of the Listener managing the service.
    Version [version] The version of the service.
    Table 7. Linux Server [cmdb_ci_linux_server​]
    Field Description
    Name [name] The hostname of the Linux server that is hosting the Oracle Listener process.
    Table 8. AIX Server [cmdb_ci_aix_server]​
    Field Description
    Name [name] The hostname of the AIX server that is hosting the Oracle Listener process.
    Table 9. HPUX Server [cmdb_ci_hpux_server]
    Field Description
    Name [name] The hostname of the HP-UX server that is hosting the Oracle Listener process.
    Table 10. Solaris Server [cmdb_ci_solaris_server]
    Field Description
    Name [name] The hostname of the Solaris server that is hosting the Oracle Listener process.

    Dependency Views map

    The following dependency views display the relationships between Oracle Listener resources.

    Figure 3. Oracle Database Listener View Map​
    Oracle Database Listener view map​.
    Figure 4. Oracle Instance View Map
    Oracle Instance View Map.
    Figure 5. Oracle Database View Map
    Oracle Database View Map.
    Figure 6. Oracle Cluster View Map
    Oracle Cluster View Map.
    Figure 7. Oracle Cluster Node View Map​
    Oracle Cluster Node View Map​.
    Figure 8. Linux Server View Map​
    Linux Server View Map​.

    CI relationships

    The Listener HD pattern creates the following relationships to support Oracle Listener discovery.

    CI Relationship CI
    Oracle Cluster [cmdb_ci_oracle_cluster] Cluster of::Cluster Oracle Cluster Node [cmdb_ci_oracle_cluster_node]
    Oracle Cluster Node [cmdb_ci_oracle_cluster_node] Hosted on::Hosts Linux Server [cmdb_ci_linux_server​]
    Oracle Instance [cmdb_ci_db_ora_instance] Runs on::Runs Linux Server [cmdb_ci_linux_server​]
    Oracle Database Listener [cmdb_ci_db_ora_listener] Depends on::Used by Oracle Instance [cmdb_ci_db_ora_instance]
    Oracle Instance [cmdb_ci_db_ora_instance] Uses::Used by Oracle Database [cmdb_ci_db_oracle_database]​
    Oracle Database [cmdb_ci_db_oracle_database]​ Hosted on::Hosts Oracle Cluster Node [cmdb_ci_oracle_cluster_node]
    Oracle Cluster Node [cmdb_ci_oracle_cluster_node] Hosted on::Hosts AIX Server [cmdb_ci_aix_server]
    Oracle Instance [cmdb_ci_db_ora_instance] Runs on::Runs AIX Server [cmdb_ci_aix_server]
    Oracle Cluster Node [cmdb_ci_oracle_cluster_node] Hosted on::Hosts Solaris Server [cmdb_ci_solaris_server]
    Oracle Instance [cmdb_ci_db_ora_instance] Runs on::Runs Solaris Server [cmdb_ci_solaris_server]
    Oracle Cluster Node [cmdb_ci_oracle_cluster_node] Hosted on::Hosts HPUX Server [cmdb_ci_hpux_server]
    Oracle Instance [cmdb_ci_db_ora_instance] Runs on::Runs HPUX Server [cmdb_ci_hpux_server]
    Oracle DB Service [cmdb_ci_db_ora_service] Managed by::Manages Oracle Database Listener [cmdb_ci_db_ora_listener]
    Oracle Instance [cmdb_ci_db_ora_instance] Uses::Used by Oracle DB Service [cmdb_ci_db_ora_service]