ca unified infrastructure management xendesktop...

xendesktop Guide v2.1 series

CA Unified Infrastructure Management

Copyright Notice

This online help system (the "System") is for your informational purposes only and is subject to change or withdrawal by CA at any time.

This System may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This System is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. This System may not be disclosed by you or used for any purpose other than as may be permitted in a separate agreement between you and CA governing your use of the CA software to which the System relates (the “CA Software”). Such agreement is not modified in any way by the terms of this notice.

Notwithstanding the foregoing, if you are a licensed user of the CA Software you may make one copy of the System for internal use by you and your employees, provided that all CA copyright notices and legends are affixed to the reproduced copy.

The right to make a copy of the System is limited to the period during which the license for the CA Software remains in full force and effect. Should the license terminate for any reason, it shall be your responsibility to certify in writing to CA that all copies and partial copies of the System have been destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS SYSTEM “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SYSTEM, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The manufacturer of this System is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

Copyright © 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Legal information on third-party and public domain software used in this product is documented in the Third-Party Licenses and Terms of Use (http://docs.nimsoft.com/prodhelp/en_US/Library/Legal.html).

http://docs.nimsoft.com/prodhelp/en_US/Library/Legal.html

Contact CA

Contact CA Support

For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

■ Online and telephone contact information for technical assistance and customer services

■ Information about user communities and forums

■ Product and documentation downloads

■ CA Support policies and guidelines

■ Other helpful resources appropriate for your product

Providing Feedback about Product Documentation

Send comments or questions about CA Technologies product documentation to [email protected].

To provide feedback about general CA Technologies product documentation, complete our short customer survey which is available on the support website at http://ca.com/docs.

http://www.ca.com/support

mailto:[email protected]

http://ca.com/docs

Contents 5

Contents

Chapter 1: xendesktop 2.1 7

Overview of xendesktop .............................................................................................................................................. 7

Overview of xendesktop .............................................................................................................................................. 7

Chapter 2: xendesktop Probe Deployment 9

Requirements for xendesktop ...................................................................................................................................... 9

Prerequisites for xendesktop ................................................................................................................................ 9

Hardware Requirements for xendesktop .............................................................................................................. 9

Software Requirements for xendesktop ............................................................................................................. 10

Supported Platforms ........................................................................................................................................... 10

Deployment Information for xendesktop Probe ........................................................................................................ 10

Chapter 3: Configuration for xendesktop 11

Probe Configuration Interface Installation for xendesktop ....................................................................................... 11

Monitoring Capabilities of xendesktop ...................................................................................................................... 12

Templates for xendesktop .......................................................................................................................................... 12

xendesktop Probe GUI ............................................................................................................................................... 12

Configuration Interface Navigation for xendesktop............................................................................................ 13

The Toolbar Buttons for xendesktop .................................................................................................................. 13

The Navigation (Left) Pane for xendesktop ......................................................................................................... 13

The Content (Right) Pane for xendesktop .......................................................................................................... 15

Configuration for xendesktop .................................................................................................................................... 16

Connecting to the XenDesktop Environment ...................................................................................................... 16

General Setup for xendesktop Probe .................................................................................................................. 26

Create a New Resource for xendesktop .............................................................................................................. 26

Message Pool Manager for xendesktop .............................................................................................................. 28

Create New Template for xendesktop ................................................................................................................ 29

Advanced Configuration for xendesktop ............................................................................................................ 30

Chapter 4: Adding Monitors to xendesktop 33

Manually Selecting Monitors to be Measured by xendesktop ........................................................................... 33

Using Templates for xendesktop......................................................................................................................... 36

Using Automatic Configurations for xendesktop ................................................................................................ 37

6 xendesktop Guide

Appendix A: Troubleshooting for xendesktop Probe 41

xendesktop Probe is Not Collecting Data ................................................................................................................... 42

xendesktop Probe Out of Memory Errors .................................................................................................................. 42

xendesktop Probe Delays in Fetching Site Data ......................................................................................................... 43

xendesktop Probe Not Fetching HealthInfo Metrics even when WinRM Enabled .................................................... 43

xendesktop Probe Known Issues ................................................................................................................................ 44

Chapter 5: xendesktop Probe Metrics 45

xendesktop Administrator Node Metrics ................................................................................................................... 45

xendesktop Broker Session Node Metrics.................................................................................................................. 46

xendesktop Broker Service Instance Node Metrics ................................................................................................... 49

xendesktop Catalog Node Metrics ............................................................................................................................. 50

xendesktop Controller Node Metrics ......................................................................................................................... 52

xendesktop Desktop Node Metrics ............................................................................................................................ 52

xendesktop Desktop Group Node Metrics ................................................................................................................. 59

xendesktop HealthInfo Node Metrics ........................................................................................................................ 63

xendesktop Hypervisor Node Metrics ........................................................................................................................ 64

xendesktop License Server Node Metrics .................................................................................................................. 64

xendesktop Machine Node Metrics ........................................................................................................................... 65

xendesktop Resource Node Metrics .......................................................................................................................... 73

xendesktop Services Node Metrics ............................................................................................................................ 74

xendesktop Site Node Metrics ................................................................................................................................... 75

Chapter 1: xendesktop 2.1 7

Chapter 1: xendesktop 2.1

This description applies to the xendesktop probe version 2.1.

This section contains the following topics:

Overview of xendesktop (see page 7) Overview of xendesktop (see page 7)

Overview of xendesktop

The CA Unified Infrastructure ManagementXenDesktop Monitoring probe automates all common monitoring and data collection tasks in the Citrix XenDesktop virtual desktop environment.

The xendesktop probe collects and stores data about desktop groups, desktop catalogs, and the hypervisor hosts and virtual machines that power the desktop, along with their relationships. Within a XenDesktop environment you can monitor multiple desktop delivery controllers (DDCs). This can be either multiple DDCs that you have access permissions for or multiple DDCs with a common access in a high availability configuration.

The probe collects QoS metrics for real-time status and for display in charts, dashboards, and historical reports. You can define alarms to be issued and propagated to the Alarm Console when specified thresholds are breached.


This table describes the version history for this document.

Version Date What's New?

2.1 July 2014 GA

Updated metrics table, added optional Kerberos authentication.

2.0 Beta September 2013

Updated documentation to reflect monitoring of clustered XenDesktop environments and support for additional virtual desktop and usage metrics.


8 xendesktop Guide

1.0 December 2012 Initial Release

Note: Serial releases within a version do not affect the documentation for the series. For example, v1.0 documentation would apply to release 1.01.

Related Documentation

Documentation for other versions of the xendesktop probe

The Release Notes for the xendesktop probe

Monitor Metrics Reference Information for CA Unified Infrastructure Management Probes (http://docs.nimsoft.com/prodhelp/en_US/Probes/ProbeReference/index.htm)

http://docs.nimsoft.com/prodhelp/en_US/Probes/AdminConsole/xendesktop/ReleaseNotes/index.htm

http://docs.nimsoft.com/prodhelp/en_US/Probes/ProbeReference/index.htm

Chapter 2: xendesktop Probe Deployment 9

Chapter 2: xendesktop Probe Deployment

This section contains information about deploying the XenDesktop Monitoring probe.


Requirements for xendesktop (see page 9) Deployment Information for xendesktop Probe (see page 10)

Requirements for xendesktop

This section describes prerequisites, hardware requirements, and software requirements for the XenDesktop Monitoring probe.

Prerequisites for xendesktop

This section describes the prerequisites for this probe:

■ XenDesktop version 5.6 or later environment.

■ Windows PowerShell command line interface on the XenDesktop Delivery Controller (DDC) server. The latest version of PowerShell that comes with Windows Server 2008R2 or later is required. For information on configuring PowerShell for use with the XenDesktop Monitoring probe, see the XenDesktop Monitoring Guide.

■ Windows Remote Management (WinRM) enabled on the DDC server. For instructions on enabling WinRM, see the xendesktop Guide.

Hardware Requirements for xendesktop

The XenDesktop Monitoring probe should be installed on a system with the following minimum resources:

■ Memory: 2-4 GB of RAM

■ CPU: 3 GHz dual-core processor, 32-bit or 64-bit

Deployment Information for xendesktop Probe

10 xendesktop Guide

Software Requirements for xendesktop

The xendesktop probe requires the following software environment:

■ CA Unified Infrastructure Management Server 5.1.1 or later

■ CA Unified Infrastructure Management Robot 5.23 or later

■ Java Virtual Machine 1.6 or later (typically installed with CA Unified Infrastructure Management server 5.0 and later)

■ Infrastructure Manager 4.02 or later

■ Microsoft .NET Framework 3.5 on the system where the Infrastructure Manager application is running

Important!: On 64-bit Linux systems, the Java jre included in the xendesktop probe package does not install successfully when you deploy the xendesktop probe on a CA Nimsoft robot. You must manually install the glibc.i686 library or compatible 32-bit libraries on 64-bit Linux systems where you deploy the xendesktop probe.

Supported Platforms

Refer to the Compatibility Support Matrix for the latest information about supported platforms. See also the Support Matrix for Probes for more specific information about the probe.

Deployment Information for xendesktop Probe

There are two ways to distribute the probe archive packages. You can distribute the package within Infrastructure Manager or use the standalone CA Unified Infrastructure Management Distribution application.

http://support.nimsoft.com/downloads/doc/NMSCompatibility_SupportMatrix_current.pdf

http://support.nimsoft.com/downloads/doc/Platform_Support_Availability_current.pdf


Chapter 3: Configuration for xendesktop

This section describes the configuration concepts and procedures for setting up the xendesktop probe.

After installing the xendesktop probe, you must define what to monitor. At a high level there are three steps:

1. Connect to the XenDesktop DDC server environment.

2. Add monitors (checkpoints). See the description in the section Adding Monitors (see page 33).

3. Configure the properties for the checkpoints, in which you define QoS data, and define alarms to be sent if specified thresholds are breached.

Note: You must click the Apply button to activate any configuration changes made in the xendesktop Probe Configuration Window.


Probe Configuration Interface Installation for xendesktop (see page 11) Monitoring Capabilities of xendesktop (see page 12) Templates for xendesktop (see page 12) xendesktop Probe GUI (see page 12) Configuration for xendesktop (see page 16) Adding Monitors to xendesktop (see page 33)

Probe Configuration Interface Installation for xendesktop

The probe configuration interface is automatically downloaded and installed by the Infrastructure Manager when the probe is deployed on a robot.

Monitoring Capabilities of xendesktop

12 xendesktop Guide

Monitoring Capabilities of xendesktop

The following XenDesktop components can be monitored:

■ Sites

■ Administrators

■ Controllers

■ Desktop Catalogs

■ Desktop Groups

■ Desktops

■ Hypervisors

■ Machines (VMs)

■ Health Info of Controllers

■ License Server

Templates for xendesktop

Templates allow you to define reusable sets of monitors to apply to XenDesktop components. After you create a template and add monitors (checkpoints) to the template, do one of the following:

■ Drag-and-drop the template onto the XenDesktop component you want to apply the template to. This creates a static monitor for that component and its children (recursively) based on the template contents at the time the static monitor is created.

■ Drag-and-drop the template into the Auto Configuration node to add the template contents to the list of auto configuration monitors.

See the section Using Templates (see page 36) for details.

xendesktop Probe GUI

This section contains the basic GUI information for the XenDesktop Monitoring probe.

The XenDesktop Monitoring probe collects and stores data and information from the monitored components with a XenDesktop server environment about all virtual desktops.

Double-click the line representing the XenDesktop Monitoring probe in the Infrastructure Manager to launch the XenDesktop Monitoring probe configuration interface. It initially appears with the Resources hierarchy empty.



Configuration Interface Navigation for xendesktop

The configuration interface consists of a row of tool buttons above a window split into two parts:

■ The Navigation pane

■ The Content pane

In addition, a status bar at the bottom of the window shows version information and date and time when the probe was last started.

The Toolbar Buttons for xendesktop

The configuration interface contains a row of toolbar buttons:

■ The General Setup button allows you to configure the log level for the probe.

■ The New Resource button allows you to add a new resource.

■ The Message Pool Manager button allows you to add, remove, or edit alarm messages.

■ The Create New Template button allows you to create a new template.

The Navigation (Left) Pane for xendesktop

The division on the left side of the window is the navigation pane. It displays the monitored resources and any templates you have created.

Resources for xendesktop

You can create a new Resource by clicking the New Resource button, or by right-clicking Resources and selecting New Resource.

The Resource is configured as a link to the XenDesktop DDC server environment. Note the following icons for the Resource node:

= Resource is inactive

= Resource is marked for deletion

= Resource is unable to connect

= New resource (not yet saved)


14 xendesktop Guide

= Resource is connected and inventory is ready to browse

= Resource is loading inventory. Not ready to browse

The Resources node contains the following sub-hierarchies:

■ The Auto Configurations node

One or more checkpoints (or templates) can be added to this node, using drag-and-drop. These checkpoints can to be used for auto configuring unmonitored devices. See the section Using Automatic Configurations (see page 37) for further information.

■ The Auto Monitors node

This is a list of the monitors that have been created based on the Auto-Configuration entries and the inventory available on the Resource.

See the section Using Automatic Configurations (see page 37) for further information.

■ The All Monitors node

This node contains the complete list of Monitors for the Resource. This includes Auto Monitors and manually configured Monitors. See the section Using Automatic Configurations (see page 37) for further information.

■ The XenDesktop VDI hierarchy

This is a list of the sites, administrators, controllers, desktop catalogs, desktop groups, desktops, hypervisors/hosts and machines (VMs), health info, and license server auto-discovered and available in the XenDesktop environment for monitoring.



Templates forxendesktop

Templates let you define reusable sets of monitors for the various Xendesktop environment resources.

■ To add a template, click the Create New Template button.

■ To edit or delete a template, click on the template name to select it, then right-click and select the action you want.

The properties for a template are Name and Description. See the section Using Templates (see page 36) for details.

This node contains the following default templates:

■ Xendesktop Desktops Monitoring

■ Xendesktop VMs Monitoring

■ Xendesktop Hypervisors Monitoring

■ Xendesktop Groups Monitoring

■ Xendesktop Catalogs Monitoring

■ Xendesktop Overview Monitoring

Navigation Pane Updates for xendesktop

A right-click with the mouse pointer in the navigation pane over the hostname or IP address node opens a pop-up menu with menu items for managing the selected object or creating new objects of its type. Options typically include: New, Edit, Delete, Deactivate, and Refresh.

Note: When available, the Refresh menu item retrieves updated values and refreshes the display.

The Content (Right) Pane for xendesktop

The content of the right pane depends on the selection in the navigation pane.

If you select a Resources node in the navigation pane, the content pane lists the XenDesktop VDI environment.

Configuration for xendesktop

16 xendesktop Guide

If you select a component in the navigation pane, the content pane lists the available monitors. Active Monitors are check-marked. The following icons can appear there:

Indicates that the monitor is active but not enabled to send alarms. The Enable Monitoring checkbox was not selected for this monitor.

Black: Indicates that the monitor is NOT activated. The Action option is not set in the properties dialog for the monitor.

Green: Indicates that the monitor is activated for monitoring and, if an alarm threshold is set, the threshold value defined in the properties dialog for the monitor is not exceeded.

Gray: Indicates that the monitor is an inactive static monitor.

Other colors: Indicates that the monitor is activated for monitoring and the threshold value defined in the properties dialog for the monitor is exceeded. The color reflects the message token selected in the properties dialog for the monitor.

This icon represents a monitor where no value has been measured.

Note: Any monitor name in italics indicates that the monitor has been modified and you must apply the changes before the monitor results are updated.

Content Pane Updates for xendesktop

A right-click with the mouse pointer on objects in the content pane opens a pop-up menu with menu items for managing the selected object type (Edit, Delete, and Add to Template).

Note: When available, the Refresh menu item fetches updated values and refreshes the display.


This section contains specific configuration information for the XenDesktop Monitoring probe.

Connecting to the XenDesktop Environment

The XenDesktop Monitoring probe connects to the XenDesktop Desktop Delivery Controller (DDC) server using the Windows Remote Management (WinRM) service. WinRM is used for general communications and to manage data collection, conducted through the remote execution of PowerShell commands using the WS-Man protocols.



WinRM on the DDC must be enabled and properly configured for use with the XenDesktop Monitoring probe. The XenDesktop Monitoring probe also requires remote unrestricted, unencrypted execution of PowerShell commands on the DDC. The PowerShell commands must have direct access (with valid user credentials) to the data store.

Note: If credentials must be delegated across multiple servers in your environment, you may need to enable CredSSP. See Set Up Multi-Hop Authentication (see page 24) for more information.

The XenDesktop Monitoring probe requires account access to the following applications/databases:

■ Local Administrator user access to the DDC server remotely over the port specified for WinRM (the default is 5985). Ensure that you use the local Administrator account and not the domain administrator account because the system where the XenDesktop Monitoring probe is deployed may be in a different domain.

■ One of the following:

■ Configuration of WinRM on the DDC to allow remote access via a WinRM listener on HTTP.

■ If SSL is used for communication between the robot system and the DDC, configuration of WinRM on the DDC to use the HTTPS connection type. You will need the keystore location and keystore password to enter in the XenDesktop Monitoring probe Edit Resource dialog.

The following sections provide more details on how to set up the connection from the XenDesktop Monitoring probe system to the DDC, and how to troubleshoot connection issues.


18 xendesktop Guide

Install the PowerShell Snap-In for xendesktop

Install the PowerShell Snap-In (McliPSSnapIn.dll) using the DDC console installer.

If the Snap-In later needs to be registered in PowerShell, run one of the following commands at the DOS command prompt:

Note: Modify these commands to refer to the location of the Installutil.exe file in .NET Framework on your system.

For 32-bit

%systemroot%\Microsoft.NET\Framework\v2.0.50727\installutil.exe McliPSSnapIn.dll

For 64-bit

%systemroot%\Microsoft.NET\Framework64\v2.0.50727\installutil.exe McliPSSnapIn.dll

You can also register the Snap-In by running one of the following commands at the PowerShell command prompt:

For 32-bit

$installutil = $env:systemroot + '\Microsoft.NET\Framework\v2.0.50727\installutil.exe'&$installutil McliPSSnapIn.dll

For 64-bit

$installutil = $env:systemroot + '\Microsoft.NET\Framework64\v2.0.50727\installutil.exe'&$installutil

McliPSSnapIn.dll

Configure XenDesktop 7 for xendesktop

If you are using XenDesktop 7, you must add a local user as a read-only administrator to the XenDesktop 7 controller. Do the steps described here on each DDC server.

Follow these steps:

1. Open the PowerShell window on the XenDesktop 7 DDC server.

2. Ensure that XenDesktop PowerShell Snap-Ins are installed.

See the topic Install the PowerShell Snap-In (see page 18) for more information.

3. Run the following commands in sequence.

$objUser = New-Object System.Security.Principal.NTAccount("shawn")

$strSID = $objUser.Translate([System.Security.Principal.SecurityIdentifier])

New-AdminAdministrator –Sid $strSID.Value

4. Assign the appropriate role to the newly added user in the XenDesktop 7 studio console.

This user account is used by the probe to retrieve all XenDesktop-related parameters. Generally a read-only delegated administrator privilege is sufficient.



Configure WinRM and PowerShell for xendesktop

The xendesktop probe requires Windows PowerShell and Windows Remote Management (WinRM) to be enabled and properly configured on the XenDesktop Desktop Delivery Controller (DDC) server. You can use an HTTP connection type for WinRM, or, if you are using SSL to connect to the DDC, an HTTPS connection type.

Follow these steps:

Note: If any of the following commands having single quotations fail, then try to run the command without the quotation marks.

1. If the DDC server is running Windows Server 2008 R2, you must enable WinRM:

a. As the Administrator user, go to the Control Panel and click Add/Remove System Components.

b. Add WinRM under the section Management and Monitoring Tools.

2. Open a PowerShell window on the DDC server and enter the following command:

Get-ExecutionPolicy

If the response says Restricted, you must change the setting to Unrestricted or RemoteSigned. For example, to set it to RemoteSigned:

a. Enter the following command:

Set-ExecutionPolicy RemoteSigned

b. Enter Y to accept the policy.

c. Enter the Get-ExecutionPolicy command again to verify the setting.

3. Open a Command Prompt window on the DDC server as the Administrator user.

4. Enter the following command:

winrm quickconfig

5. Enter Y to accept the changes.

This configures WinRM with default settings.

6. Enter the following command to check the authentication status:

winrm get winrm/config/service

You see a section in the response similar to the following:

Auth

Basic = false

Kerberos = true

Negotiate = true

Certificate = false

CredSSP = false

CBTHardeningLevel = Relaxed


20 xendesktop Guide

7. Enter the following command to enable basic authentication:

winrm set winrm/config/service/auth '@{Basic="true"}'

8. Enter the following command to allow unencrypted data:

winrm set winrm/config/service '@{AllowUnencrypted="true"}'

This setting is not required if the probe uses HTTPS to communicate with the DDC.

9. Enter the following command to trust all hosts:

winrm set winrm/config/client '@{TrustedHosts="*"}'

To trust only specified hosts list the host names, as in the following example:

winrm set winrm/config/client '@{TrustedHosts="host1, host2, host3"}'

10. Enter the following command to provide sufficient memory, 1024 MB, for the probe to execute PowerShell commands on the DDC:

winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="1024"}'

Note: If in the xendesktop.log file, you see the message: "Process is terminated due to StackOverflowException," increase this setting.

11. Complete the process by following the steps for HTTP or HTTPS below, depending on which connection type you choose.

Using an HTTP Connection for xendesktop

1. To use HTTP to connect to WinRM on the DDC, enter the following command:

winrm create winrm/config/listener?Address=*+Transport=HTTP

2. Enter the following command to test the WinRM connection:

winrm identify -r:http://winrm_server:5985 -auth:basic -u:user_name -p:password -encoding:utf-8

You should see a response similar to the following:

IdentifyResponse

ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd

ProductVendor = Microsoft Corporation

ProductVersion = OS: 6.1.7600 SP: 0.0 Stack: 2.0

If the target computer cannot connect to the DDC, you may need to set up multi-hop authentication. For more information, see Set Up Multi-Hop Authentication (see page 24).



Using an HTTPS Connection for xendesktop

1. Create a self-signed certificate for the remote host using makecert.exe or a similar tool.

2. Open a PowerShell window and enter the following command to find the thumbprint for the certificate for the remote host:

Get-childItem cert:\LocalMachine\Root\ | Select-String -pattern HOSTNAME

3. Enter the following command to create an HTTPS WinRM listener for the remote host with the thumbprint from the previous step:

winrm create winrm/config/Listener?Address=*+Transport=HTTPS @{Hostname="CN"; CertificateThumbprint="THUMBPRINT"}

4. Export the certificate.

If you want to create a backup copy of the certificate or use it on another computer, you must first export it. Exporting the certificate puts it in a file that you can then transfer to another computer or put in a safe place. We recommend that you export certificates to removable media, such as a floppy disk or USB flash drive.

a. Click the Windows Start button.

b. Enter certmgr.msc in the Search field.

c. Enter administrator credentials if prompted.

The Certificate Manager opens.

d. Right-click the certificate you want to export, choose All Tasks, then click Export.

e. Click Next in the Certificate Export Wizard.

f. Click Yes and select do not export the private key.

g. Select the Base64 encoded X.509 format, then click Next.

h. Enter the password you want to use to encrypt the key, confirm it, and click Next.

The export process creates a file to store the certificate in.

i. Specify a name and location for the certificate file.

j. Click Finish.


22 xendesktop Guide

5. Create a keystore file to use in the xendesktop probe configuration UI. This procedure tells you how to use Java keytool to generate the keystore. The keystore can be generated from a machine where a JRE is installed and available in %PATH%.

a. Open a command prompt and enter the following command:

Keytool –importcert –file “<CERTIFICATE>” –keystore “<KEYSTORE>.jks”

For CERTIFICATE enter the file name of the certificate exported in the previous step.

For KEYSTORE enter a name for the keystore in the format <path\name>.jks.

For example:

keytool -importcert -file "C:\Test1.cer" -keystore "C:\test.jks”

b. Enter a password when prompted.

c. Enter Yes when prompted whether to Trust Certificate.

The keystore is available in the path specified.

6. Copy the keystore file to the CA Unified Infrastructure Management robot machine where the xendesktop probe is deployed.

7. In the xendesktop probe configuration GUI, edit (or create if necessary) the resource that represents the DDC server:

a. Double-click the line representing the xendesktop probe in Infrastructure Manager to launch the xendesktop probe configuration GUI.

b. Right-click on the resource for the DDC server and choose Edit Resource.

c. Click the Use SSL check box.

d. Enter the appropriate information in the Keystore Location and Keystore Password fields.

e. Click OK.

More information:

Create a New Resource for xendesktop (see page 26)

Troubleshooting Connection Issues for xendesktop

This section contains troubleshooting steps you can take if the xendesktop probe is unable to connect to the XenDesktop DDC server and no data is collected.



Verify the WinRM Connection for xendesktop

If no data is displayed in the xendesktop probe GUI, follow these steps:

1. Verify that the WinRM service is running on the XenDesktop DDC server.

2. Review the WinRM configuration details for any problems by entering the following command at the Command Prompt on the XenDesktop DDC server:

winrm get winrm/config

3. Verify that the correct port is assigned to Win RM on the XenDesktop DDC server.

The port number is listed under Default Ports in the output for the previous step. The default is 5985.

Verify PowerShell Access forxendesktop

If the xendesktop probe cannot connect to the XenDesktop server, it may be because remote access to PowerShell on the XenDesktop DDC server is restricted. Verify that the correct access is set for PowerShell on the DDC server.

Follow these steps:

1. Open a PowerShell window on the DDC server and enter the following command:

Get-ExecutionPolicy

If the response says Restricted, you must change the setting to Unrestricted or RemoteSigned. For example, to set it to RemoteSigned:

a. Enter the following command:

Set-ExecutionPolicy RemoteSigned

b. Enter Y to accept the policy.

c. Enter the Get-ExecutionPolicy command again to verify the setting.


24 xendesktop Guide

Set Up Multi-Hop Authentication forxendesktop

If the xendesktop probe cannot connect to the XenDesktop server, it may be because credentials must be delegated across multiple remote computers in your environment. In this case, you must configure WinRM to use Credential Security Service Provider (CredSSP) to provide multi-hop support for authentication. Kerberos delegation is not supported by the xendesktop probe.

Follow these steps:

Note:If any of the following commands having single quotations fail, then try to run the command without the quotation marks.

1. Enable CredSSP on the WinRM client system, either by setting it manually or through a Group Policy setting.

To set it manually enter the following command:

winrm set winrm/config/client/auth '@{CredSSP="true"}'

To set it through a Group Policy, follow these steps:

a. Enter the following command in a Command Prompt window to open the Group Policy dialog:

gpedit.msc

b. Navigate to Computer Configuration\Administrative Templates\Windows Components\Windows Remote Management (WinRM)\WinRM Client.

c. Double-click on the Allow CredSSP authentication policy in the right pane to open its configuration dialog.

d. Edit the policy as necessary.

2. Enable CredSSP on the WinRM service, either by setting it manually or through a Group Policy setting.

To set it manually enter the following command:

winrm set winrm/config/service/auth '@{CredSSP="true"}'

To set it through a Group Policy, follow these steps:

a. Enter the following command in a Command Prompt window to open the Group Policy dialog:

gpedit.msc

b. Navigate to Computer Configuration\Administrative Templates\Windows Components\Windows Remote Management (WinRM)\WinRM Service.

c. Double-click on the Allow CredSSP authentication policy in the right pane to open its configuration dialog.

d. Edit the policy as necessary.



(Optional) Configure Kerberos Authentication for xendesktop

To provide authentication between a client and server or between two servers on a Windows or Linux system, you can configure Kerberos Authentication.

Note: You can skip this configuration if you don’t need Kerberos Authentication. If Kerberos is not enabled on the XenDesktop server, the probe uses Negotiate Authentication to communicate with the XenDesktop Server.

Important! For Kerberos authentication to work, in Create New Resource dialog box, only hostname should be given.

Follow these steps:

1. Determine the file realm name by running the following commands on the XenDesktop Server machine.

■ echo %userdnsdomain% - Realm

■ echo %LOGONSERVER% - KDC name

2. Go to the probe directory and rename the krb5-TEMPLATE file to krb5.conf.

3. Update the krb5.conf file with the file realm name and KDC name.

Example:

In this example, the file realm name is ASC-FORWARDINC.COM and the KDC name is asc-ad.

[libdefaults]

default_realm = ASC-FORWARDINC.COM

default_tkt_enctypes = RC4-HMAC DES-CBC-MD5 DES-CBC-CRC

default_tgs_enctypes = RC4-HMAC DES-CBC-MD5 DES-CBC-CRC

udp_preference_limit = 1

[realms]

ASC-FORWARDINC.COM = {

kdc = asc-ad.ASC-FORWARDINC.COM

}

[domain_realms]

.asc-forwardinc.com = ASC-FORWARDINC.COM

asc-forwardinc.com = ASC-FORWARDINC.COM

4. Verify that the XenDesktop Server and probe machines are in the same time zone, and the time-difference between the machines is less than 5 minutes.

Important! The Kerberos Authentication mechanism might fail if the machine time is not set correctly.

You configured Kerberos authentication.


26 xendesktop Guide

General Setup for xendesktop Probe

Click the General Setup button to set the level of details written to the log file for the XenDesktop Monitoring probe.

Log as little as possible during normal operation to minimize disk consumption. This is a sliding scale, with the level of information logged ranging from fatal errors only to extremely detailed information used for debugging.

Click the Apply button to implement the new log level immediately.

Note: The probe allows you to change the log level without restarting the probe.

Create a New Resource for xendesktop

There are two ways to create a Resource:

■ Click the New Resource button on the toolbar.

■ Right click Resources in the navigation pane and select New Resource.

The Resource (New) dialog box appears. Enter the appropriate field information:

Hostname or IP Address

The hostname or IP address of the XenDesktop DDC server system. (Do NOT use "localhost" in place of hostname.) For a clustered DDC server environment, you can specify any controller name that is part of the cluster.

Important! If Kerberos authentication is used, then only hostname should be given.

Port

The port number for the XenDesktop DDC server PowerShell environment. Default is 5985.

Active

Select this checkbox to activate or deactivate monitoring of the resource.

Username

A valid user with administrative privileges that the probe will use to log on to the XenDesktop DDC server environment.

Password

Password for the specified user name.

Use SSL

Enables SSL communication between the XenDesktop Monitoring probe and the DDC server. Check this box if you are using the HTTPS connection type for WinRM on the DDC server. Selecting this option enables the following two fields.



Keystore Location

Location of the keystore on the disk. The keystore file should be available on the machine where the CA Unified Infrastructure Management robot and probe are installed. This field is required only if you are using SSL.

Keystore Password

Password for the keystore. This field is required only if you are using SSL.

Domain Username

A valid domain user with administrative privileges. The probe uses this user name to log on to the XenDesktop DDC server environment. The domain is the same as for the DDC Server.

Domain Password

Password for the specified domain user.

Note: Domain username and password are mandatory fields.

Query Desktops Info

Enables the collection of information about the desktops in a XenDesktop DDC server environment.

Alarm Message

Select the alarm message to be sent if the resource does not respond.

Note: You can edit the message or define a new message using the Message Pool Manager.

Check Interval and Interval Unit

The check interval defines how often the probe checks the values of the monitors. The unit can be set as seconds, minutes, or hours. XenDesktop VDI environment data is updated once per minute. We recommend polling once every 10 minutes, which is the default. The polling interval should not be smaller than the time required to collect the data, otherwise a data collection error alarm is generated by the probe.

Alternate Resources

In a clustered environment with multiple XenDesktop Servers, add the secondary servers as Alternate Resources so that the probe can monitor all the nodes. Click Add, and the AlternateResource dialog appears. Enter the appropriate information in the Hostname, Port, Username, Password, Use SSL, Keystore Location, and Keystore Password fields.

Test button

Click to verify the connection to the resource.


28 xendesktop Guide

After completing the fields and testing the connection, click OK to add the resource. The initial data collection/polling cycle starts. The resource hierarchy will populate once the polling cycle has completed.

More information:

Using an HTTPS Connection for xendesktop (see page 21)

Message Pool Manager for xendesktop

You can add, remove, or modify alarm messages. These are the messages sent when a QoS threshold is breached.

Add a New Alarm Message for xendesktop

To add a new alarm message:

1. Click the Message Pool Manager button on the toolbar.

The Message Pool dialog appears.

2. Click the Add button.

The Message Properties dialog appears.

3. Complete the field information:

Identification Name

The name of the message.

Token

The type of alarm, either "monitor_error" or "resource_error".

Error Alarm Text

The alarm text sent when a violation occurs. Variables can be used in this field.

Example: $monitor

This variable will put the actual monitor name in the alarm text. There are several available variables: $resource, $host, $port, $descr, $key, $unit, $value, $oper, and $thr.

Clear Alarm Text (OK)

The text sent when an alarm is cleared.

Error Severity

Severity of the alarm.



Subsystem string/id

The NAS subsystem ID for the XenDesktop server.

4. Click OK to save the new message.

Delete an Alarm Message forxendesktop

To delete an alarm message:



2. Select the message to remove.

3. Click the Remove button.

The alarm message is removed.

4. Close the Message Pool Manager window and click Apply to implement the changes.

Edit an Alarm Message for xendesktop

To edit an alarm message:



2. Select a message ID in the list.

3. Click the Edit button.

The Message Properties dialog appears.

4. Update the message properties as needed.

5. Click OK.

6. Close the Message Pool Manager window and click Apply to implement the changes.

Create New Template for xendesktop

There are two ways to create a new template:

■ Click the New Template button on the toolbar.

■ Right click the Templates node in the navigation pane and select New Template.

See the section Using Templates (see page 36) for more information.


30 xendesktop Guide

Advanced Configuration for xendesktop

This section describes advanced configuration options for the XenDesktop Monitoring probe.

Increasing the Number of Desktops for xendesktop

If you have more than 5000 virtual desktops for a DDC server (represented as a resource in the XenDesktop Monitoring probe), you need to increase the maximum number of records allowed. To optimize performance, the maximum number of records per resource is set at 5000 by default in the XenDesktop Monitoring probe.

You can increase the maxrecordcount setting for a resource in the Raw Configure window for the XenDesktop Monitoring probe.

Follow these steps:

1. Shift + right-click on the XenDesktop Monitoringprobe in Infrastructure Manager.

2. Choose Raw Configure from the menu.

The Raw Configure dialog opens.

3. Click resources in the left pane.

4. Click the desired resource IP address or host name, then click properties.

5. Click New Key.

6. Enter the following values:

■ Enter key name = maxrecordcount

■ Enter value = number of virtual desktops you want to configure for the resource



Increasing the Heap Space for xendesktop

If you have more than 3000 virtual desktops for a DDC server (represented as a resource in the XenDesktop Monitoring probe), you may need to increase the heap space for the probe. Heap space is allocated during probe startup. By default the heap space for the XenDesktop Monitoring probe is 256 MB.

You can increase the heap space setting for the XenDesktop Monitoring probe in the Raw Configure window for the probe.

Follow these steps:

1. Shift + right-click on the XenDesktop Monitoring probe in Infrastructure Manager.

2. Choose Raw Configure from the menu.

The Raw Configure dialog opens.

3. Click startup in the left pane.

4. Select the options key and open it for editing.

5. Enter a value similar to the following:

-Xms256m –Xmx<nnnn>m

where <nnnn> is heap space up to 2048 MB or greater. For example, to increase the heap space to 1024 MB, enter the following:

-Xms256m –Xmx1024m

Ensure the machine where the CA Unified Infrastructure Management robot and probe are deployed has enough RAM.

6. Click OK and Apply.


32 xendesktop Guide

Adding Servers in a Clustered Environment for xendesktop

The XenDesktop Monitoring probe can monitor all servers in a clustered XenDesktop DDC server environment with multiple DDC servers. Add one server as the primary resource and the remaining as alternate resources.

Data is collected from the primary resource. If the primary resource is down, data is collected from the next available secondary resource.

Follow these steps:

1. In the XenDesktop Monitoring probe GUI, click the New Resource icon on the toolbar.

2. Enter the appropriate information in each field of the New Resource dialog box.

3. Click Add in the Alternate Resources section.

This queries the controller for names of XenDesktop servers and populates the drop-down menu for the Hostname field.

4. Select a host in the Hostname field and enter appropriate information in other fields.

5. Click Test to verify that the probe can connect to the resource.

6. Click OK in the AlternateResource dialog.

7. Repeat these steps to add each secondary server as an alternate resource.


Chapter 4: Adding Monitors to xendesktop

There are three different ways to add monitors to XenDesktop entities:

Manually select the monitors

To manually select and enable monitors, navigate to the target entity within the Resource. This lists its monitors in the right pane. Use the available check boxes to enable QoS monitoring for the selected metrics. To enable Alarm thresholding, you will need to launch the Edit Monitor dialog. See the section Manually Selecting Monitors to be Measured (see page 33).

Use Templates

Templates let you define reusable sets of monitors to apply to various XenDesktop monitored entities.

See the section Using Templates (see page 36) for further information.

Use Auto Configurations

Auto Configuration is a powerful way to automatically add monitors to be measured. Monitors are created for new devices (that is, ones not currently monitored) that would otherwise need manual configuration to be monitored.

Example: Auto Configuration contains an auto-monitor for VM 'Memory Used'. When a new VM is created within XenDesktop, the Auto Configuration feature creates a monitor automatically for monitoring the VM.

See the section Using Automatic Configurations (see page 37) for further information.


Manually Selecting Monitors to be Measured by xendesktop (see page 33) Using Templates for xendesktop (see page 36) Using Automatic Configurations for xendesktop (see page 37)

Manually Selecting Monitors to be Measured by xendesktop

To select a monitor you want to be measured for a resource, click the Resource node in the navigation pane, and navigate through the Resource hierarchy. Select a folder in the hierarchy to see the monitors for it, listed in the right pane. Click the check box beside the Monitors you want to be active.

Note: You can also add monitors using templates (see the section Using Templates (see page 36)).


34 xendesktop Guide

Select the All Monitors node to list all monitors currently being measured in the right pane. You can select or deselect monitors here as well.

■ Green icon - the monitor is configured and active

■ Gray icon - the monitor is configured but not active

■ Black icon - the monitor is not configured

Note: If a monitor name is in italics you have changed the configuration but have not applied the changes.

Enabling the Monitors for QoS and Alarming to xendesktop

You can now see the current values for the monitors in the Values column in the monitor list. Selecting the check box next to a monitor name only enables the monitor. To configure the probe to send QoS data and/or send alarms you must modify the properties for each monitor.

Double-click a monitor (or right-click and select Edit) to launch the monitor’s properties dialog. See To Edit Monitor Properties (see page 34) for further information.

To Edit Monitor Properties for xendesktop

Double-click a monitor (or right-click and select Edit) to launch the monitor’s properties dialog.

Monitors of Type Value for xendesktop

The properties for monitors of type value are as follows:

Name

This is the name of the monitor. The name will be inserted into this field when the monitor is retrieved from the xendesktop environment.

Key

This is a read-only field, describing the monitor key.

Description

This is a description of the monitor. This description will be inserted into this field when the monitor is retrieved from the xendesktop environment.

Value Definition

This drop-down list lets you select which value to be used, both for alarming and QoS:

You have the following options:

■ The current value. The most current value measured will be used.



■ The delta value (current – previous). The delta value calculated from the current and the previous measured sample will be used.

■ Delta per second. The delta value calculated from the samples measured within a second will be used.

■ The average value of the last and current sample: (current + previous) / 2.

■ The average value last ... The user specifies a count. The value is then averaged based on the last "count" items.

Active

This activates the monitoring of the probe.

Enable Alarming

Selecting this option activates the alarming.

Note that the monitor will also be selected in the list of monitors in the right window pane when this option is selected, and that you can enable or disable monitoring of the checkpoint from that list.

This section describes the alarm properties for the monitor.

You can define both a high and a low threshold.

Initially the high threshold is set to the current value. Set this value to match your needs.

The low threshold is initially disabled. If you want to use it, you must select another operator than "disabled" from the list and configure it to match your needs.

Operator

Select from the drop-down list the operator to be used when setting the alarm threshold for the measured value.

Example:

>= 90 means the monitor is in alarm condition if the measured value is equal to or above 90.

= 90 means the monitor is in alarm condition if the measured value is exactly 90.

Threshold

The alarm threshold value. An alarm message is sent when this threshold is violated.

Unit

This field specifies the unit of the monitored value (for example %, Mbytes etc.). The field is read-only.


36 xendesktop Guide

Message ID

Select the alarm message to be issued if the specified threshold value is breached. These messages reside in the message pool. You can modify the messages in the Message Pool Manager.

Publish Quality of Service

Select this option if you want QoS messages to be issued on the monitor.

QoS Name

The unique QoS metric. This is a read-only field.

Using Templates for xendesktop

Templates let you define reusable sets of monitors to be measured on multiple XenDesktop Controllers, Catalogs, Groups, desktops, hypervisor hosts, and machines. Templates allow you to consistently monitor your dynamic XenDesktop environment.

You can create your own templates and define a set of monitors belonging to each. You can then apply these templates to anything in the Resources or Auto Configurations hierarchies in the navigation pane by dragging the template and dropping it on the appropriate item. This assigns the template monitors to the drop point and everything below it.

If you apply a template to the Auto Configuration, its monitors are applied to all XenDesktop monitored entities as they appear in the system. If you need a finer level of control, you can apply a template to anything in the Resources hierarchy; in this case the monitors are applied to the drop-point and everything subordinate to it. Any templates applied within the Resources hierarchy are static monitors. The static monitors override any auto monitors for that specific resource entity.

Note: You can do both, placing general-purpose templates in Auto Configuration, and applying special-purpose templates that override the Auto Configuration templates on specific nodes, for specific purposes.

See the Using Automatic Configurations (see page 37) section for details on Auto Configuration.

To Create a New Template for xendesktop

There are two ways to create a template:

■ Click the toolbar button for New Template ( ).



■ Right click the Templates node in the navigation pane, and choose New Template from the menu.

In the resulting Template Properties dialog, specify a Name and a Description for the new template.

Note that you can also edit an existing template: Select one of the templates defined under the Templates node in the navigation pane, right-click it, and select Edit from the menu.

To Add Monitors to a Template for xendesktop

There are two ways to add a monitor to a template:

■ Drag it from the content pane and drop it on the template in the navigation pane.

■ Right-click on a monitor in the content pane and select Add to Template.

You can edit the properties for monitors in the template as described in the section To Edit Monitor Properties (see page 34).

To Apply a Template for xendesktop

Drag the template to the Auto Configuration node or the Resource component (Desktop Group, Desktop, Hypervisor, etc.) where you want it applied, and drop it there.

Note: You can drop the template on an object containing multiple subordinate objects. This applies the template to the entity and all its subordinate entities. A static monitor is created for this entity.

Using Automatic Configurations for xendesktop

Automatic configuration is an optional but powerful way to automatically add monitors to be measured. This is the preferred method for configuring your resources. When new XenDesktop monitored entities are detected, "Auto Monitors" are created for devices that are not currently monitored using a static monitor.


38 xendesktop Guide

The Auto Configuration feature consists of two sub-nodes located under the Resource node in the navigation pane:

Auto Configurations node

You can add contents from one or more templates or individual checkpoints to this node, using drag and drop. You must click the Apply button and restart the probe to activate the changes. The probe then searches through the XenDesktop environment for applicable entities. Auto Monitors representing the monitor(s) under the Auto Configuration node are created (and listed under the Auto Monitors node, see below) for applicable entities where the metric does not already have a static monitor configured against it.

Important! If you are experiencing performance problems, we recommend increasing the polling cycle and/or the memory configuration for the probe. Increase memory when the probe is running out of memory. Increase the polling cycle when the collection takes longer than the configured interval.

Auto Monitors node

This node lists Auto Monitors, created based on the contents added to the Auto Configuration node. The Auto Monitors are only created for content without a pre-existing static monitor.

Adding a Template to the Auto Configurations Node for xendesktop

You can add a template's content to the Auto Configurations as follows:

1. Click the Templates node in the navigation pane to list all available templates in the content pane.

2. Add a template to the Auto Configurations node by dragging the template from the list and dropping it on the Auto Configurations node in the navigation pane.

3. Click the Auto Configurations node to verify that the template's content was successfully added.

See the Using Templates (see page 36) section to learn more about templates.

Note: You must click the Apply button and restart the probe to activate configuration changes.

Adding a Monitor to the Auto Configurations Node for xendesktop

You can add a single monitor (checkpoint) to the Auto Configurations node.

To list available monitors:

1. Select the Resource node in the navigation pane and navigate to the point of interest.



2. Select an object to list its monitors in the right pane.

3. Add the monitor to the Auto Configurations node by dragging the monitor to the Auto Configurations node and dropping it there.

4. Click the Auto Configurations node and verify that the monitor was successfully added.


Exploring the Contents of the Auto Configurations Node for xendesktop

To verify that the monitors were successfully added, click the Auto Configurations node in the navigation pane.

■ To edit the properties for a monitor, right-click in the list and choose Edit from the menu. See the section To Edit Monitor Properties (see page 34) for detailed information.

■ To delete a monitor from the list, right-click in the list and choose Delete from the menu.


Checking the Auto Monitors Node for xendesktop

Note: When monitors have been added to the Auto Configurations node, you must click the Apply button and restart the probe to activate the Auto Configuration feature.

When you restart the probe, it searches through the Resource's entities. For each one that is currently not monitored, an Auto Monitor is created for each of the monitors listed under the Auto Configurations node.

All defined Auto Monitors are listed under the Auto Monitors node.


Appendix A: Troubleshooting for xendesktop Probe

This section contains troubleshooting tips for the XenDesktop Monitoring probe.


xendesktop Probe is Not Collecting Data (see page 42) xendesktop Probe Out of Memory Errors (see page 42) xendesktop Probe Delays in Fetching Site Data (see page 43) xendesktop Probe Not Fetching HealthInfo Metrics even when WinRM Enabled (see page 43) xendesktop Probe Known Issues (see page 44)

xendesktop Probe is Not Collecting Data

42 xendesktop Guide

xendesktop Probe is Not Collecting Data

Symptom:

The probe is not collecting data.

Solution 1:

The probe may not be able to connect to the XenDesktop environment. There are several issues that can cause this. See the Connecting to the XenDesktop Environment (see page 16) section of this document, including the subsection on Troubleshooting Connection Issues.

Solution 2:

You may need to allocate more memory for the probe to execute PowerShell commands on the DDC server. We recommend setting this to 1024 MB during initial configuration for the xendesktop probe. However, in some cases this may need to be increased.

Check the xendesktop.log file for the following message:

Process is terminated due to StackOverflowException

If you see the StackOverflowException message, on the DDC server added as a resource or alternate resource, open a command prompt and enter the following command :

winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="nnnn"}'

