How to Collect Diagnostic Data by using the Graphical User Interface on a Branch Repeater Appliance or Branch Repeater VPX Instance
Article ID: CTX135546
Updated On:
Description
This article describes how to capture diagnostic data by using the Show Techsupport tool from a Branch Repeater appliance or Branch Repeater VPX.
Background
Branch Repeater includes the Show Techsupport tool which collects information from multiple sources on a Branch Repeater appliance or Branch Repeater VPX to help diagnose and solve customer issues. You can run the tool from the Graphical User Interface (GUI) or from the Command Line Interface. Refer to http://support.citrix.com/article/CTX133765 for more information.
Note: For Branch Repeater version 5.5.x, contact Citrix Technical Support for assistance.
Instructions
To capture diagnostic data by using the Show Techsupport tool, complete the following steps:
Select System Maintenance > Diagnostics > Diagnostic Data, to open the page for the Show Techsupport tool.
The Show Techsupport interface includes the Diagnostic Options section where you can select the required data. In the Diagnostic Files section you can retrieve or erase collected information. Click Start to begin data collection. After you click Start a Status Window with the actions performed appears.
Diagnostic Options
The diagnostic options in the dashboard control data collection. If you do not select any options, then only basic diagnostic data is collected. The Show Techsupport tool always collects general system data, application logs, and configuration data for the currently active version installed on the Branch Repeater appliance, regardless of the option selected. Data from previously-installed versions is collected only if you select the All Releases option.
Note: Some options take more time for data collection.
|
Diagnostic Options |
Description |
|
Reports |
This option collects all the reports that the Branch Repeater appliance generates |
|
Drive Status |
With this option the Show Techsupport tool checks for drive errors and health. Note: This option is specific to a physical Branch Repeater appliance, and cannot be used with a Branch Repeater VPX. |
|
Core Files |
This option collects core dumps, if any are present. Core files from all installed versions of Branch Repeater are collected. |
|
Crash Files |
This option collects all kernel crash files (if any are present) |
|
Trace Files |
This option collects all the trace files (if any are present) |
|
All Releases |
This option collects application logs and configuration files for all installed versions of Branch Repeater; when the All Releases option is not selected, data is collected only for the currently active version of Branch Repeater. |
Starting Show TechSupport Tool
Complete the following steps to start the Show Techsupport tool:
-
Select the required diagnostic options.
-
Click Start.
A window appears that shows the background process and the status of the Show Techsupport tool. -
After the tool has completed collecting the information, you can click Continue to view the output. The output file is listed in the Diagnostic Files section.
Sample Output of Show Techsupport
Collecting diagnostic data (i) Making temporary directories /tmp/capture_logs_tmp_directory /tmp/capture_logs_dest_directory Gathering Performance Counters Gathering System Information Gathering overall raid status Gathering partition level raid status Gathering raid device level status Gathering ipmi status Gathering list of loaded kernel modules Gathering orbital directory timestamps Capturing logs. Converting current application logs to text Converting application logs to text for version /orbital/current/server Gathering current application logs Capturing logs. Compressing all logs /bin/tar: Removing leading `/' from member names Compressed log file hostname: localhost.localdomain Compressed log file primary MAC: 00_30_48_9A_FA_B3 Compressed log file date: 2012-04-13_16_47_04 Compressed log file created: localhost.localdomain_00_30_48_9A_FA_B3_2012-04- 3_16_47_04_logs.tgz Removing temporary working directory Done. Please transfer localhost.localdomain_00_30_48_9A_FA_B3_2012-04- 3_16_47_04_logs.tgz to your case notes.
When done, Click the Continue button to return to the Diagnostics Page.
Retrieving or Erasing Diagnostic Data File Packages
You can use the Diagnostic Files section to retrieve or erase the diagnostic files on the appliance:
If there are multiple support files generated, select the required file and following any of the following steps:
-
Click Retrieve File for the Browser to download the file to the local computer.
-
Click Erase File to delete the single selected support file.
Note: After clicking Erase File, you cannot retrieve this file again.
-
Click Erase All Files to delete all support files.
Note: After clicking Erase All File, you cannot retrieve these files again.
Uploading the Show Techsupport Logs
You can upload the compressed file(s) to Citrix Insight Services, with the Service Request number as a reference.
Note: CloudBridge 7.2.3 or later is required to upload the logs into Citrix Insight Services.
Issue/Introduction
Additional Information
