Please note:
You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools

LTSR Assistant v2.9.0.1

Created Date: Apr 12, 2016

Updated Date: Apr 16, 2025

What's New in v2.9.0.1

• Fixed a sporadic issue that prevented the LTSR Assistant tool from launching.

Changes from Previous Versions

• • Fixed an issue that caused compliance checks to fail for Citrix Virtual Apps and Desktops LTSR 2203 CU6 and 1912 CU10.
  • Added support for Citrix Virtual Apps and Desktops 2402 LTSR.
  • Changed the minimum supported .Net Framework version to 4.6.2.
  • Added support for Citrix Virtual Apps and Desktops 2203 LTSR Cumulative Updates.
  • Fixed a security protocol issue that caused LTSR compliance rule downloads to fail.
  • Added support for Citrix Virtual Apps and Desktops 2203 LTSR.
  • Added support for TLS 1.3.
  • Added support for XenApp and XenDesktop 7.15 LTSR, Citrix Virtual Apps and Desktops 7 1912 LTSR, and their Cumulative Updates.
  • Addressed an issue that causes failures when you run the LTSR Assistant from the command line.
  • Addressed an issue where the LTSR Assistant detected components repeatedly. The issue occurred when the hostname of a component was added more than once.
  • Updated the recommended XenServer LTSR version to 7.1.2.
  • Added support for the browser content redirection feature as a compatible component of the XenApp and XenDesktop 7.6 and 7.15 Long Term Service Releases (LTSRs).
  • Added support for TLS 1.2 and TLS 1.1.
  • Added support for XenApp and XenDesktop 7.6 LTSR and Cumulative Updates.
  • Added support for XenApp and XenDesktop 7.15 LTSR and Cumulative Updates.
  • For 7.15 LTSR, the following, additional baseline components are supported:
  • Linux VDA
  • VDAs for Windows 10
  • Profile Management
  • For 7.15 LTSR, the following, additional compatible components are supported:
  • Citrix SCOM Management Pack for XenApp and XenDesktop
  • Citrix SCOM Management Pack for StoreFront
  • Citrix SCOM Management Pack for License Server
  • Citrix SCOM Management Pack for Provisioning Services
  • Citrix SCOM Management Pack for XenServer
  • Added capability to work with non-default ports for the Delivery Controller.
  • Added Get-Help instruction for the XenServerMachine parameter.
  • Enhanced the Get-Help command for PoSH to provide a parameter description.
  • Introduced support for XenServer LTSR compliance checking.
  • Added a dialog box to notify of the latest tool version.
  • Provided Compliance Report .csv files in the upload package.
  • Made a usability improvement so that restarting the tool is no longer required when rescanning an environment.

Description

The LTSR Assistant scans components of Citrix Virtual Apps and Desktops to determine whether they are LTSR compliant. The scanned components can reside on virtual or physical machines. A compliance report is generated showing the LTSR compliance status of the installed components. The report also includes recommendations for components that are not in compliance or are not running the latest version. The compliance results can be uploaded to Citrix Insight Services (CIS) for further analysis and acceptance.

Note: XenApp and XenDesktop 7.15 LTSR includes new versions of Windows VDAs and new versions of several XenApp and XenDesktop components. 

For detailed information, see https://docs.citrix.com/en-us/xenapp-and-xendesktop/7-15-ltsr/whats-new.html.

Prerequisites

• Microsoft .NET Framework 3.5 SP1.
• Microsoft Windows PowerShell 2.0 or later.
• Windows Remote Management must be enabled on target machines
• To scan successfully, the user account must meet the following requirements:
  • Be a Citrix Virtual Apps and Desktops administrator with at least the read-only administrator default role and
  • Be a member of the local administrators group on target machines.
• Windows Firewall must allow inbound ICMP Echo Requests on target machines.
• Ensure that Internet access requirements are met.
• Ensure that required network ports are opened on target machines.

Enabling Windows Remote Management

To scan the Citrix Virtual Apps and Desktops components, the LTSR Assistant requires WinRM to be enabled on target machines.  To enable WinRM with the default settings and to enable execution of remote signed scripts:

        1. Open the PowerShell Command Line window as a local administrator on the Delivery Controller and on each target machine.

        2. Type the following commands: 

winrm qc
Set-ExecutionPolicy RemoteSigned

For more information about Windows Remote Management, see Microsoft MSDN: Installation and Configuration for Windows Remote Management.
 

Windows Firewall Must Allow Inbound ICMP Echo Requests on Target Machines

Configure Windows Firewall to allow inbound ICMP echo requests on target machines.

For detailed instructions, see Windows Firewall Troubleshooting Situations: Nobody Can Ping My Computer.