where nnnn is a number greater than 1024.

Solution 3:

Note: This solution is only valid when Kerberos Authentication is used in the probe.

In the xendesktop log, if you get the Kerberos error, "Clock Skew too great while getting initial ticket," there is a time difference between the XenDesktop server and the probe machine. Verify that both the XenDesktop server and probe machines are in the same time zone, and the time difference between the machines is not more than 5 minutes.

xendesktop Probe Out of Memory Errors

Symptom:

Out of memory errors.

Solution:

If you have more than 3000 virtual desktops for a DDC server (represented as a resource in the xendesktop probe), you may need to increase the heap space for the probe. For instructions, see Increasing the Heap Space for the Probe (see page 31).

xendesktop Probe Delays in Fetching Site Data


xendesktop Probe Delays in Fetching Site Data

Symptom:

In some environments, the Add-PSSnapin cmdlet might take approximately 60 to 90 seconds to add XenDesktop PowerShell SDK related snapin. This delay happens when the XenDesktop Server is not connected to the internet. This delay can also happen when the XenDesktop SDK Snapin is added in a PowerShell session, because the system tries to verify the Authenticode signature and this takes more time.

Solution:

To resolve this issue, you can either provide the computer with internet access so it can verify the Authenticode signature, or disable the Authenticode signature checking feature for Microsoft Management Console as mentioned below.

