Horizon Cloud API Access Test

Horizon Cloud API access allows users and organizations to interact programmatically with Horizon Cloud environments. Using API, users can automate and manage various aspects of their Horizon Cloud environment, including provisioning, monitoring, and configuration.

This test measures the responsiveness of the API to requests from the eG agent. In the process, the test brings to focus bottlenecks in the functioning of the API by revealing the response code returned. If the eG agent is unable to pull metrics from Omnissa Horizon Cloud Control Plane or is experiencing some delay in the process, then these metrics will help you explain why - is the cloud service accessible through the API? or is it owing to the poor responsiveness of the API?

Target of the test : Omnissa Horizon Cloud Control Plane

Agent deploying this test : A remote agent

Outputs of the test :One set of results for the target Omnissa Horizon Cloud Control Plane being monitored.

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed.
Host	The host for which the test is to be configured.
Port	The port to which the specified host listens.
API Token	The API token acts as a temporary credential that validates the identity of the client making the API request. After the client successfully authenticates using the API Client ID and Client Secret, the system issues an API token. Specify the API token value that was generated using the Omnissa Connect console. To know how to generate the API token in Omnissa Connect console, refer to Creating a new API token in Omnissa Connect console topic in How Does eG Enterprise Monitor Omnissa Horizon Cloud Control Plane?.
ProxyHost and ProxyPort	In some environments, all communication with the Omnissa Horizon Cloud Control Plane be routed through a proxy server. In such environments, you should make sure that the eG agent connects to the Omnissa Horizon Cloud Control Plane via the proxy server and collects metrics. To enable metrics collection via a proxy, specify the IP address of the proxy server and the port at which the server listens against the ProxyHost and ProxyPort parameters. By default, these parameters are set to none, indicating that the eG agent is not configured to communicate via a proxy, by default.
ProxyUsername, ProxyPassword, Confirm Password	If the proxy server requires authentication, then, specify a valid proxy user name and password in the Proxy Username and Proxy Password parameters, respectively. Then, confirm the password by retyping it in the Confirm Password text box. If no proxy server is used, or if the proxy server used does not require authentication, then the default setting - none - of these parameters, need not be changed.
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

API availability

Indicates the availability of Horizon Cloud API.

Percent

If the value of this measure is 100, it indicates that the API is available. The value 0 on the other hand denotes that the API is unavailable.

The detailed diagnosis for this measure shows the error message details.

Response time

Indicates the time taken by the API to respond to the requests.

Secs

If the value of this measure consistently increases, it indicates that the performance of the API is gradually deteriorating. Ideally, the value of this measure should be low.

Response code

Indicates the response code returned by the request.

The possible values for this measure and what they represent are detailed in the table below:

Measure Value	Description
200	The API request was successful and received a response.
201	The API request was successful and created an object.
400	The API request was malformed and could not be processed.
401	You have no access and/or are not authorized.
403	You are authorized but do not have the privileges for this API.
404	The URL was not found
405	The called method is not allowed or is not supported
408	The request timed out (20 seconds maximum).
500	The API request was received but there was a server error.
503	Service unavailable at this time or too early to process.
508	HTTP other than 1.1 not supported.

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the response code returned by the request. The graph of this measure however, is represented using the numeric equivalents only.