Internet Access Requirements

LTSR Assistant uses Internet access to download LTSR compliance data from the Citrix website.

The GUI executable, LTSRAssistant.exe, requires Internet access on startup.

The CLI PowerShell module, Citrix.LTSRAssistant.Commands.dll, requires Internet access except when the –ScanOnly parameter is specified.

Required Network Ports
Ensure that the following TCP ports are open and that inbound connections to these ports are allowed on the specified machines.

Delivery Controller:

• XenDesktop PowerShell SDK HTTP: 80
• WinRM HTTP: 5985

Target Machines:

• WinRM HTTP: 5985

Unverified Components

This document sometimes refers to “unverified” or “unvalidated” components. These are components that the tool attempted to scan and check for compliance but was not able to due to insufficient information on the Delivery Controller or due to network connection errors.

Installing LTSR Assistant

To install LTSR Assistant, create a folder with read and execute rights for everyone, for Example, C:\LTSRAssistant\. Download LTSRAssistant.zip and extract its content to the newly created folder.

Updating LTSR Assistant

The LTSR Assistant checks for updates on startup. When a newer version of the tool is detected, a “Get Latest Tool Version” hyperlink appears in the upper right corner of the tool interface. The link opens a window that recommends that you upgrade to the new version of the LTSR Assistant. Click "Yes" to download the new version of the tool.

How to Use LTSR Assistant

Steps to scan and view the compliance report:

1. Launch the tool by double-clicking LTSRAssistant.exe.

2. On the Welcome page, click "Next" to continue.

3. On the "Configuration" page, select "New configuration" to create a configuration, or "Existing configuration" if previously saved configuration files are available. For "Existing configuration," specify a full path to the existing configuration file in the text field shown below, or use the "Browse…" button to select the existing file.

4. On the "Delivery Controller" page, enter the name of the Delivery Controller you want to scan. In an existing configuration, the Delivery Controller field is prepopulated but can be modified if necessary. Ensure that the name is correct and click "Test Connection" to verify communication. Click "Next".

5. On the "Baseline Components" page, click + to enter the machine name where the component is installed and select the component from the list. For the machine name, use a DNS hostname - not “localhost.” For the machine name, use a DNS hostname - not "localhost." If a configuration exists, the list of baseline components is prepopulated but you can modify it if necessary. You can add new entries and edit or remove existing entries. Verify that machine names and components are correct. Click "Next".

6. On the "Compatible Components" page, click + to enter the machine name where the component is installed and select the component from the list. For the machine name, use a DNS host name - not "localhost." If a configuration exists, the list of compatible components is prepopulated but you can modify it if necessary. You can add new entries and edit or remove existing entries. Verify that machine names and components are correct. Click "Next".

7. On the "Summary" page, the tool displays a summary of machine names entered for the Delivery Controller, LTSR baseline components, and LTSR compatible components.

8. If this is a new configuration or an existing configuration that has been modified, you can save it by clicking "Save" and following the prompt to specify the configuration file name and location. If you do not want to save the configuration or any changes you made to it, click "Scan" to begin scanning the components for compliance.

9. The "Compliance Report" page shows the compliance scan progress. After the scan is completed, a compliance report appears.

10. The "Compliance Report" page displays results for scanned components. For detailed results, click the hyperlink under " Compliant Components." If a component is not compliant or not running the latest version of the LTSR, click the hyperlink under "Recommended Updates" to open the webpage that contains all necessary information (including download links for patches) to make the component compliant or to bring it up to the latest version. You can also view the compliance report in a browser by clicking "View Report in Browser".
 

Compliance report of LTSR 7.6

11. You can save the compliance report for later viewing or for proof of compliance. To do so, click "Save" and provide a file name and location.
 

12. On the "Compliance Report" page, results can be uploaded to Citrix Insight Services. To upload the compliance report, click "Upload" and then "OK" to accept the upload notification.

13. In the "Upload to Citrix" window, provide the Citrix user name and password. If a service request number has been provided, enter it here along with an optional description. After providing the information, click "Upload" to send the LTSR Compliance Report to Citrix Insight Services.

14. After the upload is completed, click "Close" to exit the "Upload to Citrix" window.

15. Click "Finish" to exit the tool. When asked to confirm, click “OK.”

Loading the LTSR Assistant PowerShell Module

To use the command line interface (CLI), load the LTSR Assistant PowerShell module in a PowerShell session. The steps to load the module are as follows:

1. Launch PowerShell as an administrator.

2. Change the working directory to C:\LTSRAssistant by typing:

          cd C:\LTSRAssistant