1. Open Internet Options in the Control Panel or Internet Explorer.

2. Click the Advanced tab.

3. Scroll down to Security.

4. Uncheck "Check for publisher's certificate revocation."

5. Uncheck "Check for server certificate revocation."

6. Click OK.

xendesktop Probe Not Fetching HealthInfo Metrics even when WinRM Enabled

Problem:

The probe will not fetch HealthInfo metrics even though WinRM is enabled.

Solution:

1. On the server from which you want the probe to fetch the HealthInfo metrics, in the Windows prompt, run the command :

winrm get winrm/config/service

2. In the command result, check that the property - AllowUnencrypted = true.

3. If the above property value is false, then run the command:

winrm set winrm/config/service @{AllowUnencrypted="true"}

4. Verify again that the property is set to true by repeating step 1.

xendesktop Probe Known Issues

44 xendesktop Guide

xendesktop Probe Known Issues

In locales where the system settings are in languages other than English, the probe may not be able to fetch data for metrics with decimal points.


Chapter 5: xendesktop Probe Metrics

This section contains the list of all metrics fetched for all nodes by the xendesktop probe.

Note: On enabling, QoS will be published for all the metrics except for those whose unit is string. All metrics generate alarms, including those for which the unit is string.


xendesktop Administrator Node Metrics (see page 45) xendesktop Broker Session Node Metrics (see page 46) xendesktop Broker Service Instance Node Metrics (see page 49) xendesktop Catalog Node Metrics (see page 50) xendesktop Controller Node Metrics (see page 52) xendesktop Desktop Node Metrics (see page 52) xendesktop Desktop Group Node Metrics (see page 59) xendesktop HealthInfo Node Metrics (see page 63) xendesktop Hypervisor Node Metrics (see page 64) xendesktop License Server Node Metrics (see page 64) xendesktop Machine Node Metrics (see page 65) xendesktop Resource Node Metrics (see page 73) xendesktop Services Node Metrics (see page 74) xendesktop Site Node Metrics (see page 75)

