Collecting Tech-Support Information

This module describes commands that are used for collecting tech-support information.

To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your AAA administrator for assistance.

This chapter covers the following topic:

Configuring Custom Profiles

Table 1. Feature History Table

Feature Name

Release

Description

Supporting Custom Profile show tech command

Release 7.5.1

This feature lets you run a customized list of show commands and System Admin show commands from all core protocols such as BGP, MPLS, Segment Routing and so on You can also generate tech-support information that is useful for Cisco Technical Support representatives when troubleshooting a router.

This feature introduces the show tech support custom profile-name command.

You can group multiple Cisco IOS XR show commands, System Admin show commands, multiple show tech-support commands from IOS XR and Admin into a custom profile. A profile can be used for protocols such as BGP, MPLS, Segment Routing etc.

Restriction

  • The System Admin show commands must be enclosed within double quotes.

Configuration Example

To configure the custom profile, perform the following instructions:

  1. Create a custom profile using customshowtech profile command.

    For example,
    Router# configure
Router(config)# customshowtech ospf_prof1

  2. Add the existing Show commands or System Admin show commands to the profile that you created.

    For example,
    Router(config-cst-ospf_prof1)#command show ospf neighbor
Router(config-cst-ospf_prof1)#command show ospf trace
Router(config-cst-ospf_prof1)#admincommand "show version"
Router(config-cst-ospf_prof1)#command show tech-support routing ospf

  3. Use Commit.

    For example,
    Router(config-cst-profile)#commit

You can use the show running-config customshowtech profile name command to view whether the commit is successful.

For example,

Router(config-cst-ospf_prof1)#show running-config customshowtech
        ospf_prof1
Thu Oct 28 17:42:53.897 UTC
customshowtech ospf_prof1
 command show ospf neighbor
 command show ospf trace
 admincommand "show version"
 command show tech-support routing ospf
!

Running Configuration Example

Use the show tech-support custom profile-name command to run the custom profile.

For example,
Router# show tech-support custom profile-name ospf_prof1

Verification Example

Verify that the show tech-support custom profile-name command generates tech-support information. By default, the output of this command is saved on the router's hard disk in a file with .tgz extension. For example, /harddisk:/showtech/name.tgz.

For example,
++ Show tech start time: 2021-Oct-28.174339.UTC ++
Thu Oct 28 17:43:39 UTC 2021 Waiting for gathering to complete
........................................
Thu Oct 28 17:45:40 UTC 2021 Compressing show tech output
Show tech output available at 0/RP0/CPU0 : /harddisk:/showtech/showtech-custom-2021-Oct-28.174339.UTC.tgz
++ Show tech end time: 2021-Oct-28.174540.UTC ++

Simplified Tech-Support Data Collection

Table 2. Feature History Table

Feature Name

Release

Description

Collect Comprehensive Tech-Support Information

Release 25.1.1

Introduced in this release on: Fixed Systems (8700 [ASIC: K100], 8010 [ASIC: A100])(select variants only*)

*This feature is supported on:

  • 8712-MOD-M

  • 8011-4G24Y4H-I

Supporting Custom Profile show tech command

Release 25.1.1

Introduced in this release on: Fixed Systems (8700 [ASIC: K100], 8010 [ASIC: A100])(select variants only*)

*This feature is supported on:

  • 8712-MOD-M

  • 8011-4G24Y4H-I

Supporting Custom Profile show tech command

Release 24.4.1

Introduced in this release on: Fixed Systems (8200 [ASIC: P100], 8700 [ASIC: P100])(select variants only*); Modular Systems (8800 [LC ASIC: P100])(select variants only*)

*This feature is supported on:

  • 8212-48FH-M

  • 8711-32FH-M

  • 88-LC1-36EH

  • 88-LC1-12TH24FH-E

  • 88-LC1-52Y8H-EM

Collect Comprehensive Tech-Support Information

Release 24.4.1

Introduced in this release on: Fixed Systems (8200 [ASIC: P100], 8700 [ASIC: P100])(select variants only*); Modular Systems (8800 [LC ASIC: P100])(select variants only*)

