Hypervisor Details - Cloud Test

This test reports the status of the connection between the cloud delivery controller in the target Site and each server that hosts the machines. In the absence of a healthy connection between the two, the controller may not be able to provision machines on-demand.

If users complaint of any delay in the servicing of their machine requests, you may want to use this test to check the connection status between the controller and the server hosting that machine, so that connection errors (if any) can be promptly detected.

Target of the test : Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each hypervisor with which the target Site communicates.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The IP address of the host for which this test is to be configured.

Port

Refers to the port at which the specified host listens to. By default, this is 80.

Customer ID

When configuring the Citrix Cloud service, you should have created an API client on the cloud, so that any external program can communicate with the cloud. This API client is tied to a customer ID. The Citrix Cloud API requires this customer ID, when calling REST APIs. To get the customer ID for the API client that you have created in your environment, do the following:

  • Sign in to the Citrix Cloud administrator console.
  • Click the “hamburger menu” in the upper left corner of the console.

  • Select “Identity and Access Management” from the drop-down menu. An API Access page (see Figure 1 ) will open in the right panel. Look for the phrase , "use <customerID> as the customer parameter" in the right panel. The <customerID> displayed within that phrase (as highlighted in Figure 1) is the customer ID you need to configure the eG tests with.

    Figure 1 : Customer ID mapped to the API client

Secure Client File Path

When creating the API client on the cloud, you will be provided with an ID and a Secret for your client. Downloading this information saves a file named secureclient.csv. The eG agent uses the ID and Secret stored in this file to connect to the Citrix Cloud API. This is why, you will have to configure this test with the full path to the secureclient.csv.here.

Note:

Before specifying the path of the secureclient.csv file, make sure that the file is downloaded by a valid Citrix cloud user with rights to access the cloud and pull metrics on critical cloud components. To know why such a user is needed and how to create this user on the cloud, refer to theHow Does eG Enterprise Monitor the Citrix Cloud Site?topic

Proxy Host

If the eG agent communicates with the Citrix Cloud via a proxy, then specify the IP address/fully-qualified host name of the proxy server here. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.

Proxy Port

If the eG agent communicates with the Citrix Cloud via a proxy, then specify the port at which the proxy server listens for requests from the eG agent. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.

Region Endpoint

By default, US is chosen from this list indicating that this test will report metrics for those organizations whose users and resources are located in the United States region. Sometimes, the eG agent may collect the required metrics with a minor time delay due to the users and resources being monitored are in a different region. To avoid such time delays and to ensure end-user proximity and offer the best user experience, administrators are allowed to change the region based on where most of the users and resources are located. For instance, if the users and resources are located in the Asia-Pacific South region or approximately nearer to the Asia-Pacific South region, then, administrators need to choose 'AP-S' from this list. However, from this list, administrators are required to choose only the region that they had chosen when they signed in for the first time after onboarding their organization to the target Citrix Cloud.

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

State of controller’s connection to hypervisor

Indicates the status of the connection between the controller and this hosting server.

 

This test reports one of the following values to indicate the status of the connection between the controller and a hosting server:

  • On
  • InMaintenanceMode
  • Unavailable

The numeric values that correspond to the above-mentioned states are as follows:

State Numeric Value Description
On 1 Indicates that the controller is in contact with the hypervisor
InMaintenanceMode 2 Indicates that the hosting server (e.g., XenServer, Hyper-V) through which machines are managed, is under maintenance
Unavailable 3 Indicates that the controller is unable to contact the hypervisor

Note:

By default, this measure reports the above-mentioned States while indicating the connection status of the controller and the hypervisor. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents - 1 to 3 only.

The detailed diagnosis capability of this measure if enabled, reveals the connection name, connection type, Hypervisor address, the preferred controller, the zone to which the controller belongs, and the user who is accessing the hypervisor.

Is controller’s connection to hypervisor in maintenance mode?

Indicates whether the connection between the controller and the hosting server is in maintenance mode.

 

This measure reports a value Yes if the connection between the controller and the hosting server is in maintenance mode and No if otherwise.

The numeric values corresponding to the above-mentioned measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the connection between the controller and the hosting server is in maintenance mode. However, the graph of this measure will be represented using the corresponding numeric equivalents i.e., 0 or 1 only.

Is controller’s connection to hypervisor in persistent?

Indicates whether/not the connection is persistent between the controller and the hosting server.

 

This measure reports a value Yes if the connection between the controller and the hosting server is persistent and No if otherwise.

The numeric values corresponding to the above-mentioned measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the connection between the controller and the hosting server is persistent. However, the graph of this measure will be represented using the corresponding numeric equivalents i.e., 0 or 1 only.

Is local storage caching enabled?

Indicates whether the local storage caching is enabled or not.

 

This measure reports a value Yes if the local storage caching capability is enabled and No if otherwise.

The numeric values corresponding to the above-mentioned measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the local storage caching capability is enabled. However, the graph of this measure will be represented using the corresponding numeric equivalents i.e., 0 or 1 only.

Is provisioning service used to create VMs?

Indicates whether/not the provisioning service is used to create provisioned machines.

 

This measure reports a value Yes if the provisioning service is used to create provisioned machines and No if otherwise.

The numeric values corresponding to the above-mentioned measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the provisioning service is used to create provisioned machines. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents i.e., 0 or 1 only.

Is hypervisor connection in ready state?

Indicates whether/not this connection between the hosting server and the delivery controller is ready.

  

The numeric values corresponding to the above-mentioned measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the connection is ready between the hosting server and the delivery controller. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents only.

Machines associated with this hypervisor connection

Indicates the number of machines associated with the connection between the hosting server and the delivery controller.

Number

  

The detailed diagnosis of the State of the controller’s connection to Hypervisor measure reveals the connection name, connection type, Hypervisor address, the preferred controller, the zone to which the controller belongs, and the user who is accessing the hypervisor.

Figure 2 : The detailed diagnosis of the State of the controller’s connection to hypervisor measure