| |
|
|
Introduction
Protocol debug provides a trouble shooting tool for technicians and engineers by displaying protocol specific information to the enabling console or telnet session and optionally to the log file. Supported protocols are BGP, IS-IS, PPP, MPLS, RSVP, and OSPF. Protocol debug is enabled using the debug command in privileged command mode. The debug command applies to the Avici router unless the interface or composite link is specified. One of three levels of information can be configured.
When disabled, Protocol debug has no impact upon system performance. Enabling too much protocol debug output can result in a significant overhead cost that can affect the Avici routers primary routing task and should only be enabled judiciously and for brief periods.
Protocol debug output displays on the console or telnet session from which the debug command was entered. A logging command provides for the additional redirection of output to the current log file. A log only option provides for the redirection of output to the log file only; protocol debug information does not display on the enabling console or telnet session when the log only option is enabled.
The debug commands enable protocol debug messages based on a user defined criteria of system, sub-system, interface and level:
- System specifies the protocol to debug.
- Sub-system specifies the aspect of the protocol to debug, e.g. peers or adjacencies.
- Interface specifies the POS, composite link, or Gigabit Ethernet interface.
- Level specifies the amount of data desired.
You enable protocol debug by system and sub-system. Table 15-1 lists the protocol debug systems and sub-systems.
Table 15-1. Protocol Debug Systems and Sub-systems
System Sub-system Description IP BGP
Provides all BGP information
Provides BGP dampened routes information.
Provides BGP states information.
Provides BGP sending and receiving keepalive information.
Provides BGP peering information.
Provides BGP updates from peers information.
IP OSPF
Provides all OSPF information.
Provides OSPF adjacency events.
Provides OSPF flooding information.
Provides OSPF High Availability information.
Provides OSPF Link State events information.
Provides OSPF packet information.
Provides OSPF retransmission events information.
Provides MPSL TE opaque advertisements information.
ISIS
Provides all IS-IS information.
Provides IS-IS adjacency related packet information.
Provides IS-IS checksum errors related debug packet information
Provides IS-IS MPLS traffic-engineering advertisements related debug packet information
Provides IS-IS MPLS traffic-engineering interface related debug packet information
Provides IS-IS protocol errors related debug packet information
Provides IS-IS CSNP/PSNP packets related debug packet information
Provides IS-IS SPF events related debug packet information
Provides IS-IS SPF timing and statistics related debug packet information
Provides IS-IS SPF triggering related debug packet information.
ppp
Provides PPP LCP packet debug information.
Provides PPP IPCP packet debug information.
gtm
Provides all GTM information.
Provides GTM Flash related messages.
Provides GTM Queue Flush related messages.
Provides GTM APIs related information.
mpls ldp
Provides MPLS LDP text messages related information.
Provides hex dump of LDP messages.
Provides LDP session finite state machine information.
mpls rsvp
Provides RSVP CLI commands related debug packet information.
Provides RSVP events related debug packet information
Provides RSVP various trace refresh task events.
Provides trace packet IO per interface on the refresh task.
Provides trace messages between the refresh task and the route-controller
Provides RSVP protocol activity related debug packet information.
Provides display of switch mapping communications.
Provides display of the communication with the path manager.
mpls
Provides changes to color information.
Provides changes to interface bandwidth information.
Provides interface updates information.
Provides tunnel errors and resiliency events.
Provides tunnel events information.
Provides tunnel timed events information.
Provides tunnel state change information.
Provides tunnel protection status and changes information.
Provides detailed TE LSDB information.
Provides IGP SPF calculations information.
Provides constraint based SPF calculations information.
show
Provides a complete dump of technical support information.
Provides the ability to FTP the technical support dump to a desired location.
Provides the ability to TFTP the technical support dump to a desired location.
snmp
Provides information for all SNMP options.
Provides a hex-dump of SNMP Query packets.
Provides a dump of all SNMP packet headers.
Provides information on trace SNMP operations within the agent.
Provides dump of SNMP traps.
Provides output of varbinds in SNMP queries.
te-lsdb
Provides IS-IS TE-LSDB information.
Provides OSPF TE-LSDB information.
You can optionally configure a specific interface for interface appropriate debug commands. If you do not configure an interface, all debug messages for the configured protocol subsystem and information level display for this router. Specifying an interface will not only narrow the debug focus, but also make it less likely that the amount of debug information generated will significantly degrade routing performance. Not all debug commands are interface appropriate.
Most MPLS traffic engineering commands that are not appropriate to the interface can be configured optionally for a specific label switched path. If you do not specify a LSP name, all debug messages for the configured MPLS traffic engineering protocol subsystem and information level display for this router. Specifying a LSP name will not only narrow the debug focus, but also make it less likely that the amount of debug information generated will significantly degrade routing performance. Not all debug MPLS traffic engineering commands are LSP appropriate.
Most Protocol debug commands can be configured for information level. Information level determines the amount of information displayed. There are three information levels: terse, normal, or verbose. Protocol debug defaults to the normal level, which provides a medium level of information between terse and verbose. Normal information level includes all terse statements. Terse provides a minimum amount of information. Verbose provides all available debug information. Along with the amount of information a level provides, an important consideration in choosing the debug information level is the degraded routing performance that accompanies higher levels of information.
The show debugging command displays whether logging is enabled for debugging and lists the debug configuration by protocol.
Enabling BGP Protocol Debug
The debug ip bgp command in privileged mode enables BGP protocol debug. The command supports the all the sub-systems listed in Table 15-1 "Protocol Debug Systems and Sub-systems" providing BGP related debug information for all listed sub-systems. BGP protocol debug can be enabled for the Avici router or for a specified interface/composite link. When the information level option is available, it can be specified as terse for minimum output, normal for moderate output including terse statements, and verbose for all protocol debug output relating to the BGP sub-system.
The following provides a single example for each IP BGP debug sub-system. Each example includes all options that are available for that command, with option descriptions enclosed in brackets.
Example 1: The following example enables BGP peering debug for the [1/1/1 POS interface] at [normal information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip bgp peer normal
router#show debugging
Debug logging is disabled
IP BGP
bgp-peer enabled for normal level on interface POS 1/1/1
router#
Example 2: The following example enables BGP dampening debug for the [1/1/1 POS interface]:
router>enable
password:
router#debug interface pos 1/1/1 ip bgp dampening
router#show debugging
Debug logging is disabled
IP BGP
bgp-dampening enabled on interface POS 1/1/1
router#
Example 3: The following example enables BGP events debug for the [1/1/1 POS interface]:
router>enable
password:
router#debug interface pos 1/1/1 ip bgp events
router#show debugging
Debug logging is disabled
IP BGP
bgp-events enabled on interface POS 1/1/1
router#
Example 4: The following example enables BGP keepalives debug for the [1/1/1 POS interface]:
router>enable
password:
router#debug interface pos 1/1/1 ip bgp keepalive
router#show debugging
Debug logging is disabled
IP BGP
bgp-keepalives enabled on interface POS 1/1/1
router#
Example 5: The following example enables BGP updates [in the in bound direction (in and outbound are available)] debug for the [1/1/1 POS interface]:
router>enable
password:
router#debug interface pos 1/1/1 ip bgp updates
router#show debugging
Debug logging is disabled
IP BGP
bgp-updates enabled on interface POS 1/1/1
router#
Enabling IS-IS Protocol Debug
The debug isis command in privileged mode enables IS-IS protocol debug. The command supports the all the sub-systems listed in Table 15-1 "Protocol Debug Systems and Sub-systems" providing IS-IS related debug information for all listed sub-systems. IS-IS protocol debug commands can be enabled for the Avici router or for a specified interface/composite link. The information level option can be specified as terse for minimum output, normal for moderate output including terse statements, and verbose for all protocol debug output relating to the IS-IS sub-system.
The following provides a single example for each IS-IS debug sub-system. Each example includes all options that are available for that command, with option descriptions enclosed in brackets.
Example 1: The following example enables IS-IS adjacency packet debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis adj-packets terse
router#show debugging
Debug logging is disabled
ISIS
adjacency enabled for terse level on interface POS 1/1/1
router#
Example 2: The following example enables IS-IS checksum errors debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis checksum-errors terse
router#show debugging
Debug logging is disabled
ISIS
checksum-errors enabled for terse level on interface POS 1/1/1
router#
Example 3: The following example enables IS-IS MPLS traffic engineering interface debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis mpls traffic-eng interface terse
router#show debugging
Debug logging is disabled
ISIS
mpls traffic-eng interface enabled for terse level on interface POS 1/1/1
router#
Example 4: The following example enables IS-IS MPLS traffic engineering advertisements debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis mpls traffic-eng advertisements terse
router#show debugging
Debug logging is disabled
ISIS
mpls traffic-eng advertisements enabled for terse level on interface POS 1/1/1
router#
Example 5: The following example enables IS-IS LSP protocol errors debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis protocol-errors terse
router#show debugging
Debug logging is disabled
ISIS
protocol-errors enabled for terse level on interface POS 1/1/1
router#
Example 6: The following example enables IS-IS CSNP/PSNP packet debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis snp-packets terse
router#show debugging
Debug logging is disabled
ISIS
snp-packets enabled for terse level on interface POS 1/1/1
router#
Example 7: The following example enables IS-IS SPF events debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis spf-events terse
router#show debugging
Debug logging is disabled
ISIS
spf-events enabled for terse level on interface POS 1/1/1
router#
Example 8: The following example enables IS-IS SPF statistics debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis spf-statistics terse
router#show debugging
Debug logging is disabled
ISIS
spf-statistics enabled for terse level on interface POS 1/1/1
router#
Example 9: The following example enables IS-IS SPF triggering debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 isis spf-triggers terse
router#show debugging
Debug logging is disabled
ISIS
spf-triggers enabled for terse level on interface POS 1/1/1
router#
Enabling PPP Protocol Debug
The debug ppp command in privileged mode enables PPP protocol debug. The command supports the lcp and ipcp sub-systems providing for the display of PPP LCP packet and IPCP packet related debug information. PPP protocol debug can be enabled for the Avici router or for a specified interface/composite link. Information level can be specified as terse for minimum output, normal for moderate output, and verbose for all protocol debug output relating to PPP LCP and IPCP packets.
Example: The following example enables PPP LCP packet debug for the oc48c1 composite link at normal information level and enables redirection to the log file:
router>enable
password:
router#debug interface composite-link oc48c1 ppp lcp normal
router#logging log-debug
router#show debugging
Debug logging is enabled
PPP
lcp enabled for normal level on composite-link oc48c1
router#
Enabling OSPF Protocol Debug
The debug ip ospf command in privileged mode enables OSPF protocol debug. The command supports the all the sub-systems listed in Table 15-1 "Protocol Debug Systems and Sub-systems" providing OSPF related debug information for all listed sub-systems. OSPF protocol debug commands can be enabled for the Avici router or for a specified interface/composite link. The information level option can be specified as terse for minimum output, normal for moderate output including terse statements, and verbose for all protocol debug output relating to the OSPF sub-system.
The following provides a single example for each OSPF debug sub-system. Each example includes all options that are available for that command, with option descriptions enclosed in brackets.
Example 1: The following example enables OSPF adjacency debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf adj terse
router#
Example 2: The following example enables OSPF link state debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf link-state terse
router#
Example 3: The following example enables OSPF te debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf te terse
router#
Example 4: The following example enables OSPF flooding debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf flood terse
router#
Example 5: The following example enables OSPF hello events debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf hello terse
router#
Example 6: The following example enables OSPF retransmission debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf retrans terse
router#
Example 7: The following example enables OSPF packet debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 ip ospf packet terse
router#
Enabling MPLS LDP Protocol Debug
The debug mpls command in privileged mode enables MPLS protocol debug. The command supports the ldp sub-system providing MPLS label distribution protocol (LDP) related debug information. MPLS protocol debug can be enabled for the Avici router or for a specified interface/composite link. Information level can be specified as terse for minimum output, normal for moderate output including terse statements, and verbose for all protocol debug output relating to MPLS LDP.
There are three options for this command: messages for the display of LDP messages, msg-hex-dump for the display of hex LDP messages for all LDP packets, and sess-fsm for session finite state machine information display.
Use the debug mpls ldp msg-hex-dump command to display hex LDP messages for the Avici router or a specified interface.
Use the debug mpls ldp sess-fsm command to display session finite state machine information for the Avici router. This command is not relevant to specific interfaces.
Example: The following example enables MPLS LDP messages debug at normal information level:
router>enable
password:
router#debug mpls ldp messages normal
router#show debugging
Debug logging is disabled
MPLS LDP
msg-hex-dump enabled for normal level
sess-fsm enabled for normal level
router#
Example: The following example enables MPLS LDP debug at normal information level:
router>enable
password:
router#debug interface pos 1/1/1 mpls ldp msg-hex-dump normal
router#show debugging
Debug logging is disabled
MPLS LDP
msg-hex-dump enabled for normal level on interface POS 1/1/1
router#
Enabling RSVP Protocol Debug
The debug mpls rsvp command in privileged mode enables RSVP protocol debug. The command supports the all the sub-systems listed in Table 15-1 "Protocol Debug Systems and Sub-systems" providing RSVP related debug information for all listed sub-systems. RSVP protocol debug commands can be enabled for the Avici router or for a specified interface/composite link. The information level option can be specified as terse for minimum output, normal for moderate output including terse statements, and verbose for all protocol debug output relating to the RSVP sub-system.
The following provides a single example for each RSVP debug sub-system. Each example includes all options that are available for that command, with option descriptions enclosed in brackets.
Example 1: The following example enables RSVP protocol IO activity debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 mpls rsvp io terse
router#
Example 2: The following example enables RSVP events debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 mpls rsvp events terse
router#
Example 3: The following example enables RSVP switch configuration debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 mpls rsvp swcfg terse
router#
Example 4: The following example enables RSVP traffic engineering debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 mpls rsvp te terse
router#
Example 5: The following example enables RSVP CLI commands debug for the [1/1/1 POS interface] at [terse information level]:
router>enable
password:
router#debug interface pos 1/1/1 mpls rsvp cli terse
router#
Redirecting Protocol Debug Output to Logging
The logging log-debug command redirects protocol debug output to the current log file in addition to displaying protocol debug output on the originating console or telnet session. You can redirect protocol debug output to the log file only by including the log-only option in the command line.
Example: The following example enables PPP LCP packet debug for the oc48c1 composite link at normal information level and enables redirection to the log file only:
router>enable
password:
router#debug interface composite-link oc48c1 ppp lcp normal
router#logging log-debug log-only
router#
| |
|
|
Copyright © 2005
Avici Systems Inc.
Avici® and TSR®
is a registered trademark of Avici Systems Inc.
IPriori™, Composite Links™, SSR™, QSR, and NSR® are
trademarks of Avici Systems Inc.
Source
File Name: ProtoDebug.fm
HTML File Name: ProtoDebug.html
Last Updated: 02/25/05 at 15:20:47