Agents Administration - Tests
 

Configuration of CtxCdZoneTest

By executing this test at regular intervals, administrators can be promptly alerted if a controller in primary zone fails over to another controller in the same zone. Additionally, this test also scans each zone configured in a site and reports the number of controllers, delivery groups, and machine catalogs in that zone.

The default parameters associated with this test are:

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

  • Specify the host for which the test is to be configured in the HOST text box.

  • Indicate the port at which the host listens to in the PORT text box.

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

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

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

  • If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

  • Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of "none" in the parameter value indicates that the corresponding parameter value can be changed if required.