IBM WebSphere Application Server discovery using patterns

  • Release version: Xanadu
  • Updated February 16, 2025
  • 3 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 IBM WebSphere Application Server discovery using patterns

    The Discovery and Service Mapping Patterns application in ServiceNow uses specific patterns—Websphere On Windows and Websphere On Unix—to discover and classify IBM WebSphere Application Servers across Windows and Linux environments. This discovery process populates the Configuration Management Database (CMDB) with detailed information about WebSphere servers, applications, and services. Starting with Visibility Content version 6.1.0, pattern-based discovery is the default method, and traditional WebSphere probes are disabled by default.

    Show full answer Show less

    Prerequisites

    To successfully discover IBM WebSphere Application Servers, ensure the following are in place:

    • Applications: Discovery and Service Mapping Patterns and Visibility Content must be up to date.
    • Windows Discovery: PowerShell must be enabled on the MID Server; access to key WebSphere installation and configuration files must be verified; Windows credentials must be created for discovery operations.
    • Linux Discovery: SSH must be enabled on the WebSphere server; access to installation and configuration files must be verified; SSH credentials must be established; elevated rights should be confirmed for executing WebSphere commands.
    • Scheduling: A horizontal discovery should be scheduled to initiate the discovery process on the target systems.

    Data Collected and CMDB Population

    During discovery, the system collects and maps detailed data into multiple configuration item (CI) classes within the CMDB:

    • IBM WebSphere Application Server (cmdbciappserverwebsphere): Includes server name, version, node, and cell groupings.
    • Websphere EAR (cmdbciappserverwsear): Records enterprise application archive file names and installation directories.
    • Web Service (cmdbciwebservice): Captures web service names, IDs, and additional attributes.
    • Websphere Cell (cmdbciwebspherecell): Contains cell names, IDs, types, discovery protocols, and descriptions (Linux only).

    CI Relationships

    The discovery process automatically establishes relationships among CIs to accurately represent the WebSphere environment:

    • WebSphere Application Servers are contained within WebSphere Cells.
    • WebSphere EAR applications are contained within WebSphere Application Servers.
    • Web Services run on WebSphere Application Servers.

    Practical Benefits for ServiceNow Customers

    This discovery capability enables ServiceNow customers to maintain an accurate and up-to-date CMDB representation of their IBM WebSphere environments, facilitating better service management, impact analysis, and operational insights. By leveraging pattern-based discovery, customers can automate the identification and classification of WebSphere components across diverse operating systems, ensuring comprehensive visibility and reducing manual effort.

    The Discovery and Service Mapping Patterns application uses the Websphere On Windows and Websphere On Unix patterns to find IBM WebSphere Application Servers. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

    The IBM WebSphere Application Server is a software framework with middleware that hosts Java-based web applications. Discovery identifies and classifies information about the IBM WebSphere Application Server on both Windows and Linux computers.

    Note:
    Starting with Visibility Content version 6.1.0, pattern-based discovery is the default method for discovering IBM WebSphere Application Servers. The WebSphere probes are disabled by default. For more information, see IBM WebSphere server discovery using probes.

    Request apps on the Store

    Visit the ServiceNow Store website 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 for Windows discovery

    Verify that the following applications are up to date:
    • Discovery and Service Mapping Patterns
    • Visibility Content
    Enable PowerShell on the MID Server
    For more information, see Set up MID Servers to use PowerShell.
    Verify access to files and directories
    Verify access to the following files and directories:
    • Installation directory of the product
    • Configuration directory of the product
    • versionInfo.bat
    • WAS.product
    • BASE.product
    • profile.version
    • Express.product
    • application.xml
    • server.xml
    • cell.xml
    Create Windows credentials
    For more information, see Windows credentials.
    Schedule a horizontal discovery
    For more information, see Schedule a horizontal discovery.

    Prerequisites for Linux discovery

    Verify that the following applications are up to date:
    • Discovery and Service Mapping Patterns
    • Visibility Content
    Enable SSH on WebSphere Application Server
    For more information, see the "Setting up SSH on Linux or UNIX servers" article in the "WebSphere Automation" section of the IBM documentation (https://www.ibm.com/docs/en/products).
    Verify access to files and directories
    Verify access to the following files and directories:
    • Installation directory of the product
    • Configuration directory of the product
    • oeconsol
    • WAS_HOME
    • CONFIG_ROOT
    • versionInfo.sh
    • WAS.product
    • BASE.product
    • profile.version
    • Express.product
    • application.xml
    • server.xml
    • cell.xml
    Create SSH credentials
    For more information, see SSH credentials.
    Verify elevated rights for IBM WebSphere Application Server commands
    For more information, see IBM WebSphere Application Server (on UNIX) table in Service Mapping commands requiring a privileged user.
    Schedule a horizontal discovery
    For more information, see Schedule a horizontal discovery.

    Data collected by Discovery during horizontal discovery

    Discovery populates the data in the CMDB when running the Websphere On Windows and Websphere On Unix patterns.

    Table 1. IBM Websphere [cmdb_ci_app_server_websphere]
    Field Description
    Name [name] Name of the WebSphere Application Server.
    Version [version] Current version of the WebSphere Application Server.
    Node [node] Name of the Node grouping the WebSphere Application Server or servers.
    Cell [cell] Name of the cell grouping one or more nodes of the WebSphere Application Server.
    Table 2. Websphere EAR [cmdb_ci_app_server_ws_ear]
    Field Description
    Name [name] Name of the enterprise application archive (EAR) file.
    Installation directory [install_directory] Installation directory of the EAR file.
    Table 3. Web Service [cmdb_ci_web_service]
    Field Description
    Name [name] Name of the web service.
    Service ID [service_id] ID of the web service.
    Attributes [attributes] Additional attributes of the web service.
    Table 4. Websphere Cell [cmdb_ci_websphere_cell]
    Field Description
    Name [name] Name of the WebSphere cell.
    Cell ID [cell_id] ID of the WebSphere cell.
    Cell type [cell_type] Type of the WebSphere cell.
    Cell discovery protocol [cell_discovery_protocol] Cell discovery protocol.
    Description [short_description] Description of the cell, if one has been provided. This field is populated in Linux discovery only.

    CI relationships

    Discovery creates these relationships to support the WebSphere Application Server discovery for both Windows and Linux systems.

    CI Relationship CI
    IBM Websphere [cmdb_ci_app_server_websphere] Contains::Contained by Websphere Cell [cmdb_ci_websphere_cell]
    IBM Websphere [cmdb_ci_app_server_websphere] Contains::Contained by Websphere EAR [cmdb_ci_app_server_ws_ear]
    Web Service [cmdb_ci_web_service] Runs on::Runs IBM Websphere [cmdb_ci_app_server_websphere]