About recommended and custom health checks

This page has moved to docs.citrix.com. You can now find all Smart Tools documentation at the Citrix Product Documentation site. Please update any page links to the new URL: https://docs.citrix.com/en-us/smart-tools/smart-check/about-health-checks.html.



With the Smart Tools Site Agent installed on your XenApp and XenDesktop Site, Smart Check can perform a wide variety of health checks that gauge the health and availability of the Delivery Controllers and VDAs in your Site, as well as the applications and desktops that you deliver to users.

In Smart Check, health checks are categorized as:

  • Citrix Recommended Checks: These checks run automatically when you add a Site to Smart Checks. 
  • Custom checks: These checks target specific machines in your environment to help you diagnose and resolve specific issues. Citrix provides several custom checks known as Citrix Checks. If you already use your own scripts and tools to perform health checks, you can use Smart Tools to deploy those checks at regular intervals and display the results in Smart Check. For more information, see Create custom checks and alerts for Smart Check.

Citrix Recommended Checks run automatically when you add a Site to Smart Check. This includes the following checks:

  • Site Health Checks
  • Apps and Desktops Checks
  • Update Checks
  • LTSR Checks

Site Health Checks

Site Health Checks consist of the checks included in the Environment Test Service in XenApp and XenDesktop, which provide a comprehensive evaluation of all the FMA services in your Site. In addition to checking the availability of these services, these checks also look for other health indicators such as database connectivity.

Smart Tools runs these checks on Delivery Controllers only. Depending on the size of your Site, these checks can take a few minutes to an hour to perform. Citrix recommends you run these checks at least once daily. 

When Site Health Checks are scheduled to run, Smart Check runs the following checks:

  • CDF tracing is enabled.
  • Database updates (XDUs) have been applied.
  • Database version matches the expected version.
  • Feature names are valid.
  • Windows Firewall rules are enabled.
  • Host connection is not in maintenance mode.
  • HTTP/HTTPS namespace reservation exists.
  • Read Committed Snapshot is enabled.
  • Service registration is in completed state.
  • SQL Server version and service-pack level checked.
  • Stored Configuration service instances are valid and up-to-date.
  • Citrix administrators have rights assigned.
  • Citrix administrators are included in Domain Users group.
  • The license server information matches the information in the Configuration Service.
  • The selected account for machine creation is valid.
  • Citrix Monitor service can access the Monitoring database.
  • Citrix Monitor service data processing has started and is running smoothly.
  • Citrix Monitor service data querying module has started.
  • Citrix Monitor service is using the correct settings for analyzing and removing unnecessary data.
  • Citrix Monitor service is using the correct settings for grooming the data.
  • Citrix Monitor service is using the correct settings for the consolidating data.
  • Monitoring data collection has started.
  • Database schema matches the expected schema.
  • A hypervisor connection can be established.
  • Hypervisor infrastructure has been verified.
  • Hypervisor networks have been verified.
  • Hypervisor storage locations have been verified.
  • An Organization Unit in the AD identity pool exists.
  • The AD identity pool, as configured, is suitable for provisioning accounts.
  • The AD identity pool is unlocked.
  • A recent database backup exists.
  • The licensed product edition supports Configuration Logging.
  • The Configuration Logging database is connected. 
  • Configuration Logging machine SID resolution is successful.
  • The virtual machine has disks attached.
  • Connectivity to core XenDesktop services is established.
  • Connectivity to peer database instances is established.
  • File-based logging permissions are enabled and sufficient disk space is available.
  • A XenDesktop service account exists.
  • A XenDesktop service account is available in the AD Identity Service.
  • The Site database can be reached.
  • The next account generated by the AD identity pool does not exist already.
  • The service instance is registered with the Configuration Service.

Note: Smart Check executes all of these checks when Site Health Checks are run on-demand or scheduled to run at a later time. You cannot disable individual checks. 