*This feature is supported on:

  • 8212-48FH-M

  • 8711-32FH-M

  • 88-LC1-36EH

  • 88-LC1-12TH24FH-E

  • 88-LC1-52Y8H-EM

Collect Comprehensive Tech-Support Information

 Release 24.2.11

You can now collect a comprehensive list of troubleshooting data and restore network operations quickly in case of a network disruption. This release allows you to collect more tech-support data than you could in previous releases by executing the show tech-support custom command.

Supporting Custom Profile show tech command

 Release 24.2.11

We have simplified the process to collect technical support information for traffic, control-plane, and system by consolidating multiple commands for each of these parameters under the following options:

  • traffic - Generates tech-support information related to network traffic.

  • control-plane - Generates tech-support information related to the control-plane.

  • system - Generates tech-support information related to the system (router).

This release adds the keywords traffic , control-plane , and system to the show tech-support custom command.

When diagnosing a potential problem in the network or when collecting information related to a specific area such as network traffic, control-plane, or the system, you no longer need to run several show commands or show tech-support commands. Instead, you can run a minimum set of CLIs to generate or gather entire tech-support data related to a specific area. Data is collected from all Route Processors (RPs), Line Cards (LCs), and Fabric Cards (FCs) on the router.

The show tech-support custom traffic command generates tech-support information related to network traffic, the show tech-support custom control-plane command generates tech-support information related to the control-plane, and the show tech-support custom system command generates tech-support information related to the system (router).

Cisco IOS XR Release 24.2.11 collects a comprehensive list of tech-support data in addition to providing internal checks to ensure the router does not collect the same command output more than once.


Note

The command execution may take a few to several minutes. Moreover, the output is usually large and varies in size depending on the number of LCs on the router. So, before executing the CLI command, ensure that you have enough disk space available.

Guidelines for Gathering Technical Support Information Using Custom Options

The guidelines for gathering technical support information are as follows:

  • We do not recommend parallel execution of the show tech-support custom command with different options.

  • We do not recommend using show tech-support custom command in automated scripts.

  • We do not recommend executing the show tech-support custom command at the same time as PAM (Platform Automated Monitoring), EEM (Embedded Event Manager), EDCD (Event-Driven CLI Database) scripts.

Example

The following codeblocks show the show tech-support custom command options generating tech-support information. By default, the output of this command is saved on the hard disk of the router in a file with .tgz extension. For example, /harddisk:/showtech/name.tgz. 

Router# show tech-support custom traffic 
++ Show tech start time: 2023-Jun-16.195852.UTC ++
Fri Jun 16 19:58:52 UTC 2023 Waiting for gathering to complete
......................................................................................................................................
Fri Jun 16 20:05:45 UTC 2023 Compressing show tech output
Show tech output available at 0/RP0/CPU0 : /harddisk:/showtech/showtech-custom-traffic-2023-Jun-16.195852.UTC.tgz
++ Show tech end time: 2023-Jun-16.200546.UTC ++
Router# show tech-support custom system
Fri Jan 12 11:57:04.991 UTC
++ Show tech start time: 2024-Jan-12.115709.UTC ++
Fri Jan 12 11:57:09 UTC 2024 Waiting for gathering to complete
.....................................................................................................................................................................................................................................................
Fri Jan 12 12:09:39 UTC 2024 Compressing show tech output
Show tech output available at 0/RP0/CPU0 : /harddisk:/showtech/showtech-custom-system-2024-Jan-12.115709.UTC.tgz
++ Show tech end time: 2024-Jan-12.120946.UTC ++
Router# show tech-support custom control
Fri Jan 12 13:21:48.433 UTC
++ Show tech start time: 2024-Jan-12.132153.UTC ++
Fri Jan 12 13:21:53 UTC 2024 Waiting for gathering to complete
....................................................................................................................................
Fri Jan 12 13:28:37 UTC 2024 Compressing show tech output
Show tech output available at 0/RP0/CPU0 : /harddisk:/showtech/showtech-custom-control-2024-Jan-12.132153.UTC.tgz
++ Show tech end time: 2024-Jan-12.132842.UTC ++