About health checks

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.

The health checks that Smart Check performs are categorized as follows:

Note: Site Health Checks, Apps and Desktops Checks, Update Checks, and LTSR Checks are categorized as Citrix Recommended Health Checks and are run automatically when you add a Site to Smart Check. 

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. 


Custom checks

If you use custom scripts and tools to perform health checks, you can deploy those tools with Smart Tools and view the results in Smart Check. You can also target the check so it runs only on the machines you specify. To do this, see Create custom checks and alerts for Smart Check.

You can create custom checks to evaluate any machine in your environment. When you run custom checks on StoreFront, Provisioning Services, or Licensing machines, Smart Check displays the check results alongside the results for the Delivery Controllers, Machine Catalogs, and Delivery Groups in your Site.

Requirements for remote machines

To run health checks on remote machines, ensure the remote machines meet the following requirements:

Adding 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 and Citrix Partners. Custom checks are stored in the Blueprint Catalog in the following sections:

  • 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.  
  • Citrix Checks: Contains custom checks developed and maintained by Citrix and Citrix Partners. These checks are available to all Smart Tools users.

To use custom checks, you must add them to Smart Check. From the Blueprint Catalog, simply click the plus sign (+) on the check. Smart Tools adds the check to Smart Check, where it appears in the Perform Check menu.


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 and the appropriate machine credentials (if they're different from the Site credentials). If the check requires it, you also specify any configuration parameters that are required to run the check.