Overview of troubleshooting tools for Citrix
There are several troubleshooting tools for Citrix environments out there, some from Citrix and from many 3-parties.
Here is a overview of many good tools to troubleshoot with and some to do configuration in Citrix XenApp, XenDesktop, Xenserver and Provisioning Server.
Citrix XenDesktop Troubleshooting Tools:
| XD Ping Tool | The XDPing tool is a command-line based application which automates the process of checking for the causes of common configuration issues in a XenDesktop environment. The tool can be used to verify configuration settings on both the XenDesktop Broker and VDA machines, both from the console and remotely. |
| Citrix Xnapshot |
Citrix Xnapshot is a profiling and monitoring utility focused on the Citrix XenDesktop Environment. It collects a wealth of information about the underlying system and its configuration, such as BIOS information, Registry information, Device Drivers, Windows Services, Installed Hotfixes, Citrix Binaries, and Citrix XenDesktop Farm information. The data collected is organized in such a way to make it easy for various Xnapshot collections to be compared against each other to quickly highlight any changes in the environment. The Xnapshot application itself provides the facility for viewing and comparing these reports. |
| CDFCheck 1.0 | Cmd is a small utility which allows you to determine the CDF Module which a binary file uses, if any. |
| XenDesktop Virtual Desktop Agent Troubleshooting Utility | When reproducing XenDesktop Virtual Desktop Agent issues in a lab environment it can be a time-consuming task to make frequent changes to Virtual Desktop Agent settings, such as changing its farm membership, checking Virtual Desktop Agent and ICA software versions, and viewing other pertinent information such as current farm, registered Desktop Delivery Controller (DDC), Desktop Group, hostname, IP address, log settings, and so on. |
| XenDesktop Session Parser | XenDesktop Session Parser is a useful tool that allows an administrator to historically track and retrieve detailed connection data for each user and workstation from a central point. |
| XenDesktop 4.0 Client Identity Pack | Citrix XenDesktop 4.0 Client Identity Pack contains tools to obtain information on a XenDesktop 4.0 Virtual Desktop Machine relating to the identity of the client machine (if any) that is connected to the desktop using ICA. |
| HDX Experience Monitor for XenDesktop | his tool is designed to provide detailed information about the various HDX technologies, their performance and diagnostics information. The HDX technologies covered by this tool are:
Thinwire (Graphics), Audio, MediaStream, Flash, USB, Branch Repeater |
| Citrix Printing Tool 3.1 | Citrix Printing Tool 3.1 helps configuring and troubleshooting the Citrix Printing subsystem on XenApp, XenApp Online Plugin, and XenDesktop. |
XenServer Tools:
| Citrix Project Kensho | Kensho OVF technology is now available from within XenServer 5.6. We still take feed back and provide limited support for the Project Kensho OVF Tool 1.3’s Hyper-V functionality. Bring your issues and comments to the forum. We’d love to hear from you. |
| XenServer Virtual Machine Performance Utility. | PerformanceVM is a XenServer virtual machine that helps troubleshoot performance related issues, such as poor performance caused by storage I/O and network I/O. The virtual machine, built on Debian Linux, equips with following test utilities and is accessible using a Web based user interface |
| Citrix Xnapshot 1.0 | Citrix Xnapshot is a profiling and monitoring utility focused on the Citrix XenDesktop Environment. It collects a wealth of information about the underlying system and its configuration, such as BIOS information, Registry information, Device Drivers, Windows Services, Installed Hotfixes, Citrix Binaries, and Citrix XenDesktop Farm information. The data collected is organized in such a way to make it easy for various Xnapshot collections to be compared against each other to quickly highlight any changes in the environment. The Xnapshot application itself provides the facility for viewing and comparing these reports. |
| XenServer Workload Balancing Administration Tool | The XenServer Workload Balancing Administration Tool lets you monitor the Workload Balancing (WLB) server status and manage properties specific to the WLB server, such as WLB services, accounts, and logging.
This utility runs on the WLB server and is not part of XenCenter. You must be a local administrator to run this tool |
Misc/General Tools:
| Tool Name |
The purpose of this tool |
| AccessEnum v1.32 | AccessEnum gives you a full view of your file system and Registry security settings.
AccessEnum uses standard Windows security APIs to populate its listview with read, write, and deny access information. This tool can be used to troubleshoot access and rights issues. |
| Citrix Utility AppEdit | Simple GUI tool to allow quick management of published applications on a Citrix Server farm. |
| AppManagmentTool – Perform Common Application Management Tasks with this MFCOM Utility | Perform common application management tasks faster and easier with this handy MFCOM utility. Use the AppManagement tool to manage applications. This tool is written in C#.net and uses an Mfcom.dll to query the IMA. |
| Centralis Centinel Reboot | Monitors connections to a Terminal Server and reboots it once all users are logged off or disconnected. Can also automatically run a script before reboot. |
| CHFARM
-Available with the Citrix Presentation Server installation Presentation Server Administration Guide – Appendix A |
An administrator can use CHFARM to move a server from its current server farm. The server can be moved to an existing server farm or can be moved into a new farm which is created at the same time that the server is moved.
CHFARM can be used to isolate problems and prove whether the data store is involved, or causing the issue. |
| Citrix Enterprise Tracer 5.8 | Citrix Enterprise Tracer 5.8 enables IMA debugging trace information under the instruction of Citrix Technical Support. |
| Common Diagnostics Facility (CDF)
– Available with the Citrix Presentation Server installation |
The Common Diagnostic Facility (CDF) is a utility available as part of the Access Suite Console that allows administrators to collect traces for problem analysis/diagnosis.
Traces can be collected on all retail binaries from MetaFrame Presentation Server 3.0 onwards without the need for stopping and starting services or disrupting users. Traces can be started and stopped remotely through the Access Suite Console, and can be easily packaged and uploaded to Citrix Technical Support to assist in problem diagnosis and resolution. Usage: Generally this tool is used on the advice of Citrix Technical Support in relation to a specific support case. |
| Viewing Common Diagnostics Facility Traces Using TraceView | CDF Viewer is a utility that allows you to view the output of a diagnostics log file that is created when a CDF trace session is completed using either the MetaFrame Access Suite Console or the CDF Viewer itself. |
| CDFControl | CDFControl is a software debugging utility that captures Citrix Diagnostic Facility (CDF) trace output messages that are output from the various Citrix product modules. |
| CtxDataXP | The CTXDataXP utility for MetaFrame XP that gathers Farm information:
IPconfig, qfarm, hotfix information, published applications clicense, queryDC, queryDS, queryHR, odbcdata, MDAC version, MetaFrame Server version, qwinsta, and the winmsd report. This utility gathers real data and pertinent information that is required to isolate, troubleshoot, and resolve issues. |
| User Profile Deletion Utility | Delprof is a command-line utility that you can use to delete user profiles on local or remote computers running Windows 2000, Windows XP, and Windows Server 2003. User profiles can grow large and may take up considerable disk space, especially if there are several users using one computer. |
| ExamDiff | This tool is for comparing text files. |
| FarmAppUtil Tool | The FarmAppUtil tool saves all the application properties with users and servers assigned to those applications in an XML file. The tool also creates a text file with a folder structure. The XML file created from the application can be modified and used for republishing all the applications and also recreate the folder structure in the new farm. |
| fc.exe
– Native to Windows 2000, Windows 2003 and NT4.0 |
Can be used to compare ntuser.dat files. |
| FileMon for Windows v7.04 | Permissions issues, such as user can not perform a task but an administrator can. |
| Findapp | Finds application running on Presentation Servers by application executable or published application name. |
| Finduser | Finds application running on you presentation servers by user name or client ID. |
| ICAPORT
-Installed with Presentation Server |
Use icaport to query or change the TCP/IP port number used by the ICA protocol on the server. The default port number is 1494. The port number must be in the range of 0–65535 and must not conflict with other well-known port numbers. |
| MessageHistory 2.0 for 32-bit and 64-bit platforms | Simple GUI tool that traces window messages, like spy++ or Winspector, but easier to use.
Consists of two executable files (32- and 64-bit). Simply start the exe, select via tick boxes which messages should be traced and click start. |
| MFHotfixutil | The MFHotfixutil tool can be used for listing and storing all hotfixes on MetaFrame servers in the form of an XML file. It can also compare the hotfixes present on two servers and list the hotfixes that are not on both servers. This tool is written in C#.net and uses Mfcom.dll to query the IMA. |
| MSGHOOK.EXE V4.0.1.0
– Presentation Server 4.x Server CD – Support – Debug: Windows 2003 |
MsgHook.exe (Message Hook) is an executable from Citrix Independent Management Architecture. MsgHook is a command line utility that displays all IMA traffic on a member server – Note: Execute msghook only if information is requested by a Citrix Technical Support representative or a Citrix engineer. When invoked, this command significantly reduces Presentation Server performance. |
| PDBFinder for 32-bit and 64-bit Platforms | The PDBFinder Deluxe utility simplifies finding rare program database (PDB) or debug (DBG) files (symbols) or determine a hotfix corresponding to a given module name and date. |
| Process Explorer v11.04 | Process Explorer shows information about which handles and DLLs processes have opened or loaded. Can be used for tracking down DLL-version problems or handle leaks, and provide insight into the way Windows and applications work. |
| PsExec v1.92 | PsExec is a light-weight telnet-replacement that lets you execute processes on other systems, complete with full interactivity for console applications, without having to manually install client software. |
| Qfarm (query farm)
– Installed with Presentation Server |
Use it to display information about servers within an IMA based server farm For Example: display the current load on each server with qfarm /load, list all currently active servers in the farm with qfarm /online. |
| QRYClientIP | Command line tool to query a session’s client IP. Used to allow one login script to process specific commands for specific IP addresses or IP segments. |
| QUERY PROCESS | Displays information about processes running on a terminal server. You can use this command to find out which programs a specific user is running, and also which users are running a specific program. |
| QUERY SESSION | Displays information about sessions on a terminal server. The list includes information not only about active sessions but about other sessions that the server runs. |
| QUERY TERMSERVER | Displays a list of all terminal servers on the network. |
| QUERY USER | Displays information about user sessions on a terminal server. |
| QueryDC
– Presentation Server installation CD – Support – Debug |
The QueryDC utility is used to determine the data collector for a given zone. Without any parameters, Querydc defaults to the host server’s zone and returns the zone name and name of the current zone data collector. |
| QueryHR
– Presentation Server installation CD – Support – Debug |
Use this utility to display information about member servers in the farm. Executing queryhr with no parameters lists all servers in the farm. Queryhr obtains information from the local host cache. |
| RegMon for Windows v7.04 | Regmon traces activity on the registry, like Processes writing/reading different registry keys.
In case of a failed access it gives the appropriate reason such as “access denied” or “not found”. It also uses filters to limit the output to what is the activity of certain processes or on certain keys. |
| Regshot | This tool compares two registry snapshots. |
| Runin | Runs an application in another session, that is from the console start an app in another users session. |
| SHADOW | Enables you to remotely control an active session of another user. |
| wbemtest.exe
– Native to Windows 2000 and Windows 2003 |
Troubleshooting Issues that Involve WMI Data. This would mainly include issues with licensing, the Access Suite Console, Suite Monitoring and Alerting or the Presentation Server Management pack for MOM.
The tool can be used to test basic functionality of WMI providers. |
| BareTail(Pro), BareGrep(Pro) | log file monitoring tool
file finding and text searching tool |
| Windows 2000 Resource Kit Tool: Soon.exe | Schedules commands to run within the next 24 hours. |
| Fiddler | Fiddler is a HTTP Debugging Proxy which logs all HTTP traffic between your computer and the Internet. Fiddler allows you to inspect all HTTP Traffic, set breakpoints, and “fiddle” with incoming or outgoing data. Fiddler is designed to be much simpler than using NetMon or Achilles, and includes a simple but powerful JScript.NET event-based scripting subsystem. |
| MemProfiler | .NET Memory Profiler is a powerful tool for finding memory leaks and optimizing the memory usage in programs written in C#, VB.NET or any other .NET Language.
It allows you to retrieve information about all instance allocations performed on the garbage collected heap (GC heap) and all instances that reside on the GC heap. The retrieved information is presented in real-time, both numerically and graphically. Using the new unmanaged resources tracker, information about unmanaged resources such as HBITMAP, HWND and unmanaged memory is also presented. |
| Wireshark | A network protocol analyzer that captures network packets for display. Useful when troubleshooting network issues related to performance, disconnects, etc. |
Terminal Services Log |
Terminal Services Log is an application that allows you to monitor Users, Applications, Farm & Application Licenses, File Audit and more. |
| Microsoft Network Monitor (NetMon) | A network protocol analyzer that captures network traffic for display. Useful when troubleshooting network issues related to performance, disconnects, etc. |
| ObserveIT Xpress v5.1 | ObserveIT is like a security camera on your servers.
Record every user action in each session: Terminal, Citrix, RDP, VMWare and more! |
Citrix Application Isolation Environments
| Dependency Walker | Dependency Walker (Depends) is a useful GUI tool for pointing to an executable on a system and listing all the DLLS required by that DLL, it will highlight any missing DLLs or conflicts. | Dependency Walker (Depends) is a useful tool for trouble-shooting application errors, file registration errors, memory access violations, and invalid page faults.
Also useful for troubleshooting Application Isolation Environment issues. |
Citrix Independent Management Architecture (IMA)
| Tool Name |
The purpose of this tool |
| Citrix Enterprise Tracer 5.8 | Citrix Enterprise Tracer 5.8 enables IMA debugging trace information under the instruction of Citrix Technical Support. |
| IMA Kill SQL Script | This script will terminate all IMA connections to an SQL 2000 database. |
| IMAPORT
– Installed with Presentation Server |
Use imaport to query, set or reset the IMA – TCP/IP port. Important: If you change port number 2513 on the first server in the farm on which you install MetaFrame Presentation Server, you cannot join additional servers to the server farm. |
| MSGHOOK.EXE V4.0.1.0
Presentation Server 4.x Server CD – Support – Debug: Windows 2003 |
MsgHook.exe (Message Hook) is an executable from Citrix Independent Management Architecture. MsgHook is a command line utility that displays all IMA traffic on a member server – Note: Execute msghook only if information is requested by a Citrix Technical Support representative or a Citrix engineer. When invoked, this command significantly reduces Presentation Server performance. |
Citrix Installation Manager
| Tool Name |
The purpose of this tool |
| The GIDWIM GUIDE from Ervik.as | A guide for application delivery, application streaming and Installation Manager |
| PackageUtil | A tool to update Installation Manager package fileshares. |
Citrix Web Interface
| Tool Name |
The purpose of this tool |
| Citrix Web Server Debugging & Analysis Tool | This tool is an Active Server Page (ASP) script for use by Citrix Web server administrators. This tool inspects a Web server running Microsoft Internet Information Services (IIS) and reports on its status as an NFuse Classic Web server, a Citrix Secure Gateway Secure Ticket Authority (STA), or a MetaFrame server providing the Citrix XML Service through IIS. |
| CTXXMLSS
– Available with the Citrix Presentation Server installation |
By default, the Citrix XML Service shares a port with IIS. The CTXXMLSS command can be used to change to a different port, or revert back to sharing with IIS |
| IE HTTP HEADERS | Internet Explorer: Used to see all the HTTP communication between a Web browser and a Web server. This includes GET requests, cookies, Referer URLs, HTTP Codes (404, 200, 500, and so on) Etags, Compression Encoding, etc. This tool is invaluable when a Web site or Web application is not behaving as it should, and you need to see what is going on “behind the scenes”. An understanding of the HTTP protocol is required to get the most out of this tool. |
| RSATest | RSATest Web page is used when you have a Secure Gateway implementation where an RSA backend server does the second method authentication. This page is used to assert proper communication between Secure Gateway/Logon Agent objects and RSA backend server. |
Microsoft Specific Tools for RDS
If you miss some great Tools, please drop us a comment to get it included!
