Agents Administration - Tests
 

Default Parameters for CtxCdXDConTest

This test connects to the Citrix Cloud service via an API client and in the process, reports the following:

  • Whether/not the cloud service is available;

  • How quickly is the cloud responding to requests.

This way, the test points administrators to issues in connecting to the cloud.

This page depicts the default parameters that need to be configured for the CtxCdXDConTest test.

  • The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

  • 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. This customer ID should be specified agaisnt the CUSTOMER ID parameter. 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 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 is the customer ID you need to configure the eG tests with.

  • 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 specify the full path to the secureclient.asv in the SECURE CLIENT FILE PATH text box.

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

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

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

    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.

  • Once the above values are provided, click on the UPDATE button to register the changes made.

When changing default configurations of tests, the values with “$” indicate variables that will be replaced by the eG system according to the specific server being managed - for instance, $hostName is the host/nickname of the target host, $port is the port number of the server being monitored. E.g., for a server xyz:80, $hostName will be changed automatically by the eG manager to “xyz*” and $port will be changed to “80” when configuring a test.