Agents Administration - Tests
 

Default Parameters for CtxCdHypTest

This test reports the status of the connection between the cloud delivery controller 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.

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

  • 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. 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.

    • Specify the determined customer ID in the CUSTOMER ID text box.

  • 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 in the SECURE CLIENT FILE PATH text box.

  • Specify the IP address of the proxy server and the port at which the server listens against the PROXY HOST and PROXY PORT textboxes. By default, these parameters are set to none, indicating that the eG agent is not configured to communicate via a proxy, by default.

  • If the eG agent communicates with the Citrix Cloud via a proxy server, and if proxy server requires authentication, then specify valid credentials for authentication against PROXY USERNAME and PROXY PASSWORD. If no proxy server is used or if the proxy server used does not require authentication, then set the PROXY USERNAME and PROXY PASSWORD to none.

  • Confirm the PROXY PASSWORD by retyping it in CONFIRM PASSWORD textbox.

  • By default, the PROXY SSL is disabled. Accordingly, the PROXY SSL flag is set to No by default.

  • Once the necessary values have been provided, clicking on the UPDATE button will 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.