3. Import the LTSR Assistant PowerShell module by typing:

import-module .\Citrix.LTSRAssistant.Commands.dll

How to Use the LTSR Assistant Command Line Interface

The following command line examples follow the convention used in PowerShell documentation when specifying command line synopses. Optional parameters are enclosed in square brackets, required values are enclosed in angle brackets, and placeholders for sets of parameters such as “Logging Parameters” and “CIS Upload Parameters” are enclosed in angle brackets.

Get command help

Use this command to get detailed information about parameters.

Get-Help Invoke-LTSRAssistant

Scanning a Site
Use this command when scanning a Citrix Virtual Apps and Desktops Site.

Invoke-LTSRAssistant [-DeliveryController] <String> [-Machines] <Object> [-ScanSite] –ReportXmlFile <Filename> –ReportHtmlFile <Filename> <Logging Parameters> <CIS Upload Parameters>

After generating the report, the cmdlet writes a report object to the PowerShell object pipeline that contains the data in the report.
 

Scanning a Machine

Use this command when scanning a single machine. The tool must be running on the machine to be scanned.

Invoke-LTSRAssistant –ScanMachine –LTSRVersion<LTSR version> –ReportXmlFile <Filename> –ReportHtmlFile <Filename> <Logging Parameters> <CIS Upload Parameters>

After generating the report, the cmdlet writes a report object to the PowerShell object pipeline that contains the data in the report.

Scanning a Citrix Hypervisor

Use this command when scanning a Citrix Hypervisor.

Invoke-LTSRAssistant  [-XenServerMachines] <Object> [-ScanSite] –ReportXmlFile <Filename> –ReportHtmlFile <Filename> <Logging Parameters> <CIS Upload Parameters>

After generating the report, the cmdlet writes a report object to the PowerShell object pipeline that contains the data in the report.

Notes : The object value for parameter -XenSeverMachines can be initialized like below:

$XSLists = @{}

$XSCredential = Get-Credential

$XSName =  <XenServer FQDN/IP>

$ XSLists [$XSName] = $ XSCredential

Using a Configuration File

Use this command line to read parameters from a configuration file that was generated by the GUI.

Invoke-LTSRAssistant –ScanConfigurationFile <Filename> –ReportXmlFile <Filename> –ReportHtmlFile <Filename> <Logging Parameters> <CIS Upload Parameters>

After generating the report, the cmdlet writes a report object to the PowerShell object pipeline that contains the data in the report.

Scanning in a Network that Does Not Have Internet Access
Use this command to scan a Citrix Virtual Apps and Desktops Site or a single machine on a network that does not have Internet access. The result of the scan is saved to the file name specified with the ScanXmlFile parameter. This file can then be used by the tool running on a different machine with Internet access to generate and upload the report.

Scanning Step (does not require Internet access):

Invoke-LTSRAssistant [-DeliveryController] <String> [-Machines] <Object> [-ScanSite] -ScanOnly –ScanXmlFile <Filename> <Logging Parameters>

- OR -

Invoke-LTSRAssistant -ScanMachine -ScanOnly –ScanXmlFile <Filename> <Logging Parameters>

Report Generation Step (requires Internet access):

Invoke-LTSRAssistant –ReportOnly –ScanXmlFile <Filename> [–LTSRVersion]<LTSR version> –ReportXmlFile <Filename> –ReportHtmlFile <Filename> <Logging Parameters> <CIS Upload Parameters>

Note: If the scanxmlfile includes brokerservice instance, there is no need to add the “-LTSRVersion” parameter. Otherwise, you must add this parameter. 

After generating the report, the cmdlet writes a report object to the PowerShell object pipeline that contains the data in the report. The report object contains information identical to the report XML file and provides PowerShell scripts access to the data in the report.

Logging Parameters

The following parameters control the logging output of the tool. If none of these parameters is specified, the PowerShell cmdlet defaults to LogToConsole and LogToCDF.

[-LogToCDF] [[-LogToFile] [-LogFile <Filename>]] [-LogToConsole]

CIS Upload Parameters

The following parameters enable and control uploading of the report to Citrix Insight Services (CIS). These parameters are assumed to be off or unset by default.

[-UploadToCIS [-CISCredential <PSCredential>] [-SupportCase <String>]]

Definitions of CLI Parameters

Format of the Machines Parameter

The Machines parameter takes an Object that is either a PowerShell hash or array
When passing a hash as the value of the Machines parameter, the format is:

@{
MachineType1=”MachineName1”;
MachineType2=”MachineName2”;
…
}

The hash key “MachineType1” is associated with the string “MachineName1”.
The hash key “MachineType2” is associated with the string “MachineName2”.

