Agents Administration - Tests
 

Default Parameters for CtxCdLoadIdxTest

Administrators can use this test to periodically evaluate the load on the servers managed by a delivery group. This is imperative to ensure that load is uniformly balanced across the servers. In addition, in times of an overload, this test can help administrators accurately identify which server is overloaded and which resource is the constraint.

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

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

  • By default, the REPORT BY DELIVERY GROUP flag is set to Yes indicating that this test reports metrics for each delivery group that contains machines running a particular server OS. The delivery group-level insight into the load evaluator index enables administrators to gauge the overall load on every delivery group. If required, you can change the status of this flag to No; in this case, this test will report metrics for every server OS machine in a delivery group. The machine-level insight into load enables administrators to understand whether/not load is uniformly balanced across the different server OS machines, and accurately identify the machine that is overloaded.

  • 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 in the PROXY HOST text box. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.

  • If the eG agent communicates with the Citrix Cloud via a proxy, then specify the port in the PROXY PORT text box, 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.

  • By default, US is chosen from REGION ENDPOINT 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.

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