Agents Administration - Tests
 

Default Parameters for CtxCdFMachTest

The CtxCdUserTest test monitors the user logon process from a delivery group perspective; in other words, it monitors user logins to the desktops/applications in a delivery group, measures the ‘aggregate’ duration of the login across all users to that group, and thus points to bottlenecks in the user logon process to that group.

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

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

  • In the HOST text box, specify the IP address of the host for which this test is to be configured.

  • 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 as the customer parameter” in the right panel. The displayed within that phrase (as highlighted in Figure 1) 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 configure this test with the full path to the secureclient.csv.here.

  • By default, this flag is set to Yes indicating that the individual descriptors of this test - i.e., the delivery groups- are classified based on their machine type; in other words, the delivery groups will be listed either under Server OS Machines or Desktop OS Machines based on their machine type. If you do not want to group the delivery groups based on their machine types, set this flag to No.

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

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

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

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

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