If any of the checks return a negative result, Smart Check displays an alert for the affected components, recommends a fix to resolve the issue, and provides links to other Citrix resources so you can learn more about the issue and its resolution.

Apps and Desktops Checks

Apps and Desktops Checks verify the availability of all the Delivery Groups in your Site to ensure they are capable of delivering applications and desktops to your users. These checks do not evaluate the availability of specific applications or desktops. 

If the checks return a negative result, Smart Check displays an alert for the affected delivery group so you can address the issue.

Update Checks

Update Checks evaluate the patch level of the Delivery Controllers and VDAs in your Site, recommend applicable hotfixes, and provide links to other Citrix resources so you can learn more about the update. 

LTSR Checks

LTSR Checks verify that the Delivery Controllers and VDAs in your Site are running the correct version of XenApp and XenDesktop LTSR. 

Note: LTSR Checks only evaluate Delivery Controllers and VDAs. To verify LTSR compliance of other components in your Site, launch the LTSR Assistant and specify the components you want to check. For more information about using the Citrix LTSR Assistant, see CTX209577 in the Citrix Knowledge Center.

LTSR Assistant requirements

To run the LTSR Compliance Check successfully, the Delivery Controllers and VDAs in your Site must meet the following requirements:

  • Support for PowerShell 2.0, at a minimum.
  • Windows Firewall allows inbound ICMP Echo requests.
  • Windows Remote Management (WinRM) is enabled.
  • Port 80 allows inbound connections for the XenApp and XenDesktop PowerShell SDK. (Delivery Controllers only)
  • Port 5985 allows inbound connections for Windows Remote Management. (Delivery Controllers and VDAs)

For a complete list of requirements, see CTX209577 in the Citrix Knowledge Center.

If the Delivery Controllers and VDAs in your Site don't meet these requirements, Smart Check will fail to run LTSR Checks and will display an error status for the checks on the Site's health report. 

How LTSR checks are performed

Smart Check runs the Citrix LTSR Assistant tool on the Delivery Controllers and VDAs in your Site and generates compliance data that is analyzed through Citrix Insight Services. If any Delivery Controllers or VDAs require LTSR updates, Smart Check displays alerts for the affected machines. Smart Check does not display compliance reports when performing this check. For more detailed compliance information, run the LTSR Assistant on the affected machines as described in CTX209577

By default, Smart Check runs the latest version of the LTSR Assistant when performing these checks. If your Delivery Controllers already have the latest version of the tool installed, Smart Check runs the installed tool to perform the checks. If your Delivery Controllers have an older version installed, Smart Check installs the latest version hosted by Smart Tools to your Delivery Controllers and runs the checks. 

When you run LTSR Checks for the first time (for example, after you add your Site to Smart Check), Smart Check sends you an email notification with the check results. The email displays the machines checked and the number of warnings, if any, for each one. Smart Check sends this notification separately from notifications for Site Health, Apps and Desktops, and Updates Checks. 

LTSR alerts

Smart Check displays alerts from LTSR Compliance Checks as Warnings. If any Delivery Controllers are out of compliance, Smart Check displays an alert for each affected Controller. If any VDAs are out of compliance, Smart Check displays a single alert for the Machine Catalog to which they belong. 


Back to top

Custom checks

System requirements for targeted machines

Because custom checks allow you to target the machines where you want to run the check, the machines you target must meet the following requirements to run the check successfully.

Requirements for all custom checks

Requirements for Delivery Controller Configuration Checks

  • The Delivery Controllers you target with the check meet the requirements for all custom checks.
  • The XenApp and XenDesktop PowerShell SDK is installed on each Delivery Controller you want the check to target. The SDK is installed automatically when you install the Delivery Controller component.
  • At least one Delivery Controller in the Site is powered on, the Broker Service is running, and the database connection is working.

Add custom health checks to Smart Check

