Citrix Virtual Apps and Desktops, formerly XenDesktop, fits the enterprise need to bring both VDI and apps into a user-centric experience.
Citrix Virtual Apps, formerly XenApp, fits the enterprise need to bring legacy apps into a cloud management environment.
Citrix Health Assistant v1.8.3.71
Created Date: Mar 4, 2016
Updated Date: Oct 16, 2023
SHA 256 Checksum: a00ee71edef04eccae1f694e348905a1f9a90c17af2f69195fc2d467ece3f4d3
Description
The Citrix Health Assistant is a Windows tool that helps administrators troubleshoot configuration issues in a Citrix environment. The tool provides GUI and supports operation from the command line.
The tool conducts the following health checks on a VDA and reports check results in the GUI and in the log file:
VDA registration:
- VDA Software Installation
- VDA Machine Domain Membership
- VDA Communication Port Availability
- VDA Services Status
- Windows Firewall Configuration
- Communication with Controller
- Time Sync with Controller
- VDA Registration Status
Session Launch:
- Session Launch Communication Port Availability
- Session Launch Services Status
- Session Launch Windows Firewall Configuration
- VDA Remote Desktop Services Client Access Licenses
- VDA Application Launch Path
Time Zone Redirection:
- Windows Hotfix Installation
- Citrix Hotfix Installation
- Microsoft Group Policy Settings
- Citrix Group Policy Settings
Citrix Provisioning Event Log:
- Citrix Provisioning Licensing Status
Profile Management Configuration:
- Profile Management WinLogon Logon Hook
- Profile Management WinLogon Logoff Hook
- Profile Management Installation Status
- Profile Management Driver Status
- Recommended Value Check
Prerequisites
- Windows 7 or later with .Net 4.6.2 or later installed
- Citrix XenDesktop or XenApp 7.6 VDA or later
- To check a remote VDA, you must:
- Enable Windows Remote Management (WinRM) on the remote VDA you want to check.
- Have a domain user account with local administrator privileges on the remote VDA and an administrator role of Citrix Studio on the Delivery Controller.
What's New in v1.8.3.71
- Changed the minimum supported .Net Framework version to 4.6.2.
- Added support for detecting the statuses of well-known inbound rules when checking Windows Firewall Configuration for “VDA Registration” and “Session Launch”.
- Fixed an issue that might cause false “Missing or incorrect versions of the Microsoft Visual C++ Redistributable” alarms when the Citrix Desktop Service is stopped.
Changes from Previous Versions
v1.8.2.62
- Fixed an issue that might cause false "Remote Desktop Server Client Access License is invalid" alarms on single-session OS VDAs.
- Fixed an issue that might cause false "Citrix HDX MediaStream for Flash Service is not found" alarms.
v1.8.1.23
- Removed the “Share data with Customer Experience Improvement Program” setting option from the tool.
- Skipped application launch path checks on Desktop OS VDAs.
v1.8.0.15
- Added live session checks.
- Integrated the UPMConfigCheck tool (see Knowledge Center article CTX132805).
- Improved user interface.
- Added checks on the installation statuses of required C++ redistributables.
- Added checks to ensure that the VDA’s functional level is not lower than its machine catalog’s minimum functional level.
- Added checks on Citrix Provisioning event logs.
- Provided hyperlinks to Citrix Knowledge Center articles in check failure descriptions.
- Provided a hyperlink to the Citrix Technical Support website on the Report screen.
- Added a precondition check to ensure that the user running the tool has local administrator privileges on the VDA.
v1.6.0.26
- Added session launch checks on the VDA application launch paths and on the VDA Remote Desktop Services client access licenses (RDS CALs).
- Addressed an issue where the CHA log was displaying an incorrect VDA version.
v1.5.0.57
- Addressed an issue that could cause the tool exit unexpectedly.
- Added detailed error messages for domain, ports, services, and Delivery Controllers.
- Added tool exit codes when running the tool from the command line.
v1.4.0.36
- Added time zone redirection configuration checks.
- Bug fixes.
v1.3.0.17
- Removed the need for pressing Enter to end a command line execution.
- Provided an error message if there is a time difference between the local and the remote machines during remote check.
- Addressed an issue that could cause the tool to stop running unexpectedly.
- Addressed an issue that could prevent the tool from processing parentheses in listofDDCs correctly.
- Addressed an issue that could prevent the tool from checking the Delivery Controllers specified through Group Policy.
- Addressed an issue where multiple tool instances could be run at the same time.
- Bug fixes.
How to Use Citrix Health Assistant
To use the tool, download CitrixHealthAssistant.zip file from the top of this webpage. Extract the zip file to a folder on the target VDA or on any Windows machine that is in the same domain as the target VDA. No installation is required.
You can use the tool both from the graphical UI (GUI) and from the command line.
To use the tool from GUI:
1. Run CitrixHealthAssistant.exe as an administrator by right-clicking the executable file and selecting "Run as administrator."
2. Specify the VDA to be checked.
- To perform checks on the current machine, choose “Run locally.”
- To perform checks on a remote VDA, choose “Enter the FQDN of the target VDA.” Enter the Fully Qualified Domain Name (FQDN), username, and password.
Click “Next.”
3. On the Report screen, a green check mark indicates a successful check and a red cross mark indicates a failed check. Expand the arrow at the end of each item to see details.
Expand check results. See the following image for an example.
4. Click "View Log" to view logs of all checks conducted.
5. Click the gear icon in the top-right corner to see and edit the tool’s settings. You can:
- Send feedback by clicking the link provided.
- Click “Check for new version” to check whether a new version of the tool is available.
To use the tool from the command line:
- To start the tool, run the command “Citrix Health Assistant.exe" –start.
- To view the command line help, run the command “Citrix Health Assistant.exe" –help.
- To specify whether to upload CEIP data, run the command “Citrix Health Assistant.exe" –start –upload [yes/no] The default setting is Yes.
- To get the tool exit code, run the command “start /wait CitrixHealthAssistant.exe -parm1 -parm2 ...” or the command "echo %errorlevel%".
- Exit code 0: All checks are completed and all tests passed.
- Exit code 1: All checks are completed but one or more checks failed.
- Exit code 2: The tool execution was canceled.
To customize the logging level:
Open the log4net.config file, located in the same folder as CitrixHealthAssistant.exe. Locate “<level value="INFO" />” in the “<root>” element, and change it to “<level value=" DEBUG" />” or “<level value="ERROR" />” based on your preference. The log uses “INFO” as the default.
Data Modified by Citrix Health Assistant
None, except the log files in the “Log” folder located in the same folder as CitrixHealthAssistant.exe.
Uninstalling Citrix Health Assistant
Delete the extracted files from the current folder, including the Log folder if needed.
Known Issues
| Failure Type | Description | Possible corrective action |
| Remote check | Remote check might fail with the following error message: “DEBUG – Exception details: Could not find a part of the path ‘\\FQDN\Admin$\Temp\Log\CitrixHealthAssistant.log'” |
Check whether the Application Experience service has been stopped on your remote machine. If the service has been stopped, restart it and rerun the tool. This issue tends to occur on Windows 7 and Windows 2008 R2 systems. |
| Remote check | Remote check with both the “Citrix Provisioning Event Log Check” and the “Profile Management Configuration Check” selected causes the Profile Management Configuration Check script to become unresponsive until the timeout (40 seconds) is reached and the execution ends. |
Citrix is working on resolving the issue in a future version. |
Contact Information
Questions? Concerns? Comments? Send your feedback to https://podio.com/webforms/15150115/1015618.
Disclaimer
These software applications are provided to you as is with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.