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, Proxy Port, Proxy User Name, Proxy Password, and Proxy SSL

These parameters are applicable only if the Citrix Cloud Connector communicates with the Citrix Cloud via a Proxy server.

If the Proxy server requires authentication, then specify the credentials of a valid Proxy user against the Proxy User Name and Proxy Password text boxes. Confirm that password by retyping it in the Confirm Password text box. If the Proxy server does not require authentication, then specify none against the Proxy User Name, Proxy Password, and Confirm Password text boxes.

By default, the Proxy SSL flag is set to No. If the specified proxy server is SSL-enabled, then set the Proxy SSL flag to Yes

On the other hand, if the Citrix Cloud Connector is not using a Proxy server to communicate with the Citrix Cloud, then you need not disturb the default setting of any of the Proxy-related parameters. By default, these parameters are set to none.

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