Gateway Server Health Test

In an Omnissa Horizon environment, Omnissa Horizon Unified Access Gateway (UAG) server within an Omnissa Horizon Cluster/Pod often serves as a secure gateway for external connections and facilitates access to virtual desktops and applications from outside the corporate network. This ensures that the connections are safe, efficient and controlled at all times. When the UAG is stalled or is unresponsive, users accessing the virtual desktops or applications through UAG may experience connectivity issues and further more, when they try to reconnect to their virtual desktops/applications, they may experience authentication failures. This may directly affect the productivity of the users, leads to frustrated users and hence impact the user experience. Therefore, it is essential to keep track on the status of the UAG and proactively identify if the UAG is stalled. The Gateway Server Health test helps administrators in this regard!

This test auto-discovers each Omnissa Horizon Unified Access Gateway (UAG) server configured on the target Omnissa Horizon Cluster/Pod and for each UAG, reports the current status. This test also throws light of whether the UAG is an internal gateway server or if the UAG is stalled. This test further reveals if the UAG has contacted the Omnissa Horizon Connection server for connections.

Target of the test : An Omnissa Horizon Cluster/Pod

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each Omnissa Horizon Unified Access Gateway server configured on the Omnissa Horizon Cluster/Pod being monitored

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed.
Host	The host for which the test is to be configured.
Port	Refers to the port used by the target Omnissa Horizon Cluster/Pod. By default, this is set to NULL.
Connection Server Name	By default, this test connects to every Horizon Connection Server configured in the Omnissa Horizon Cluster/Pod remotely and collects the required metrics. For this, it is necessary to specify valid credentials of the Horizon Connection Servers. To help administrators provide these credentials quickly and easily, the eG administrative interface embeds a special configuration page. To access this page, simply click on the encircled '+' icon that appears alongside this parameter in the test configuration page. To know how to use this special page, refer to Configuring the Omnissa Horizon Connection Servers for Monitoring.
User Name, Password and Confirm Password	By default, this test uses Omnissa Restful APIs to collect the required metrics from the target Omnissa Horizon Cluster/Pod. For this, the eG agent should be configured with read-only user privileges that will allow the agent to communicate with the Horizon Connection Server in a particular domain and extract statistics. Therefore, specify the credentials of the user who is authorized to access the Horizon Connection Server against the User Name, Password and Confirm Password text boxes.
Domain Name	Specify the name of the domain to which the Horizon Connection Server belongs to.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Status

Indicates the current status of this gateway server.

The values that this measure can take and its corresponding numeric values are discussed in the table below:

Measure Value	Numeric Value
OK	1
Not ok	0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate the current status of this gateway server. However, the graph of this measure will represent the same using the numeric equivalents only i.e., 0 or 1.

The detailed diagnosis of this measure lists the IP address of the Horizon Unified Access Gateway server.

Is gateway internal?

Indicates whether/not this gateway server is an internal gateway.

The Unified Access Gateway (UAG) is classified as an internal server since the server provides access to external clients, and operates within the internal network's architecture and security framework. The primary function of the server is to secure and manage external connections to internal Horizon resources, making it an integral part of the internal infrastructure bridging external and internal network components.

The values that this measure can take and its corresponding numeric values are discussed in the table below:

Measure Value	Numeric Value
Yes	1
No	0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate whether/not this gateway server is an internal gateway. However, the graph of this measure will represent the same using the numeric equivalents only i.e., 0 or 1.

Is gateway stalled?

Indicates whether/not this gateway server is stalled.

The values that this measure can take and its corresponding numeric values are discussed in the table below:

Measure Value	Numeric Value
Yes	1
No	0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate the whether/not this gateway server is stalled. However, the graph of this measure will represent the same using the numeric equivalents only i.e., 0 or 1.

Has the gateway contacted the connection server?

Indicates whether/not this gateway server has contacted the connection server configured on the target Horizon Cluster/Pod.

The values that this measure can take and its corresponding numeric values are discussed in the table below:

Measure Value	Numeric Value
Yes	1
No	0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate whether/not this gateway server has contacted the connection server. However, the graph of this measure will represent the same using the numeric equivalents only i.e., 0 or 1.