Multiple machine names can be associated with the same hash key “MachineType” by associating an array of machine names with the MachineType:

@{
MachineType=”MachineName1”,”MachineName2”;
…
}

The hash key “MachineType” is associated with the array containing “MachineName1” and “MachineName2”.

When passing an array as the value of the Machines parameter, the format is:

@(“MachineType1”, “MachineName1”, “MachineType2”, “MachineName2”, … )

Elements with an even index are treated as MachineTypes.

Elements with an odd index are treated as MachineNames.

An array of machine names can be associated with a “MachineType” by using an array:

@(“MachineType1”, @(“MachineName1”,”MachineName2”,”MachineName3”), “MachineType2”, “MachineName4”, “MachineType3”, “MachineName5”)

The machine type “MachineType1” is associated with the array containing “MachineName1”, “MachineName2” and “MachineName3”. The machine type “MachineType2” is associated with “MachineName4”. The machine type “MachineType3” is associated with “MachineName5”.

The MachineType string is case-sensitive.

These are the valid values for MachineType:

CitrixDirector (Citrix Director)
CitrixStudio (Citrix Studio)
GPMX (Group Policy Management Experience)
PVS (Provisioning Services)
SessionRecording (Session Recording)
Storefront  (Storefront)
UPS (Universal Print Server)
AppDNA (Citrix AppDNA)
HDXRealTimeOptimizationPack (Citrix HDX RealTime Connector)
LicenseServer (Citrix Licensing)
ProfileManagement (Citrix Profile Management)

MachineNames must be valid DNS host names. They cannot be IP addresses and they must not contain the name “localhost”.

Report Object Written to PowerShell Object Pipeline

The Invoke-LTSRAssistant cmdlet writes an object of type “Citrix.LTSRAssistant.Reporting.SerializedObjects.ComplianceReport” to the PowerShell object pipeline when the ScanSite or ScanMachine switch parameters or ScanConfigurationFile parameter are specified. To use this object, assign the result of “Invoke-LTSRAssistant” to a PowerShell variable (e.g., $yourVariable = Invoke-LTSRAssistant …).

This section describes the structure of this report object. The data types listed in this section belong to the “Citrix.LTSRAssistant.Reporting.SerializedObjects” namespace, except for the .NET Common Language Runtime (CLR) data types that are prefixed with the “System” namespace name.

ComplianceReport : Represents a complete report. This object contains the same information that is written to the report XML file.

Summary : Contains the report summary.

ComplianceStatusType : An enumeration that represents different compliance status values.

ProductsSummary : Contains ProductSummary objects for various products.

ProductSummary : Contains information about a product and includes the counts for all components belonging to a product.

ComponentDefinitions : Contains ComponentSummary objects for various Components.

ComponentSummary : Contains information about a component and includes the counts for a particular component.

ReportLinks : Contains URLs to related information.

NonCompliantMachinesNonCompliantMachine : Contains information about an instance of a Component that is not compliant.

CompliantMachinesCompliantMachine : Contains information about an instance of a Component that is compliant.

UnvalidatedMachinesUnvalidatedMachine : Contains information about an instance of a component that is unvalidated.

Package : Represents a Cumulative Update package.

Security Permissions Required by LTSR Assistant

This tool needs to be run by a user account that is both an administrator on each of the target machines and a Citrix Virtual Apps and Desktops administrator with at least the read-only administrator default role.

Data Modified by LTSR Assistant

No modifications are made to the system by the tool.  However, the tool does generate a log for troubleshooting and debugging purposes in %Temp%\Citrix\LTSRAssistant\.  Temporary copies of the compliance report are created in %Temp%.

How to Undo the Changes Made by LTSR Assistant

To delete the tool log file and temporary copies of the compliance report, make sure to exit the tool.

Uninstalling LTSR Assistant

To uninstall the tool, exit the tool and delete the folder containing the tool and its related files.

Delete the folder %APPDATA%\..\Local\Citrix\LTSRAssistant.

Known Issues

The following table describes the various failure scenarios detected by the tool and the recommended corrective actions.

Proxy Settings

To do proxy settings through Control Panel:

1. Open Control Panel, click Internet Options, and select the Connections tab.

2. Click LAN settings. Enter the IP address and port number of the proxy server. 

3. Click Advanced in the proxy server pane. 

4. In the Exceptions pane, enter the IP address and domain name for internal machines.

5. Open PowerShell as an administrator. Import the proxy and ensure that the Bypass List is correct.

Contact Information

Questions?  Concerns?  Comments? Send your feedback to https://forms.gle/TwWrKPT6J8u7GdKA6.

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.