Controller Service Details - Cloud Test

This test auto-discovers the critical services executing on the Citrix Cloud Delivery Controller, and reports the status of each service. With the help of this test, you can promptly detect which services have failed currently.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the monitored Site.

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.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Broker service status

Indicates the current status of the broker service.

The Citrix Broker Service brokers connections from endpoint devices to desktops and applications.

The numeric values that correspond to the Measure Values that this measure can take are as follows:

Measure Value Numeric Value
OK 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
Electroencephalographic 5
DBOlderVersionThanService 6
DBVersionChangeInProgress 7
PendingFailure 8
Failed 9
Unknown 10
DBNotFound 11
DBMissingOptionalFeature 12
DBMissingMandatoryFeature 13

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current state of the broker service. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents – i.e., 1 to 13.

Configuration service status

Indicates the current status of the Configuration Service.

The Citrix Configuration Service stores the configuration information related to Citrix services in the broker’s MS SQL database.

The values that this measure can report and their corresponding numeric values are as follows:

Measure Value Numeric Value
OK 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNotFound 5
DBNewerVersionThanService 6
DBOlderVersionThanService 7
DBVersionChangeInProgress 8
Failed 9
Unknown 10

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current status of the Configuration service. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents – i.e., 1 to 10.