You can also use custom checks that have been developed and published by other Smart Tools users, as well as by Citrix. Custom checks are stored in the Checks and Blueprints catalog in the following sections:

  • Citrix Checks: Contains troubleshooting checks provided by Citrix. These checks are available to all Smart Tools users.
  • Community: Contains custom checks created by other Smart Tools users. Before you can use a custom check from this section, the check creator must first include you in their list of allowed users when they publish the check. Otherwise, the check is not visible to you in the catalog.  

When you add a custom check from the catalog, Smart Tools adds the check to Smart Check, where it appears in the Perform Check menu.


Find more custom checks

To find more custom checks, you can jump to the Checks and Blueprints catalog easily from within Smart Check. Use one the following methods:

  • Click Configure and then click Find more custom checks
  • Click the Perform Checks menu and then click Find More Checks.

You can run custom checks on demand or you can schedule them to run at intervals you specify. To do this, you must specify the machines where you want to run the check. 

Remove custom checks from the Perform Checks menu

You can remove custom checks that you've added to Smart Check from the Checks and Blueprints catalog. When you remove custom checks from one Site, Smart Tools removes them for all Sites that you use with Smart Check. After you remove a custom check, it no longer appears in the Perform Checks menu or on the Configuration page for your Site. Additionally, the check tile in the Checks and Blueprints catalog displays the Add (plus sign) icon, indicating you can add it again to Smart Check. 

  1. From the Smart Tools menu, click Smart Check, locate the Site you want and click View.
  2. From the Health Alerts page, click Configure.
  3. Under Custom Tools, select the custom check you want to remove.
  4. Click the trash can icon to remove the custom check. A message appears, asking you to confirm you want to remove the check.
  5. Click Remove

Back to top

Citrix Checks 

Citrix provides several checks that help you identify possible causes for common issues, verify StoreFront certificates, and optimize the machines in your environment. These checks are available to all Smart Tools users in the Checks and Blueprints catalog. 

Important: Before you run Citrix Checks, review System requirements for targeted machines in this topic to ensure the machines you target can run the checks successfully. If these requirements are not met, the checks will fail.  

VDA Health Checks

VDA Health Checks identify possible root causes for common VDA registration and session launch issues. 

For VDA registration, the following checks are performed:

  • VDA software installation
  • VDA machine domain membership
  • VDA communication ports availability
  • VDA services status
  • VDA Windows firewall configuration
  • VDA communication with each Controller
  • VDA registration status

For session launch, the following checks are performed:

  • Session launch communication ports availability
  • Session launch services status
  • Session launch Windows firewall configuration

StoreFront Certificate Checks

This check validates the SSL certificates for Storefront and verifies the following conditions:

  • Whether or not the certificate is bound to the SSL port for the host URL.
  • Whether or not the certificate chain is complete. 
  • Whether or not certificates have expired.
  • Whether or not a certificate is expiring soon (within 30 days).

Delivery Controller Configuration Checks

This check verifies whether or not the following Delivery Controller issues exist, based on Citrix recommendations for XenApp and XenDesktop Sites:

  • One or more Delivery Controllers in the Site are in a failed state.
  • There is only one Delivery Controller in the Site.
  • Delivery Controllers are of different versions.

Citrix Optimizer Checks

This check recommends optimizations to improve the performance of XenDesktop components on Windows systems. The check includes OS-specific templates for enabling or disabling Windows services, disabling scheduled tasks, removing applications, and so on according to Citrix recommendations and best practices.

The check includes the following templates:

  • Windows 7 SP1 
  • Windows 8.1
  • Windows 10 Revision 1703 and 1709
  • Windows 10 LTSB
  • Windows Server 2008 R2
  • Windows Server 2012 R2
  • Windows Server 2016

When you run the check, you must select the Delivery Controllers or VDAs that you want the check to target. After the check runs, any issues that are found appear on the Site's Health Alerts page. The alerts for these items provide guidance and instructions for performing the recommended optimizations. You can also download this guidance as a report by clicking View Reports. For more information about the reports generated from checks, see View reports from health checks.

Back to top