xendesktop Administrator Node Metrics Metric Unit Description

ApplicationIconUID Integer UID of application icon

BrokerAdmin Boolean True if the user is a BrokerAdmin

Catalogs String Catalogs the admin is assigned

CatalogNames String Catalogs with which the admin is associated

DesktopGroup String Desktop groups with which the admin is associated

DesktopGroupNames String Desktop group names with which the admin is associated

Enabled Boolean True if admin is enabled

FullAdmin Boolean True if the admin has all rights

xendesktop Broker Session Node Metrics

46 xendesktop Guide

FullName String Full name of the admin

Name String Name of the admin

ProvisioningAdmin Boolean True if the admin is a Provisioning Admin

Sid String SID of the admin

ReadOnly Boolean Read only status of the admin

Rights String Rights of the admin

xendesktop Broker Session Node Metrics Metrics Unit Description

AgentVersion String Version of the Citrix Virtual Delivery Agent (VDA) installed on the machine

ApplicationsInUse String List of SDK name property of applications in use in the session

AutonomouslyBrokered Boolean Indicates whether or not the session is anonymously brokered

BrokeringDuration Integer Duration of brokering

BrokeringTime String Time at which session was brokered

BrokeringUserName String Name of user on brokered session

BrokeringUserSID String SID of user on brokered session

