Desktop OS Machines Test

Citrix Virtual Desktop supports two types of Delivery Agents: one for Windows Server OS machines and one for Windows Desktop OS machines. Desktop OS Machines are VMs or physical machines based on the Windows Desktop operating system used for delivering personalized desktops to users, or applications from desktop operating systems.

Delivery groups consist of virtual desktops and applications that are pooled, pre-assigned, or assigned on first use. Each group can contain only one type of desktop or application. To track the status of desktop OS machines in each delivery group configured in a site, use the Desktop OS Machines - Cloud test.

Target of the test : A Citrix Cloud Control Plane

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each delivery group containing desktop OS machines

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the host for which this test is to be configured.
Port	Refers to the port at which the specified host listens to. By default, this is 80.
Customer ID	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 determine the customer ID that is mapped to the API client you created, refer to Determining the Customer ID Mapped to an API Client.
Secure Client File Path	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 the Citrix Cloud Connectivity test with the full path to the secureclient.csv. Note: Before specifying the path of the secureclient.csv file, make sure that the API client is created and this file downloaded by a valid Citrix cloud user with Read-only administrator rights to virtual apps/desktops. To know how to create this user on the cloud, refer to theCreating a New Citrix Cloud User for Monitoring PurposestopicTo know how this user can create an API client on the cloud, refer to Creating API Client on the Citrix Cloud.
Region Endpoint	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.
Show Total Machines DD	By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Total machines 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.
Show PoweredOff Machine DD	By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Powered off machines 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.
Proxy Host and Proxy Port	If the Citrix Cloud Connector communicates with the Citrix Cloud via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Citrix cloud without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against Proxy Host. Specify the port at which the proxy server listens for requests from the eG agent, against Proxy Port. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy. Note: Before configuring these test parameters, make sure that the proxy server settings are imported to the eG agent side from the connector. To know how to achieve this, refer to Configuring the eG Agent with Proxy Server Settings. To know what values you should configure these parameters with, do the following: Login to the system hosting the Citrix Cloud Connector being monitored. Open the Internet Explorer browser on that system, and click on the icon provided at the right corner of that browser. Clicking the icon will invoke a menu. Choose Internet Optionsfrom the menu. Then, select the Connections tab in the Internet Options window that appears. Now, click the LAN Settings button. This will open the Local Area Network (LAN) Settings window. In the Proxy Server section of this window, you will find that the Use a proxy server for your LAN check box is enabled. Configure the Proxy Host and Proxy Port parameters with the IP address and port numbers displayed in the Address and Port text boxes (respectively) under that check box. If the Use a proxy server for your LAN check box is not enabled, then it means that the connector is not communicating with the cloud via a proxy. In this case, you need not change the default configuration for these parameters.
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.
Detailed Diagnosis	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.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Total machines	Indicates the total number of machines in this group.	Number	Use the detailed diagnosis of this measure to know which desktop OS machines are part of a delivery group.
Preparing machines	Indicates the number of machines in this group that are currently preparing sessions for users.	Number
Pending image update machines	Indicates the number of machines managed by this delivery group to which updates are currently pending.	Number	Use the detailed diagnosis of this measure to know which machines are awaiting updates. Note that the value of this measure excludes the count of machines that are in maintenance mode while counting the machines in other states for the status of image update.
Maintenance mode enabled machines	Indicates the number of machines in this group for which maintenance mode has been enabled.	Number
Powered on machines	Indicates the number of machines in this desktop group that are currently powered on.	Number	Use the detailed diagnosis of this measure to know which machines are currently powered on.
Machines with suspended power state	Indicates the number of machines in this delivery group that are currently in the Suspended state.	Number	Use the detailed diagnosis of this measure to know which machines are currently in the Suspended state.
Powered off machines	Indicates the number of machines in this delivery group that are currently powered off.	Number	Use the detailed diagnosis of this measure to know which machines are currently in the powered off.
Machines with unknown power state	Indicates the number of machines in the following power states: Unavailable Unmanaged Unknown	Number	A low value is desired for this measure. The detailed diagnosis of this measure will reveal the complete details of the unavailable machines, such as, the machine name, IP address, the machine type, the delivery group and catalog to which the machine belongs, the hosting server on which the machine operates, the name of the hypervisor and the controller on which the machine operates, the user who is active on the session, the location at which the changes made by the user is stored, the provision type of the machine, and the application published on the machine, if the machine is a Virtual Apps server.
Assigned machines	Indicates the number of machines that are assigned to users in this delivery group.	Number	Use the detailed diagnosis of this measure to know which machines are assigned to users.
Unassigned machines	Indicates the number of machines in this delivery group that are not assigned to users.	Number	Use the detailed diagnosis of this measure to know which machines are not assigned to users.
Resuming machines	Indicates the number of machines in this group that are in the Resume state currently.	Number	Use the detailed diagnosis of this measure to know which machines are in the Resume state.
Total sessions	Indicates the total number of user sessions to this delivery group.	Number
Percentage of assigned machines	Indicates the percentage of machines that are assigned to users in this delivery group.	Percent
Desktop utilization	Indicates the percentage of desktops in this delivery group to which users are currently logged in.	Percent	A value close to 100% indicates that almost all desktops in the group are in use. Under such circumstances, you may want to add more desktops to the group to meet with the demand for desktops.
Unregistered machines	Indicates the number of machines that are configured in this delivery group but are in an unregistered state.	Number	If a machine is in an unregistered state, it means that registration has not successfully completed for that machine. The value 0 is hence desired for this measure. In case the measure reports a non-zero value, you may want to enable the detailed diagnosis for this measure, so that you can view which machines in the group are unregistered.
Percentage of unregistered machines	Indicates the percentage of machines that are configured in this delivery group but are in an unregistered state.	Percentage	A low value is desired for this measure.
Percentage of maintenance mode enabled machines	Indicates the percentage of machines in this group for which maintenance mode has been enabled.	Percentage