Product Documentation

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. This article describes the checks available, requirements for running checks, and how to find additional checks.

Checks that run automatically

When you initially add your Site to Smart Check, Smart Tools runs a series of checks on your Site by default. These checks are:

These checks run on the Delivery Controllers in your Site and display results for the Delivery Controllers, Delivery Groups, and Machine Catalogs.

Checks targeting other machines

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

To run these checks, either on-demand or on a schedule, you must specify the machines that you want the check to target.

System requirements for targeted machines

Before running any machine-targeting checks, ensure the machines where you intend to run the check meet the following system requirements:

  • File and Printer Sharing is enabled.
  • Windows Remote Management (WinRM) is enabled. For instructions, see Installation and Configuration for Windows Remote Management on the Microsoft web site.
  • Windows Management Instrumentation (WMI) is enabled. For instructions, see the section “Automatic agent installation on VMs provisioned on Citrix XenServer” in [Install or remove the Citrix Smart Tools Agent]](../smart-tools-agent/install-remove-smart-tools-agent.html).

Some checks might have additional requirements which are included in the descriptions in this article.

Site Health Checks

Site Health Checks provide a comprehensive evaluation of all the FMA services including their database connectivity on your Delivery Controllers. Citrix recommends you run these checks at least once daily. Site Health Checks verify the following conditions:

  • A recent site database backup exists
  • Citrix broker client is running for environment test
  • Citrix Monitor Service can access its historical database
  • Database connection of each FMA service is configured
  • Database can be reached by each FMA service
  • Database is compatible and working properly for each FMA service
  • Endpoints for each FMA service are registered in the Central Configuration service
  • Configuration Service instances match for each FMA service
  • Configuration Service instances are not missing for each FMA service
  • No extra Configuration Services instance exists for each FMA service
  • Service instance published by each FMA Service matches the service instance registered with the Configuration service
  • Database version matches the expected version for each FMA service
  • Each FMA service can connect to Configuration Logging Service
  • Each FMA service can connect to 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 items within the 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. Smart Tools runs these checks automatically when you initially add your Site to Smart Check.

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. Smart Tools runs these checks automatically when you initially add your Site to Smart Check.

LTSR Checks

LTSR Checks verify that the Delivery Controllers and VDAs in your Site are running the correct version of XenApp and XenDesktop LTSR. Smart Tools runs these checks automatically when you initially add your Site to Smart Check.

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.

LTSR Checks report for Machine Catalogs

VDA Health Checks

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

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

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 Checks

StoreFront Checks validate the service status, connectivity to Active Directory, Base URL setting, IIS Application Pool version, and the SSL certificates for StoreFront. This check verifies the following conditions:

  • Citrix Default Domain Services is running
  • Citrix Credential Wallet services is running
  • The connectivity from the StoreFront server to Active Directory port 88
  • The connectivity from the StoreFront server to Active Directory port 389
  • Base URL has a valid FQDN
  • The correct IP address from the Base URL can be retrieved
  • IIS application pool is using .NET 4.0
  • 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)

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

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.

Delivery Controller requirements

In addition to the system requirements for targeted machines, ensure that at least one Delivery Controller in the Site where you intend to run this check is powered on, the Broker Service is running, and the database connection is working.

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.

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

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.

Provisioning Services Checks

Provisioning Services Check verifies Citrix Provisioning Services (PVS) status and configuration.

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

The checks verify the following conditions:

  • Installation of Provisioning Server and Console
  • Whether or not the Inventory executable is running
  • Whether or not the Notifier executable is running
  • Whether or not the MgmtDaemon executable is running
  • Whether or not the StreamProcess executable is running
  • Whether or not the Stream service is running
  • Whether or not the Soap Server service is running
  • Whether or not the TFTP Service is running
  • PowerShell minimum version
  • Database and PVS server availability
  • License Server connectivity
  • PVS Update Check
  • Whether or not the PXE service is running
  • Whether or not the TSB service is running

Citrix License Server Checks

Citrix License Server Check verifies License server status, SA eligibility date compatibility, and provides license upgrade suggestions.

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

These checks verify the following conditions:

  • License Server connectivity from the Delivery Controller
  • License Server firewall remote access status
  • Citrix Licensing service status
  • License Server grace period state
  • License Server ports connectivity
  • Whether or not the CITRIX vendor daemon is running
  • Whether or not system clocks are synchronized
  • Whether or not the Citrix Licensing service is running under the Local Service account
  • Presence of the CITRIX.opt file
  • License SA eligibility date
  • Citrix License Server Update
  • Whether or not the License Server certificate is in the Delivery Controller’s trusted root store

Citrix Life Cycle Checks

Citrix Life Cycle Checks verify end of life (EOL) and end of maintenance (EOM) status of Delivery Controllers and other XenApp and XenDesktop components. The checks also provide recommendations for available LTSR Cumulative Updates, new LTSR versions, and new Current Releases. For more information about lifecycle milestones for XenApp and XenDesktop, see https://www.citrix.com/support/product-lifecycle/milestones/xenapp-xendesktop.html.

Important: Ensure the machines where you intend to run this check meet the requirements specified in System requirements for targeted machines. Otherwise, the check will fail.

The following checks are performed:

  • End of maintenance check
  • End of life check
  • Availability of new Current Releases
  • Availability of new Cumulative Updates for LTSR Release
  • Availability of new LTSR Programs

Add or remove checks

In addition to the checks that are included when you initially add your Site to Smart Check, Citrix provides more checks that you can add to Smart Check at any time. These checks are stored in the Checks and Blueprints catalog.

To add checks

To add a check from the catalog, simply click the plus sign (+) on the check you want to add. The check appears on the Perform Checks menu in Smart Check.

Perform Checks menu with catalog check selected

You can also jump to the Checks and Blueprints catalog easily from within Smart Check. Use one of the following methods:

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

Remove custom checks from the Perform Checks menu

When you remove checks from one Site, Smart Tools removes them for all Sites that you use with Smart Check. After you remove a 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 and then select the check you want to remove.
  3. Click the trash can icon to remove the check. A message appears, asking you to confirm you want to remove the check.
  4. Click Remove.