CatalogName String The name of the catalog that the machine hosting the session is assigned to

ClientAddress String Host name of client connected to desktop

ClientName String IP address of client connected to desktop

ClientVersion String The version of the Citrix Receiver running on the client connected to the session

ConnectedViaHostName String The host name of the incoming connection. This is usually a gateway, router or client.

ConnectedViaIP String The IP of the incoming connection. This is usually a gateway, router or client.



Metrics Unit Description

ControllerDNSName String The DNS host name of the controller that the session's hosting machine is registered with

DesktopGroupname String Desktop group name of machine which the brokered session is on

DesktopGroupUID Integer Desktop group UID of machine which the brokered session is on

DesktopKind Enumeration Desktop kind, either shared or private

DesktopSID String The Windows SID of the machine the session is on

DesktopUID Integer Desktop UID of brokered session

DeviceID String Unique identifier for the client device that has most recently been associated with the session

DNSName String DNS name of brokered session

EstablishmentTime String Time the session was established

EstablishmentDuration Integer The duration it took to establish session

HardwareID String Unique identifier for the client hardware that has been most recently associated with the session

Hidden Boolean Indicates whether or not brokered session is hidden from the user and not to be reconnected to

HostedMachineName String

The friendly name of a hosted machine running the session, as used by its hypervisor. This does not necessarily match either the DNS or AD name of the machine.

HostingServerName String DNS name of the hypervisor that is hosting the machine hosting the session

HypervisorConnectionName String The name of the hypervisor connection that the machine hosting the session has been assigned to

ImageOutofDate Boolean

Denotes whether the VM image for a hosted machine is out of date and due to be updated to a new master image when the machine next reboots


48 xendesktop Guide


InMaintenanceMode Boolean Indicates whether or not the machine hosting session is in maintenance mode

IPAddress String IP address of machine hosting session

IsPhysical Boolean This value is false if the machine hosting the session can be power managed, and true otherwise

LaunchedViaHostName String Specific name of the host by which the user launched brokered session

LaunchedViaIP String IP address by which the user launched brokered session

MachineName String DNS name of machine hosting the session

MachineSummaryState Enumeration The summary state of the machine: Available; InUse ; Disconnected ; Off; Unregistered; Unknown.

MachineUID Integer UID of machine hosting the session

MetaDataMap String Map of metadata for this session

OSType String OS type of machine hosting the session

PersistUserChanges Enumeration Describes whether/how the user changes are persisted. Possible values are:OnLocal ,Discard ,OnPvd, Unknown.

PowerState Enumeration

The current power state of the machine hosting the session. Possible values are: Unmanaged, Unknown, Unavailable, On, Suspended, TurningOn, TurningOff, Suspending and Resuming.

Protocol Enumeration The protocol that the session is using, can be either "HDX" or "RDP"

ProvisioningType Enumeration Describes how the machine was provisioned: Manual, PVS, MCS or Unknown

SecureICAActive Boolean Indicates whether SecureICA is active on the session

SessionKey String GUID that provides a unique identifier for this session

SessionSupport Enumeration Indicates if the machine hosting the session supports multiple or single sessions

xendesktop Broker Service Instance Node Metrics



SessionType Enumeration Indicates if this is an Application or Desktop session

SessionID Integer

A unique identifier that Remote Desktop Services uses to track the session but it is only unique on that machine

SessionState Enumeration

