Citrix Scout Help

Run
from a single XenDesktop controller (DDC) or XenApp server, Citrix Scout
captures key data points and CDF traces on selected computers followed by
secure and reliable upload of the data package to Citrix Technical Support.

Key Data points include:

Hardware

Software

BIOS

Computer

Devices

Disk Drive

IDE Controller

Logical Drive

Memory Information

Network Adapter and Configuration

Page File Usage

PNP Device

Printers

Processor

SCSI Controller

Video Controller

Driver

Group Policy Information (RSOP)

Microsoft Hotfix

OS

PNP Driver

Processes

Service Packs

System Environment Variables

Registry

HKLM\Software\Citrix

HKLM\Software\Wow6432Node\Citrix Systems

HKLM\Software\Microsoft\Windows
NT\Windows

HKLM\Software\Microsoft\Windows NT\Winlogon

HKLM\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer

HKLM\System\CurrentControlSet\Citrix
HKLM\System\CurrentControlSet\Control\Print\Environments

HKLM\System\CurrentControlSet\Control\Session
Manager

Event Logs

Application Event Log

System Event Log

XenDesktop 5.x

XenApp 6.x

Site

Farm

Broker Administrators

Broker Hypervisor Connection

Broker Service Status

Catalogs

Configured VDA

Connection Log

Controllers

Desktop Groups

Hotfix Details (XenDesktop 5.6 and later)

Hypervisor

Hypervisor Alerts

Installed DB Version

License Server Info

License Server Compatibility

Registered Service Instance Details

Site Information

XDDBDiag Output1

Administrators

Citrix Hotfixes

Configuration Logging

Data Store Details (XADSInfo)1

Farm Information

License Server Info

Load Evaluators

Published Applications

Server Load Details

Session Information

Worker Groups

XenApp Policies

Zone Information

Computer

CDF Traces

Citrix Binary Details

Printer Drivers

RDS
Information

Citrix
Profile Management Logs

Computer

CDF Traces

Citrix Binary Details

Citrix Broker Service Info

Citrix PortICA Log

Citrix
Profile Management Logs

Citrix VDA Info

Controller Service Configuration and Log
Files

Personal vDisk Logs

Virtual Desktop Agent Configuration and
Log Files

Virtual Desktop Agent HDX Configuration

XDPing Output

Footnotes:

1.
Data Store details
are supported only with MS-SQL based data stores; the user running Scout must
have administrative rights on the SQL database.

New
in this Release

Common

·
Additional
datapoints for Analysis & Environment Overview

·
Security
Updates:

o
Remove Ability to collect “Security Event Log”

o
Delete Scout Saved Data after upload to CIS

XenApp

§  Bug fixes

XenDesktop

§  Bug fixes

Prerequisites

·
Microsoft
.NET Framework, Version 3.5, with Service Pack 1, or .NET 4.0

·
Microsoft
Windows PowerShell version 2.0

·
Must
be run from the same domain as the Citrix Desktop Delivery Controller or XenApp
server.

·
User
must be a local administrator and domain user for each machine being queried.

·
Need
to run as administrator

Supported
Citrix Products

·
XenApp
6.x

·
XenDesktop
5.x, 7

For  XenDesktop 7.1,
Scout download is not required – Scout is pre-installed on XD7.1 environments,
and can be found in the Citrix Folder on the start menu (Windows 2008), or in
the Citrix Apps (Windows 2012)

Note: The following message appears if you attempt to start
Scout on a machine where a supported version of XenDesktop or XenApp is not
installed.

Getting Started
with Scout

To
run Scout, unzip the Citrix Scout package to a folder, such as Desktop, on the
targeted DDC, or XenApp Server.

To Start Scout

Navigate
to the folder where you unzipped the download and double-click Run.

How to use Scout
& CIS to Analyze your environment

Citrix
Scout Overview

Citrix
TV contains the following video on using Scout & CIS:

http://www.citrix.com/tv/#videos/9268

Duration:
49:44 minutes

To
set Scout Configuration Options

1.
From the menu
bar, click Options -> Config

2.
Make any desired
changes to the default settings.

Note:  Changing the default event log days or number
of machines for data collection may increase the duration and size of the data
capture.

To
capture a CDF trace

1.
Click Start
CDF Trace

2.
Select up to 10
target computers.

Note:

For XenApp only, you might select specific modules for tracing. The
default setting is present in all modules. Citrix does not recommend changing
the default setting unless you have been instructed by a Citrix Technical
Support engineer.

