Controller Details - Cloud Test

Controllers are server machines running instances of the delivery controller service. The delivery controller service is responsible for the delivery controllering of user sessions to desktops or applications, and for power management of the underlying machines. An operational site must contain at least one Controller.

This test auto-discovers the Delivery Controllers configured within a Citrix Cloud Site, and reports the current status of each controller and the count of machines registered with every controller.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each delivery controller operating in the Citrix cloud.

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.

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 the below figure) 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.

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

Controller state

Indicates the current state of this cloud delivery controller.

 

This test reports one of the following values to indicate the current state of a cloud delivery controller:

  • Active – Indicates that the delivery controller is powered-on and fully operational
  • On – Indicates that the delivery controller is powered-on, but not fully operational
  • Failed – Indicates that the delivery controller has failed due to some reason
  • Off – Indicates that the delivery controller is powered-off

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

State Numeric Value
Active 1
On 2
Failed 3
Off 4

Note:

By default, this measure reports the above-mentioned States while indicating the current state of a delivery controller. However, the graph of this measure will represent states using the corresponding numeric equivalents – i.e., 1 to 4.

The detailed diagnosis of this measure reveals when the controller was last accessed, when it was last started, the zone to which the controller belongs, and also displays the site services that were active on the controller during its last access.

Total registered machines

Indicates the number of machines that are currently registered with this delivery controller.

Number

Use the detailed diagnosis of the Controller state measure to know when the controller was last accessed, when it was last started, the zone to which the controller belongs, and the site services that were active on the controller during its last access.

Figure 2 : The detailed diagnosis of the Controller state measure