The state of the session. Valid values are: Active; Connected; Disconnected; Reconnecting; PreparingSession; NonBrokeredSession; Unknown.

SessionStateChangeTime String Time of most recent state change for session

SmartAcessTags String Smart access tags for session

StartTime String Start time for session

UID Integer UID for session

UserFullName String User full name for session

UserUPN String User UPN name for session

UserName String User name for session

UserSID String User SID for session

xendesktop Broker Service Instance Node Metrics Metric Unit Description

Address String Address of broker service admin

Binding String Binding of broker service instance

InterfaceType String Interface type of broker service instance

ServiceAccount String Account for broker service instance

ServiceAccountSID String Account SID for broker service instance

ServiceGroupName String Service group name

ServiceGroupUID String Service group UID

ServiceInstanceUID String UID of broker server instance

ServiceType String Service type of the broker server instance

xendesktop Catalog Node Metrics

50 xendesktop Guide

Version String Broker server instance version

xendesktop Catalog Node Metrics Metrics Unit Description

AdministratorNames String Names of Administrators of current catalog

AllocationType Enumeration Catalog allocation type (values can be: Unknown, Permanent and Random)

AssignedCount Integer Number of machines that are assigned to users

AvailableAssignedCount Integer Number of available machines that are assigned to users

AvailableCount Integer Number of available machines

AvailableUnassignedCount Integer Number of available machines not assigned to users

CatalogKind Enumeration

Catalog Type(Valid values are ThinCloned, SingleImage, PowerManaged, Unmanaged, Pvs, Pvd, and PvsPvd)

Description String Description of the catalog

HypervisorConnectionUID Integer

The UID of the hypervisor connection that is associated with the machines in the catalog. This only applies for MCS provisioned catalogs as with other provisioning types, the machines can be from one or more different hypervisor connections.

IsRemotePC Boolean

Specifies if the catalog is a RemotePC catalog or not. Remote PC catalogs automatically configure appropriate machines.

MachinesArePhysical Boolean Catalogs containing physical machines. This applies to only Provisioning Services catalogs.

MetaDatamap String Holds any metadata associated with the catalog

MinimumFunctionalLevel String The expected minimal functional level of the machines in the catalog.

xendesktop Catalog Node Metrics


Name String Name of the catalog



ProvisioningSchemeID String

The GUID of the provisioning scheme (if any) associated with the catalog. This only applies if the provisioning type is MCS.

PVSAddress String Catalogs containing machines provided by the Provisioning Services server with the specified address

PVSDomain String Catalogs containing machines provided by the Provisioning Services server in the specified domain

PVSforVM String Catalog’s reference to the Provisioning Scheme

RemotePCGroupUIDs String UIDs of the Remote PC desktop groups associated with this catalog

RemoteDesktopGroupPriorities String Remote PC desktop groups' association priorities

Scopes String The list of the delegated admin scopes to which the catalog belongs

SessionSupport Enumeration Specifies the session support of the machines in the catalog: single or multi

UID Integer UID of the virtual desktop

UnassignedCount Integer Number of unassigned machines (machines not assigned to users)

UsedCount Integer Number of machines used in a desktop group

UUID String UUID of the virtual desktop

xendesktop Controller Node Metrics

52 xendesktop Guide

xendesktop Controller Node Metrics Metric Unit Description

AssociatedHypervisorConnectionUids String The UIDs of the associated hypervisor connections

ControllerVersion String Version of the broker controller

DesktopsRegistered Integer Number of desktops registered

DNSName String DNS name of the broker controller

LastActivityTime String Last activity time of the broker controller

LastStartTime String Last Start time of the broker controller

LicensingBurnInDate String License burn in date of the broker controller

MachineName String Name of the broker controller machine

OSType String Type of the broker controller machine OS

OSVersion String Version of the broker controller OS

SID String SID of the broker controller

State String State of the broker controller: Failed, Off, On, Active, Unknown

UID Integer UID of the broker controller

xendesktop Desktop Node Metrics Metric Unit Description

AgentVersion String Virtual desktop agent version

ApplicationsInUse String Applications that are currently in use

AssignedClientName String Desktops assigned to a specific client name

AssignedIPAddress String Desktop assigned to a specific IP address

xendesktop Desktop Node Metrics


AssociatedUserFullNames String

Associated user identified by their full name (usually in the form 'first-name last-name'). Associated users are the current user for shared desktops, and the assigned users for private desktops.

AssociatedUserName String

Associated user for desktop identified by their user name (in the form 'domain\user'). Associated users are the current user for shared desktops, and the assigned users for private desktops.

AssociatedUserUPNS String Associated user for desktop identified by their User Principle Name (in the form 'user@domain')

AutonomouslyBrokered Boolean Desktop with the autonomously brokered session flag

CatalogName String Name of catalog to which existing desktop belongs

ClientName String Desktop with a specific client name

ClientAddress Integer Client IP address of desktop

ClientVersion String Desktop with a specific client version

ColorDepth String Desktop configured with a specific color depth. Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.

Conditions String Outstanding desktop condition. Valid values are CPU, ICALatency, UPMLogonTime

Catalog Kind Enumeration

Catalog type(valid values are ThinCloned, SingleImage, PowerManaged, Unmanaged, Pvs, Pvd, and PvsPvd)

CatalogUID Integer UID of catalog to which existing desktop belongs to

ControllerDNSName String DNS name of the controller with which desktop is registered

CPUUsage Integer CPU usage of the desktop

ConnectionUser String User of the connection


54 xendesktop Guide

Conditions_CPU Boolean Indicates very busy CPU when true

DesktopConditions_ICALatency Boolean Indicates high ICA Latency when true

DesktopConditions_UMPLogonTime Boolean Indicates long UMP Logon Time when true

ConfigVersion String Version of the site's machine and user policies

ConnectedViaHostName String Host name of the incoming connection. This is usually a proxy or Citrix Access Gateway server

ConnectedViaIP String IP address of the incoming connection

DesktopGroupName String Desktop group name to which existing desktop belongs

DesktopGroupUID Integer UID of the group to which existing desktop belongs

DesktopKind Enumeration Denotes what kind of desktop: DesktopsOnly; AppsOnly; DesktopsAndApps; Unknown

Description String Description of the virtual desktop

DeliveryType Enumeration

Denotes whether the desktop delivers desktops only, apps only, or both: DesktopsOnly; AppsOnly; DesktopsAndApps; Unknown.

DeviceId String Desktop with a specific client device ID

DNSName String DNS Name of the virtual desktop

FunctionalLevel String The functional level of the desktop, if known

HardDiskGB GBytes Hard Disk size in GB of the virtual desktop

HardwareID String Desktop with a specific hardware ID

HostedMachineId String Desktop with a specific machine ID known to the hypervisor

HostedMachineName String Desktop with a specific machine name known to the hypervisor

HostingServerName String Desktop with a specific name of the hosting hypervisor server



HypervisorConnectionName String Desktop with a specific name of the hosting hypervisor connection

HypervisorConnectionUid Integer Desktop with a specific UID of the hosting hypervisor connection

ICASessionLatency Milliseconds ICA session latency of the virtual desktop

IconUID String Desktop with a specific configured icon. Note that desktops with a null IconUid use the icon of the desktop group

ImageOutOfDate Boolean Desktop if they have an ImageOutOfDate flag

InMaintenanceMode Boolean Desktop with a specific InMaintenanceMode setting

IsPhysical Boolean

This value is true if the desktop is physical (not power managed by the Citrix Broker Service), and false otherwise

IPAddress String IP Address of the virtual desktop

IsAssigned Boolean Assignment state of the desktop. Private desktops can be assigned to users or IP addresses

LastConnectionFailure Enumeration

Reason for the last recorded connection failure; None; SessionPreparation; RegistrationTimeout; ConnectionTimeout; Licensing; Ticketing; Other; Unknown.

LastConnectionTime String

Last connected time. This is the time that the broker detected that the connection attempt either succeeded or failed

LastConnectionUser String Last attempted connection by user (in the form 'domain\user')


56 xendesktop Guide

LastDeregistrationReason String

Last deregistered error reason: Last reason given for deregistration of the machine with the broker: AgentShutdown; AgentSuspended; AgentRequested;IncompatibleVersion; AgentAddressResolutionFailed; AgentNotContactable; AgentWrongActiveDirectoryOU; EmptyRegistrationRequest; MissingRegistrationCapabilities; MissingAgentVersion; InconsistentRegistrationCapabilities; NotLicensedForFeature; UnsupportedCredentialSecurityVersion; InvalidRegistrationRequest; SingleMultiSessionMismatch; FunctionalLevelTooLowForCatalog; FunctionalLevelTooLowForDesktopGroup; PowerOff;DesktopRestart; DesktopRemoved; AgentRejectedSettingsUpdate; SendSettingsFailure; SessionAuditFailure; SessionPrepareFailure; ContactLost; SettingsCreationFailure; UnknownError; BrokerRegistrationLimitReached; Unknown

LastDeregistrationTime String Last deregistered time

LastErrorReason String Last error reason

LastErrorTime String Last error time

LastHostingUpdateTime String Specific time that the hosting information was last updated

LaunchedViaHostName String Specific host name of the Web Interface server from which the user launched the session

LaunchedViaIP String Specific IP address of the Web Interface server from which the user launched the session

LicenseID String Specific ID used for licensing.

LogicalDiskFreespacePercent Percent Logical disk free space by percent

MachineInternalState Enumeration Specified internal machine state: Available; InUse; Disconnected; Off; Unregistered; Unknown.



MachineName String Machine name (in the form 'domain\machine')

MachineUid Integer Specific machine UID

Memory KBytes Memory Available in KB

MemoryAvailableinMB Mbytes Memory Available in MB

MemoryPagesInputPerSec OpsPerSec Memory Pages Input Per Sec

MemoryUsage Integer Memory usage of the desktop

NetworkUsage Integer Network usage of the desktop

OSType String Operating system type of the desktop

OSVersion String Specific OS version of the desktop

PagingFileUsagePeakPercent Percent Paging file usage

PagingFileUsagePercent Percent Paging file usage peak

PercentProcessorTime Percent Percent processor time


PhysicalDiskCurrentQueueLength Integer Physical disk current queue length

PhysicalDiskTotalDiskBytesPerSec BytesPerSec Physical disk total disk bytes per sec

PhysicalMemoryMB MBytes Physical memory MB of the virtual desktop

PowerActionPending Boolean State of pending power action (true or false)

PowerState Enumeration

The current power state of the machine hosting the session. Possible values are: Unmanaged, Unknown, Unavailable, On, Suspended, TurningOn, TurningOff, Suspending and Resuming.

ProcessWorkingSetAverage Double Total process working set average

ProcessorQueueLength Integer Processor queue length

Protocol Enumeration

Connection to desktop using a specific protocol, for example 'HDX', or 'RDP' published on it (identified by its browser name)


58 xendesktop Guide

ProvisioningType Enumeration

Describes how the machine was provisioned: Manual, PVS, MCS or Unknown

PublishedApplications String Desktop with a specific application

PublishedName String Desktop with a specific published name

PVDStage Enumeration Personal vDisk stage: Working; PoweringOn; Requested; None; Unknown.

