Citrix XenDesktop 5.x Site Checker Tool
Citrix have released a cool tool to your Citrix XenDesktop 5.x environment. Great for troubleshooting.
The XenDesktop site checker uses the XenDesktop Powershell SDK to enumerate XenDesktop 5 service groups, service instances, active site services, and hosting units. It checks whether or not services are running, it provides the ability to enable logging for each service, and provides detailed information about each component that it checks.
This tool require .NET 3.5 SP1 and the XenDesktop Powershell SDK (both must be installed with XenDesktop 5 or later).
Installing XenDesktop Site Checker
Extract XD Site Checker.exe from the download and execute on a Desktop Delivery Controller (DDC) that is a member broker of a XenDesktop site.
How to Use XenDesktop Site Checker
To use this tool, run the executable file on a XenDesktop 5 member DDC. After the site is enumerated, click any node in the right-hand tree view to view details about the node. Right-clicking different types of nodes will provide actions that can be performed, such as testing service instances, starting/stopping services, enabling service logging, or changing a hosting unit’s preferred DDC.
- The following screen shot displays the main form. The tool breaks the site up into three main nodes; Service Groups, Hosting Units, and Active Site Services:
- Selecting a node will display up to date details in the ‘Node Details’ field, and will also provide a summary of that node’s function in the ‘Description’ field.
- Right-clicking certain nodes provide actions to perform. For example, right clicking a service will provide the ability to start/stop/restart the service, or enable/disable logging:
• You can send a ping request to any service instance, if you right-click on the service instance, as shown in the following screen shot:
- If the utility did not detect an issue with an instance and the instances must be reset, then select Reset Service Instances to force a reset.
- You can also use this tool to remove storage units from a hosting unit (achieves the same result as CTX131207).
- All powershell scripts used by the tool are shown in the ‘Log Viewer’ pane.
Security Permissions Required by XenDesktop Site Checker
A XenDesktop administrator must run this tool, for the tool to have full access to the XenDesktop site and services.
Data Modified by XenDesktop Site Checker
XenDesktop Site Checker uses PowerShell to register site services, similar to the commands outlined in CTX132188. It also has the ability to start and stop services on brokers in a site, and add logging parameters to services, as outlined in CTX117452.
How to Undo the Changes Made by XenDesktop Site Checker
The changes made by this tool are all done through the SDK. However, it is always recommended to backup the XenDesktop database before troubleshooting and/or using this tool.