To select specific modules
for XenApp, click the Modules
selection icon for only the machines where you want to make a custom selection.

1.    Click
Clear All to clear the default
setting of all modules.

2.
Select one or more trace categories on the left
side and/or individual modules on the right. You can search for modules by
typing the first few letters of the module name in the Search field and then make your selection.

Note: The module selection will be
saved until Scout is closed.

3.    Click
Continue to begin the trace on the
selected modules.

4.    Reproduce
the issue for which you would like to capture details.

5.    Click
Stop CDF Trace once the issue has
been reproduced.

·
Multiple CDF
traces can be run by repeating Steps 1 – 3 above.  When running a second trace, a dialog will
appear asking if you would like to overwrite the existing trace file (Yes) or
create a new trace file (No).   Each new
trace (.etl) file will have a unique filename
comprising the date and a serial number.

·
CDF trace files
are written to tmp\<farm-site-name>\<hostname>\Citrix\CDFControl Traces in the folder where you unzipped the
download.

To collect and upload environment
information

1.
Click Collect
& Upload

2.
Select up to 10
target computers, and then click Continue

Action Messages

Corrective Action

Check
Network

Check network connection or power status of
machine

Enable
WinRM

Enable WinRM on XenApp Server or XenDesktop VDA or
Controller (click the Settings icon)

Enable
File and Printer Sharing

Enable File and Printer Sharing (Network Adapter Properties)

3.
If necessary,
click the Settings icon to enable WinRM remotely or XenDesktop service
logging for VDAs and Controllers.

Note:  The
progress bar in the lower left corner of the Scout window will update as Citrix
Scout collects environment information.

4.
Select a location
for saving the file, provide a filename for the information to be zipped, and
click Save.

Note:  Click OK if
you receive a “File not found or no read permission.” error.  This will not impact the completeness of the
information being collected and the compression will continue.

5.
Once the “Save”
process is completed, you will be presented with a dialogue explaining the
upload & Analysis process. Click “Continue” on this to proceed

6.
When the Upload
to cis.citrix.com dialog appears, enter your My Citrix Username, password,
8-digit service request number (optional), a brief description (optional), and
then click Upload.

·
Any CDF Trace
files that have been created will also be included in the zip file.

·
The
status report will be sent directly to Citrix Technical Support. Once the MD5
checksum test is completed that ensures your upload was successful, a
confirmation message will be sent to the contact email address for the
associated Service Request number.

NB: Once you have successfully uploaded your data, the results file you
saved locally will be deleted upon exiting Scout.  This is a security measure to ensure
the security of the system information gathered for CIS. If you wish to keep a
copy of this file, please make a back-up copy before exiting Scout.

To
Check for Updates to Scout

1.
From the menu
bar, select Help -> Check for Updates

2.
If the Local
and Server versions do not match, click Download

Note:  To check the current installed
version of Scout, click Help -> About

To
open and review a saved report after closing Scout

1.
Click File
-> Open, and navigate to the location of the saved report.

2.
Use the left
navigation pane to select and expand the environment nodes.

To
upload a saved report after closing Scout

1.
Click File
-> Upload

2.
Navigate to the
location of the saved report, select the file, and then click Open

3.
When the Upload
to cis.citrix.com dialog appears, enter your My Citrix ID, password, and
8-digit service request number, and then click Upload.

Data Modified by Scout

Scout does not make any system modifications. Only data and
log files are captured.

How to Undo the Changes Made by Scout

If you enable additional logging for your XenDesktop
environment during your collection, you will be prompted to turn this off
afterwards. Some logs can be quite verbose, so it is best practice to turn off
any such logs once troubleshooting is complete.

Removing Scout

To remove Scout, delete the folder created after unzipping
the download.

Blocking Scout from collecting Data

For some customers it may be desirable to prevent Scout data
capture from specific machines.  To
prevent Scout from capturing data (remotely or locally) from a specific server
or VDA, you can add a registry key entry that Scout will read before allowing
data collection.

HKLM\Software\Citrix\PreventScoutDataCapture

Reg_DWORD

Value = 1

If this Registry Key is
present on any server you try to select, the following warning will be
received, and collection will not be possible.

If they key is applied to all
machines in the environment, no Scout Collection will be possible at all.

Contact Information

If you have any issues using Citrix Scout or any other tool
from Citrix or you want to provide feedback and suggestions, visit https://cis.citrix.com/feedback or
in the Scout menu bar, select Help >
Feedback.

Disclaimer

This software application is 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.