RegistrationState Enumeration Registration state of the desktop; valid values are Registered; Unregistered; AgentError; Unknown.

SecureICAActive Boolean State of current session; indicates if it uses secure ICA or not

SecureICARequired Boolean

Desktop configured with a particular SecureIcaRequired setting. Note that the desktop setting of $null indicates that the desktop group value is used.

SID String Machine SID of the desktop

SmartAccessTags String Specific SmartAccess tag of current session.

StartTime String Start time of the desktop session

SessionId String

A unique identifier that Remote Desktop Services uses to track the session but it is only unique on that machine

SessionState Enumeration

The state of the session. Valid values are: Active; Connected; Disconnected ; Reconnecting; PreparingSession; NonBrokeredSession; Unknown.

SessionStateChangeTime String The time of the most recent state change for the session

SessionUid String Session UID ($null for no session)

xendesktop Desktop Group Node Metrics


SessionUsername String User name for the current session (in the form 'domain\user')

SessionUserSID String SID of the current session user

SummaryState Enumeration The summary state of the machine: Available; InUse; Disconnected; Off; Unregistered; Unknown.

SystemContextSwitchesPerSec Integer Number of system context switches per second

SystemProcessorQueueLength String System Processor Queue Length

Tags String Desktop tag

UID Integer UID of the desktop

UnregisteredPowerOffState Boolean Machine is in unregistered state and powered off

UnregisteredPowerOnState Boolean Machine is in unregistered state and powered on

VCPU Integer VCPU of the virtual desktop

WillShutdownAfterUse Boolean Shut down after use or not (True or False)

ProvisioningType Enumeration

Describes how the machine was provisioned: Manual, PVS, MCS or Unknown

xendesktop Desktop Group Node Metrics Metric Unit Description

AdministratorNames String Desktop groups to which the specified administrator has been added

AutomaticPowerOnForAssigned Boolean Desktop groups with the specified value of AutomaticPowerOnForAssigned

ColorDepth String Desktop groups with the specified color depth. Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.

Description String Description of the desktop groups

DesktopKind Enumeration Kind of desktop either private or shared

DesktopsAvailable Integer Number of available desktops


60 xendesktop Guide

DesktopsDisconnected Integer Number of disconnected desktops

DesktopsInUse Integer Number of desktops currently in use

DesktopsNeverRegistered Integer Number of desktops never registered

DesktopsPreparing Integer Number of desktops in preparing state

DesktopsUnregistered Integer Number of unregistered desktops

Enabled Boolean State of desktop group. Disabled desktop groups do not appear to users.

IconUid Integer The UID of the broker icon to be displayed to users for their desktop(s) in this desktop group.

InMaintenceMode Boolean Denotes whether or not group is in maintenance mode

Name String Name of desktop group

OffPeakBufferSizePercent Percent The percentage of machines in the desktop group that should be kept available in an idle state outside peak hours

OffPeakDisconnectAction Enumeration The action to be performed after a configurable period of a user session disconnecting outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

OffPeakDisconnectTimeout Integer The number of minutes before the configured action should be performed after a user session disconnects outside peak hours

OffPeakExtendedDisconnectAction Enumeration The action to be performed after a second configurable period of a user session disconnecting outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

OffPeakExtendedDisconnectTimeout Integer The number of minutes before the second configured action should be performed after a user session disconnects outside peak hours

OffPeakLogOffAction Enumeration The action to be performed after a configurable period of a user session ending outside peak hours. Possible values are Nothing, Suspend, or Shutdown.



OffPeakLogOffTimeout Integer The number of minutes before the configured action should be performed after a user session ends outside peak hours

PeakBufferSizePercent Percent The percentage of machines in the desktop group that should be kept available in an idle state in peak hours

PeakDisconnectAction Enumeration The action to be performed after a configurable period of a user session ending outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

PeakDisconnectTimeout Integer The number of minutes before the configured action should be performed after a user session disconnects in peak hours

PeakExtendedDisconnectAction Enumeration The action to be performed after a configurable period of a user session ending outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

PeakExtendedDisconnectTimeout Integer Number of minutes before the second configured action should be performed after a user session disconnects in peak hours

PeakLogOffAction Enumeration The action to be performed after a configurable period of a user session ending outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

PeakLogOffTimeout Integer The number of minutes before the configured action should be performed after a user session ends in peak hours

ProtocolPriority String A list of protocol names in the order in which they should be attempted for use during connection

PublishedName String The name that will be displayed to users for their desktop(s) in this desktop group

SecureIcaRequired Boolean HDX connections to desktops in the new desktop group require the use of a secure protocol or not


62 xendesktop Guide

ShutdownDesktopsAfterUse Boolean Desktops in current desktop group should be automatically shut down when each user session completes (only relevant to power-managed desktops)

Tags String Tags

TimeZone String The time zone name to be used for desktops in this group

TotalDesktops Integer Total number of desktops in the group

UUID String Unique ID of the desktop group

UID Integer Internal ID of the desktop group

AutomaticPowerOnForAssignedDuringPeak Boolean Specifies whether assigned desktops in the desktop are automatically started throughout peak time periods

ConfigurationSlotUids String UIDs of any configuration slots which hold machine configurations associated with the desktop group

DeliveryType Enumeration The type of resources being published: DesktopsOnly; AppsOnly; DesktopsAndApps; Unknown.

IsRemotePC Boolean Specifies whether the desktop group is a remote PC desktop group

MachineConfigurationNames String The machine configuration names associated with the desktop group

MachineConfigurationUids String The machine configuration uids associated with the desktop group

MetadataMap String Metadata associated with the desktop group

MinimumFunctionalLevel String The minimum functional level required for the machines in the desktop group to be able to register with the Citrix broker service

Scopes String The list of the delegated admin scopes to which the desktop group belongs

SessionSupport String Specifies the session support (single/multi) of the machines in the desktop group. Machines with the incorrect session support for the desktop group will be unable to register with the Citrix Broker Service.

xendesktop HealthInfo Node Metrics


Sessions Integer The total number of user sessions currently running on all of the machines in the desktop group

TotalApplications Integer Total number of applications associated with the desktop group

TurnOnAddedMachine Boolean Specifies whether the broker should attempt to turn on power-managed machines when they are added to the desktop group

xendesktop HealthInfo Node Metrics Metrics Unit Description

LogicalDiskFreeSpacePercent Percent Logical disk free space

MemoryAvailableinMB MBytes Memory available in MB

MemoryPagesInputPerSec OpsPerSec Memory pages input per sec

PagingFileUsagePeakPercent Percent Paging file usage peak

PagingFileUsagePercent Percent Paging file usage

PercentProcessorTime Percent Percent processor time

PhysicalDiskCurrentQueueLength Long Physical disk current queue length

PhysicalDiskTotalDiskBytesPerSec BytesPerSec Physical disk total disk bytes per sec

ProcessWorkingSet Long Total process working set

ProcessWorkingSetAverage String Total process working set

ProcessorQueueLength Long Processor queue length

State Enumeration State of broker controller: Failed, Off, On, Active, Unknown

SystemContextSwitchesPerSec OpsPerSec System context switches per sec

SystemProcessorQueueLength String System processor queue length

RegistrationRequests Integer Number of registration requests

RegistrationRequestsPerSec OpsPerSec Registration requests per sec

RegistrationRejectsPerSec Integer Registration rejects per sec

RegistrationAvgRequestTime Double Registration average request time

xendesktop Hypervisor Node Metrics

64 xendesktop Guide

SoftRegistrationsPerSec OpsPerSec Soft registrations per sec

HardRegistrationsPerSec OpsPerSec Hard registrations per sec

DatabaseConnected Integer Total number of databases connected

DatabaseTransactionsPerSec Integer Database transactions per sec

DatabaseTransactionErrorsPerSec Integer Database transaction errors per sec

DatabaseAvgTransactionTime Double Database average transaction time

ExpiredLaunchesPerSec OpsPerSec Expired launches per sec

ExpiredRegistrationsPerSec OpsPerSec Expired registrations per sec

PingRequests Integer Total number of ping requests

RegistrationRequests Integer Total number of registration requests

DeregistrationRequests Integer Total number of deregistration requests

ExpiredRegistrations Integer Total number of expired registrations

BrokeredSessions Integer Total number of brokered sessions

xendesktop Hypervisor Node Metrics Metric Unit Description

Capabilities String Capabilities the machine supports: MultiSession, CBP1_5, Unknown

HypHypervisorConnectionUID String Internal ID of specific hypervisor

Name String Name of the hypervisor attached to desktop

PreferredController String Name of the controller under which the hypervisor exists

State Boolean State of the connection between broker and hypervisor: Failed, Off, On, Active, Unknown

UID Integer Internal UID of specific hypervisor

xendesktop License Server Node Metrics Metric Unit Description

ApplicationLicenseEdition String Address of broker service instance

xendesktop Machine Node Metrics


ApplicationLicenseGraceSessionsRemaining Integer Count of remaining application grace sessions for the license

ApplicationLicenseModel String Application license model: Concurrent; UserDevice; Unkown

ApplicationLicenseSessionsActive Integer Count of application active license sessions

DesktopLicenseEdition String Desktop groups with the specified color depth. Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.

DesktopLicenseGraceSessionsRemaining Integer Count of remaining desktop license grace sessions

DesktopLicenseModel String Desktop license model in use. Values can be Unknown, Concurrent or UserDevice.

DesktopLicenseSessionsActive Integer Count of desktop active license sessions

DNSResolutionEnabled Boolean Indicates whether DNS resolution is enabled

LicenseGraceHours Integer Count of license grace hours remaining

LicenseGracePeriodActive Boolean Indicates whether license grace period is active or not

LicenseGraceSessionsRemaining String Count of license grace remaining

LicenseOutOfBoxGracePeriod Boolean Indicates whether out of box grace period is active or not

LicenseSessionsActive Integer Count of active license sessions

LicenseServerName String Name of license server

LicenseServerPort Integer Port of license server

xendesktop Machine Node Metrics Metric Unit Description

AgentVersion String Version of the Citrix Virtual Delivery Agent (VDA) installed on the machine

AllocationType Enumeration How the machine is allocated to the user (values can be: Unknown, Permanent and Random)


66 xendesktop Guide

ApplicationsInUse String List of applications in use on the machine (in the form of browser name)

AssignedClientName String Machines that are assigned to specific client name

AssignedIPAddress String Machines that are assigned to specific IP address

AssociatedUserSIDs String User SIDs associated with the machine

AssociatedUserFullNames String Current user for shared desktops, and assigned user for private desktop

AssociatedUserNames String Name of the user associated with virtual desktop (in the form 'domain\user')

AssociatedUserUPNs String User Principle Name (in the form 'user@domain')

Capabilities Enumeration List of the capabilities that the machine supports. Valid capabilities are:MultiSession, CBP1_5, Unknown.

CatalogKind Enumeration Catalog Type(Valid values are ThinCloned, SingleImage, PowerManaged, Unmanaged, Pvs, Pvd, and PvsPvd).

CatalogName String Name of catalog which is associated with the virtual desktop

CatalogUID Integer UID of the catalog that is associated with the virtual desktop

