IBM WebSphere Application Server discovery using patterns

  • Release version: Yokohama
  • 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 IBM WebSphere Application Servers on Windows and Linux systems. This discovery identifies and classifies detailed information about WebSphere Application Servers, which are middleware platforms hosting Java-based web applications. Pattern-based discovery is now the default method starting with Visibility Content version 6.1.0, replacing WebSphere probes which are disabled by default.

    Show full answer Show less

    Prerequisites and Setup

    • For Windows discovery: Ensure Discovery and Service Mapping Patterns and Visibility Content applications are up to date. Enable PowerShell on the MID Server, verify access to key installation and configuration files (such as versionInfo.bat, server.xml, cell.xml), and create required Windows credentials. A horizontal discovery must be scheduled to initiate the process.
    • For Linux discovery: Ensure the same core applications are up to date. Enable SSH access on the WebSphere server, verify access to installation and configuration files (including versionInfo.sh and server.xml), create SSH credentials, and confirm elevated rights are available for WebSphere commands. Scheduling a horizontal discovery is also necessary here.

    Data Collected

    During discovery, ServiceNow populates the Configuration Management Database (CMDB) with detailed CI records, including:

    • IBM WebSphere Application Server: Fields such as name, version, node, and cell.
    • WebSphere EAR (Enterprise Archive): Includes the EAR name and installation directory.
    • Web Services: Captures the service name, ID, and additional attributes.
    • WebSphere Cells: Includes the cell name, ID, type, discovery protocol, and description (Linux only).

    CI Relationships

    The discovery process establishes important relationships among Configuration Items (CIs) to accurately model the environment:

    • WebSphere Application Servers are contained by WebSphere Cells.
    • WebSphere EAR files are contained by the WebSphere Application Servers.
    • Web Services run on WebSphere Application Servers.

    What ServiceNow Customers Can Expect

    By using these discovery patterns, customers gain automated, accurate identification and classification of IBM WebSphere Application Server environments within their CMDB. This enables better visibility, management, and service mapping of WebSphere middleware components across Windows and Linux platforms. Customers should ensure prerequisites are met and schedule horizontal discoveries to capture and maintain up-to-date CI data and relationships.

    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]