{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":30129,"path":"it-operations-management/discovery-and-service-mapping-patterns/ibm_webseal_discovery_patterns.md","title":"IBM WebSEAL discovery","bundle":null,"doc_type":null,"release":"australia","body":"\n# IBM WebSEAL discovery\n\nThe ® Discovery application uses the IBM WebSEAL patterns to find WebSEAL applications, web application servers, and junctions on your infrastructure. Discovering some of these resources requires installing the Discovery and Service Mapping Patterns application from the ® Store.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Prerequisites\n\n-   **Detailed information on IBM WebSEAL**\n\n    For information, see [Detailed information on products discovered by ITOM Visibility](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/itom-visibility/r_SupportedApplications.md)\n\n-   **Authentication**\n\n    The WebSEAL authentication process includes HTTP header authentication with basic credentials [Basic authentication credentials](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/r_BasicAuthCredentialsForm.md).\n\n    If you’re running discovery for the first time, configure Credential affinity for Discovery and Orchestration [Credential affinity for Discovery and Orchestration](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_CredentialAffinity.md).\n\n    **Note:** Credential affinity isn’t available In debug mode.\n\n-   **Configured MID Server**\n\n    Ensure the MID Server has access and permissions to send HTTPS requests to the WebSEAL application.\n\n-   **Configured user permissions to execute API calls**\n\n    Ensure that the user has the permission to run the following API:\n\n    -   /net/general\n\n    -   /net/dns\n\n    -   /wga/reverseproxy\n\n    -   /wga/reverseproxy/&lt;reverse\\_proxy\\_id&gt;/configuration/stanza/junction/entry\\_name/match-vhj-first\n\n    -   /wga/reverseproxy/&lt;reverse\\_proxy\\_id&gt;/junctions\n    -   /wga/reverseproxy/\"&lt;reverse\\_proxy\\_id&gt;/junctions?junctions\\_id=&lt;junction\\_id&gt;\n\n    -   /wga/widgets/health.json\n\n-   **HTTP Classification enabled**\n\n    The IBM WebSEAL Pattern is triggered when you run the discovery on the server that the WebSEAL is on. Ensure that the HTTP Classification is present in the instance. For more information, see [Create an HTTP classification](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery/create-an-http-classifier.md) and [Run discovery through an HTTP or HTTPS REST call](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/itom-visibility/run-http-discovery.md)\n\n\n## Data collected during horizontal discovery\n\n<table id=\"table_olj_wwb_x5b\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td class=\"sub-head\" colspan=\"2\">\n\nISAM Server \\[cmdb\\_ci\\_isam\\_server\\] \n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nThe name of the server as returned by the `/net/general` API call. If the field is empty, `nslookup` on the IP address would be attempted to populate this field.\n\n</td></tr><tr><td>\n\nIP Address \\[ip\\_address\\]\n\n</td><td>\n\nThe IP address according to the discovery schedule/configuration.\n\n</td></tr><tr><td>\n\nfqdn\n\n</td><td>\n\nThe `search_domain` returned by the`/net/dns` API call.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nWebSEAL \\[cmdb\\_ci\\_app\\_server\\_webseal\\]\n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nThe name of the WebSEAL server as returned by the API.\n\n</td></tr><tr><td>\n\nIP Address \\[ip\\_address\\]\n\n</td><td>\n\nThe IP address according to the discovery schedule/configuration.\n\n</td></tr><tr><td>\n\nfqdn\n\n</td><td>\n\nThe `search_domain` returned by the`/net/dns` API call.\n\n</td></tr><tr><td>\n\ninstall\\_status\n\n</td><td>\n\nThe status is set to **installed** by default.\n\n</td></tr><tr><td>\n\noperation\\_status\n\n</td><td>\n\nThe status is set to **operational** by default.\n\n</td></tr><tr><td>\n\ninstall\\_directory\n\n</td><td>\n\nAccording to the identification requirement, this field is populated with the FQDN of the server.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nWebSEAL Reverse Proxies \\[cmdb\\_ci\\_webseal\\_reverse\\_proxy\\]\n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nThe name of the resource according to the API response.\n\n</td></tr><tr><td>\n\nobject\\_id\n\n</td><td>\n\nThe ID of the resource, of the API response.\n\n</td></tr><tr><td>\n\ninstall\\_status\n\n</td><td>\n\nIndicates if the installation is enabled.\n\n</td></tr><tr><td>\n\noperational\\_status\n\n</td><td>\n\nIndicates if the operation has started.\n\n</td></tr><tr><td>\n\nservice\\_type – hard-coded\n\n</td><td>\n\nThe status is set to `Webseal Reverse Proxy`by default.\n\n</td></tr><tr><td>\n\nwebseal\\_health\\_status\n\n</td><td>\n\nThe WebSEAL reported health status regarding the `/wga/widgets/health.json` API call\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nWebSEAL Junctions \\[cmdb\\_ci\\_webseal\\_junction\\]\n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nThe name of the resource according to the API response.\n\n</td></tr><tr><td>\n\nobject\\_id\n\n</td><td>\n\nThe id of the resource, created as a unique hash number corresponding to the case-sensitive name of the resource.\n\n**Note:** The case insensitivity of the queries may create duplicate fields when the **name** value is identical to the **Object ID** value. One of the identification attributes must be changed to have a unique value.\n\n</td></tr><tr><td>\n\ninstall\\_status\n\n</td><td>\n\nHard-coded to installed status\n\n</td></tr><tr><td>\n\noperational\\_status\n\n</td><td>\n\nHard-coded to operational status\n\n</td></tr><tr><td>\n\nstateful\\_junction\n\n</td><td>\n\nBoolean value indicating whether it’s a stateful Junction\n\n</td></tr><tr><td>\n\ntransparent\\_path\\_junction\n\n</td><td>\n\nBoolean value indicating whether it’s a transparent path Junction\n\n</td></tr><tr><td>\n\njunction\\_type\n\n</td><td>\n\nList for the type of the Junction\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nWebSEAL Backend Servers \\[cmdb\\_ci\\_webseal\\_backend\\_server\\]\n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nthe name of the resource, as per API response\n\n</td></tr><tr><td>\n\nobject\\_id\n\n</td><td>\n\nthe id of the resource, as per API response\n\n</td></tr><tr><td>\n\ninstall\\_status\n\n</td><td>\n\nthe status of the resource as per the “enabled” value in the API response\n\n</td></tr><tr><td>\n\noperational\\_status\n\n</td><td>\n\nthe status of the resource as per the “operation state” value\n\n</td></tr><tr><td>\n\nserver\\_id\n\n</td><td>\n\nThe UUID used to identify the junction web server\n\n</td></tr><tr><td>\n\nhttp\\_port\n\n</td><td>\n\nHTTP port of the back-end third-party server. Applicable when the junction type is tcp.\n\n</td></tr><tr><td>\n\nservice\\_port\n\n</td><td>\n\nTCP port of the back-end third-party server. Default is 80 for TCP junctions and 443 for SSL junctions\n\n</td></tr><tr><td>\n\nPriority\n\n</td><td>\n\nThe priority of the server \\(1-9\\). Default is 9.\n\n</td></tr></tbody>\n</table><table id=\"table_nxq_dcc_x5b\"><thead><tr><th>\n\nCI\n\n</th><th>\n\nRelationship Type\n\n</th><th>\n\nCI\n\n</th></tr></thead><tbody><tr><td>\n\nWebseal \\[cmdb\\_ci\\_app\\_server\\_webseal\\]\n\n</td><td>\n\nRuns on::Runs\n\n</td><td>\n\nISAM Server \\[cmdb\\_ci\\_isam\\_server\\]\n\n</td></tr><tr><td>\n\nWebseal Reverse Proxy \\[cmdb\\_ci\\_webseal\\_reverse\\_proxy\\]\n\n</td><td>\n\nHosted on::Hosts\n\n Reference\\[load\\_balancer\\]\n\n</td><td>\n\nWebseal \\[cmdb\\_ci\\_app\\_server\\_webseal\\]\n\n</td></tr><tr><td>\n\nWebseal Reverse Proxy \\[cmdb\\_ci\\_webseal\\_reverse\\_proxy\\]\n\n</td><td>\n\nRuns on::Runs\n\n Reference\\[isam\\_server\\]\n\n</td><td>\n\nISAM Server\n\n \\[cmdb\\_ci\\_isam\\_server\\]\n\n</td></tr><tr><td>\n\nWebseal Junction \\[cmdb\\_ci\\_webseal\\_junction\\]\n\n</td><td>\n\nAllocated to::Allocates\n\n Reference \\[service\\]\n\n</td><td>\n\nWebseal Reverse Proxy \\[cmdb\\_ci\\_webseal\\_reverse\\_proxy\\]\n\n</td></tr><tr><td>\n\nWebseal Junction \\[cmdb\\_ci\\_webseal\\_junction\\]\n\n</td><td>\n\nOwns::Owned by\n\n Reference \\[pool\\]\n\n</td><td>\n\nLoad Balancer Pool Member \\[cmdb\\_ci\\_webseal\\_backend\\_server\\]\n\n</td></tr><tr><td>\n\nWebseal Junction \\[cmdb\\_ci\\_webseal\\_junction\\]\n\n</td><td>\n\nReference only \\[load\\_balancer\\]\n\n</td><td>\n\nWebseal \\[cmdb\\_ci\\_app\\_server\\_webseal\\]\n\n</td></tr></tbody>\n</table>**Note:** Currently, the relation between the back-end servers and actual server CIs in the CMDB isn’t possible for HD.\n\n**Parent Topic:**[Available on-premise discovery patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/available-patterns.md)\n\n"}}