Configuring Online Diagnostics

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the feature information table at the end of this module.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to http:/​/​www.cisco.com/​go/​cfn. An account on Cisco.com is not required.

Information About Configuring Online Diagnostics

Online Diagnostics

With online diagnostics, you can test and verify the hardware functionality of the Switch while the Switch is connected to a live network.

The online diagnostics contain packet switching tests that check different hardware components and verify the data path and the control signals.

The online diagnostics detect problems in these areas:

  • Hardware components

  • Interfaces (Ethernet ports and so forth)

  • Solder joints

Online diagnostics are categorized as on-demand, scheduled, or health-monitoring diagnostics. On-demand diagnostics run from the CLI; scheduled diagnostics run at user-designated intervals or at specified times when the Switch is connected to a live network; and health-monitoring runs in the background with user-defined intervals. By default, the health-monitoring test runs for every 30 seconds.

After you configure online diagnostics, you can manually start diagnostic tests or display the test results. You can also see which tests are configured for the Switch or switch stack and the diagnostic tests that have already run.

How to Configure Online Diagnostics

Starting Online Diagnostic Tests

After you configure diagnostic tests to run on the switch, use the diagnostic start privileged EXEC command to begin diagnostic testing.

After starting the tests, you cannot stop the testing process.

Use this privileged EXEC command to manually start online diagnostic testing.

SUMMARY STEPS

    1.    diagnostic start switch number test {name | test-id | test-id-range | all | basic | non-disruptive }


