If you are running Scout on a machine delivered by Citrix Workspace Cloud, you will be asked enter your credentials as follows:
Created Date: July 5, 2011
Updated Date: February 22, 2016
Run Citrix Scout from a single XenDesktop controller (DDC) or XenApp server to capture key data points and CDF traces for selected computers followed by secure and reliable upload of the data package to Citrix Technical Support.
Key Data points include:
Network Adapter and Configuration
Page File Usage
Group Policy Information (RSOP)
System Environment Variables
Application Event Log
System Event Log
XenDesktop 5.x, 7.x
Broker Hypervisor Connection
Broker Service Status
Installed DB Version
License Server Compatibility
License Server Info
Registered Service Instance Details
Data Store Details (XADSInfo)1
License Server Info
Server Load Details
Citrix Binary Details
Citrix Broker Service Info
Citrix PortICA Log
Citrix VDA Info
Controller Service Configuration and Log Files
Virtual Desktop Agent Configuration and Log Files
Personal vDisk Logs
Virtual Desktop Agent HDX Configuration
Citrix Profile Management Logs
Citrix Binary Details
Citrix Profile Management logs
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
- Cloud deployments support
- Any one of the following Microsoft .NET Framework - .NET version 3.5 with Service Pack 1, .NET 4.0, .NET 4.5 or .NET 4.5.1
- Microsoft Windows PowerShell version 2.0, or newer??
- User must be a local administrator and domain user for each machine being queried.
- Must run as administrator??
- For on-premises deployments, Scout must run on one of the Citrix Desktop Delivery Controller machines when capturing product information.
- For cloud deployments, Scout must run on any machine in the same domain as the VDA machines when capturing product information
- For cloud deployments, the?? Apps and Desktop Service PowerShell SDK?? is required
Supported Citrix Workspace Cloud Services
- Apps and Desktops Service
Supported Citrix Product Versions
- XenDesktop 5.x, 7.x
- XenApp 6.x, 7.x
To install Scout, unzip the Citrix Scout package to a folder, such as Desktop.
How to use Scout & Citrix Insight Services (CIS) to analyze your environment
Citrix TV contains a?? video?? http://www.citrix.com/tv/#videos/9268?? explaining how to use Scout & CIS.
To Start Scout
Navigate to the folder where you unzipped the download and click Run.
Once signed in, select a customer:
Scout will open so you can continue to perform the appropriate configuration.
Note: Cloud deployments can only collect information from VDAs (Controller(s) information will not be captured)
To Set Scout Configuration Options
- From the menu bar, click Config > Settings.
- Make any required changes to the default settings:
Note: Changing the default event log collection setting might increase the duration and size of the data capture.
To Capture a CDF Trace
- Click Start CDF Trace.
- Select up to 10 target computers, and then click Continue.
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.
- Click Clear All to clear the default setting of all modules.
- 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.
- Click Continue to begin the trace on the selected modules.
- Reproduce the issue for which you would like to capture details.
- Click Stop CDF Trace once the issue has been reproduced.
- Multiple CDF traces can be run by repeating Steps 1 through 5 explained in the preceding procedure. When running a second trace, a dialog appears asking if you would like to overwrite the existing trace file (Yes) or create a new trace file (No). Each new trace (.etl) file has a unique filename comprising the date and a serial number.
- CDF trace files are written to tmp\<site-farmname>\<hostname>\Citrix\CDFControl Traces in the folder where you unzipped the download.
To Collect and Upload Environment Information
- Click Collect & Upload.
- Select up to 10 target computers, and then click Continue.
|Status Messages||Corrective Action|
|Check Network||Check network connection or power status of machine|
|Enable WinRM||Enable WinRM on the VDA or Controller (click the Settings icon)|
|Enable File and Printer Sharing||Enable File and Printer Sharing (Network Adapter Properties)|
- 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 updates as Citrix Scout collects environment information.
- 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 does not impact the completeness of the information being collected and the compression continues.
- Once the “Save” process is completed, you will be presented with a dialogue explaining the upload & Analysis process. Click “Continue” on this to proceed
- 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 is sent directly to Citrix Technical Support. An MD5 checksum test is performed to ensure your upload was successful. Once the checksum test has completed a confirmation message is sent to the contact email address for the MyCitrix account or 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 un-tick the “Delete saved collection results on exit” option presented when exiting Scout.
If you do not have Internet Access on your Controller, you can upload the saved results file manually by copying the saved file to a location with Internet access, and then logging onto cis.citrix.com and clicking the “upload” button.
To Check for Updates to Scout
- 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
- Click File > Open, and navigate to the location of the saved report.
- Use the left navigation pane to select and expand the environment nodes.
To Upload a Saved Report after Closing Scout
- Click File > Upload.
- Navigate to the location of the saved report, select the file, and then click Open.
When the Upload to cis.citrix.com dialog appears, enter your My Citrix ID and password.
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.
Using Scout in Command-line mode
In the V2.20 release, a command-line execution option was added to Scout to allow for unattended and scripted execution of Scout.
To run Scout in command-line mode, simply copy Scout to a convenient location on the required XA or XD controller, and open a command prompt to that location:
To execute, just use the syntax “run.exe mode=cli”
If you have not used CLI mode Scout on this controller before, you will be prompted for your MyCitrix credentials.
Once you enter these successfully, Scout will retrieve a token to allow it make uploads on your behalf, without need for username & password input each time. The token will expire after 6 months, and you will be prompted to enter your credentials after this to retrieve a new token.
Once the token has been retrieved, Scout will run silently in the background, and will upload once the collection is complete.
Please Note: Commandline Scout will only collect data from the local controller, and the site or farm. It will not collect data from any other Controllers, so you will need to run commandline Scout on each Controller you wish to collect data from. Commandline scout does not collect data from VDAs, as Scout can only execute on Controllers.
If you do not have internet access on a Controller, Command-line Scout will fail to execute properly, as it needs internet both to retrieve the uplaod token, and also to upload the results afterwards.
An instructional video on Command-line Scout usage is available on Citrix TV:
To uninstall 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.
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.
Proxy Internet Support
For some customers Internet access from Servers is restricted by proxy servers and/or proxy authentication. To ensure that Scout can upload the collection bundle, you may add proxy details on the Config à Settings menu. If you do not wish to add proxy settings, you may still choose to save the collection locally, and upload it manually to cis.citrix.com from another machine with Internet access.
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.
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.