Default Parameters for CtxCdDGTest

With the help of this test, you can determine the maintenance mode of each delivery group managed by the monitored cloud delivery controller, and track the usage of desktops within each group. Unregistered desktops, CPU-intensive desktops, disconnected desktops, and desktops available to users, which are managed by this controller, can thus be quickly and accurately isolated.

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

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

• By default, the REPORT BY MACHINE TYPE flag is set to Yes indicating that the individual descriptors of this test - i.e., the catalogs - are classified based on their machine type; in other words, the catalogs 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 catalogs based on their machine types, set this flag to No.

• By default, the SHOW TOTAL MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Total_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of all machines that are part of a delivery group, as part of detailed diagnostics.

• By default, the SHOW AVAILABLE MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for the Available_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of all machines that are currently available in each delivery group managed by the Cloud Delivery Controller.

• By default, the SHOW HIGH LATENCY MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the High_latency_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the high latency machines in a delivery group.

• By default, the SHOW HIGH CPU MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the High_profile_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details those machines in the group that are taking too long to load profiles.

• By default, the SHOW AGENT ERROR STATE MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Agent_error_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in the agent error state.

• By default, the SHOW DISK IMAGE OUT OF DATE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Pending_update_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group for which the disk image is out-dated.

• By default, the SHOW USED MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Used_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in use presently.

• By default, the SHOW SUSPENDED MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for the Suspended_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in a suspended power state.

• By default, the SHOW POWEREDOFF MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Poweredoff_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are currently powered off.

• By default, the SHOW UNKNOWN POWER STATE MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with unknown power state measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in an unknown power state.

• By default, the SHOW PENDING POWER ACTION DD flag is set to No. This implies that by default, detailed metrics will not be available for the Power_pending_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that have pending power actions.

• By default, the SHOW MACHINES UNDER MAINTENANCE DD flag is set to No. This implies that by default, detailed metrics will not be available for the Maintenance_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that have pending power actions.

• By default, the SHOW REGISTERED MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for Registered_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines (in each delivery group) that are currently registered with the broker being monitored.

• By default, the SHOW POWERED ON MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for Poweredon_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the powered on machines in each delivery group that is managed by the broker.

• By default, the SHOW CONNECTION FAILED MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for Last_con_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

• By default, the SHOW DEREGISTERED MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for last_dereg_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the deregistered machines in the group.

• By default, the SHOW UNREGISTERED MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for Unregistered measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines in the group that are not registered with the target controller.

• By default, the SHOW MACHINES WITH ERROR DD flag is set to No. This implies that by default, detailed metrics will not be available for last_error_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

• By default, the SHOW DISCONNECTED MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for Disonnected_desktops measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

• By default, the SHOW ESTABLISHED SESSION DD flag is set to No. This implies that by default, detailed metrics will not be available for Established_session measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

• By default, the SHOW PENDING SESSION DD flag is set to No. This implies that by default, detailed metrics will not be available for Pending_session measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the pending sessions.

• By default, the SHOW PHYSICAL MACHINE DD flag is set to No. This implies that by default, detailed metrics will not be available for Physical_machine measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the physical machines in the group.

• By default, the SHOW ENTITLED MACHINES DD flag is set to No. This implies that by default, detailed metrics will not be available for Assigned_machine measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the entitled machines in the group.

• By default, the SHOW MACHINES NOT ENTITLED DD flag is set to No. This implies that by default, detailed metrics will not be available for Unassigned_machine measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines in the group that are not entitled.

• In some environments, a few machines in the delivery groups may not be logged in by any user for long period of time. Even if users are not logged on, the machines continued to consume resources unnecessarily leading to resource wastage. The resources used by those machines cannot be released or allocated to other machines until the resources are properly released. Therefore, it is necessary for administrators to identify the machines that are not used for long period of time. To achieve this, administrators can use the Unused Machines In Days parameter. Administrators can specify the number of days against this parameter beyond which this test should count the machines as “unused’. By default, this parameter is set to 30 days. However, administrators can override this default value depending upon their need.

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

• The DD FREQUENCY refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD FREQUENCY.

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