DETAILED STEPS
     Command or ActionPurpose
    Step 1diagnostic start switch number test {name | test-id | test-id-range | all | basic | non-disruptive }


    Example:
    Switch# diagnostic start switch 2 test basic
    
    
     

    Starts the diagnostic tests.

    The switch number keyword is supported only on stacking switches. The range is from 1 to 8.

    You can specify the tests by using one of these options:

    • name—Enters the name of the test.

    • test-id—Enters the ID number of the test.

    • test-id-range—Enters the range of test IDs by using integers separated by a comma and a hyphen.

    • all—Starts all of the tests.

    • basic— Starts the basic test suite.

    • non-disruptive—Starts the non-disruptive test suite.

     

    Configuring Online Diagnostics

    You must configure the failure threshold and the interval between tests before enabling diagnostic monitoring.

    Scheduling Online Diagnostics

    You can schedule online diagnostics to run at a designated time of day or on a daily, weekly, or monthly basis for a switch. Use the no form of this command to remove the scheduling.

    SUMMARY STEPS

      1.    configure terminal

      2.    diagnostic schedule switch number test {name | test-id | test-id-range | all | basic | non-disruptive |} {daily | on mm dd yyyy hh:mm | weekly day-of-week hh:mm}


    DETAILED STEPS
       Command or ActionPurpose
      Step 1configure terminal


      Example:
      Switch# configure terminal
      
      
       

      Enters global configuration mode.

       
      Step 2diagnostic schedule switch number test {name | test-id | test-id-range | all | basic | non-disruptive |} {daily | on mm dd yyyy hh:mm | weekly day-of-week hh:mm}


      Example:
      Switch(config)# diagnostic schedule switch 1 test 1-5 on July 3 2013 23:10
      
      
       

      Schedules on-demand diagnostic tests for a specific day and time.

      The switch number keyword is supported only on stacking switches. The range is from 1 to 8.

      When specifying the tests to be scheduled, use these options:

      • name—Name of the test that appears in the show diagnostic content command output.

      • test-id—ID number of the test that appears in the show diagnostic content command output.

      • test-id-range—ID numbers of the tests that appear in the show diagnostic content command output.

      • all—All test IDs.

      • basic—Starts the basic on-demand diagnostic tests.

      • non-disruptive—Starts the non-disruptive test suite.

      You can schedule the tests as follows:

      • Daily—Use the daily hh:mm parameter.

      • Specific day and time—Use the on mm dd yyyy hh:mm parameter.

      • Weekly—Use the weekly day-of-week hh:mm parameter.

       

      Configuring Health-Monitoring Diagnostics

      You can configure health-monitoring diagnostic testing on a Switch while it is connected to a live network. You can configure the execution interval for each health-monitoring test, enable the Switch to generate a syslog message because of a test failure, and enable a specific test.

      Use the no form of this command to disable testing.

      By default, health monitoring is disabled, but the Switch generates a syslog message when a test fails.

      Follow these steps to configure and enable the health-monitoring diagnostic tests:

      SUMMARY STEPS

        1.    enable

        2.    configure terminal

        3.    diagnostic monitor interval switch number test {name | test-id | test-id-range | all} hh:mm:ss milliseconds day

        4.    diagnostic monitor syslog

        5.    diagnostic monitor threshold switch number number test {name | test-id | test-id-range | all} failure count count

        6.    diagnostic monitor switch number test {name | test-id | test-id-range | all}

        7.    end

        8.    show running-config

        9.    copy running-config startup-config


      DETAILED STEPS
         Command or ActionPurpose
        Step 1 enable


        Example:
        Switch> enable
        
        
         

        Enables privileged EXEC mode. Enter your password if prompted.

         

        Step 2configure terminal


        Example:
        
        Switch# configure terminal
        
        
         

        Enters the global configuration mode.

         
        Step 3diagnostic monitor interval switch number test {name | test-id | test-id-range | all} hh:mm:ss milliseconds day


        Example:
        Switch(config)# diagnostic monitor interval switch 2 test 1 12:30:00 750 5
        
         

        Configures the health-monitoring interval of the specified tests.

        The switch number keyword is supported only on stacking switches.

        When specifying the tests, use one of these parameters:

        • name—Name of the test that appears in the show diagnostic content command output.

        • test-id—ID number of the test that appears in the show diagnostic content command output.

        • test-id-range—ID numbers of the tests that appear in the show diagnostic content command output.

        • all—All of the diagnostic tests.

        When specifying the interval, set these parameters:

        • hh:mm:ss—Monitoring interval in hours, minutes, and seconds. The range for hh is 0 to 24, and the range for mm and ss is 0 to 60.

        • milliseconds—Monitoring interval in milliseconds (ms). The range is from 0 to 999.

        • day—Monitoring interval in the number of days. The range is from 0 to 20.

         
        Step 4diagnostic monitor syslog


        Example:
        Switch(config)# diagnostic monitor syslog
        
         

        (Optional) Configures the switch to generate a syslog message when a health-monitoring test fails.

         
        Step 5diagnostic monitor threshold switch number number test {name | test-id | test-id-range | all} failure count count


        Example:
        Switch(config)# diagnostic monitor threshold switch 2 test 1 failure count 20
        
         

        (Optional) Sets the failure threshold for the health-monitoring tests.

        The switch number keyword is supported only on stacking switches. The range is from 1 to 8.

        When specifying the tests, use one of these parameters:

        • name—Name of the test that appears in the show diagnostic content command output.

        • test-id—ID number of the test that appears in the show diagnostic content command output.

        • test-id-range—ID numbers of the tests that appear in the show diagnostic content command output.

        • all—All of the diagnostic tests.

        The range for the failure threshold count is 0 to 99.

         
        Step 6diagnostic monitor switch number test {name | test-id | test-id-range | all}


        Example:
        Switch(config)# diagnostic monitor switch 2 test 1
        
         

        Enables the specified health-monitoring tests.

        The switch number keyword is supported only on stacking switches. The range is from 1 to 9.

        When specifying the tests, use one of these parameters:

        • name—Name of the test that appears in the show diagnostic content command output.

        • test-id—ID number of the test that appears in the show diagnostic content command output.

        • test-id-range—ID numbers of the tests that appear in the show diagnostic content command output.

        • all—All of the diagnostic tests.

         
        Step 7end


        Example:
        
        Switch(config)# end
        
        
         

        Returns to privileged EXEC mode.

         
        Step 8show running-config


        Example:
        
        Switch# show running-config 
        
        
         

        Verifies your entries.

         
        Step 9copy running-config startup-config


        Example:
        Switch# copy running-config startup-config 
        
        
         

        (Optional) Saves your entries in the configuration file.

         
        What to Do Next

        Use the no diagnostic monitor interval testtest-id | test-id-range } global configuration command to change the interval to the default value or to zero. Use the no diagnostic monitor syslog command to disable generation of syslog messages when a health-monitoring test fails. Use the diagnostic monitor threshold testtest-id | test-id-range }failure countcommand to remove the failure threshold.

        Monitoring and Maintaining Online Diagnostics

        Displaying Online Diagnostic Tests and Test Results

        You can display the online diagnostic tests that are configured for the Switch or Switch stack and check the test results by using the privileged EXEC show commands in this table:

        Table 1 Commands for Diagnostic Test Configuration and Results

        Command

        Purpose

        show diagnostic content switch [number | all]

        Displays the online diagnostics configured for a switch.

        The switch [number | all] parameter is supported only on stacking switches.

        show diagnostic status

        Displays the currently running diagnostic tests.

        show diagnostic result switch [number | all] [detail | test {name | test-id | test-id-range | all} [detail]]

        Displays the online diagnostics test results.

        The switch [number | all] parameter is supported only on stacking switches.

        show diagnostic switch [number | all] [detail]

        Displays the online diagnostics test results.

        The switch [number | all] parameter is supported only on stacking switches.

        show diagnostic schedule switch [number | all]

        Displays the online diagnostics test schedule.

        The switch [number | all] parameter is supported only on stacking switches.

        show diagnostic post

        Displays the POST results. (The output is the same as the show post command output.)

        Configuration Examples for Online Diagnostic Tests

        Starting Online Diagnostic Tests

        After you configure diagnostic tests to run on the switch, use the diagnostic start privileged EXEC command to begin diagnostic testing.

        After starting the tests, you cannot stop the testing process.

        Use this privileged EXEC command to manually start online diagnostic testing.

        SUMMARY STEPS

          1.    diagnostic start switch number test {name | test-id | test-id-range | all | basic | non-disruptive }


        DETAILED STEPS
           Command or ActionPurpose
          Step 1diagnostic start switch number test {name | test-id | test-id-range | all | basic | non-disruptive }


          Example:
          Switch# diagnostic start switch 2 test basic
          
          
           

          Starts the diagnostic tests.

          The switch number keyword is supported only on stacking switches. The range is from 1 to 8.

          You can specify the tests by using one of these options:

          • name—Enters the name of the test.

          • test-id—Enters the ID number of the test.

          • test-id-range—Enters the range of test IDs by using integers separated by a comma and a hyphen.

          • all—Starts all of the tests.

          • basic— Starts the basic test suite.

          • non-disruptive—Starts the non-disruptive test suite.

           

          Example: Configure a Health Monitoring Test

          This example shows how to configure a health-monitoring test:

          Switch(config)# diagnostic monitor threshold switch 1 test 1 failure count 50
          Switch(config)# diagnostic monitor interval switch 1 test TestPortAsicStackPortLoopback
          
          
          

          Examples: Schedule Diagnostic Test

          This example shows how to schedule diagnostic testing for a specific day and time on a specific switch:

          Switch(config)# diagnostic schedule test DiagThermalTest on June 3 2013  22:25
          
          

          This example shows how to schedule diagnostic testing to occur weekly at a certain time on a specific switch:

          Switch(config)# diagnostic schedule switch 1 test 1,2,4-6 weekly saturday 10:30
          
          

          Displaying Online Diagnostics: Examples

          This example shows how to display the online diagnostic detailed information on a specific switch:

          Switch# show diagnostic switch 1 detail
          
          Switch 1: SerialNo : 
          
          Overall Diagnostic Result for Switch 1 : UNTESTED
          
          Test results: (. = Pass, F = Fail, U = Untested)
          
          ___________________________________________________________________________
          
          1) TestPortAsicStackPortLoopback ---> U
          
          Error code ------------------> 3 (DIAG_SKIPPED)
          Total run count -------------> 0
          Last test testing type ------> n/a
          Last test execution time ----> n/a
          First test failure time -----> n/a
          Last test failure time ------> n/a
          Last test pass time ---------> n/a
          Total failure count ---------> 0
          Consecutive failure count ---> 0
          ___________________________________________________________________________
          
          2) TestPortAsicLoopback ------------> U
          
          Error code ------------------> 3 (DIAG_SKIPPED)
          Total run count -------------> 0
          Last test testing type ------> n/a
          Last test execution time ----> n/a
          First test failure time -----> n/a
          Last test failure time ------> n/a
          Last test pass time ---------> n/a
          Total failure count ---------> 0
          Consecutive failure count ---> 0
          ___________________________________________________________________________
          
          3) TestPortAsicCam -----------------> U
          
          Error code ------------------> 3 (DIAG_SKIPPED)
          Total run count -------------> 0
          Last test testing type ------> n/a
          Last test execution time ----> n/a
          First test failure time -----> n/a
          Last test failure time ------> n/a
          Last test pass time ---------> n/a
          Total failure count ---------> 0
          Consecutive failure count ---> 0
          ___________________________________________________________________________
          
          4) TestPortAsicMem -----------------> U
          
          Error code ------------------> 3 (DIAG_SKIPPED)
          Total run count -------------> 0
          Last test testing type ------> n/a
          Last test execution time ----> n/a
          First test failure time -----> n/a
          Last test failure time ------> n/a
          Last test pass time ---------> n/a
          Total failure count ---------> 0
          Consecutive failure count ---> 0
          ___________________________________________________________________________
          
          5) TestInlinePwrCtlr ---------------> U
          
          Error code ------------------> 3 (DIAG_SKIPPED)
          Total run count -------------> 0
          Last test testing type ------> n/a
          Last test execution time ----> n/a
          First test failure time -----> n/a
          Last test failure time ------> n/a
          Last test pass time ---------> n/a
          Total failure count ---------> 0
          Consecutive failure count ---> 0
          ___________________________________________________________________________
          
           
           
          
          

          This example shows how to display the online diagnostics that are configured on a specific switch:

          Switch# show diagnostic content switch 3
          
          Switch 1:
          Diagnostics test suite attributes:
              B/* - Basic ondemand test / NA
            P/V/* - Per port test / Per device test / NA
            D/N/* - Disruptive test / Non-disruptive test / NA
              S/* - Only applicable to standby unit / NA
              X/* - Not a health monitoring test / NA
              F/* - Fixed monitoring interval test / NA
              E/* - Always enabled monitoring test / NA
              A/I - Monitoring is active / Monitoring is inactive
              R/* - Switch will reload after test list completion / NA
              P/* - will partition stack / NA
          
                                                                  Test Interval   Thre-
          ID   Test Name                          Attributes      day hh:mm:ss.ms shold
          ==== ================================== ============    =============== =====
            1) TestPortAsicStackPortLoopback ---> B*N****I**      not configured  n/a
            2) TestPortAsicLoopback ------------> B*D*X**IR*      not configured  n/a
            3) TestPortAsicCam -----------------> B*D*X**IR*      not configured  n/a
            4) TestPortAsicRingLoopback --------> B*D*X**IR*      not configured  n/a
            5) TestMicRingLoopback -------------> B*D*X**IR*      not configured  n/a
            6) TestPortAsicMem -----------------> B*D*X**IR*      not configured  n/a
          
          
          

          This example shows how to display the online diagnostic results for a switch:

          Switch# show diagnostic result
          
          Switch 1: SerialNo :
          Overall diagnostic result: PASS
          Test results: (. = Pass, F = Fail, U = Untested)
          1) TestPortAsicStackPortLoopback ---> .
          2) TestPortAsicLoopback ------------> .
          3) TestPortAsicCam -----------------> .
          4) TestPortAsicRingLoopback --------> .
          5) TestMicRingLoopback -------------> .
          6) TestPortAsicMem -----------------> .
          
          
          

          This example shows how to display the online diagnostic test status:

          Switch# show diagnostic status
          
          <BU> - Bootup Diagnostics, <HM> - Health Monitoring Diagnostics,
          <OD> - OnDemand Diagnostics, <SCH> - Scheduled Diagnostics
          ====== ================================= =============================== ======
          Card   Description                       Current Running Test             Run by
          ------ --------------------------------- ---------------------            ------
          1                                         N/A                              N/A
          2                                         TestPortAsicStackPortLoopback    <OD>
                                                    TestPortAsicLoopback             <OD>
                                                    TestPortAsicCam                  <OD>
                                                    TestPortAsicRingLoopback         <OD>
                                                    TestMicRingLoopback              <OD>
                                                    TestPortAsicMem                  <OD>
          3                                         N/A                              N/A 
          4                                         N/A                              N/A
          ====== ================================= =============================== ======
          Switch# 
          
          
          

          This example shows how to display the online diagnostic test schedule for a switch:

          Switch# show diagnostic schedule switch 1
           
          Current Time = 14:39:49 PST Tue May 5 2013
          Diagnostic for Switch 1:
          Schedule #1:
          To be run daily 12:00
          Test ID(s) to be executed: 1.
          
          
          

          Additional References for Online Diagnostics

          Related Documents

          Related Topic Document Title

          Online diagnostics commands

          Catalyst 2960-X Switch System Management Command Reference

          Platform-independent command references

          Cisco IOS 15.3M&T Command References

          Platform-independent configuration information

          Cisco IOS 15.3M&T Configuration Guides

          Standards and RFCs

          Standard/RFC Title
          None

          MIBs

          MIB MIBs Link

          All supported MIBs for this release.

          To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

          http:/​/​www.cisco.com/​go/​mibs

          Technical Assistance

          Description Link

          The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies.

          To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds.

          Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.

          http:/​/​www.cisco.com/​support

          Feature History and Information for Configuring Online Diagnostics

          Release

          Modification

          Cisco IOS 15.0(2)EX

          This feature was introduced.