CatalogUUID String UUUID of the catalog the machine is a member of

ColorDepth String The color depth setting configured on the machine.Possible values are:$null, FourBit, EightBit, SixteenBit, and TwentyFourBit.

ControllerDNSName String DNS name of the controller the machine is registered to

DeliveryType String Denotes whether the machine delivers desktops only, apps only, or both: DesktopsOnly; AppsOnly; DesktopsAndApps; Unknown.

Description String Description of the machine



DesktopConditions String List of outstanding desktop conditions for the machine

DesktopGroupUID String UID of desktop group the machine is a member of

DesktopGroupUUID String UUID of desktop group the machine is a member of

DesktopGroupName String Name of the desktop group the machine is a member of.

DesktopUID Integer Internal ID (UID) of the virtual desktop

DesktopKind Enumeration Denotes whether the machine is private or shared. Note: AllocationType should be used instead

DNSName String DNS name of the virtual desktop

FaultState String Summary state of any current fault state of the machine

FunctionalLevel String Functional level of the machine, if known

HostedMachineID String Machine ID of the virtual desktop as known by hypervisor

HostedMachineName String Machine name of the virtual desktop as known by hypervisor

HostingServerName String DNS name of the hypervisor that is hosting the machine if managed

HypervisorConnectionName String Name of the hypervisor connection

HypervisorConnectionUID Integer Internal ID (UID) of the hypervisor which is hosting the current virtual desktop

HypHypervisorConnectionUID String The UUID of the hypervisor connection that the machine’s hosting server is accessed through

IconUID Integer The UID of the machine's icon that is displayed in StoreFront.

ImageOutofDate Boolean Denotes whether the VM image for a hosted machine is out of date

InMaintenanceMode Boolean Denotes whether the machine is in maintenance mode


68 xendesktop Guide

MachineInternalState String Specified internal machine state: Available; InUse; Disconnected; Off; Unregistered; Unknown.

IPAddress String IP address of the machine

IsAssigned Boolean Assignment status of virtual desktop (Machines may be assigned to one or more users or groups, a client IP address or a client endpoint name)

IsPhysical Boolean This value is true if the machine is physical (ie not power managed by the Citrix Broker service, and false otherwise.

LastConnectionFailure String Reason for the last recorded connection failure; None; SessionPreparation; RegistrationTimeout; ConnectionTimeou; Licensing; Ticketing; Other; Unknown.

LastConnectionTime String Last connected time. This is the time that the broker detected that the connection attempt either succeeded or failed.

LastConnectionUser String The SAM name (in the form DOMAIN\user) of the user that last attempted a connection with the machine. If the SAM name is not available, the SID is used.



LastDeregistrationReason Enumeration Last reason given for deregistration of the machine with the broker: AgentShutdown; AgentSuspended;

AgentRequested;IncompatibleVersion; AgentAddressResolutionFailed; AgentNotContactable; AgentWrongActiveDirectoryOU; EmptyRegistrationRequest; MissingRegistrationCapabilities; MissingAgentVersion; InconsistentRegistrationCapabilities; NotLicensedForFeature; UnsupportedCredentialSecurityVersion; InvalidRegistrationRequest; SingleMultiSessionMismatch; FunctionalLevelTooLowForCatalog; FunctionalLevelTooLowForDesktopGroup; PowerOff;DesktopRestart; DesktopRemoved; AgentRejectedSettingsUpdate; SendSettingsFailure; SessionAuditFailure; SessionPrepareFailure; ContactLost; SettingsCreationFailure; UnknownError; BrokerRegistrationLimitReached; Unknown

LastDeregistrationTime String Time of last deregistration of machine with the controller

LastErrorReason String Reason for last error on machine

LastErrorTime String Time of last error on machine

LastHostingUpdateTime String Last update time of hosting information on machine

LastConnFailure String Reason for the last recorded connection failure. Valid values are: None; SessionPreparatio; RegistrationTimeout; ConnectionTimeout; Licensing; Ticketing; Other; Unknown.

LoadIndex Integer Gives current effective load index for multi-session machines


70 xendesktop Guide

LoadIndexes String Gives the last reported individual load indexes that were used in the calculation of the LoadIndex value. This value is only set for multi-session machines.

MachineName String Machine name (in the form 'domain\machine')

MachineInternalState String The internal state of the machine; reported while the machine is registered to a controller, plus some private Citrix Broker Service states while the machine is not registered. Specified internal machine state: Available; InUse; Disconnected; Off; Unregistered; Unknown.

MetaDataMap String Any metadata that is associated with the machine

OSType String Used to identify the operating system that is running on the machine

OSVersion String Used to identify the operating system version that is running on the machine


PowerActionPending Boolean State of pending power action (true or false)

PowerState Enumeration Current power state of virtual desktop. Possible values are: Unmanaged, Unknown, Unavailable, On, Suspended, TurningOn, TurningOff, Suspending and Resuming.


PublishedApplications String List of applications published by the machine (displayed as browser names)

PublishedName String The name of the machine that is displayed in StoreFront, if the machine has been published



PVDStage Enumeration Personal vDisk stage. Valid values are Working; PoweringOn; Requested; None; Unknown.

RegistrationState Enumeration Registration state of the desktop. Valid values are :Registered, Unregistered, and AgentError.

ScheduledReboot Enumeration Indicates the state of any scheduled reboot operation for a machine

SecureICAReq Boolean Flag indicates whether SecureICA is required or not when starting a session on the machine

SessionAutonomouslyBrokered Boolean Session property indicating if the current session was started without the use of the broker

SessionClientAddress String Session property indicating the IP address of the client connected to the machine

SessionClientName String Session property indicating the host name of the client connected to the machine

SessionClientVersion String Session property indicating the host name of the client connected to the machine

SessionConnectedViaHostName String Session property, indicates host name of the connection gateway, router or client

SessionConnectedViaIP String Session property, indicates the IP address of the connection gateway, router or client

SessionCount Integer Number of sessions on the machine

SessionDeviceID String Session property indicating a unique identifier for the client device that has most recently been associated with the current session

SessionHardwareId String Session property indicating a unique identifier for the client hardware that has been most recently associated with the current session

SessionHidden Boolean Indicates whether or not the session is hidden


72 xendesktop Guide

SessionKey String The key of current session on the machine

SessionLaunchedViaHostname String Denotes the host name of the StoreFront server used to launch the current brokered session

SessionLaunchedViaIp String Denotes the IP address of the StoreFront server used to launch the current brokered session

SessionProtocol Enumeration Denotes the protocol that the current session is using, can be either HDX or RDP

SessionSecureICAActive Boolean Indicates whether or not secure ICA active on the current session

SessionsEstablished Integer The SID of the machine

SessionSmartAccessTags String Smart access tags for current session

SessionsPending Integer Number of pending (brokered but not yet established) sessions on this machine. For multi-session machines this also includes established sessions which have not yet completed their logon processing.

SessionStartTime String Start time for current session

SessionState String State of current session: Active = 0; Connected = 10; Disconnected = 20; Reconnecting = 30; PreparingSession = 40; NonBrokeredSession = 50; Unknown = 100.

SessionStateChangeTime String Time current session last changed state

SessionSupport String Indicates session support for the machine, single or multi

SessionUID Integer Session UID ($null for no session)

SessionUserName String Name of current session user

SessionUserSID String SID of the current session user

SID String MachineSID

SummaryState String The summary state of the machine: Available; InUse; Disconnected; Off; Unregistered; Unknown.

Tags String Tags for the machine

xendesktop Resource Node Metrics


UID Integer Internal ID(UID) of the machine object

UUID String Universally unique identifier (UUID) of the machine object

VMToolsState String State of hypervisor tools on the VM machine, if any

WillShutDownAfterUse Boolean Machine will shut down after use (True or False)

WindowsConnectionSetting Enumeration The logon mode reported by Windows itself (multi-session machines only).Values are: LogonEnabled; Draining; DrainingUntilRestart; LogonDisabled; Unknown. For single-session machines the value is always hardwired to LogonEnabled.

xendesktop Resource Node Metrics Metrics Unit Description

DesktopsAvailable Integer Number of available desktops

DesktopsAvailablePercent Percent Percentage of all desktops available

DesktopsDisconnected Integer Number of disconnected desktops

DesktopsDisconnectedPercent Percent Percentage of disconnected desktops

DesktopsInMaintenanceMode Integer Number of desktops in maintenance mode

DesktopsInMaintenanceModePercent Percent Percent of desktops in maintenance mode

DesktopsInUse Integer Number of desktops currently in use

DesktopsInUsePercent Percent Percent of desktops currently in use

DesktopsNeverRegistered Integer Number of desktops never registered

DesktopsNeverRegisteredPercent Percent Percent of desktops never registered

DesktopsPreparing Integer Number of desktops in preparing state

DesktopsPreparingPercent Percent Percent of desktops in preparing state

DesktopsTotalCount Integer Total number of all desktops

DesktopsUnregistered Integer Number of unregistered desktops

DesktopsUnregisteredPercent Percent Percent of unregistered desktops

xendesktop Services Node Metrics

74 xendesktop Guide

DesktopsUnregisteredPowerOff Integer Number of unregistered desktops which are powered off

DesktopsUnregisteredPowerOffPercent Percent Percent of unregistered desktops which are powered off

DesktopsUnregisteredPowerOn Integer Number of unregistered desktops which are powered on

DesktopsUnregisteredPowerOnPercent Percent Percent of unregistered desktops which are powered on

HypervisorsTotalCount Integer Number of hypervisors

MachinesTotalCount Integer Total number of machines

xendesktop Services Node Metrics Metric Unit Description

DesktopInteract Boolean Windows service that runs on the interactive desktop

DisplayName String Display name of the service in the UI

ErrorControl Enumeration Instructions for how to proceed if the driver for the service fails to load or initialize

ExitCode Integer Exit codes generated when a service fails without an error message

Name String Name of the service

Path String Path of the service

ProcessId Integer Process Id of the service

ServiceType Enumeration

Type of the service: Kernel Driver; File System Driver Adapter; Recognizer Driver; Own Process; Share Process; Interactive Process; Null

Started Boolean States whether or not service has started

StartMode Enumeration Start mode of the service: Boot; System; Auto;Manual; Disabled; Null

State Enumeration

State of the service: Stopped;StartPending; StopPending; Running; ContinuePending; PausePending; Paused; Null

xendesktop Site Node Metrics


Status String Status of the service: Ignore; Normal; Severe; Critical; Null

xendesktop Site Node Metrics Metric Unit Description

BrokerServiceStatus String UnknownBroker service status: String; DBUnconfigured; DBRejectedConnection; InvalidDBConfigured; DBNotFound; DBMissingOptionalFeature; DBMissingMandatoryFeature; DBNewerVersionThanService; DBOlderVersionThanService; DBVersionChangeInProgress; OK; PendingFailure; Failed; Unknown

DBVersion String DB version of the broker controller

HypConnectionUID String Hypervisor Connection UID of the broker controller

InitialCatalog String Initial catalog of the broker controller

IntegratedSecurity String Integrated security of the broker controller

Server String Server for the broker controller

ca unified infrastructure management xendesktop...

Documents