Citrix Command Lines

1. What What it doesMore informationAccessEnum v1.32AccessEnum 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. Useful in a scenario where an issue is only seen by a user but not by an administrator.Citrix Utility AppEditSimple GUI tool to allow quick management of published applications on a Citrix Server farm.Useful to quickly move and change published applications between servers to isolate a test environment or take a suspect server out of the possible causes. Can be used in conjunction with CHFarm to isolate a server.AppManagmentTool - Perform Common Application Management Tasks with this MFCOM UtilityPerform 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. CTX106668Centralis Centinel RebootMonitors connections to a Terminal Server and reboots it once all users are logged off or disconnected. Can also automatically run a script before reboot.This tool can be used to automate the implementation of a fix or registry hack and then reboot the server without causing any data loss for users. CHFARM-Available with the Citrix Presentation Server installationPresentation 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.If the server you want to move provides information for a Resource Manager summary database, update the summary database before using chfarm.CTX736659 Citrix Enterprise Tracer 5.8Citrix Enterprise Tracer 5.8 enables IMA debugging trace information under the instruction of Citrix Technical Support.No installation is required. Execute from a Citrix MetaFrame server Feature Release 1 – Feature Release 3 / Service Pack 4.Common Diagnostics Facility (CDF)- Available with the Citrix Presentation Server installationThe 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.There are many articles on support.citrix.com detailing which quot;
IMA modulesquot;
to select for tracing particular types of problems.CTX104578Viewing Common Diagnostics Facility Traces Using TraceViewCDF 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. CDFControlCDFControl is a software debugging utility that captures Citrix Diagnostic Facility (CDF) trace output messages that are output from the various Citrix product modules.To get this tool you need to authenticate to our support site. Support.citrix.comCtxDataXPThe 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.Ipconfig information is useful for checking issues on Multihomed computers, and identifying issues with the routing tables, also useful to have in conjunction with Network traces to identify serversQfarm is useful for identifying how many servers in the farm and which ones are Data Collectors along with the IP addresses.User Profile Deletion UtilityDelprof 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.Can be used in scenarios where there is only one user experiencing the problem or to clean local profiles off a Presentation Server. ETHEREALUsed to analyze Network traces taken in the pcap format. This tool can capture data “off the wire” or can read data saved in files from previous captures. Displayed data can be filtered to narrow down your search to traffic to and from a particular IP address. Understanding the protocol you are analyzing (such as TCP/IP) is a prerequisite to understanding the results of this tool. Example case studies: CTX110007ExamDiffThis tool is for comparing text files.Very useful for comparing good CDF traces with bad CDF traces. Capture two separate traces of any technical issue experience. Parse your output pointing to TMF files. Save the parsed output from CdfViewer to CSV format and use Examdiff to speed up the comparison of the output. Could also be used for comparing XML files for Web Interface setups.FarmAppUtil ToolThe 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. FarmAppUtil S and FarmAppUtil <folderstructure.txt> <FarmName.xml>fc.exe- Native to Windows 2000, Windows 2003 and NT4.0Can be used to compare ntuser.dat files.fc /?FileMon for Windows v7.04Permissions issues, such as user can not perform a task but an administrator can. Look for “File Not Found” or ”Permission Denied” on specific registry keys or values or search for .wav files for system beeps.Example case studies: CTX109109, CTX108980FindappFinds application running on Presentation Servers by application executable or published application name. FinduserFinds application running on you presentation servers by user name or client ID. ICAPORT-Installed with Presentation ServerUse 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.CTX101594MessageHistory 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.Used to troubleshoot issues with GUI, Seamless, Clipboard, client, and so on. 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 2003MsgHook.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 PlatformsThe 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.04Process 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.For Application Isolation Environment you can see if DLLs and Named Objects are virtualized.For Virtual Memory Optimization issues, you can use Process explorer to highlight relocated DLLs.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.Can be used in combination with SystemDump.exe to execute a system dump remotely.Qfarm (query farm)- Installed with Presentation ServerUse 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.Presentation Server Administrator's Guide - Appendix AQRYClientIPCommand 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 PROCESSDisplays 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 SESSIONDisplays 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 TERMSERVERDisplays a list of all terminal servers on the network. QUERY USERDisplays information about user sessions on a terminal server. QueryDC- Presentation Server installation CD - Support - DebugThe 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.04Regmon 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 quot;
access deniedquot;
or quot;
not foundquot;
.It also uses filters to limit the output to what is the activity of certain processes or on certain keys.Usually used to track down permission issues or problems where certain settings cannot be changed.CTX109109RegshotThis tool compares two registry snapshots.This tool can be used to troubleshoot issues with server configuration/custom registry settingsRuninRuns an application in another session, that is from the console start an app in another users session. SHADOWEnables you to remotely control an active session of another user. wbemtest.exe- Native to Windows 2000 and Windows 2003Troubleshooting 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.CTX108365BareTail(Pro), BareGrep(Pro)log file monitoring toolfile finding and text searching tool Windows 2000 Resource Kit Tool: Soon.exeSchedules commands to run within the next 24 hours.Could be used in conjunction with PrintMigrator to schedule Driver replication.FiddlerFiddler 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 quot;
fiddlequot;
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. <br />Back to top<br />Advanced Access Control<br />What What it doesMore informationMSAM / NFuse Elite CDA Packager UtilityThe MSAM / NFuse Elite CDA Packager Utility is a wizard-driven tool designed to automate the process of packaging a CDA into a MetaFrame Secure Access Manager installable format. It is used by MetaFrame Secure Access Manager developers to transition CDAs from development to production. RSATestRSATest Webpage 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. <br />Back to top<br />Application Isolation Environments<br />What What it doesMore informationAIERUN- Available with the Citrix Presentation Server installationThis is the command to launch an isolated application. Primarily for use in scripting environments. Aierun is an internal launcher used by Presentation Server during application launching. Can be used to modify shortcuts in a desktop to launch an application in Isolation. For troubleshooting purposes this could be used to test running the application in Application Isolation Environment without publishing it (remove a layer of complexity)Syntax Aierun AieName c:athpp.exe Presentation Server Administration Guide - Appendix A + Errata Dependency WalkerDependency 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.<br />Back to top<br />Fatal Errors and Application Crashes<br />- any fatal errors on servers, Dr Watson userdump<br />What What it doesMore informationHow to Use the Citrix Symbol Server to Obtain Debug SymbolsThe Citrix Symbol Server can be used to obtain the symbol files necessary to debug Citrix products. The symbol server currently contains symbols for the CPS3.0 to XenApp5.0 products.You must use a debugging tool to connect to the Citrix Symbol ServerCitrix DumpCheck Explorer Extension version 1.4 The Citrix DumpCheck tool helps to diagnose corrupt dumps. This tool is easier and quicker to use than launching WinDbg.exe and then loading the dump, and so on.Before sending dump files to another party, check that the file is not corruptCitrix DumpCheck Utility (Command Line) version 1.4The Citrix DumpCheck Utility helps diagnose corrupt dumps. This tool is easier and quicker to use than launching WinDbg.exe and then loading the dump, and so on. Unlike the Explorer extension described in CTX108825 – Citrix DumpCheck Explorer Extension version 1.4, it doesn’t require changing the environment.CTX108890Dependency WalkerDependency 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 conflictsDependency 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.Dr. Watson- Available with the Windows installationCollect the dump file when applications crash or suddenly exit.Enable Dr Watson by issuing the DrWtsn32.exe –I command at the command prompt. Further configuration options are available by issuing the command DrWtsn32.exe.When enabled, Dr Watson generates a dump file and a log file in the ocuments and Settingsll UsersocumentsrWatson directory (by default). The log file can be used to determine basic information about the error, and the dump file can be analyzed with WinDbg.Example case studies: CTX108312LiveKDLiveKD allows you to run the KD and Windbg Microsoft kernel debuggers, which are part of the Debugging Tools for Windows package, locally on a live system. Execute all the debugger commands that work on crash dump files to look deep inside the system. See the Debugging Tools for Windows documentation and our book for information on how to explore a system with the kernel debuggers.Citrix Technical Support may request you to use LiveKD in certain circumstancesLoadOrderIf you need to see the order in which the system loads device driver, this tool is for you! Can be useful in resolving device driver conflicts, exp when multiple drivers for the same device exist on the system. PDBFinder for 32-bit and 64-bit PlatformsThe 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.Windows 2000 Resource Kit Tool : CPU Usage by Processes (qslice.exe)QSlice is used in conjunction with UserDump.exe to show the thread within a process causing the spike or hang. Open Qslice, click into hanging process to get thread detail and take a screenshot before taking userdump.SystemDump 3.1 for 32-bit and 64-bit platformsThe SystemDump GUI utility can force a server to generate a memory dump from the session or when a keyboard is not available or non-standard (fatal error).UMDHUMDH dumps information about the heap allocation of a process and can be used to determine memory leaks.CTX104201UMDH DemonstrationUser Mode Process Dumper Version 8.0You can use the Userdump.exe tool to generate a user dump of a process that shuts down with an exception or that stops responding (hangs). Before dumping a hanging process, it is helpful to take a screenshot of the Qslice.exe window. This output will assist in dump analysis.Microsoft Knowledge Base article 241215WinDBGUse WinDbg to open crash dumps obtained from Dr. Watson, manually generated userdumps, or Windows crashes. Once the crash dump has finished loading, many commands can be used to provide helpful information about the error.The command !analyze –v performs basic exception analysis, reporting the error that occurred and the module in which it occurred. The command lmv can be used to show all of the modules loaded, including their full path and version information.Search support.citrix.com for quot;
WinDBGquot;
to get a list of How To guides.WinDBG 64-bitThis is the Windows debugger for 64-bit platforms. <br />Back to top<br />Citrix Access Gateway<br />What What it doesMore informationAccess Gateway Enterprise Event Log ConsolidatorThe Access Gateway Enterprise Event Log Consolidator (ELC) is a tool that facilitates collecting and viewing event log information generated by the Access Gateway Enterprise server components. *This tool is a standalone tool and is intended to work with Advanced Access Control version 4.0* RSATestRSATest 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. Secure Access Client Installation Detection and Removal Tool Secure Access Client Remover is used to detect if any Secure Access Client modules or registry entries are left after uninstalling it.If the installation of the Secure Access client is suspected to cause a conflict with another application and has to be removed for testing.CTX108092<br />Back to top<br />Citrix Licensing<br />What What it doesMore informationLMNEWLOG- Installed on Citrix License ServerThe lmnewlog utility switches the report log file by moving the existing report log information to a new file, then starting a new report log with the original report log file name. Advanced Concepts GuideLMSWITCH- Installed on Citrix License ServerThe lmswitch utility switches the debug log file written by the Citrix vendor daemon by closing the existing debug log for that vendor daemon and starting a new debug log for that vendor daemon with a new file name. Advanced Concepts Guide<br />Back to top<br />Citrix Presentation Server Console<br />Citrix Password Manager<br />What What it doesMore informationCTXDOMAINPREP.EXE- Password Manager CD - Tools folder: Password Manager 4.0A domain administrator can use the Active Directory Setup for the MetaFrame Password Manager utility to set the correct permissions for these objects. This tool is a utility, run from a command line, that sets the correct permissions for these objects on Admin Guide: CTX107846CTXFILESYNCCLEAN.EXE- Password Manager CD - Tools folder: Password Manager 4.0CtxFileSyncClean.exe removes any folders in your central store that point to objects that were deleted. This ensures that your environment contains the most up-to-date information.Admin Guide: CTX107846CTXFILESYNCPREP.EXE- Password Manager CD - Tools folder: Password Manager 4.0Delegating administration of a Citrix Password Manager central store to a group or user account that is not a domain administrator. By default, no permissions are allowed to propagate from root share to the child folders CentralStoreRoot and People. Admin Guide: CTX107846CTXNWFILESYNCPREP.EXE- Password Manager CD - Tools folder: Password Manager 4.0If you plan to use a Novell NetWare folder as your central store, you must create (while logged on with supervisor rights) the shared folder and a folder named People inside the shared folder. Admin Guide: CTX107846CTXSCHEMAPREP.EXE- Password Manager CD - Tools folder: Password Manager 4.0Delegating administration of a Citrix Password Manager central store to a group or user account that is not a domain administrator. The schema preparation tool must be run by a member of the Schema Administrators group for the target forest. Admin Guide: CTX107846Hot Desktop Shared Account (HDSA) Update ToolThe HDSA Update tool can be used to correct or update the Hot Desktop Shared Account (HDSA) information on a Hot Desktop machine. CTX108771<br />Back to top<br />Clients<br />What What it doesMore informationCHANGE CLIENT- Available with the Citrix Presentation Server installation.Presentation Server Administration Guide - Appendix Aquot;
Change clientquot;
changes the current disk drive, COM port and LPT port mapping settings for a client device.quot;
Change Clientquot;
or quot;
CHGCDMquot;
command Can be used to query or refresh client setting or printer settings. May correct settings for a timing issue at connect time or clients reconnecting from a new device.FTACLNThe FTACLN utility can be used to clean up the file type associations in the Windows Registry on the device running the Program Neighborhood Agent.After uninstalling the Program Neighborhood Agent Version 6.3x from a client device and restarting, some of the file types associated with the PNAgent can remain on the client device. This is evident, for example, when you double-click a .txt file in Explorer and the “Executable Cannot be Found” Windows message appears.CTX101594Can also be found on:Presentation Server 4.x Server CD - Support - DebugMessageHistory 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.Used to troubleshoot issues with GUI, Seamless, Clipboard, client, and so on.MSI Installation Log- Available with the Windows installationThe Microsoft Windows Installer Tool can generate a log of an MSI-based installation. To enable this the MSI file must be installed using the MSEXEC command from the command prompt.Microsoft Knowledge Base article 227091Repair Clipboard Chain 2.0.1The RepairCBDChain utility temporarily restores clipboard functionality.Run the RepairCBDChain utility on your workstation and/or inside the session desktop Repair Clipboard Chain 2.0.1 for 64-bit platformsThe RepairCBDChain64 utility for x64 platforms. TWCONFIG- Installed with Presentation ServerUse twconfig to configure ICA display settings that affect graphics performance for clients.Presentation Server Administration Guide - Appendix AWindowHistory 4.0 for 32-bit platformsThe WindowHistory utility complements Spy++ and other tools. It constantly monitors windows in the system (session) and records all changes made to it. Information about windows can then be saved for further analysis. WindowHistory Mobile Version 2.2This is the version of the WindowHistory tool that works on ARM processors. WindowHistory64 4.0 for x64 platformsThis is the version of the WindowHistory tool that works on 64-bit platforms. WinspectorWinspector is a freeware that can be used instead of Spy++ with mostly the same functionality.It captures all messages (keyboard input, mouse movements/click, changes in the window size and location, and so on) sent to a particular application for identifying issues with ICA clients, compare results inside a session and outside a session, keyboard mapping issues, and so on.Useful for troubleshooting some Seamless Windows issues and allows distinguishing of the Window Class Name, which is then used to set an exception flag.CTX103137CTX101644<br />Back to top<br />Content Redirection<br />What What it doesMore informationFTACLNThe FTACLN utility can be used to clean up the file type associations in the Windows Registry on the device running the Program Neighborhood Agent.After uninstalling the Program Neighborhood Agent Version 6.3x from a client device and restarting, some of the file types associated with the Program Neighborhood Agent can remain on the client device. This is evident, for example, when you double-click a .txt file in Explorer and the “Executable Cannot be Found” Windows message appears.CTX101594Can also be found on:Presentation Server 4.x Server CD - Support - Debug<br />Back to top<br />CPU Utilization and Memory Optimization<br />What What it doesMore informationADSCleaner 2.0Citrix Memory Optimization works by creating Alternate Data Streams on each of the optimized files. Disabling the feature or adding a file to the exclusion list does not remove the Alternate Data Stream. The ADSCleaner.exe utility lists and optionally deletes alternative data streams created by Citrix memory optimization code. ADSCleaner64 2.0 (for x64 platforms)Citrix Memory Optimization works by creating Alternate Data Streams on each of the optimized files. Disabling the feature or adding a file to the exclusion list does not remove the Alternate Data Stream. The ADSCleaner64.exe utility lists and optionally deletes alternative data streams created by Citrix memory optimization code on x64 platforms.<br />Back to top<br />Data Store Issues<br />- database corrupted, database migration issue, database connection issues<br />What What it doesMore informationDSCHECK Version 5.15 - For Presentation Server 4.0 - DiscontinuedDSCheck provides a way to perform validation checks on a server farm's data store. Results are displayed on the console and written to the event log. The /clean option deletes inconsistent records. Citrix recommends that you back up the data store before using the /clean option.Further information on using this tool can be found in Citrix Knowledge Base article CTX107800 Example case studies: CTX106958Can be used if irregularities are seen in the Presentation Server Console.DSMaint- Available with the Citrix Presentation Server installationDSMAINT is used to configure the IMA data store database for a server farm. When using this command, user names and passwords may be case-sensitive, depending on the database product being used and the operating system it runs on. DSView - Available on the Support folder of the Server CDDSView can be used when you need to look at the value or find a specific record in the data store or the local host cache. DSView works by capturing the data from the Binary Large Object (BLOB) and placing it in an order so it can be interpreted.CTX106232Example case studies: CTX109189, CTX108318FarmAppUtil ToolThe 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. FarmAppUtil S and FarmAppUtil <folderstructure.txt> <FarmName.xml>fc.exe- Native to Windows 2000, Windows 2003 and NT4.0Can be used to compare ntuser.dat filesfc /?IMA Kill SQL ScriptThis script will terminate all IMA connections to an SQL 2000 database.CTX106684MIGRATETOMSDE- Installed with Presentation ServerUse migratetomsde to migrate a server farm’s data store from Microsoft Access to Microsoft SQL Server 2000 Database Engine (MSDE). Migratetomsde offers fail-safe operation and automatically rolls back any changes that it makes to the system in the event oPresentation Server Administration Guide - Appendix AQueryHR- Presentation Server installation CD - Support - DebugUse 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. <br />Back to top<br />Independent Management Architecture (IMA)<br />What What it doesMore informationCitrix Enterprise Tracer 5.8Citrix Enterprise Tracer 5.8 enables IMA debugging trace information under the instruction of Citrix Technical Support.No installation is required. Execute from a Citrix MetaFrame server Feature Release 1 – Feature Release 3 / Service Pack 4.IMA Kill SQL ScriptThis script will terminate all IMA connections to an SQL 2000 database.CTX106684IMAPORT- Installed with Presentation ServerUse 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.Administrators Guide - Appendix AMSGHOOK.EXE V4.0.1.0Presentation Server 4.x Server CD - Support - Debug: Windows 2003MsgHook.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. <br />Back to top<br />Installation Manager<br />What What it doesMore informationPackageUtilA tool to update Installation Manager package fileshares.In case the share has moved or packages removed from the share. Run packageutil /? To get a full list of switches.<br />Back to top<br />Installation/Migration<br />- any issue related to installation or migration of Presentation Server, unable to install/uninstall<br />What What it doesMore informationMIGRATETOMSDE- Installed with Presentation ServerUse migratetomsde to migrate a server farm’s data store from Microsoft Access to Microsoft SQL Server 2000 Database Engine (MSDE). Migratetomsde offers fail-safe operation and automatically rolls back any changes that it makes to the system in the event o.Presentation Server Administration Guide - Appendix AMSI Installation Log- Available with the Windows installationThe Microsoft Windows Installer Tool can generate a log of an MSI-based installation. To enable this the MSI file must be installed using the MSEXEC command from the command prompt.Microsoft Knowledge Base article 227091Wilogutl.exe- Available with Microsoft Platform SDKWilogutl.exe assists the analysis of log files from a Windows Installer installation, and it displays suggested solutions to errors that are found in a log file. <br />Back to top<br />Load Balancing<br />What What it doesMore informationQueryDS- Presentation Server installation CD - Support - DebugBecause all of the dynamic information is stored in tables in the data collector’s physical RAM, this command-line utility is provided to query the current information on the local zone data collector. You can use QueryDS to determine which servers are currently available in a farm. It retrieves all information from the tables stored on the local zone data collector. For example, the PN_Table contains information about all available servers that are accepting Program Neighborhood connections. <br />Back to top<br />Login/Authentication <br />- any authentication issue such as Single Sign On, smart card authentication, Novell authentication<br />What What it doesMore informationACRCFG- Available with the Citrix Presentation Server installationUse ACRCFG to configure or enable automatic client reconnection settings for a server or a server farm.acrcfg [/server:servername | /farm][/query | /q]acrcfg /?Troubleshoot client disconnects or not getting automatically reconnected.AUDITLOG- Available with the Citrix Presentation Server installationAuditlog generates reports of logon/logoff activity for a server based on the Windows NT Server security event log. To use auditlog, you must first enable logon/logoff accounting. You can direct the auditlog output to a file.Presentation Server Administration Guide - Appendix ACAE Internet Connectivity Test ServiceWhen configuring CAE Remote access, if you run into connectivity problems this tool helps narrow down the problem by running a series of tests.Is DNS registration OK?Is IIS running?Is ASP.NET working?Is the correct website present?Is Secure Gateway running?Are any inappropriate ports open?On failure or error, a suggested resolution is provided. See Citrix Access Essentials Connectivity TestingUser Profile Deletion UtilityDelprof 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.Can be used in scenarios where there is only one user experiencing the problem or to clean local profiles off a Presentation Server. Resource Kit Web Package: IfMember.exeChecks whether the current user is a member of a specified group.Verifying Program Neighborhood Agent application sets, or desktop icons, can reference the group the application is published to.Limit LoginThe application adds the ability to limit concurrent user logins and to keep track of all login information in an Active Directory domain. LimitLogin capabilities include limiting the number of logins per user from any machine in the domain (including Terminal Server sessions), displaying the login information of any user in the domain according to specific criteria.While the main purpose of LimitLogin is to enforce concurrent login quotas, it can also be used purely as a login data capture solution that lets you manage your Active Directory environment more effectively. LogonSessions v1.1When you want to see who is authenticated and is running a session on a server.It lists the currently active logon sessions and the processes running in each session. It lists the session ID, name of the user, the authentication type, SID, Logon Server and Domain of the user.NetdiagNetdiag.exe is a command-line tool that you can use to test the network connectivity of the computer. Netdiag.exe performs a series of tests to determine the state and functionality of your network client computer. You can use the results of these tests, and the network status information that is provided by Netdiag.exe, to isolate network and connectivity problems on your Windows based workstation or server.Can be used for troubleshooting multihomed servers or client latency.Nltest.exeNltest.exe is a very powerful command-line utility that can be used to test trust relationships and the state of domain controller replication in a Windows NT domain.Can be used for multi domain farms where you suspect trusts to be an issue, when publishing applications to users or using Advanced Access Control.MedEvac 2.5The MedEvac tool is utilized to run checks against a Presentation Server farm to verify environment health.CTX108311QueryDC- Presentation Server installation CD - Support - DebugThe 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. QueryDS- Presentation Server installation CD - Support - DebugBecause all of the dynamic information is stored in tables in the data collector’s physical RAM, this command-line utility is provided to query the current information on the local zone data collector. You can use QueryDS to determine which servers are currently available in a farm. It retrieves all information from the tables stored on the local zone data collector. For example, the PN_Table contains information about all available servers that are accepting Program Neighborhood connections. RDT.EXERDT.EXE (Read Date Time) can be used to read the date and time stamps from all of the various keys in a the server's shadow area. SDT.EXE (Set Date Time) can be used to manually set the datestamps of those keys to any date that you choose.User Profile Hive Cleanup ServiceUPH Clean fixes issues with “stuck” user profiles. It kills any processes that have hooks open to the user’s profile after the user initiates the logoff process.Issues with this are commonly encountered with roaming user profiles.Microsoft Knowledge Base article 837115Userenv.log- Available with the Windows installationThe Userenv.log file is used for capturing logging and debugging information regarding the user profile and the Windows system policy processes, including registry accesses, during the logon process. This can be helpful for troubleshooting issues that occur during the logon to a Citrix server.Because of the large amount of data logged, it should be enabled on an isolated server when possible.Microsoft Knowledge Base article 221833<br />Back to top<br />NetScaler<br />What What it doesMore informationIE HTTP HEADERSInternet 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, and so on. 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. NSCONMSG- Located in /netscaler/ on all NetScaler systemsExecuted from SHELL in a NetScaler SSH session. Examples of the command are: (Note the capital K as a command switch!!)nsconmsg -K /var/nslog/newnslog -d consmsg gives you all messages sent to the console during the timeline covered by the newnslog nsconmsg -K /var/nslog/newnslog -d ? lists other arguments which can be used to gather more information.SHOW- Part of the NetScaler CLI, all versions of the NetScaler operating systemRun this command to view current configuration information. It extracts a snapshot of information from the NetScaler Kernel. Use this command if you are not familiar with the configuration or environment in which the NetScaler sits. Tcpdump- This is part of the CLI when you SSH into a TEROS box. Located in /usr/sbin on NetScalerThis command can be used to gather information on all TCP traffic passing through a particular NIC. CTX109345<br />Back to top<br />Performance <br />- ICA session slow, server slow down, ICA session hangs, application hangs, server hangs<br />What What it doesMore informationAutomatic Farm TunerThe Automatic Farm Tuner utility is designed to tweak the advanced registry setting on the data collectors in a large farm and tune the data collectors to adapt to a large farm environment. With this utility in place, all manual performance tweaking on the data collectors can be automatically set.CTX108456BAT (Bandwidth Analysis Tool)Display network usage for any client connected to any server on the LAN over RDP or ICA.Information displayed includes bytes transferred per second, timeout errors, % CPU used by the connection, memory used.Individual connections can be combined to display a summary of network usage, useful if you need to check traffic over a 64k or 128k line.Enables you to quickly see if a client (and which) is causing high CPU/RAM load or consumes network bandwidth. Can be used to troubleshoot bandwidth policies and performance issues.Citrix Connection Test Tool “Citrix Connection Test Tool” provides various connection methods for scalability test and other tests which require a number of sessions to be established. The tool enables testers to establish as many numbers of ICA sessions as they want by creating or duplicating session settings on Citrix Presentation Server Client.Useful for loading the server for trying to identify performance issues.Citrix Server Test KitThe Citrix Server Test Kit (CSTK) version 2.1 is an automated tool that can be used by administrators to configure and run various user load combinations. Can be used for loading servers for performance testing.CTX091649Latency CheckerRun this tool within an ICA session and monitor the real time the latency of your ICA session as well as CPU and memory usage on the server.This tool can be used for troubleshooting performance issues.NetdiagNetdiag.exe is a command-line tool that you can use to test the network connectivity of the computer. Netdiag.exe performs a series of tests to determine the state and functionality of your network client computer. You can use the results of these tests, and the network status information that is provided by Netdiag.exe, to isolate network and connectivity problems on your Windows based workstation or server.Can be used for troubleshooting multihomed servers or client latency.QSliceQSlice is used in conjunction with UserDump.exe to show the thread within a process causing the spike or hang. Open Qslice, click into hanging process to get thread detail and take a screenshot before taking userdump. RDT.EXERDT.EXE (Read Date Time) can be used to read the date and time stamps from all of the various keys in a the server's shadow area. SDT.EXE (Set Date Time) can be used to manually set the datestamps of those keys to any date that you choose.SMU (Session Memory Usage)Displays memory usage of each individual session on your Presentation Server TWCONFIG- Installed with Presentation ServerUse twconfig to configure ICA display settings that affect graphics performance for clients.Presentation Server Administration Guide - Appendix AUserdumpYou can use the Userdump.exe tool to generate a user dump of a process that shuts down with an exception or that stops responding (hangs). Before dumping a hanging process, it is helpful to take a screenshot of the Qslice.exe window. This output will assist in dump analysis.Microsoft Knowledge Base article 241215WinDBGUse WinDbg to open crash dumps obtained from Dr. Watson, manually generated userdumps, or Windows crashes. Once the crash dump has finished loading, many commands can be used to provide helpful information about the error.The command !analyze –v performs basic exception analysis, reporting the error that occurred and the module in which it occurred. The command lmv can be used to show all of the modules loaded, including their full path and version information.Search support.citrix.com for quot;
WinDBGquot;
to get a list of How To guides.WinDBG 64-bitThis is the Windows debugger for 64-bit platforms. <br />Back to top<br />Ports and Printing <br />- any cases related to port mapping and printing, printer autocreation, printer drivers, replications, and spooler issues/crashes<br />What What it doesMore informationStressPrinters 1.3.2 for 32-bit and 64-bit PlatformsUse to test if a driver is suitable for multi-user environments. It should be configured with multiple instances simultaneously, simulating multiple sessions autocreating printers using the same print driver. This allows an admin to ensure a driver does not cause a fatal error on their server and autocreates successfully. Print DetectiveEnumerates print drivers on local and remote machines. Displays driver details, provider, supporting files, and so on.Great for determining non-native print drivers and quickly removing them.PRINTUIBuilt-in utility to perform many printing related tasks including pushing print drivers, adding and deleting printers, and more.PRINTUI ReferenceCHANGE CLIENT- Available with the Citrix Presentation Server installation.Presentation Server Administration Guide - Appendix AChange client changes the current disk drive, COM port, and LPT port mapping settings for a client device.quot;
Change Clientquot;
or quot;
CHGCDMquot;
command Can be used to query or refresh client setting or printer settings. May correct settings for a timing issue at connect time or clients reconnecting from a new device.CLTPRINT- Available with the Citrix Presentation Server installationUse cltprint to set the number of printer pipes for the client print spooler. Printer pipes are used to send data from applications to client print spoolers. The number of pipes specifies the number of print jobs that can be sent to the spooler simultaneously.Presentation Server Administration Guide - Appendix AUse this tool to query if the maximum number of pipes has been set too low.Driver DeleterA utility for cleaning the registry after removing printer drivers.The Driver Deleter utility is used to remove old driver files and registry entries before installing new drivers. After running this utility you must reboot your server for the effects to take place. Enumerate All Printer Drivers In A Citrix FarmThe ListPrinterDrivers tool allows you to list all printer drivers in a farm. MFPrinterUtil ToolThe MFPrinterUtil.exe tool can be used for listing and storing all printer drivers on MetaFrame servers in the form of an XML file. It can also compare the printer drivers present on two servers and list the printer drivers that are not on both servers. This tool is written in C#.net and uses Mfcom.dll to query the IMA. Portmon for Windows v3.02Displays serial and parallel port activity on a system with the capability to filter the output for better overview.Useful to troubleshoot port problems, for example, using a device on the client's serial port from a published application. Run the tool in the session and on the client and see which actual commands are being sent to the port.Microsoft Windows Server 2003 Print Migrator 3.1Print Migrator provides complete backup, restore and migration operations for Windows NT-based operating systems from Windows NT 4 to Windows 2003. Qprinter- Presentation Server CD - Support – Debug folderThe Qprinter utility is used to monitor the progress of the printer driver replication queue and to import printer name mapping parameters into the data store.<br />Back to top<br />Resource Manager<br />What What it doesMore informationTSSHUTDNEnables an administrator to remotely shut down or reboot a terminal server. You can also choose to power off the server if the computer supports software control of AC power. <br />Back to top<br />Seamless <br />- any issue related to applications in Seamless only<br />What What it doesMore informationMessageHistory 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.Used to troubleshoot issues with GUI, Seamless, Clipboard, client, and so on. WindowHistory 4.0 for 32-bit platforms The WindowHistory utility complements Spy++ and other tools. It constantly monitors windows in the system (session) and records all changes made to it. Information about windows can then be saved for further analysis. WindowHistory Mobile Version 2.2This is the version of the WindowHistory tool that works on ARM processors. WindowHistory64 4.0 for x64 platforms This is the version of the WindowHistory tool that works on 64-bit platforms. WinspectorWinspector is a freeware that can be used instead of Spy++ with pretty much the same functionality.It captures all messages (keyboard input, mouse movements/click, changes in the window size and location, and so on) sent to a particular application for identifying issues with ICA clients, compare results inside a session and outside a session, keyboard mapping issues, and so on.Useful for troubleshooting some Seamless Windows issues and allows distinguishing of the Window Class Name, which is then used to set an exception flag.CTX103137CTX101644<br />Back to top<br />Shadowing<br />What What it doesMore informationSHADOWEnables you to remotely control an active session of another user. <br />Back to top<br />Teros<br />What What it doesMore informationIE HTTP HEADERSInternet 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, and so on. 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. LIST_NETWORK_CONFIG- This is part of the CLI when you SSH into a TEROS boxThis command is used to view the network IP configuration of a TEROS device. This gives a very basic overview of what IPs are configured on the box.Other variants of the ‘list_’ command are: list_open_ports ; list_routing_tables ; list_arp_tableLIVE HTTP HEADERSFireFox: 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, and so on. 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. PAROSJava HTTP Proxy Cross-platform suitable for Java 1.4.2 or later. Used to display HTTP Header and HTTP Body content. This can be used to simulate a Web user’s session when interacting with a Web application. It is possible for the proxy to trap a request or a response, whereby you can edit this, before sending it on to the browser or the server. In this you can insert your own malformed HTTP requests or HTTP Web server responses. This is especially useful in troubleshooting an application which does not behave as expected when being protected by a TEROS appliance. Can be used instead of HTTP Headers. It may not be necessary to process the HTML Body content, just the HTTP Header information.PING IP_ADDRESS [CTRL|LAN|WAN]- This is part of the CLI when you SSH into a TEROS boxThis command is used to send ICMP packets out through a specific interface. This can help resolve routing issues. Tcpdump- This is part of the CLI when you SSH into a TEROS box. Located in /usr/sbin on NetScalerThis command can be used to gather information on all TCP traffic passing through a particular NIC. CTX109345<br />Back to top<br />Virtual IP (VIP)<br />What What it doesMore informationQRYClientIPCommand 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. <br />Back to top<br />Web Interface <br />What What it doesMore informationCitrix 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. CTX052061See CTX103673 for Web Interface 3.0 and 4.0 error messaging.CTXXMLSS- Available with the Citrix Presentation Server installationBy 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 IISCTX104063Can be used to ensure that port conflicts are not seen on Presentation Servers with IIS. Try changing the XML port to a different port to see if problem persists.IE HTTP HEADERSInternet 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. RSATestRSATest 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. <br />