Cisco IOS High Availability Command Reference
show pppatm statistics through vrrp timers learn

Table Of Contents

show pppatm statistics

show pppoe statistics

show pppoe summary

show redundancy

show route-map

show tcp

show tcp ha connections

show tech-support mpls

show vrrp

show vrrp interface

snmp-server enable traps

snmp-server host

standby authentication

standby delay minimum reload

standby ip

standby mac-address

standby mac-refresh

standby preempt

standby priority

standby redirect

standby timers

standby track

standby use-bia

subscriber redundancy

subscribe-to-alert-group

time-period

timers graceful-restart purge-time

timers nsf converge

timers nsf route-hold

timers nsf signal

track

tunnel mpls traffic-eng backup-bw

vrrp authentication

vrrp description

vrrp ip

vrrp preempt

vrrp priority

vrrp timers advertise

vrrp timers learn


show pppatm statistics

To display PPP over ATM (PPPoA) statistics, use the show pppatm statistics command in privileged EXEC mode.

show pppatm statistics

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(31)SB2

This command was introduced.


Usage Guidelines

Use the show pppatm statistics command to obtain statistics for PPPoA sessions. This command gives a total count of PPPoA events since the clear pppatm statistics command was last issued.

Examples

The following example displays PPPoA statistics:

Router# show pppatm statistics

	4000 : Context Allocated events
	3999 : SSS Request events
	7998 : SSS Msg events
	3999 : PPP Msg events
	3998 : Up Pending events
	3998 : Up Dequeued events
	3998 : Processing Up events
	3999 : Vaccess Up events
	3999 : AAA unique id allocated events
	3999 : No AAA method list set events
	3999 : AAA gets nas port details events
	3999 : AAA gets retrived attrs events
	68202 : AAA gets dynamic attrs events
	3999 : Access IE allocated events

Table 137 describes the significant fields shown in the displays. Any data not described in Table 137 is used for internal debugging purposes.

Table 137 show pppatm statistics Field Descriptions 

Field
Description

Context allocated events

Number of PPPoA events for which a context has been allocated.

SSS request events

Subscriber service switch (SSS) requests.

SSS Msg events

SSS responses

PPP Msg events

PPP responses.

Up Pending events

ATM VC notification of events in queue.

Up dequeued events

ATM VC notification of events removed from queue.

Processing Up events

PPPoA events processed.

Vaccess Up events

Number of events for which the virtual access interface state changed to up.

AAA unique id allocated events

Number of events for which a unique AAA ID was allocated.

No AAA method list set events

Number of events for which no AAA accounting list was configured.

AAA get NAS port details events

Number of NAS port events.

AAA gets retrieved attrs events

Number of AAA retrieved attributes events for incoming and outgoing packets.

AAA gets dynamic attrs events

Number of AAA dynamic attributes events for start/stop packets.

Access IE allocated events

Number of IE (internal ID ) allocated events.


Related Commands

Command
Description

clear pppatm statistics

Clears PPP ATM statistics.


show pppoe statistics

To display PPP over Ethernet (PPPoE) events and statistics, use the show pppoe statistics command in privileged EXEC mode.

show pppoe statistics

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(31)SB2

This command was introduced.

12.2(33)SRC

This command was integrated into Cisco IOS Release 12.2(33)SRC.


Usage Guidelines

This command is useful for obtaining statistics and events for PPPoE sessions. Use the show pppoe statistics command to display a cumulative count of PPPoE events and statistics, and to display an incremental count since the last time the clear pppoe statistics command was issued.

Examples

The following is sample output from the show pppoe statistics command:

Router# show pppoe statistics

PPPoE Events                   TOTAL         SINCE CLEARED
------------------------------ ------------- -------------
INVALID                        0             0            
PRE-SERVICE FOUND              0             0            
PRE-SERVICE NONE               0             0            
SSS CONNECT LOCAL              16002         16002        
SSS FORWARDING                 0             0            
SSS FORWARDED                  0             0            
SSS MORE KEYS                  16002         16002        
SSS DISCONNECT                 0             0            
CONFIG UPDATE                  0             0            
STATIC BIND RESPONSE           16002         16002        
PPP FORWARDING                 0             0            
PPP FORWARDED                  0             0            
PPP DISCONNECT                 0             0            
PPP RENEGOTIATION              0             0            
SSM PROVISIONED                16002         16002        
SSM UPDATED                    16002         16002        
SSM DISCONNECT                 0             0            
> 
PPPoE Statistics               TOTAL         SINCE CLEARED
------------------------------ ------------- -------------
SSS Request                    16002         16002        
SSS Response Stale             0             0            
SSS Disconnect                 0             0            
PPPoE Handles Allocated        16002         16002        
PPPoE Handles Freed            0             0            
Dynamic Bind Request           16002         16002        
Static Bind Request            16002         16002        

Table 138 describes the significant fields shown in the displays. Any data not described in Table 138 is used for internal debugging purposes.

Table 138 show pppoe statistics Field Descriptions 

Field
Description

INVALID

Errors in the segment handling state machine; this field typically displays a zero.

PRE-SERVICE FOUND

Number of occurrences of PPPoE service policy having been located and configuration data having been read from the external server to the bba-group profile.

PRE-SERVICE NONE

Number of failures of PPPoE service policy profile configuration read from the external server.

SSS CONNECT LOCAL

Subscriber service switch (SSS) connections that received loca l termination directives.

SSS FORWARDING

SSS connections that received forwarding notification.

SSS FORWARDED

SSS connections that received forwarded notification.

SSS MORE KEYS

PPPoE sessions that are in the intermediate state, processing service keys, before a session is forwarded or terminated locally.

SSS DISCONNECT

PPPoE sessions disconnected after receiving a disconnect notification from the subscriber service switch.

CONFIG UPDATE

PPPoE sessions receiving serving policy configuration updates.

STATIC BIND RESPONSE

Number of responses that the interface is bound to the PPP session.

PPP FORWARDING

Number of PPPoE sessions in the forwarding state.

PPP FORWARDED

Number of forwarded PPPoE sessions.

PPP DISCONNECT

PPPoE sessions disconnected after receiving a disconnect message from the state machine.

PPP RENEGOTIATION

PPPoE sessions renegotiated after receiving a renegotiation message from the state machine.

SSM PROVISIONED

Segment switching manager (SSM) response that the dataplane has been initialized.

SSM UPDATED

SSM response that the dataplane has been successfully updated.

SSM DISCONNECT

Dataplane disconnects from PPPoE sessions.

SSS Request

SSS requests to determine if a call is to be forwarded or locally terminated.

SSS Response Stale

SSS responses received for sessions that are already freed.

SSS Disconnect

SSS disconnect messages to PPPoE sessions.

PPPoE Handles Allocated

Handles assigned for PPPoE sessions.

PPPoE Handles Freed

Handles freed for PPPoE sessions.

Dynamic Bind Request

PPPoE requests to start PPP sessions.

Static Bind Request

PPPoE requests to bind interfaces to PPP sessions.


Related Commands

Command
Description

clear pppoe statistics

Clears PPPoE statistics.


show pppoe summary

To display a summary of the currently active PPP over Ethernet (PPPoE) sessions, use the show pppoe summary command in user EXEC or privileged EXEC mode.

show pppoe summary

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Release
Modification

12.2(21)SB

This command was introduced in a release earlier than Cisco IOS Release 12.2(21)SB.

12.4(1)

This command was integrated into Cisco IOS Release 12.4(1).

12.2(33)SRC

This command was integrated into Cisco IOS Release 12.2(33)SRC.


Examples

The following is sample output from the show pppoe summary command:

Router# show pppoe summary

PTA  : Locally terminated sessions
    FWDED: Forwarded sessions
    TRANS: All other sessions (in transient state)

                      TOTAL     PTA   FWDED   TRANS
TOTAL                 20434   20434       0       0
GigabitEthernet2/0/0   4096    4096       0       0
ATM3/0/0              16247   16247       0       0

Table 139 describes the significant fields shown in the display.

Table 139 show pppoe summary Field Descriptions 

Field
Description

TOTAL

Total number of sessions.

PTA

Locally terminated sessions.

FWDED

Forwarded sessions.

TRANS

All other sessions in transient state.


Related Commands

Command
Description

show pppoe session

Displays information about currently active PPPoE sessions.


show redundancy

To display current or historical status and related information on planned or logged handovers, use the show redundancy command in user EXEC or privileged EXEC mode.

Privileged EXEC Mode

show redundancy [clients | counters | debug-log | handover | history | switchover history | states | inter-device]

User EXEC Mode

show redundancy {clients | counters | history | states | switchover}

Syntax Description

clients

(Optional) Displays the redundancy-aware client-application list.

counters

(Optional) Displays redundancy-related operational measurements.

debug-log

(Optional) Displays up to 256 redundancy-related debug entries.

handover

(Optional) Displays details of any pending scheduled handover.

history

(Optional) Displays past status and related information about logged handovers. This is the only keyword supported on the Cisco AS5800.

switchover history

(Optional) Displays redundancy switchover history.

states

(Optional) Displays redundancy-related states: disabled, initialization, standby, active (various substates for the latter two).

switchover

(Optional) Displays the switchover counts, the uptime since active, and the total system uptime.

inter-device

(Optional) Displays redundancy interdevice operational state and statistics.


Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Release
Modification

11.3(6)AA

This command was introduced in privileged EXEC mode.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T. Support for the Cisco AS5800 and Cisco AS5850 is not included in this release.

12.2(8)MC2

This command was introduced in user EXEC mode.

12.2(11)T

The privileged EXEC mode form of this command was implemented on the Cisco AS5800 and Cisco AS5850.

12.2(14)SX

The user EXEC mode form of this command was introduced on the Supervisor Engine 720.

12.2(18)S

This command was introduced on Cisco 7304 routers running Cisco IOS Release 12.2S.

12.2(20)S

The states, counters, clients, history, and switchover history keywords were added.

12.2(17d)SXB

Support for the user EXEC mode form of this command was extended to the Supervisor Engine 2.

12.3(8)T

The inter-device keyword was added to the privileged EXEC form of the command.

12.3(11)T

The user EXEC form of this command was integrated into Cisco IOS Release 12.3(11)T.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SGA

This command was integrated into Cisco IOS Release 12.2(31)SGA.

12.2(33)SRB

The clients keyword was enhanced to provide information about the status of each client.

12.2(33)SRB1

ISSU is supported on the Cisco 7600 series routers in Cisco IOS Release 12.2(33)SRB1.

12.2(31)SXH

This command was integrated into Cisco IOS Release 12.2(31)SXH.

12.2(33)SRE

This command was integrated into Cisco IOS Release 12.2(33)SRE.


Usage Guidelines

Cisco AS5800

Use this command from the router-shelf console to determine when failover is enabled. Use this command with the history keyword to log failover events.

Cisco AS5850

To use this command, the router must have two route-switch-controller (RSC) cards installed and must be connected to one of them.

Examples

The following example shows how to display information about the RF client:

Router# show redundancy clients

 clientID = 0       clientSeq = 0        RF_INTERNAL_MSG
 clientID = 25      clientSeq = 130      CHKPT RF
 clientID = 5026    clientSeq = 130      CHKPT RF
 clientID = 5029    clientSeq = 135      Redundancy Mode RF
 clientID = 5006    clientSeq = 170      RFS client
 clientID = 6       clientSeq = 180      Const OIR Client
 clientID = 7       clientSeq = 190      PF Client
 clientID = 5008    clientSeq = 190      PF Client
 clientID = 28      clientSeq = 330      Const Startup Config
 clientID = 29      clientSeq = 340      Const IDPROM Client
 clientID = 65000   clientSeq = 65000    RF_LAST_CLIENT

The output displays the following information:

clientID displays the client's ID number.

clientSeq displays the client's notification sequence number.

Current RF state.

The following example shows how to display information about the RF counters:

Router# show redundancy counters

Redundancy Facility OMs
               comm link up = 0
        comm link down down = 0

          invalid client tx = 0
          null tx by client = 0
                tx failures = 0
      tx msg length invalid = 0

      client not rxing msgs = 0
 rx peer msg routing errors = 0
           null peer msg rx = 0
        errored peer msg rx = 0

                 buffers tx = 0
     tx buffers unavailable = 0
                 buffers rx = 0
      buffer release errors = 0

 duplicate client registers = 0
  failed to register client = 0
       Invalid client syncs = 0

The following example shows information about the RF history:

Router# show redundancy history

00:00:00 client added: RF_INTERNAL_MSG(0) seq=0
00:00:00 client added: RF_LAST_CLIENT(65000) seq=65000
00:00:02 client added: Const Startup Config Sync Clien(28) seq=330
00:00:02 client added: CHKPT RF(25) seq=130
00:00:02 client added: PF Client(7) seq=190
00:00:02 client added: Const OIR Client(6) seq=180
00:00:02 client added: Const IDPROM Client(29) seq=340
00:00:02 *my state = INITIALIZATION(2) *peer state = DISABLED(1)
00:00:02 RF_PROG_INITIALIZATION(100) RF_INTERNAL_MSG(0) op=0 rc=11
00:00:02 RF_PROG_INITIALIZATION(100) CHKPT RF(25) op=0 rc=11
00:00:02 RF_PROG_INITIALIZATION(100) Const OIR Client(6) op=0 rc=11
00:00:02 RF_PROG_INITIALIZATION(100) PF Client(7) op=0 rc=11

The following example shows information about the RF state:

Router# show redundancy states

       my state = 13 -ACTIVE
     peer state = 1  -DISABLED
           Mode = Simplex
           Unit = Primary
        Unit ID = 1

Redundancy Mode (Operational) = Route Processor Redundancy
Redundancy Mode (Configured)  = Route Processor Redundancy
     Split Mode = Disabled
   Manual Swact = Disabled  Reason: Simplex mode
 Communications = Down      Reason: Simplex mode

   client count = 11
 client_notification_TMR = 30000 milliseconds
          keep_alive TMR = 4000 milliseconds
        keep_alive count = 0
    keep_alive threshold = 7
           RF debug mask = 0x0

If you enter the show redundancy states command with stateful switchover (SSO) configured, the Redundancy Mode (Operational) and the Redundancy Mode (Configured) fields display stateful switchover.

The following example shows how to display the switchover counts, the uptime since active, and the total system uptime:

Router> show redundancy switchover

Switchovers this system has experienced          : 1
Uptime since this supervisor switched to active  : 1 minute
Total system uptime from reload                  : 2 hours, 47 minutes

Cisco AS5850 Example

The following is sample output from the show redundancy handover and show redundancy states commands on a Cisco AS5850:

Router# show redundancy handover

No busyout period specified
Handover pending at 23:00:00 PDT Wed May 9 2001

Router# show redundancy states

my state = 14 -ACTIVE_EXTRALOAD
peer state = 4 -STANDBY COLD
Mode = Duplex
Unit = Preferred Primary
Unit ID = 6
Redundancy Mode = Handover-split: If one RSC fails, the peer RSC will take over the 
feature boards
Maintenance Mode = Disabled
Manual Swact = Disabled Reason: Progression in progress
Communications = Up
client count = 3
client_notification_TMR = 30000 milliseconds
keep_alive TMR = 4000 milliseconds
keep_alive count = 1
keep_alive threshold = 7
RF debug mask = 0x0

Cisco AS5800 Example

The following is sample output from the show redundancy command on a Cisco AS5800:

Router# show redundancy

DSC in slot 12:
Hub is in 'active' state.
Clock is in 'active' state.
DSC in slot 13:
Hub is in 'backup' state.
Clock is in 'backup' state.

Cisco AS5800 with History Example

The following is sample output from the show redundancy history command on a Cisco AS5800:

Router# show redundancy history

DSC Redundancy Status Change History:

981130 18:56 Slot 12 DSC: Hub, becoming active - RS instruction
981130 19:03 Slot 12 DSC: Hub, becoming active - D13 order

Cisco AS5800 Router Shelves as Failover Pair Example

The following is sample output from two Cisco AS5800 router shelves configured as a failover pair. The active router shelf is initially RouterA. The show redundancy history and show redundancy commands have been issued. The show redundancy command shows that failover is enabled, shows the configured group number, and shows that this router shelf is the active one of the pair. Compare this output with that from the backup router shelf (RouterB) that follows.


Note When RouterA is reloaded, thereby forcing a failover, new entries are shown on RouterB when a
show redundancy history command is issued after failover has occurred.


Log from the First Router (RouterA)

RouterA# show redundancy history

DSC Redundancy Status Change History:

010215 18:17 Slot -1 DSC:Failover configured -> ACTIVE role by default.
010215 18:18 Slot -1 DSC:Failover -> BACKUP role.
010215 18:18 Slot 12 DSC:Failover -> ACTIVE role.
010215 18:18 Slot 12 DSC:Hub, becoming active - arb timeout

RouterA# show redundancy

failover mode enabled, failover group = 32
Currently ACTIVE role.
DSC in slot 12:
Hub is in 'active' state.
Clock is in 'active' state.
No connection to slot 13

RouterA# reload

Proceed with reload? [confirm] y
*Feb 15 20:19:11.059:%SYS-5-RELOAD:Reload requested
System Bootstrap, Version xxx
Copyright xxx by cisco Systems, Inc.
C7200 processor with 131072 Kbytes of main memory

Log from the Second Router (RouterB)

RouterB# show redundancy

failover mode enabled, failover group = 32
Currently BACKUP role.
No connection to slot 12
DSC in slot 13:
Hub is in 'backup' state.
Clock is in 'backup' state.

*Feb 16 03:24:53.931:%DSC_REDUNDANCY-3-BICLINK:Switching to DSC 13
*Feb 16 03:24:53.931:%DSC_REDUNDANCY-3-BICLINK:Failover:changing to active mode
*Feb 16 03:24:54.931:%DIAL13-3-MSG:
02:32:06:%DSC_REDUNDANCY-3-EVENT:Redundancy event:LINK_FAIL from other DSC
*Feb 16 03:24:55.491:%OIR-6-INSCARD:Card inserted in slot 12, interfaces administratively 
shut down
*Feb 16 03:24:58.455:%DIAL13-3-MSG:
02:32:09:%DSC_REDUNDANCY-3-EVENT:Redundancy event:LINK_FAIL from other DSC
*Feb 16 03:25:04.939:%DIAL13-0-MSG:

RouterB# show redundancy

failover mode enabled, failover group = 32
Currently ACTIVE role.
No connection to slot 12
DSC in slot 13:
Hub is in 'active' state.
Clock is in 'backup' state.

RouterB# show redundancy history

DSC Redundancy Status Change History:

010216 03:09 Slot -1 DSC:Failover configured -> BACKUP role.
010216 03:24 Slot 13 DSC:Failover -> ACTIVE role.
010216 03:24 Slot 13 DSC:Hub, becoming active - D12 linkfail
010216 03:24 Slot 13 DSC:Hub, becoming active - D12 linkfail

*Feb 16 03:26:14.079:%DSIPPF-5-DS_HELLO:DSIP Hello from shelf 47 slot 1 Succeeded
*Feb 16 03:26:14.255:%DSIPPF-5-DS_HELLO:DSIP Hello from shelf 47 slot 3 Succeeded
*Feb 16 03:26:14.979:%DSIPPF-5-DS_HELLO:DSIP Hello from shelf 47 slot 10 Succeeded

Privileged EXEC Mode Example

The following is sample output generated by this command in privileged EXEC mode on router platforms that support no keywords for the privileged EXEC mode form of the command:

RouterB# show redundancy

MWR1900 is the Active Router 
Previous States with most recent at bottom 

 INITL_INITL     Dec 31 19:00:00.000 
 LISTN_INITL     Feb 28 19:00:15.568 
 LISTN_LISTN     Feb 28 19:00:15.568 
 SPEAK_LISTN     Feb 28 19:00:18.568 
 SPEAK_SPEAK     Feb 28 19:00:18.568 
 STDBY_SPEAK     Mar 19 08:54:26.191 
 ACTIV_SPEAK     Mar 19 08:54:26.191 
 ACTIV_STDBY     Mar 19 08:54:26.191 
 ACTIV_ACTIV     Mar 19 08:54:26.191 
 INITL_ACTIV     Mar 19 08:56:22.700 
 INITL_INITL     Mar 19 08:56:22.700 
 INITL_LISTN     Mar 19 08:56:28.544 
 LISTN_LISTN     Mar 19 08:56:28.652 
 LISTN_SPEAK     Mar 19 08:56:31.544 
 SPEAK_SPEAK     Mar 19 08:56:31.652 
 SPEAK_STDBY     Mar 19 08:56:34.544 
 SPEAK_ACTIV     Mar 19 08:56:34.544 
 STDBY_ACTIV     Mar 19 08:56:34.652 
 ACTIV_ACTIV     Mar 19 08:56:34.652 
 INITL_ACTIV     Mar 19 10:20:41.455 
 INITL_INITL     Mar 19 10:20:41.455 
 INITL_LISTN     Mar 19 10:20:49.243 
 LISTN_LISTN     Mar 19 10:20:49.299 
 LISTN_SPEAK     Mar 19 10:20:52.244 
 SPEAK_SPEAK     Mar 19 10:20:52.300 
 SPEAK_STDBY     Mar 19 10:20:55.244 
 STDBY_STDBY     Mar 19 10:20:55.300 
 ACTIV_STDBY     Mar 19 10:21:01.692 
 ACTIV_ACTIV     Mar 19 10:21:01.692 

Related Commands

Command
Description

debug redundancy

Displays information used for troubleshooting dual (redundant) router shelves (Cisco AS5800) or RSCs (Cisco AS5850).

hw-module

Enables the router shelf to stop a DSC or to restart a stopped DSC.

mode

Sets the redundancy mode.

mode y-cable

Invokes y-cable mode.

redundancy

Enters redundancy configuration mode.

redundancy force-switchover

Forces a switchover from the active to the standby supervisor engine.

show chassis

Displays, for a router with two RSCs, information about mode (handover-split or classic-split), RSC configuration, and slot ownership.

show standby

Displays the standby configuration.

standalone

Specifies whether the MWR 1941-DC router is used in a redundant or standalone configuration.

standby

Sets HSRP attributes.


show route-map

To display static and dynamic route maps, use the show route-map command in privileged EXEC mode.

show route-map [map-name | dynamic [dynamic-map-name | application [application-name]] | all] [detailed]

Syntax Description

map-name

(Optional) Name of a specific route map.

dynamic

(Optional) Displays dynamic route map information.

dynamic-map-name

(Optional) Name of a specific dynamic route map.

application

(Optional) Displays dynamic route maps based on applications.

application-name

(Optional) Name of a specific application.

all

(Optional) Displays all static and dynamic route maps.

detailed

(Optional) Displays the details of the access control lists (ACLs) that have been used in the match clauses for dynamic route maps.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

10.0

This command was introduced.

12.0(22)S

This command was integrated into Cisco IOS Release 12.0(22)S, and support for continue clauses was integrated into the command output.

12.2(14)S

This command was integrated into Cisco IOS Release 12.2(14)S.

12.2(27)SBA

The output was enhanced to display dynamically assigned route maps to VRF tables.

12.2(15)T

An additional counter collect policy routing statistic was integrated into Cisco IOS Release 12.2(15)T.

12.3(2)T

Support for continue clauses was integrated into Cisco IOS Release 12.3(2)T.

12.2(17b)SXA

This command was integrated into Cisco IOS Release 12.2(17b)SXA.

12.3(7)T

The dynamic, application, and all keywords were added.

12.0(28)S

The support for recursive next-hop clause was added.

12.3(14)T

The support for recursive next-hop clause was integrated into Cisco IOS Release 12.3(14)T. Support for the map display extension functionality was added. The detailed keyword was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

Cisco IOS XE Release 2.2

In Cisco IOS XE Release 2.2 this command was introduced on the Cisco ASR 1000 Series Routers.


Usage Guidelines

For Cisco IOS Release 12.3(14)T and later 12.4 and 12.4T releases, you can display the ACL-specific information that pertains to the route map in the same display without having to execute a show route-map command to display each ACL that is associated with the route map.

Examples

The show route-map command will display configured route-maps, match, set, and continue clauses. The output will vary depending on which keywords are included with the command, and which software image is running in your router, as shown in the following examples:

show route-map Command with No Keywords Specified: Example

show route-map Command with Dynamic Route Map Specified: Example

show route-map Command with Detailed ACL Information for Route Maps Specified: Example

show route-map Command with VRF Autoclassification: Example

show route-map Command with No Keywords Specified: Example

The following is sample output from the show route-map command:

Router# show route-map

route-map ROUTE-MAP-NAME, permit, sequence 10
  Match clauses:
    ip address (access-lists): 1 
    metric 10 
  Continue: sequence 40
  Set clauses:
    as-path prepend 10
  Policy routing matches: 0 packets, 0 bytes
route-map ROUTE-MAP-NAME, permit, sequence 20
  Match clauses:
    ip address (access-lists): 2 
    metric 20 
  Set clauses:
    as-path prepend 10 10
  Policy routing matches: 0 packets, 0 bytes
route-map ROUTE-MAP-NAME, permit, sequence 30
  Match clauses:
  Continue: to next entry 40
  Set clauses:
    as-path prepend 10 10 10
  Policy routing matches: 0 packets, 0 bytes
route-map ROUTE-MAP-NAME, deny, sequence 40
  Match clauses:
    community (community-list filter): 20:2 
  Set clauses:
    local-preference 100
  Policy routing matches: 0 packets, 0 bytes
route-map LOCAL-POLICY-MAP, permit, sequence 10
  Match clauses:
  Set clauses:
    community 655370
  Policy routing matches: 0 packets, 0 bytes

The following example shows Multiprotocol Label Switching (MPLS)-related route map information:

Router# show route-map

route-map OUT, permit, sequence 10
Match clauses:
  ip address (access-lists): 1 
Set clauses:
  mpls label
Policy routing matches: 0 packets, 0 bytes
       
route-map IN, permit, sequence 10
Match clauses:
  ip address (access-lists): 2 
  mpls label
Set clauses:
Policy routing matches: 0 packets, 0 bytes

Table 140 describes the significant fields shown in the display.

Table 140 show route-map Field Descriptions 

Field
Description

route-map ROUTE-MAP-NAME

Name of the route map.

permit

Indicates that the route is redistributed as controlled by the set actions.

sequence

Number that indicates the position a new route map is to have in the list of route maps already configured with the same name.

Match clauses:
  tag

Match criteria—conditions under which redistribution is allowed for the current route map.

Continue:

Continue clause—shows the configuration of a continue clause and the route-map entry sequence number that the continue clause will go to.

Set clauses:
  metric

Set actions—the particular redistribution actions to perform if the criteria enforced by the match commands are met.

Policy routing matches:

Number of packets and bytes that have been filtered by policy routing.


show route-map Command with Dynamic Route Map Specified: Example

The following is sample output from the show route-map command when entered with the dynamic keyword:

Router# show route-map dynamic

route-map AAA-02/06/04-14:01:26.619-1-AppSpec, permit, sequence 0, identifier 1137954548
  Match clauses:
    ip address (access-lists): PBR#1 PBR#2 
  Set clauses:
  Policy routing matches: 0 packets, 0 bytes
route-map AAA-02/06/04-14:01:26.619-1-AppSpec, permit, sequence 1, identifier 1137956424
  Match clauses:
    ip address (access-lists): PBR#3 PBR#4 
  Set clauses:
  Policy routing matches: 0 packets, 0 bytes
route-map AAA-02/06/04-14:01:26.619-1-AppSpec, permit, sequence 2, identifier 1124436704
  Match clauses:
    ip address (access-lists): PBR#5 PBR#6 
    length 10 100
  Set clauses:
    ip next-hop 172.16.1.1
    ip gateway 172.16.1.1
  Policy routing matches: 0 packets, 0 bytes
Current active dynamic routemaps = 1

The following is sample output from the show route-map command when entered with the dynamic and application keywords:

Router# show route-map dynamic application

Application - AAA
  Number of active routemaps = 1

When you specify an application name, only dynamic routes for that application are shown. The following is sample output from the show route-map command when entered with the dynamic and application keywords and the AAA application name:

Router# show route-map dynamic application AAA

AAA
  Number of active rmaps = 2
AAA-02/06/04-14:01:26.619-1-AppSpec
AAA-02/06/04-14:34:09.735-2-AppSpec

Router# show route-map dynamic AAA-02/06/04-14:34:09.735-2-AppSpec

route-map AAA-02/06/04-14:34:09.735-2-AppSpec, permit, sequence 0, identifier 1128046100
  Match clauses:
    ip address (access-lists): PBR#7 PBR#8 
  Set clauses:
  Policy routing matches: 0 packets, 0 bytes
route-map AAA-02/06/04-14:34:09.735-2-AppSpec, permit, sequence 1, identifier 1141277624
  Match clauses:
    ip address (access-lists): PBR#9 PBR#10 
  Set clauses:
  Policy routing matches: 0 packets, 0 bytes
route-map AAA-02/06/04-14:34:09.735-2-AppSpec, permit, sequence 2, identifier 1141279420
  Match clauses:
    ip address (access-lists): PBR#11 PBR#12 
    length 10 100
  Set clauses:
    ip next-hop 172.16.1.12
    ip gateway 172.16.1.12
  Policy routing matches: 0 packets, 0 bytes
Current active dynamic routemaps = 2

show route-map Command with Detailed ACL Information for Route Maps Specified: Example

The following is sample output from the show route-map command with the dynamic and detailed keywords entered:

Router# show route-map dynamic detailed

route-map AAA-01/20/04-22:03:10.799-1-AppSpec, permit, sequence 1, identifier 29675368 
Match clauses: 
ip address (access-lists): 
Extended IP access list PBR#3 
1 permit icmp 0.0.16.12 1.204.167.240 10.1.1.0 0.0.0.255 syn dscp af12 log-input fragments 
Extended IP access list PBR#4 
1 permit icmp 0.0.16.12 1.204.167.240 10.1.1.0 0.0.0.255 syn dscp af12 log-input fragments 
Set clauses: 
ip next-hop 172.16.1.14 
ip gateway 172.16.1.14 
Policy routing matches: 0 packets, 0 bytes 

show route-map Command with VRF Autoclassification: Example

The following is sampe output from the show route-map command when a specified VRF is configured for VRF autoclassification:

Router# show route-map dynamic

route-map None-06/01/04-21:14:21.407-1-IP VRF, permit, sequence 0
identifier 1675771000
 Match clauses:
 Set clauses: vrf red
 Policy routing matches: 0 packets, 0 bytes
Current active dynamic routemaps = 1

Related Commands

Command
Description

redistribute (IP)

Redistributes routes from one routing domain into another routing domain.

route-map (IP)

Defines the conditions for redistributing routes from one routing protocol into another, or enables policy routing.


show tcp

To display the status of Transmission Control Protocol (TCP) connections when Cisco IOS or Cisco IOS Software Modularity images re running, use the show tcp command in user EXEC or privileged EXEC mode.

show tcp [line-number] [tcb address]

Syntax Description

line-number

(Optional) Absolute line number of the line for which you want to display Telnet connection status.

tcb

(Optional) Specifies the transmission control block (TCB) of the ECN-enabled connection that you want to display.

address

(Optional) TCB hexadecimal address. The valid range is from 0x0 to 0xFFFFFFFF.


Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Release
Modification

10.0

This command was introduced.

12.3(7)T

The tcb keyword and address argument were added.

12.4(2)T

The output is enhanced to display status and option flags.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB. The display output was modified to include the SSO capability flag and to indicate the reason that the SSO property failed on a TCP connection.

12.2(18)SXF4

This command was integrated into Cisco IOS Release 12.2(18)SXF4 to support Software Modularity images.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.


Examples

Example output varies between Cisco IOS software images and Cisco IOS Software Modularity software images. To view the appropriate output, choose one of the following sections:

Cisco IOS Software

Cisco IOS Software Modularity

Cisco IOS Software

The following is sample output that displays the status and option flags:

Router# show tcp
.
.
.
Status Flags: passive open, active open, retransmission timeout, app closed

Option Flags: vrf id set

IP Precedence value: 6
.
.
.
SRTT: 273 ms, RTTO: 490 ms, RTV: 217 ms, KRTT: 0 ms
minRTT: 0 ms, maxRTT: 300 ms, ACK hold: 200 ms
 Status Flags: active open, retransmission timeout
 Option Flags: vrf id set
 IP Precedence value: 6

Table 141 contains the types of flags, all possible command output enhancements, and descriptions. See Table 142 through Table 146 for descriptions of the other fields in the sample output.

Table 141 Type of Flags, All Possible Output Enhancements, and Descriptions 

Type of Flag
Output Enhancement
Description
Status
 

Passive open

Set if passive open was done.

 

Active open

Set if active open was done.

 

Retransmission timeout

Set if retransmission timeout aborts.

 

Net output pending

Output to network is pending.

 

Wait for FIN

Wait for FIN to be acknowledged.

 

App closed

Application has closed the TCB.

 

Sync listen

Listen and establish a handshake.

 

Gen tcbs

TCBs are generated as passive listener.

 

Path mtu discovery

Path maximum transmission unit (MTU) discovery is enabled.

 

Half closed

TCB is half closed.

 

Timestamp echo present

Echo segment is present.

 

Stopped reading

Read half is shut down.

Option
 

VRF id set

Set if connection has a VRF table identifier.

 

Idle user

Set if the connection is idle.

 

Sending urgent data

Set if urgent data is being sent.

 

Keepalive running

Set if keepalive timer is running, or if an Explicit Congestion Notification (ECN)-enabled connection, or a TCB address bind is in effect.

 

Nagle

Set if performing the Nagle algorithm.

 

Always push

All packets and full-sized segments (internal use) are pushed.

 

Path mtu capable

Path MTU discovery is configured.

 

MD5

Message digest 5 (MD) messages are generated.

 

Urgent data removed

Urgent data is removed.

 

SACK option permitted

Peer permits a selective acknowledgment (SACK) option.

 

Timestamp option used

Time-stamp option is in use.

 

Reuse local address

Local address can be reused.

 

Non-blocking reads

Nonblocking TCP is read.

 

Non-blocking writes

Nonblocking TCP is written.

 

No delayed ACK

No TCP delayed acknowledgment is sent.

 

Win-scale

Peer permits window scaling.

 

Linger option set

The linger-on close option is set.


The following is sample output from the show tcp command:

Router# show tcp

tty0, connection 1 to host cider
Connection state is ESTAB, I/O status: 1, unread input bytes: 0
Local host: 172.31.232.17, Local port: 11184
Foreign host: 172.31.1.137, Foreign port: 23

Enqueued packets for retransmit: 0, input: 0, saved: 0

Event Timers (current time is 67341276):
Timer:       Retrans   TimeWait    AckHold    SendWnd  KeepAlive
Starts:           30          0         32          0          0 
Wakeups:           1          0         14          0          0 
Next:              0          0          0          0          0 

iss:   67317172  snduna:   67317228  sndnxt:   67317228     sndwnd:   4096
irs: 1064896000  rcvnxt: 1064897597  rcvwnd:       2144  delrcvwnd:      0

SRTT: 317 ms, RTTO: 900 ms, RTV: 133 ms, KRTT: 0 ms
minRTT: 4 ms, maxRTT: 300 ms, ACK hold: 300 ms
Flags: higher precedence, idle user, retransmission timeout
Datagrams (max data segment is 536 bytes):
Rcvd: 41 (out of order: 0), with data: 34, total data bytes: 1596
Sent: 57 (retransmit: 1), with data: 35, total data bytes: 55

Table 142 describes the first five lines of output shown in the above display.

Table 142 show tcp Field Descriptions—First Section of Output 

Field
Description

tty

Identifying number of the line.

connection

Identifying number of the TCP connection.

to host

Name of the remote host to which the connection has been made.

Connection state is

A connection progresses through a series of states during its lifetime. The states that follow are shown in the order in which a connection progresses through them.

LISTEN—Waiting for a connection request from any remote TCP and port.

SYNSENT—Waiting for a matching connection request after having sent a connection request.

SYNRCVD—Waiting for a confirming connection request acknowledgment after having both received and sent a connection request.

ESTAB—Indicates an open connection; data received can be delivered to the user. This is the normal state for the data transfer phase of the connection.

FINWAIT1—Waiting for a connection termination request from the remote TCP or an acknowledgment of the connection termination request previously sent.

FINWAIT2—Waiting for a connection termination request from the remote TCP host.

CLOSEWAIT—Waiting for a connection termination request from the local user.

CLOSING—Waiting for a connection termination request acknowledgment from the remote TCP host.

LASTACK—Waiting for an acknowledgment of the connection termination request previously sent to the remote TCP host.

TIMEWAIT—Waiting for enough time to pass to be sure that the remote TCP host has received the acknowledgment of its connection termination request.

CLOSED—Indicates no connection state at all.

For more information about TCBs, see RFC 793, Transmission Control Protocol Functional Specification.

I/O status

Number that describes the current internal status of the connection.

unread input bytes

Number of bytes that the lower-level TCP processes have read but that the higher-level TCP processes have not yet processed.

Local host

IP address of the network server.

Local port

Local port number, as derived from the following equation: line-number + (512 * random-number). (The line number uses the lower nine bits; the other bits are random.)

Foreign host

IP address of the remote host to which the TCP connection has been made.

Foreign port

Destination port for the remote host.

Enqueued packets for retransmit

Number of packets that are waiting on the retransmit queue. These are packets on this TCP connection that have been sent but that have not yet been acknowledged by the remote TCP host.

input

Number of packets that are waiting on the input queue to be read by the user.

saved

Number of received out-of-order packets that are waiting for all packets in the datagram to be received before they enter the input queue. For example, if packets 1, 2, 4, 5, and 6 have been received, packets 1 and 2 would enter the input queue, and packets 4, 5, and 6 would enter the saved queue.



Note Use the show tcp brief command to display information about the ECN-enabled connections.


The following line of output shows the current elapsed time according to the system clock of the local host. The time shown is the number of milliseconds since the system started.

Event Timers (current time is 67341276):

The following lines of output display the number of times that various local TCP timeout values were reached during this connection. In this example, the local host re-sent data 30 times because it received no response from the remote host, and it sent an acknowledgment many more times because there was no data.

Timer:       Retrans   TimeWait    AckHold    SendWnd     Keepalive    GiveUp    PmtuAger 
Starts:           30          0         32          0          0         0           0 
Wakeups:           1          0         14          0          0         0           0 
Next:              0          0          0          0          0         0           0

Table 143 describes the fields in the above lines of output.

Table 143 show tcp Field Descriptions—Second Section of Output 

Field
Description

Timer

Names of the timer types in the output.

Starts

Number of times that the timer has been triggered during this connection.

Wakeups

Number of keepalives sent without receiving any response. (This field is reset to zero when a response is received.)

Next

System clock setting that triggers a timer for the next time an event (for example, TimeWait, AckHold, SendWnd, etc.) occurs.

Retrans

Retransmission timer is used to time TCP packets that have not been acknowledged and that are waiting for retransmission.

TimeWait

A time-wait timer ensures that the remote system receives a request to disconnect a session.

AckHold

An acknowledgment timer delays the sending of acknowledgments to the remote TCP in an attempt to reduce network use.

SendWnd

A send-window timer ensures that there is no closed window due to a lost TCP acknowledgment.

KeepAlive

A keepalive timer controls the transmission of test messages to the remote device to ensure that the link has not been broken without the knowledge of the local device.

GiveUp

A give-up timer determines the amount of time a local host will wait for an acknowledgment (or other appropriate reply) of a transmitted message after the the maximum number of retransmissions has been reached. If the timer expires, the local host gives up retransmission attempts and declares the connection dead.

PmtuAger

A path MTU (PMTU) age timer is an interval that displays how often TCP estimates the PMTU with a larger maximum segment size (MSS). When the age timer is used, TCP path MTU becomes a dynamic process. If the MSS is smaller than what the peer connection can manage, a larger MSS is tried every time the age timer expires. The discovery process stops when the send MSS is as large as the peer negotiated or the timer has been manually disabled by being set to infinite.


The following lines of output display the sequence numbers that TCP uses to ensure sequenced, reliable transport of data. The local host and remote host each use these sequence numbers for flow control and to acknowledge receipt of datagrams.

iss:   67317172  snduna:   67317228  sndnxt:   67317228     sndwnd:   4096
irs: 1064896000  rcvnxt: 1064897597  rcvwnd:       2144  delrcvwnd:      0

Table 144 describes the fields shown in the display above.

Table 144 show tcp Field Descriptions—Sequence Numbers 

Field
Description

iss

Initial send sequence number.

snduna

Last send sequence number that the local host sent but for which it has not received an acknowledgment.

sndnxt

Sequence number that the local host will send next.

sndwnd

TCP window size of the remote host.

irs

Initial receive sequence number.

rcvnxt

Last receive sequence number that the local host has acknowledged.

rcvwnd

TCP window size of the local host.

delrcvwnd

Delayed receive window—data that the local host has read from the connection but has not yet subtracted from the receive window that the host has advertised to the remote host. The value in this field gradually increases until it is larger than a full-sized packet, at which point it is applied to the rcvwnd field.


The following lines of output display values that the local host uses to keep track of transmission times so that TCP can adjust to the network that it is using.

SRTT: 317 ms, RTTO: 900 ms, RTV: 133 ms, KRTT: 0 ms
minRTT: 4 ms, maxRTT: 300 ms, ACK hold: 300 ms
Flags: higher precedence, idle user, retransmission timeout

Table 145 describes the significant fields shown in the output above.

Table 145 show tcp Field Descriptions—Line Beginning with "SRTT" 

Field
Description

SRTT

A calculated smoothed round-trip timeout.

RTTO

Round-trip timeout.

RTV

Variance of the round-trip time.

KRTT

New round-trip timeout (using the Karn algorithm). This field separately tracks the round-trip time of packets that have been re-sent.

minRTT

Smallest recorded round-trip timeout (hard-wire value used for calculation).

maxRTT

Largest recorded round-trip timeout.

ACK hold

Time for which the local host will delay an acknowledgment in order to add data to it.

Flags

Properties of the connection.



Note For more information on the above fields, see Round Trip Time Estimation, P. Karn and C. Partridge, ACM SIGCOMM-87, August 1987.


The following lines of output display the number of datagrams that are transported with data.

Datagrams (max data segment is 536 bytes):
Rcvd: 41 (out of order: 0), with data: 34, total data bytes: 1596
Sent: 57 (retransmit: 1), with data: 35, total data bytes: 55

Table 146 describes the significant fields shown in the last lines of the show tcp command output.

Table 146 show tcp Field Descriptions—Last Section of Output 

Field
Description

Rcvd

Number of datagrams that the local host has received during this connection (and the number of these datagrams that were out of order).

with data

Number of these datagrams that contained data.

total data bytes

Total number of bytes of data in these datagrams.

Sent

Number of datagrams that the local host sent during this connection (and the number of these datagrams that needed to be re-sent).

with data

Number of these datagrams that contained data.

total data bytes

Total number of bytes of data in these datagrams.


The following is sample output from the show tcp tcb command that displays detailed information by hexadecimal address about an ECN-enabled connection:

Router# show tcp tcb 0x62CD2BB8

Connection state is LISTEN, I/O status: 1, unread input bytes: 0
Connection is ECN enabled
Local host: 10.10.10.1, Local port: 179
Foreign host: 10.10.10.2, Foreign port: 12000

Enqueued packets for retransmit: 0, input: 0 mis-ordered: 0 (0 bytes)

Event Timers (current time is 0x4F31940):
Timer          Starts    Wakeups            Next
Retrans             0          0             0x0
TimeWait            0          0             0x0
AckHold             0          0             0x0
SendWnd             0          0             0x0
KeepAlive           0          0             0x0
GiveUp              0          0             0x0
PmtuAger            0          0             0x0
DeadWait            0          0             0x0

iss:          0 snduna:          0 sndnxt:          0     sndwnd:      0
irs:          0 rcvnxt:          0 rcvwnd:       4128  delrcvwnd:      0

SRTT: 0 ms, RTTO: 2000 ms, RTV: 2000 ms, KRTT: 0 ms
minRTT: 60000 ms, maxRTT: 0 ms, ACK hold: 200 ms
Flags: passive open, higher precedence, retransmission timeout

TCB is waiting for TCP Process (67)

Datagrams (max data segment is 516 bytes):
Rcvd: 6 (out of order: 0), with data: 0, total data bytes: 0
Sent: 0 (retransmit: 0, fastretransmit: 0), with data: 0, total data
bytes: 0

Cisco IOS Software Modularity

The following is sample output from the show tcp tcb command from a Software Modularity image:

Router# show tcp tcb 0x1059C10

Connection state is ESTAB, I/O status: 0, unread input bytes: 0
Local host: 10.4.2.32, Local port: 23
Foreign host: 10.4.2.39, Foreign port: 11000
VRF table id is: 0

Current send queue size: 0 (max 65536)
Current receive queue size: 0 (max 32768)  mis-ordered: 0 bytes

Event Timers (current time is 0xB9ACB9):
Timer          Starts    Wakeups            Next(msec)
Retrans             6          0                0
SendWnd             0          0                0
TimeWait            0          0                0
AckHold             8          4                0
KeepAlive          11          0          7199992
PmtuAger            0          0                0
GiveUp              0          0                0
Throttle            0          0                0

irs:    1633857851  rcvnxt: 1633857890  rcvadv: 1633890620  rcvwnd:  32730
iss:    4231531315  snduna: 4231531392  sndnxt: 4231531392  sndwnd:   4052
sndmax: 4231531392  sndcwnd:     10220

SRTT: 84 ms,  RTTO: 650 ms,  RTV: 69 ms,  KRTT: 0 ms
minRTT: 0 ms,  maxRTT: 200 ms, ACK hold: 200 ms

Keepalive time: 7200 sec, SYN wait time: 75 sec
Giveup time: 0 ms, Retransmission retries: 0, Retransmit forever: FALSE

State flags: none

Feature flags: Nagle

Request flags: none
Window scales: rcv 0, snd 0, request rcv 0, request snd 0
Timestamp option: recent 0, recent age 0, last ACK sent          0

Datagrams (in bytes): MSS 1460, peer MSS 1460, min MSS 1460, max MSS 1460
Rcvd: 14 (out of order: 0), with data: 10, total data bytes: 38
Sent: 10 (retransmit: 0, fastretransmit: 0), with data: 5, total data bytes: 76

Header prediction hit rate: 72 %

Socket states: SS_ISCONNECTED, SS_PRIV

Read buffer flags: SB_WAIT, SB_SEL, SB_DEL_WAKEUP
Read notifications: 4

Write buffer flags: SB_DEL_WAKEUP
Write notifications: 0
Socket status: 0

Related Commands

Command
Description

show tcp brief

Displays a concise description of TCP connection endpoints.


show tcp ha connections

To display connection-ID-to-TCP mapping data, use the show tcp ha connections command in privileged EXEC mode.

show tcp ha connections

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(28)SB

This command was introduced.


Usage Guidelines

The show tcp ha connections command is used to display connection-ID-to-TCP mapping data.

Examples

The following is sample output from the show tcp ha connections command:

Router# show tcp ha connections

SSO enabled for 40 connections
TCB       Local Address           Foreign Address        (state)    Conn Id
71EACE60  10.0.56.1.179           10.0.56.3.58671         ESTAB      37
71EA9320  10.0.53.1.179           10.0.53.3.58659         ESTAB      34
71EA35F8  10.0.41.1.179           10.0.41.3.58650         ESTAB      22
71A21FE0  10.0.39.1.179           10.0.39.3.58641         ESTAB      20
71EAA6E0  10.0.54.1.179           10.0.54.3.58663         ESTAB      35
71EA2238  10.0.40.1.179           10.0.40.3.58646         ESTAB      21
71EABAA0  10.0.55.1.179           10.0.55.3.58667         ESTAB      36
71EAE710  10.0.28.1.179           10.0.28.3.58676         ESTAB      9
71EA2728  10.0.50.1.179           10.0.50.3.58647         ESTAB      31
720541D8  10.0.49.1.179           10.0.49.3.58642         ESTAB      30
71EAA1F0  10.0.44.1.179           10.0.44.3.58662         ESTAB      25
2180B3A8  10.0.33.1.179           10.0.33.3.58657         ESTAB      14
71EAB5B0  10.0.45.1.179           10.0.45.3.58666         ESTAB      26
21809FE8  10.0.32.1.179           10.0.32.3.58653         ESTAB      13
71EA8E30  10.0.43.1.179           10.0.43.3.58658         ESTAB      24
71EAD350  10.0.27.1.179           10.0.27.3.58672         ESTAB      8
2180A9C8  10.0.52.1.179           10.0.52.3.58655         ESTAB      33
2180A4D8  10.0.42.1.179           10.0.42.3.58654         ESTAB      23
71EABF90  10.0.26.1.179           10.0.26.3.58668         ESTAB      7
71EA3AE8  10.0.51.1.179           10.0.51.3.58651         ESTAB      32
720546C8  10.0.59.1.179           10.0.59.3.58643         ESTAB      40

Table 147 describes the significant fields shown in the display.

Table 147 show tcp ha connections Field Descriptions 

Field
Description

SSO enabled for

Displays the number of TCP connections that support BGP Nonstop Routing (NSR) with SSO.

TCB

An internal identifier for the endpoint.

Local Address

The local IP address and port.

Foreign Address

The foreign IP address and port (at the opposite end of the connection).

(state)

TCP connection state. A connection progresses through a series of states during its lifetime. The states that follow are shown in the order in which a connection progresses through them.

LISTEN—Waiting for a connection request from any remote TCP and port.

SYNSENT—Waiting for a matching connection request after having sent a connection request.

SYNRCVD—Waiting for a confirming connection request acknowledgment after having both received and sent a connection request.

ESTAB—Indicates an open connection; data received can be delivered to the user. This is the normal state for the data transfer phase of the connection.

FINWAIT1—Waiting for a connection termination request from the remote TCP or an acknowledgment of the connection termination request previously sent.

Conn id

Identifying number of the TCP connection.


show tech-support mpls

To generate a report of all Multiprotocol Label Switching (MPLS)-related information, use the show tech-support mpls command in privileged EXEC mode.

show tech-support mpls [vrf vrf-name]

Syntax Description

vrf vrf-name

(Optional) Displays MPLS information about the specified VPN routing and forwarding (VRF) instance.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(25)S

This command was introduced.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.


Usage Guidelines

This command is useful when you contact technical support personnel with questions regarding MPLS. The show tech-support mpls command generates a series of reports. The show tech-support mpls command is equivalent to issuing the following commands:

MPLS Forwarding Information Commands

show adjacency detail
show cef drop show cef events
show cef not-cef-switched
show cef state
show interface accounting | exclude sab
show interfaces statistic | exclude sabl
show ip cef adjacency discard
show ip cef adjacency drop
show ip cef adjacency glean
show ip cef adjacency null
show ip cef adjacency punt
show ip cef detail internal
show ip cef inconsistency
show ip cef summary
show ip cef unresolved internal
show ip interfaces
show ip route
show ip traffic
show mpls forwarding-table detail
show mpls interfaces all
show mpls interfaces all internal
show mpls label range
show mpls static binding

MPLS Forwarding: Cell Mode (LC-ATM) Commands


Note These commands are not supported on Cisco 10000 series routers.


show atm vc
show controller vsi descriptor
show controller vsi session
show controller vsi status
show XTagATM cross-connect
show XTagATM cross-connect traffic
show XTagATM vc

MPLS Forwarding: Quality of Service (QoS) Commands


Note These commands are not supported on Cisco 10000 series routers.


show interfaces fair-queue
show interfaces mpls-exp
show interfaces precedence

MPLS Label Distribution Protocol (LDP) Commands

show mpls atm-ldp bindings
show mpls atm-ldp bindwait
show mpls atm-ldp capability
show mpls atm-ldp summary            <=====
Not supported on Cisco 10000 series routers
show mpls ip binding detail
show mpls ldp backoff
show mpls ldp discovery all detail
show mpls ldp neighbor all
show mpls ldp neighbor detail
show mpls ldp parameters

MPLS LDP: Stateful Switchover/Nonstop Forwarding (SSO/NSF) Support and Graceful Restart Commands

show mpls checkpoint label-binding
show mpls ldp checkpoint
show mpls ldp graceful-restart
show mpls ldp neighbor graceful-restart

MPLS Traffic Engineering Commands

show ip ospf database opaque-area
show ip ospf database opaque-link
show ip ospf mpls traffic-eng fragment
show ip ospf mpls traffic-eng link
show ip rsvp fast-reroute detail
show ip rsvp installed
show ip rsvp interface
show ip rsvp neighbor
show ip rsvp reservation
show ip rsvp sender
show isis mpls traffic-eng adjacency-log
show isis mpls traffic-eng advertisements
show isis mpls traffic-eng tunnel
show mpls traffic-end link-management interfaces
show mpls traffic-eng autoroute
show mpls traffic-eng fast-reroute database detail
show mpls traffic-eng fast-reroute log reroutes
show mpls traffic-eng forwarding adjacency
show mpls traffic-eng link-management admission-control
show mpls traffic-eng link-management advertisements
show mpls traffic-eng link-management bandwidth-allocation
show mpls traffic-eng link-management summary
show mpls traffic-eng topology
show mpls traffic-eng tunnels
show mpls traffic-eng tunnels brief
show mpls traffic-eng tunnels statics summary

MPLS VPN Commands

show ip bgp labels
show ip bgp neighbors
show ip bgp vpnv4 all
show ip bgp vpnv4 all labels
show ip bgp vpnv4 all summary
show ip vrf detail
show ip vrf interfaces
show ip vrf select

Any Transport over MPLS (AToM) Commands

show mpls l2transport binding
show mpls l2transport hw-capability
show mpls l2transport summary
show mpls l2transport vc detail

MPLS VPN VRF-Specific Commands

show ip bgp vpnv4 vpn-name dampening flap-statistics
show ip bgp vpnv4
vpn-name labels
show ip bgp vpnv4
vpn-name peer-group
show ip bgp vpnv4
vpn-name summary
show ip bgp vpnv4 vrf
vpn-name neighbors
show ip vrf detail
vpn-name
show ip vrf interfaces vpn-name
show ip vrf select vpn-name

MPLS VPN VRF-Specific Forwarding Commands

show ip cef vrf vpn-name adjacency discard
show ip cef vrf
vpn-name adjacency drop
show ip cef vrf
vpn-name adjacency glean
show ip cef vrf
vpn-name adjacency null
show ip cef vrf
vpn-name adjacency punt
show ip cef vrf
vpn-name inconsistency
show ip cef vrf
vpn-name internal
show ip cef vrf
vpn-name summary
show ip route vrf
vpn-name
show ip vrf interfaces vpn-name
show mpls forwarding-table vrf vpn-name
show mpls interface vrfvpn-name detail

MPLS LDP VRF-Specific Commands

show mpls ip binding vrf vpn-name atm detail
show mpls ip binding vrf
vpn-name detail
show mpls ip binding vrf
vpn-name local
show mpls ip binding vrf
vpn-name summary
show mpls ldp discovery vrf
vpn-name detail
show mpls ldp neighbor vrf
vpn-name detail

MPLS LDP VRF Graceful Restart-Specific Commands

show mpls ldp neighbor vrf vpn-name graceful-restart


These commands are documented in individual feature modules or Cisco IOS Release 12.2 command references. Refer to the individual commands for information about the output these commands generate.

Examples

The following example displays an abbreviated version of the show tech-support mpls command output:

Router# show tech-support mpls 

------------------ show version ------------------

Cisco IOS Software, 7300 Software (C7300-P-M), Version 12.2(27)SBC, RELEASE SOF)
Technical Support: http://www.cisco.com/techsupport
Copyright (c) 1986-2005 by Cisco Systems, Inc.
Compiled Sat 10-Sep-05 17:44 by ssearch
.
.
.
------------------ show running-config ------------------

Building configuration...

Current configuration : 1827 bytes
.
.
.
------------------ show mpls ldp graceful-restart ------------------

LDP Graceful Restart is disabled
Neighbor Liveness Timer: 120 seconds
Max Recovery Time: 120 seconds
Forwarding State Holding Time: 600 seconds

Related Commands

Command
Description

show tech-support

Displays the equivalent of the show buffers, show controllers, show interfaces, show process, show process memory, show running-config, show stacks, and show version commands.


show vrrp

To display a brief or detailed status of one or all configured Virtual Router Redundancy Protocol (VRRP) groups on the router, use the show vrrp command in privileged EXEC mode.

show vrrp [all | brief]

Syntax Description

all

(Optional) Provides VRRP group information about all VRRP groups, including groups in a disabled state.

brief

(Optional) Provides a summary view of the group information.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

12.0(18)ST

This command was introduced.

12.0(22)S

This command was integrated into Cisco IOS Release 12.0(22)S.

12.2(13)T

This command was integrated into Cisco IOS Release 12.2(13)T.

12.2(14)S

This command was integrated into Cisco IOS Release 12.2(14)S.

12.3(2)T

This command was enhanced to display the state of a tracked object.

12.3(14)T

This command was enhanced to display message digest 5 (MD5) authentication for a VRRP using text strings, key chains, or key strings.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

12.2(33)SRC

This command was enhanced to display synchronized state information from the Active RP.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.

12.4(24)T

This command was modified. The output was modified to hide configured passwords when MD5 key-string or text authentication is configured.


Usage Guidelines

If no group is specified, all groups are displayed.

Examples

The following is sample output from the show vrrp command:

Router# show vrrp

Ethernet1/0 - Group 1 
State is Master
Virtual IP address is 10.2.0.10 
Virtual MAC address is 0000.5e00.0101 
Advertisement interval is 3.000 sec 
Preemption is enabled 
 min delay is 0.000 sec 
Priority 100 
 Track object 1 state down decrement 15
Master Router is 10.2.0.1 (local), priority is 100 
Master Advertisement interval is 3.000 sec 
Master Down interval is 9.609 sec

Ethernet1/0 - Group 2 
State is Master 
Virtual IP address is 10.0.0.20 
Virtual MAC address is 0000.5e00.0102 
Advertisement interval is 1.000 sec 
Preemption is enabled 
 min delay is 0.000 sec 
Priority 95 
Master Router is 10.0.0.1 (local), priority is 95 
Master Advertisement interval is 1.000 sec 
Master Down interval is 3.628 sec

The following sample output shows the MD5 authentication for a VRRP group using a key string:

Router# show vrrp

Ethernet0/1 - Group 1
State is Master
Virtual IP address is 10.21.0.10
Virtual MAC address is 0000.5e00.0101
Advertisement interval is 1.000 sec
Preemption is enabled
 min delay is 0.000 sec
Priority is 100
Authentication MD5, key-string
Master Router is 10.21.0.1 (local), priority is 100
Master Advertisement interval is 1.000 sec
Master Down interval is 3.609 sec

The following is sample output from the show vrrp command in Cisco IOS Release 12.2(33)SRC or later releases, displaying peer RP state information:

Router# show vrrp

Ethernet0/0 - Group 1  
  State is Init (standby RP, peer state is Master)
  Virtual IP address is 172.24.1.1
  Virtual MAC address is 0000.5e00.0101
  Advertisement interval is 1.000 sec
  Preemption enabled
  Priority is 255 
  Master Router is 172.24.1.1 (local), priority is 255 
  Master Advertisement interval is 1.000 sec
  Master Down interval is 3.003 sec

Table 148 describes the significant fields shown in the displays.

Table 148 show vrrp Field Descriptions 

Field
Description

Ethernet1/0 - Group

Interface type and number, and VRRP group number.

(standby RP, peer state is Master)

State of the peer RP.

State is

Role this interface plays within VRRP (master or backup).

Virtual IP address is

Virtual IP address for this group.

Virtual MAC address is

Virtual MAC address for this group.

Advertisement interval is

Interval at which the router will send VRRP advertisements when it is the master virtual router. This value is configured with the vrrp timers advertise command.

Preemption is

Preemption is either enabled or disabled.

Track object

Object number representing the object to be tracked.

state

State value (up or down) of the object being tracked.

decrement

Amount by which the priority of the router is decremented (or incremented) when the tracked object goes down (or comes back up).

Priority

Priority of the interface.

Authentication MD5, key-string

The currently configured authentication mechanism for this group. Possible values for this field include "MD5" for Message Digest 5 encryption, as shown in the example above. Other messages not displayed in the example include "text, string `my_secret_password'" for plain text and "key-chain `the_chain_i'm_looking_at'."

Master Router is

IP address of the current master virtual router.

priority is

Priority of the current master virtual router.

Master Advertisement interval is

Advertisement interval of the master virtual router.

Master Down interval is

Calculated time that the master virtual router can be down before the backup virtual router takes over.


The following is sample output from the show vrrp command with the brief keyword:

Router# show vrrp brief

Interface	     Grp  Prio   Time   Own  Pre  State    Master addr    Group addr
Ethernet1/0    1   100    3609          P  Master   10.0.0.4        10.0.0.10
Ethernet1/0    2   105    3589          P  Master   10.0.0.4        10.0.0.20

Table 149 describes the fields shown in the display.

Table 149 show vrrp brief Field Descriptions 

Field
Description

Interface

Interface type and number.

Grp

VRRP group to which this interface belongs.

Prio

VRRP priority number for this group.

Time

Calculated time that the master virtual router can be down before the backup virtual router takes over.

Own

IP address owner.

Pre

Preemption status. P indicates that preemption is enabled. If this field is empty, preemption is disabled.

State

Role this interface plays within VRRP (master or backup).

Master addr

IP address of the master virtual router.

Group addr

IP address of the virtual router.


Related Commands

Command
Description

vrrp ip

Enables VRRP on an interface and identifies the IP address of the virtual router.


show vrrp interface

To display the Virtual Router Redundancy Protocol (VRRP) groups and their status on a specified interface, use the show vrrp interface command in user EXEC or privileged EXEC mode.

show vrrp interface type number [brief]

Syntax Description

type

Interface type.

number

Interface number.

brief

(Optional) Provides a summary view of the group information.


Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Release
Modification

12.0(18)ST

This command was introduced.

12.0(22)S

This command was integrated into Cisco IOS Release 12.0(22)S.

12.2(13)T

This command was integrated into Cisco IOS Release 12.2(13)T.

12.2(14)S

This command was integrated into Cisco IOS Release 12.2(14)S.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.

12.4(24)T

This command was modified. The output was modified to hide configured passwords when MD5 key-string or text authentication is configured.


Examples

The following is sample output from the show vrrp interface command:

Router# show vrrp interface ethernet 1/0

Ethernet1/0 - Group 1
State is Master
Virtual IP address is 10.2.0.10
Virtual MAC address is 0000.5e00.0101
Advertisement interval is 3.000 sec
Preemption enabled, delay min 4 secs
Priority is 100
Master Router is 10.2.0.1 (local), priority is 100
Master Advertisement interval is 3.000 sec
Master Down interval is 9.609 sec

Ethernet1/0 - Group 2
State is Master
Virtual IP address is 10.0.0.20
Virtual MAC address is 0000.5e00.0102
Advertisement interval is 1.000 sec
Preemption enabled, delay min 2 sec
Priority is 95
Authentication MD5, key-string
Master Router is 10.0.0.1 (local), priority is 95
Master Advertisement interval is 1.000 sec
Master Down interval is 3.628 sec

Table 150 describes the significant fields shown in the display.

Table 150 show vrrp interface Field Descriptions 

Field
Description

Ethernet1/0 - Group 1

Interface type and number, and VRRP group number.

State is

Role this interface plays within VRRP (master or backup).

Virtual IP address is

Virtual IP address for this group.

Virtual MAC is

Virtual MAC address for this group.

Advertisement interval is

Interval at which the router will send VRRP advertisements when it is the master virtual router. This value is configured with the vrrp timers advertise command.

Preemption

Preemption is either enabled or disabled.

delay min

If preemption is enabled, delay min is the minimum time (in seconds) that a router will wait before preempting the current master router. This field is displayed only if the delay is set at greater than 0 seconds.

Authentication MD5, key-string

The currently configured authentication mechanism for this group. Possible values for this field include "MD5" for Message Digest 5 encryption, as shown in the example above. Other messages not displayed in the example include "text, string "`my_secret_password'" for plain text and "key-chain `the_chain_i'm_looking_at'."

Priority is 100

Priority of this group on this interface.

Master Router is 10.2.0.1 (local)

IP address of the current master virtual router.

Priority is 100

Priority of the current master router.

Master Advertisement interval

Advertisement interval of the master virtual router.

Master Down interval

Calculated time that the master virtual router can be down before the backup virtual router takes over.


Related Commands

Command
Description

vrrp ip

Enables VRRP and identifies the IP address of the virtual router.

vrrp timers advertise

Configures the interval between successive advertisements by the master virtual router in a VRRP group.


Related Commands

snmp-server enable traps

To enable all Simple Network Management Protocol (SNMP) notification types that are available on your system, use the snmp-server enable traps command in global configuration mode. To disable all available SNMP notifications, use the no form of this command.

snmp-server enable traps [notification-type] [vrrp]

no snmp-server enable traps [notification-type] [vrrp]

Syntax Description

notification-type

(Optional) Type of notification (trap or inform) to enable or disable. If no type is specified, all notifications available on your device are enabled or disabled (if the no form is used). The notification type can be one of the following keywords:

alarms—Enables alarm filtering to limit the number of syslog messages generated. Alarms are generated for the severity configured as well as for the higher severity values.

The severity argument is an integer or string value that identifies the severity of an alarm. Integer values are from 1 to 4. String values are critical, major, minor, and informational. The default is 4 (informational). Severity levels are defined as follows:

1—Critical. The condition affects service.

2—Major. Immediate action is needed.

3—Minor. Minor warning conditions.

4—Informational. No action is required. This is the default.

 

auth-framework [sec-violation]—Enables the SNMP CISCO-AUTH-FRAMEWORK-MIB traps. The optional sec-violation keyword enables the SNMP camSecurityViolationNotif notification.1

 

config—Controls configuration notifications, as defined in the CISCO-CONFIG-MAN-MIB (enterprise 1.3.6.1.4.1.9.9.43.2). The notification type is (1) ciscoConfigManEvent.

 

dot1x—Enables IEEE 802.1X traps. This notification type is defined in the CISCO PAE MIB.

Catalyst 6500 Series Switches

The following keywords are available under the dot1x keyword:

auth-fail-vlan—Enables the SNMP cpaeAuthFailVlanNotif notification.

no-auth-fail-vlan—Enables the SNMP cpaeNoAuthFailVlanNotif notification.

guest-vlan—Enables the SNMP cpaeGuestVlanNotif notification.

no-guest-vlan—Enables the SNMP cpaeNoGuestVlanNotif notification.

 

ds0-busyout—Sends notification when the busyout of a DS0 interface changes state (Cisco AS5300 platform only). This notification is defined in the CISCO-POP-MGMT-MIB (enterprise 1.3.6.1.4.1.9.10.19.2), and the notification type is (1) cpmDS0BusyoutNotification.

ds1-loopback—Sends notification when the DS1 interface goes into loopback mode (Cisco AS5300 platform only). This notification type is defined in the CISCO-POP-MGMT-MIB (enterprise 1.3.6.1.4.1.9.10.19.2) as (2) cpmDS1LoopbackNotification.

dsp—Enables SNMP digital signal processing (DSP) traps. This notification type is defined in the CISCO-DSP-MGMT-MIB.

dsp oper-state—Sends a DSP notification made up of both a DSP ID that indicates which DSP is affected and an operational state that indicates whether the DSP has failed or recovered.

 

l2tc—Enable the SNMP Layer 2 tunnel configuration traps. This notification type is defined in CISCO-L2-TUNNEL-CONFIG-MIB.1

 

entity—Controls Entity MIB modification notifications. This notification type is defined in the ENTITY-MIB (enterprise 1.3.6.1.2.1.47.2) as (1) entConfigChange.

 

entity-diag type— Enables the SNMP CISCO-ENTITY-DIAG-MIB traps. The valid type values are as follows:1

boot-up-fail—(Optional) Enables the SNMP ceDiagBootUpFailedNotif traps.1

hm-test-recover—(Optional) Enables the SNMP ceDiagHMTestRecoverNotif traps.1

hm-thresh-reached—(Optional) Enables the SNMP ceDiagHMThresholdReachedNotif traps.1

scheduled-fail—(Optional) Enables the SNMP ceDiagScheduledJobFailedNotif traps.1

 

hsrp—Controls Hot Standby Routing Protocol (HSRP) notifications, as defined in the CISCO-HSRP-MIB (enterprise 1.3.6.1.4.1.9.9.106.2). The notification type is (1) cHsrpStateChange.

 

ipmulticast—Controls IP multicast notifications.

 

license—Enables licensing notifications as traps or informs. The notifications are grouped into four categories that may be controlled individually by combining the following coresponding keywords with the license keyword, or as a group by using the license keyword by itself.

deploy—Controls notifications generated as a result of install, clear, or revoke license events.

error—Controls notifications generated as a result of a problem with the license itself or usage of the license.

imagelevel—Controls notifications related to the image level of the license.

usage—Controls usage notifications related to the license.

 

modem-health—Controls modem-health notifications.

 

module-auto-shutdown [status]—Enables the SNMP CISCO-MODULE-AUTO-SHUTDOWN-MIB traps. The optional status keyword enables the SNMP Module Auto Shutdown status change traps.1

 

rsvp—Controls Resource Reservation Protocol (RSVP) flow change notifications.

 

sys-threshold—(Optional) Enables the SNMP cltcTunnelSysDropThresholdExceeded notification. This notification type is an enhancement to the CISCO-L2-TUNNEL-CONFIG-MIB.1

 

tty—Controls TCP connection notifications.

 

xgcp—Sends External Media Gateway Control Protocol (XGCP) notifications. This notification is from the XGCP-MIB-V1SMI.my, and the notification is enterprise 1.3.6.1.3.90.2 (1) xgcpUpDownNotification.

Note For additional notification types, see the Related Commands table.

vrrp

(Optional) Specifies the Virtual Router Redundancy Protocol (VRRP).

1 Supported on the Catalyst 6500 series switches.


Command Default

No notifications controlled by this command are sent.

Command Modes

Global configuration (config)

Command History

Release
Modification

10.3

This command was introduced.

12.0(2)T

The rsvp notification type was added in Cisco IOS Release 12.0(2)T.

12.0(3)T

The hsrp notification type was added in Cisco IOS Release 12.0(3)T.

12.0(24)S

This command was integrated into Cisco IOS Release 12.0(24)S.

12.2(14)SX

Support for this command was implemented on the Supervisor Engine 720.

12.2(18)S

This command was integrated into Cisco IOS Release 12.2(18)S.

12.2(17d)SXB

Support for this command on the Supervisor Engine 2 was integrated into Cisco IOS Release 12.2(17d)SXB.

12.3(11)T

The vrrp notification type was added in Cisco IOS Release 12.3(11)T.

12.4(4)T

Support for the alarms notification type and severity argument was added in Cisco IOS Release 12.4(4)T.

Support for the dsp and dsp oper-state notification types was added in Cisco IOS Release 12.4(4)T.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.4(11)T

The dot1x notification type was added in Cisco IOS Release 12.4(11)T.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

12.4(20)T

The license notification type keyword was added.

12.2(33)SXH

The l2tc keyword was added and supported on the Catalyst 6500 series switch.

12.2(33)SXI

The following keywords were added and supported on the Catalyst 6500 series switch:

auth-fail-vlan

entity-diag

guest-vlan

module-auto-shutdown

no-auth-fail-vlan

no-guest-vlan

sys-threshold


Usage Guidelines

For additional notification types, see the Related Commands table for this command.

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform requests for the specified notification types. To specify whether the notifications should be sent as traps or informs, use the snmp-server host [traps | informs] command.

To configure the router to send these SNMP notifications, you must enter at least one snmp-server enable traps command. If you enter the command with no keywords, all notification types are enabled. If you enter the command with a keyword, only the notification type related to that keyword is enabled. To enable multiple types of notifications, you must issue a separate snmp-server enable traps command for each notification type and notification option.

Most notification types are disabled by default but some cannot be controlled with the snmp-server enable traps command.

The snmp-server enable traps command is used in conjunction with the snmp-server host command. Use the snmp-server host command to specify which host or hosts receive SNMP notifications. To send notifications, you must configure at least one snmp-server host command.

Catalyst 6500 Series Switches

The following MIBs were enhanced or supported in Cisco IOS Release 12.2(33)SXI and later releases on the Catalyst 6500 series switch:

CISCO-L2-TUNNEL-CONFIG-MIB-LLDP—Enhancement. The CISCO-L2-TUNNEL-CONFIG-MIB provides SNMP access to the Layer 2 tunneling-related configurations.

CISCO-PAE-MIB—Enhancement for critical condition and includes traps when the port goes into the Guest Vlan or AuthFail VLAN.

CISCO-MODULE-AUTO-SHUTDOWN-MIB—Supported. The CISCO-MODULE-AUTO-SHUTDOWN-MIB provides SNMP access to the Catalyst 6500 series switch Module Automatic Shutdown component.

CISCO-AUTH-FRAMEWORK-MIB—Supported. The CISCO-AUTH-FRAMEWORK-MIB provides SNMP access to the Authentication Manager component.

CISCO-ENTITY-DIAG-MIB—The CISCO-ENTITY-DIAG-MIB provides SNMP traps for generic online diagnostics (GOLD) notification enhancements.

Examples

The following example shows how to enable the router to send all traps to the host specified by the name myhost.cisco.com, using the community string defined as public:

Router(config)# snmp-server enable traps 
Router(config)# snmp-server host myhost.cisco.com public

The following example shows how to configure an alarm severity threshold of 3:

Router# snmp-server enable traps alarms 3

The following example shows how to enable the generation of a DSP operational state notification from from the command-line interface (CLI):

Router(config)# snmp-server enable traps dsp oper-state

The following example shows how to enable the generation of a DSP operational state notification from a network management device:

setany -v2c 1.4.198.75 test cdspEnableOperStateNotification.0 -i 1
cdspEnableOperStateNotification.0=true(1)

The following example shows how to send no traps to any host. The Border Gateway Protocol (BGP) traps are enabled for all hosts, but the only traps enabled to be sent to a host are ISDN traps (which are not enabled in this example).

Router(config)# snmp-server enable traps bgp 
Router(config)# snmp-server host user1 public isdn

The following example shows how to enable the router to send all inform requests to the host at the address myhost.cisco.com, using the community string defined as public:

Router(config)# snmp-server enable traps 
Router(config)# snmp-server host myhost.cisco.com informs version 2c public 

The following example shows how to send HSRP MIB traps to the host myhost.cisco.com using the community string public:

Router(config)# snmp-server enable traps hsrp 
Router(config)# snmp-server host myhost.cisco.com traps version 2c public hsrp 

The following example shows that VRRP will be used as the protocol to enable the traps:

Router(config)# snmp-server enable traps vrrp
Router(config)# snmp-server host myhost.cisco.com traps version 2c vrrp

The following example shows how to send IEEE 802.1X MIB traps to the host "myhost.example.com" using the community string defined as public:

Router(config)# snmp-server enable traps dot1x
Router(config)# snmp-server host myhost.example.com traps public

Related Commands

Command
Description

snmp-server enable traps atm pvc

Enables ATM PVC SNMP notifications.

snmp-server enable traps atm pvc extension

Enables extended ATM PVC SNMP notifications.

snmp-server enable traps bgp

Enables BGP server state change SNMP notifications.

snmp-server enable traps calltracker

Enables Call Tracker callSetup and callTerminate SNMP notifications.

snmp-server enable traps envmon

Enables environmental monitor SNMP notifications.

snmp-server enable traps frame-relay

Enables Frame Relay DLCI link status change SNMP notifications.

snmp-server enable traps ipsec

Enables IPsec SNMP notifications.

snmp-server enable traps isakmp

Enables IPsec ISAKMP SNMP notifications.

snmp-server enable traps isdn

Enables ISDN SNMP notifications.

snmp-server enable traps memory

Enables memory pool and buffer pool SNMP notifications.

snmp-server enable traps mpls ldp

Enables MPLS LDP SNMP notifications.

snmp-server enable traps mpls traffic-eng

Enables MPLS TE tunnel state-change SNMP notifications.

snmp-server enable traps mpls vpn

Enables MPLS VPN specific SNMP notifications.

snmp-server enable traps repeater

Enables RFC 1516 hub notifications.

snmp-server enable traps snmp

Enables RFC 1157 SNMP notifications.

snmp-server enable traps syslog

Enables the sending of system logging messages via SNMP.

snmp-server host

Specifies whether you want the SNMP notifications sent as traps or informs, the version of SNMP to use, the security level of the notifications (for SNMPv3), and the destination host (recipient) for the notifications.

snmp-server informs

Specifies inform request options.

snmp-server trap-source

Specifies the interface (and the corresponding IP address) from which an SNMP trap should originate.

snmp trap illegal-address

Issues an SNMP trap when a MAC address violation is detected on an Ethernet hub port of a Cisco 2505, Cisco 2507, or Cisco 2516 router.

vrrp shutdown

Disables a VRRP group.


snmp-server host

To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use the snmp-server host command in global configuration mode. To remove the specified host from the configuration, use the no form of this command.

snmp-server host {hostname | ip-address} [vrf vrf-name] [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]} [community-string [udp-port port] [notification-type]]

no snmp-server host {hostname | ip-address} [vrf vrf-name] [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]} [community-string [udp-port port] [notification-type]]

Syntax Description

hostname

Name of the host. The SNMP notification host is typically a network management station (NMS) or SNMP manager. This host is the recipient of the SNMP traps or informs.

ip-address

IP address or IPv6 address of the SNMP notification host.

vrf

(Optional) Specifies that a Virtual Private Network (VPN) routing and forwarding (VRF) instance should be used to send SNMP notifications.

vrf-name

(Optional) VPN VRF instance used to send SNMP notifications.

traps

(Optional) Specifies that notifications should be sent as traps. This is the default.

informs

(Optional) Specifies that notifications should be sent as informs.

version

(Optional) Specifies the version of the SNMP that is used to send the traps or informs. The default is 1.

If you use the version keyword, one of the following keywords must be specified:

1—SNMPv1.

2c—SNMPv2C.

3—SNMPv3. The most secure model because it allows packet encryption with the priv keyword. The default is noauth.

One of the following three optional security level keywords can follow the 3 keyword:

auth—Enables Message Digest 5 (MD5) and Secure Hash Algorithm (SHA) packet authentication.

noauth—Specifies that the noAuthNoPriv security level applies to this host. This is the default security level for SNMPv3.

priv—Enables Data Encryption Standard (DES) packet encryption (also called "privacy").

community-string

Password-like community string is sent with the notification operation.

Note You can set this string using the snmp-server host command by itself, but Cisco recommends that you define the string using the snmp-server community command prior to using the snmp-server host command.

Note The "at" sign (@) is used for delimiting the context information.

udp-port

(Optional) Specifies that SNMP traps or informs are to be sent to an NMS host.

port

(Optional) UDP port number of the NMS host. The default is 162.

notification-type

(Optional) Type of notification to be sent to the host. If no type is specified, all available notifications are sent. The notification type can be one or more of the following keywords:

bgp—Sends Border Gateway Protocol (BGP) state change notifications.

calltrackerSends Call Tracker call-start/call-end notifications.

cef — Sends notifications related to Cisco Express Forwarding.

config—Sends configuration change notifications.

cpu—Sends CPU-related notifications.

director—Sends notifications related to DistributedDirector.

dspu—Sends downstream physical unit (DSPU) notifications.

eigrp—Sends Enhanced Interior Gateway Routing Protocol (EIGRP) stuck-in-active (SIA) and neighbor authentication failure notifications.

entity—Sends Entity MIB modification notifications.

envmon—Sends Cisco enterprise-specific environmental monitor notifications when an environmental threshold is exceeded.

flash—Sends flash media insertion and removal notifications.

frame-relay—Sends Frame Relay notifications.

hsrp—Sends Hot Standby Routing Protocol (HSRP) notifications.

iplocalpool—Sends IP local pool notifications.

ipmobile—Sends Mobile IP notifications.

ipsec—Sends IP Security (IPsec) notifications.

isdn—Sends ISDN notifications.

l2tun-pseudowire-status—Sends pseudowire state change notifications.

l2tun-session—Sends Layer 2 tunneling session notifications.

license—Sends licensing notifications as traps or informs.

llc2—Sends Logical Link Control, type 2 (LLC2) notifications.

memory—Sends memory pool and memory buffer pool notifications.

mpls-ldp—Sends Multiprotocol Label Switching (MPLS) Label Distribution Protocol (LDP) notifications indicating status changes in LDP sessions.

 

mpls-traffic-eng—Sends MPLS traffic engineering notifications indicating changes in the status of MPLS traffic engineering tunnels.

mpls-vpn—Sends MPLS VPN notifications.

nhrp—Sends Next Hop Resolution Protocol (NHRP) notifications.

ospf—Sends Open Shortest Path First (OSPF) sham-link notifications.

pim—Sends Protocol Independent Multicast (PIM) notifications.

repeater—Sends standard repeater (hub) notifications.

rsrb—Sends remote source-route bridging (RSRB) notifications.

rsvp—Sends Resource Reservation Protocol (RSVP) notifications.

rtr—Sends Response Time Reporter (RTR) notifications.

sdlc—Sends Synchronous Data Link Control (SDLC) notifications.

sdllc—Sends SDLC Logical Link Control (SDLLC) notifications.

snmp—Sends any enabled RFC 1157 SNMP linkUp, linkDown, authenticationFailure, warmStart, and coldStart notifications.

Note To enable RFC 2233 compliant link up/down notifications, you should use the snmp server link trap command.

srp—Sends Spatial Reuse Protocol (SRP) notifications.

stun—Sends serial tunnel (STUN) notifications.

syslog—Sends error message notifications (Cisco Syslog MIB). Use the logging history level command to specify the level of messages to be sent.

tty—Sends Cisco enterprise-specific notifications when a TCP connection closes.

voice—Sends SNMP poor quality of voice traps, when used with the snmp enable peer-trap poor qov command.

vrrp—Sends Virtual Router Redundancy Protocol (VRRP) notifications.

vsimaster—Sends Virtual Switch Interface (VSI) Master notifications.

x25—Sends X.25 event notifications.


Command Default

This command is disabled by default. A recipient is not specified to receive notifications.

Command Modes

Global configuration (config)

Command History

Release
Modification

10.0

This command was introduced.

Cisco IOS Release 12 Mainline/T Train

12.0(3)T

The version 3 [auth | noauth | priv] syntax was added as part of the SNMPv3 Support feature.

The hsrp notification-type keyword was added.

The voice notification-type keyword was added.

12.1(3)T

The calltracker notification-type keyword was added for the Cisco AS5300 and AS5800 platforms.

12.2(2)T

The vrf vrf-name keyword/argument combination was added.

The ipmobile notification-type keyword was added.

Support for the vsimaster notification-type keyword was added for the Cisco 7200 and Cisco 7500 series.

12.2(4)T

The pim notification-type keyword was added.

The ipsec notification-type keyword was added.

12.2(8)T

The mpls-traffic-eng notification-type keyword was added.

The director notification-type keyword was added.

12.2(13)T

The srp notification-type keyword was added.

The mpls-ldp notification-type keyword was added.

12.3(2)T

The flash notification-type keyword was added.

The l2tun-session notification-type keyword was added.

12.3(4)T

The cpu notification-type keyword was added.

The memory notification-type keyword was added.

The ospf notification-type keyword was added.

12.3(8)T

The iplocalpool notification-type keyword was added for the Cisco 7200 and 7301 series routers.

12.3(11)T

The vrrp keyword was added.

12.3(14)T

Support for SNMP over IPv6 transport was integrated into Cisco IOS Release 12.3(14)T. Either an IP or IPv6 Internet address can be specified as the hostname argument.

The eigrp notification-type keyword was added.

12.4(20)T

The license notification-type keyword was added.

15.0(1)M

This command was modified. The nhrp notification-type keyword was added.

Cisco IOS Release 12.0S

12.0(17)ST

The mpls-traffic-eng notification-type keyword was integrated into Cisco IOS Release 12.0(17)ST.

12.0(21)ST

The mpls-ldp notification-type keyword was integrated into Cisco IOS Release 12.0(21)ST.

12.0(22)S

All features in the Cisco IOS Release 12.0ST train were integrated into Cisco IOS Release 12.0(22)S.

The mpls-vpn notification-type keyword was added.

12.0(23)S

The l2tun-session notification-type keyword was added.

12.0(26)S

The memory notification-type keyword was added.

12.0(27)S

Support for SNMP over IPv6 transport was added. Either an IP or IPv6 Internet address can be specified as the hostname argument.

The vrf vrf-name keyword argument pair was integrated into Cisco IOS Release 12.0(27)S to support multiple Lightweight Directory Protocol (LDP) contexts for VPNs.

12.0(31)S

The l2tun-pseudowire-status notification-type keyword was added.

Release 12.2S
 

12.2(18)S

This command was integrated into Cisco IOS Release 12.2(18)S.

12.2(25)S

The cpu notification-type keyword was added.

The memory notification-type keyword was added.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

The cef notification-type keyword was added.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

12.2(33)SB

This command was integrated into Cisco IOS Release 12.2(33)SB.


Usage Guidelines

If you enter this command with no optional keywords, the default is to send all notification-type traps to the host. No informs will be sent to the host.

The no snmp-server host command with no keywords disables traps, but not informs, to the host. To disable informs, use the no snmp-server host informs command.


Note If a community string is not defined using the snmp-server community command prior to using this command, the default form of the snmp-server community command will automatically be inserted into the configuration. The password (community string) used for this automatic configuration of the snmp-server community will be the same as specified in the snmp-server host command. This automatic command insertion and use of passwords is the default behavior for Cisco IOS Release 12.0(3) and later releases.


SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver does not send acknowledgments when it receives traps. The sender cannot determine if the traps were received. However, an SNMP entity that receives an inform request acknowledges the message with a SNMP response protocol data unit (PDU). If the sender never receives the response, the inform request can be sent again. Thus, informs are more likely than traps to reach their intended destination.

Compared to traps, informs consume more resources in the agent and in the network. Unlike a trap, which is discarded as soon as it is sent, an inform request must be held in memory until a response is received or the request times out. Also, traps are sent only once; an inform may be tried several times. The retries increase traffic and contribute to a higher overhead on the network.

If you do not enter a snmp-server host command, no notifications are sent. To configure the router to send SNMP notifications, you must enter at least one snmp-server host command. If you enter the command with no optional keywords, all trap types are enabled for the host.

To enable multiple hosts, you must issue a separate snmp-server host command for each host. You can specify multiple notification types in the command for each host.

When multiple snmp-server host commands are given for the same host and kind of notification (trap or inform), each succeeding command overwrites the previous command. Only the last snmp-server host command will be in effect. For example, if you enter an snmp-server host inform command for a host and then enter another snmp-server host inform command for the same host, the second command will replace the first.

The snmp-server host command is used in conjunction with the snmp-server enable command. Use the snmp-server enable command to specify which SNMP notifications are sent globally. For a host to receive most notifications, at least one snmp-server enable command and the snmp-server host command for that host must be enabled.

Some notification types cannot be controlled with the snmp-server enable command. Some notification types are always enabled, and others are enabled by a different command. For example, the linkUpDown notifications are controlled by the snmp trap link-status command. These notification types do not require an snmp-server enable command.

The availability of a notification-type options depends on the router type and the Cisco IOS software features supported on the router. For example, the envmon notification type is available only if the environmental monitor is part of the system. To see what notification types are available on your system, use the command help ? at the end of the snmp-server host command.

The vrf keyword allows you to specify the notifications being sent to a specified IP address over a specific VRF. The VRF defines a VPN membership of a user so data is stored using the VPN.

Notification-Type Keywords

The notification-type keywords used in the snmp-server host command do not always match the keywords used in the corresponding snmp-server enable traps command. For example, the notification keyword applicable to Multiprotocol Label Switching Protocol (MPLS) traffic engineering tunnels is specified as mpls-traffic-eng (containing two hyphens and no embedded spaces). The corresponding parameter in the snmp-server enable traps command is specified as mpls traffic-eng (containing an embedded space and a hyphen).

This syntax difference is necessary to ensure that the command-line interface (CLI) interprets the notification-type keyword of the snmp-server host command as a unified, single-word construct, which preserves the capability of the snmp-server host command to accept multiple notification-type keywords in the command line. The snmp-server enable traps commands, however, often use two-word constructs to provide hierarchical configuration options and to maintain consistency with the command syntax of related commands. Table 151 maps some examples of snmp-server enable traps commands to the keywords used in the snmp-server host command.

Table 151 SNMP-server enable traps Commands and Corresponding Notification Keywords

snmp-server enable traps Command
snmp-server host Command Keyword

snmp-server enable traps l2tun session

l2tun-session

snmp-server enable traps mpls ldp

mpls-ldp

snmp-server enable traps mpls traffic-eng1

mpls-traffic-eng

snmp-server enable traps mpls vpn

mpls-vpn

1 See the Cisco IOS Multiprotocol Label Switching Command Reference for documentation of this command.


Examples

If you want to configure a unique SNMP community string for traps but prevent SNMP polling access with this string, the configuration should include an access list. The following example shows how to name a community string comaccess and number an access list 10:

Router(config)# snmp-server community comaccess ro 10 
Router(config)# snmp-server host 192.20.2.160 comaccess 
Router(config)# access-list 10 deny any 


Note The "at" sign (@) is used as a delimiter between the community string and the context in which it is used. For example, specific VLAN information in BRIDGE-MIB may be polled using community@VLAN-ID (for example, public@100), where 100 is the VLAN number.


The following example shows how to send RFC 1157 SNMP traps to a specified host named myhost.cisco.com. Other traps are enabled, but only SNMP traps are sent because only snmp is specified in the snmp-server host command. The community string is defined as comaccess.

Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com comaccess snmp 

The following example shows how to send the SNMP and Cisco environmental monitor enterprise-specific traps to address 192.30.2.160 using the community string public:

Router(config)# snmp-server enable traps snmp 
Router(config)# snmp-server enable traps envmon 
Router(config)# snmp-server host 192.30.2.160 public snmp envmon 

The following example shows how to enable the router to send all traps to the host myhost.cisco.com using the community string public:

Router(config)# snmp-server enable traps 
Router(config)# snmp-server host myhost.cisco.com public 

The following example will not send traps to any host. The BGP traps are enabled for all hosts, but only the ISDN traps are enabled to be sent to a host. The community string is defined as public.

Router(config)# snmp-server enable traps bgp
Router(config)# snmp-server host myhost.cisco.com public isdn

The following example shows how to enable the router to send all inform requests to the host myhost.cisco.com using the community string public:

Router(config)# snmp-server enable traps 
Router(config)# snmp-server host myhost.cisco.com informs version 2c public 

The following example shows how to send HSRP MIB informs to the host specified by the name myhost.cisco.com. The community string is defined as public.

Router(config)# snmp-server enable traps hsrp
Router(config)# snmp-server host myhost.cisco.com informs version 2c public hsrp

The following example shows how to send all SNMP notifications to company.com over the VRF named trap-vrf using the community string public:

Router(config)# snmp-server host company.com vrf trap-vrf public

The following example shows how to configure an IPv6 SNMP notification server with the IPv6 address 2001:0DB8:0000:ABCD:1 using the community string public:

Router(config)# snmp-server host 2001:0DB8:0000:ABCD:1 version 2c public udp-port 2012

The following example shows how to specify VRRP as the protocol using the community string public:

Router(config)# snmp-server enable traps vrrp
Router(config)# snmp-server host myhost.cisco.com traps version 2c public vrrp

The following example shows how to send all Cisco Express Forwarding informs to the notification receiver with the IP address 192.40.3.130 using the community string public:

Router(config)# snmp-server enable traps cef
Router(config)# snmp-server host 192.40.3.130 informs version 2c public cef

The following example shows how to enable all NHRP traps, and how to send all NHRP traps to the notification receiver with the IP address 192.40.3.130 using the community string public:

Router(config)# snmp-server enable traps nhrp
Router(config)# snmp-server host 192.40.3.130 traps version 2c public nhrp

Related Commands

Command
Description

show snmp host

Displays recipient details configured for SNMP notifications.

snmp-server enable peer-trap poor qov

Enables poor quality of voice notifications for applicable calls associated with a specific voice dial peer.

snmp-server enable traps

Enables SNMP notifications (traps and informs).

snmp-server enable traps nhrp

Enables SNMP notifications (traps) for NHRP.

snmp-server informs

Specifies inform request options.

snmp-server link trap

Enables linkUp/linkDown SNMP trap that are compliant with RFC 2233.

snmp-server trap-source

Specifies the interface from which an SNMP trap should originate.

snmp-server trap-timeout

Defines how often to try resending trap messages on the retransmission queue.


standby authentication

To configure an authentication string for the Hot Standby Router Protocol (HSRP), use the standby authentication command in interface configuration mode. To delete an authentication string, use the no form of this command.

standby [group-number] authentication {text string | md5 {key-string [0 | 7] key [timeout seconds] | key-chain name-of-chain}} 

no standby [group-number] authentication {text string | md5 {key-string [0 | 7] key [timeout seconds] | key-chain name-of-chain}}

Syntax Description

group-number

(Optional) Group number on the interface to which this authentication string applies. The default group number is 0.

text string

Authentication string. It can be up to eight characters long. The default string is cisco.

md5

Message Digest 5 (MD5) authentication.

key-string key

Specifies the secret key for MD5 authentication. The key can contain up to 64 characters. We recommend using at least 16 characters.

0

(Optional) Unencrypted key. If no prefix is specified, the text also is unencrypted.

7

(Optional) Encrypted key.

timeout seconds

(Optional) Duration in seconds that HSRP will accept message digests based on both the old and new keys.

key-chain name-of-chain

Identifies a group of authentication keys.


Command Default

No text authentication string is configured.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

10.0

This command was introduced.

12.1

The text keyword was added.

12.3(2)T

The md5 keyword and associated parameters were added.

12.2(25)S

This command was integrated into Cisco IOS Release 12.2(25)S

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.


Usage Guidelines

The authentication string is sent unencrypted in all HSRP messages when using the standby authentication text string option. The same authentication string must be configured on all routers and access servers on a cable to ensure interoperation. Authentication mismatch prevents a device from learning the designated Hot Standby IP address and the Hot Standby timer values from other routers configured with HSRP.

When group number 0 is used, no group number is written to NVRAM, providing backward compatibility.

If password encryption is configured with the service password-encryption command, the software saves the key string as encrypted text.

The timeout seconds is the duration that the HSRP group will accept message digests based on both the old and new keys. This allows time for configuration of all routers in a group with the new key. HSRP route flapping can be minimized by changing the keys on all the routers, provided that the active router is changed last. The active router should have its key string changed no later than one holdtime period, specified by the standby timers interface configuration command, after the non-active routers. This procedure ensures that the non-active routers do not time out the active router.

Examples

The following example configures "company1" as the authentication string required to allow Hot Standby routers in group 1 to interoperate:

interface ethernet 0
 standby 1 authentication text company1

The following example configures MD5 authentication using a key string named "345890":

interface Ethernet0/1
 standby 1 ip 10.21.0.12
 standby 1 priority 110
 standby 1 preempt
 standby 1 authentication md5 key-string 345890 timeout 30

The following example configures MD5 authentication using a key chain. HSRP queries the key chain "hsrp1" to obtain the current live key and key ID for the specified key chain:

key chain hsrp1
 key 1
  key-string 543210

interface Ethernet0/1
 standby 1 ip 10.21.0.10
 standby 1 priority 110
 standby 1 preempt
 standby 1 authentication md5 key-chain hsrp1

Related Commands

Command
Description

service password-encryption

Encrypts passwords.

standby timers

Configures the time between hello packets and the time before other routers declare the active Hot Standby or standby router to be down.


standby delay minimum reload

To configure the delay period before the initialization of Hot Standby Router Protocol (HSRP) groups, use the standby delay minimum reload command in interface configuration mode. To disable the delay period, use the no form of this command.

standby delay minimum min-seconds reload reload-seconds

no standby delay minimum min-seconds reload reload-seconds

Syntax Description

min-seconds

Minimum time (in seconds) to delay HSRP group initialization after an interface comes up. This minimum delay period applies to all subsequent interface events.

The valid range is 0 to 300 seconds. The default is 1 second. The recommended value is 30 seconds.

reload-seconds

Time (in seconds) to delay after the router has reloaded. This delay period applies only to the first interface-up event after the router has reloaded.

The valid rang is 0 to 300 seconds. The default is 5 seconds. The recommended value is 60 seconds.


Command Default

HSRP group initialization is not delayed.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

12.2

This command was introduced.

12.2(14)SX

Support for this command was added for the Supervisor Engine 720.

12.2(17d)SXB

Support for this command on the Supervisor Engine 2 was extended to Cisco IOS Release 12.2(17d)SXB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.


Usage Guidelines

If the active router fails or is removed from the network, then the standby router will automatically become the new active router. If the former active router comes back online, you can control whether it takes over as the active router by using the standby preempt command.

However, in some cases, even if the standby preempt command is not configured, the former active router will resume the active role after it reloads and comes back online. Use the standby delay minimum reload command to set a delay period for HSRP group initialization. This command allows time for the packets to get through before the router resumes the active role.

We recommend that all HSRP routers have the standby delay minimum reload configured with a minimum delay time of 30 seconds and a minimum reload time of 60 seconds.

The delay will be cancelled if an HSRP packet is received on an interface.

The standby delay minimum reload interface configuration command delays HSRP groups from initializing for the specified time after the interface comes up.

This command is separate from the standby preempt delay interface configuration command, which enables HSRP preemption delay.

Examples

The following example sets the minimum delay period to 30 seconds and the delay period after the first reload to 120 seconds:

interface ethernet 0
 ip address 10.20.0.7 255.255.0.0
 standby delay minimum 30 reload 60
 standby 3 ip 10.20.0.21
 standby 3 timers msec 300 msec 700
 standby 3 priority 100

Related Commands

Command
Description

show standby delay

Displays HSRP information about delay periods.

standby preempt

Configures the HSRP preemption and preemption delay.

standby timers

Configures the time between hello packets and the time before other routers declare the active HSRP or standby router to be down.


standby ip

To activate the Hot Standby Router Protocol (HSRP), use the standby ip command in interface configuration mode. To disable HSRP, use the no form of this command.

standby [group-number] ip [ip-address [secondary]]

no standby [group-number] ip [ip-address]

Syntax Description

group-number

(Optional) Group number on the interface for which HSRP is being activated. The default is 0. The group number range is from 0 to 255 for HSRP version 1 and from 0 to 4095 for HSRP version 2.

ip-address

(Optional) IP address of the Hot Standby router interface.

secondary

(Optional) Indicates the IP address is a secondary Hot Standby router interface. Useful on interfaces with primary and secondary addresses; you can configure primary and secondary HSRP addresses.


Defaults

The default group number is 0.
HSRP is disabled by default.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

10.0

This command was introduced.

10.3

The group-number argument was added.

11.1

The secondary keyword was added.

12.3(4)T

The group number range was expanded for HSRP version 2.

12.2(25)S

This command was integrated into Cisco IOS Release 12.2(25)S.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The standby ip command activates HSRP on the configured interface. If an IP address is specified, that address is used as the designated address for the Hot Standby group. If no IP address is specified, the designated address is learned through the standby function. For HSRP to elect a designated router, at least one router on the cable must have been configured with, or have learned, the designated address. Configuration of the designated address on the active router always overrides a designated address that is currently in use.

When the standby ip command is enabled on an interface, the handling of proxy Address Resolution Protocol (ARP) requests is changed (unless proxy ARP was disabled). If the Hot Standby state of the interface is active, proxy ARP requests are answered using the MAC address of the Hot Standby group. If the interface is in a different state, proxy ARP responses are suppressed.

When group number 0 is used, no group number is written to NVRAM, providing backward compatibility.

HSRP version 2 permits an expanded group number range from 0 to 4095. The increased group number range does not imply that an interface can, or should, support that many HSRP groups. The expanded group number range was changed to allow the group number to match the VLAN number on subinterfaces.

Examples

The following example activates HSRP for group 1 on Ethernet interface 0. The IP address used by the Hot Standby group will be learned using HSRP.

interface ethernet 0
 standby 1 ip

In the following example, all three virtual IP addresses appear in the ARP table using the same (single) virtual MAC address. All three virtual IP addresses are using the same HSRP group (group 0).

ip address 10.1.1.1. 255.255.255.0
ip address 10.2.2.2. 255.255.255.0 secondary
ip address 10.3.3.3. 255.255.255.0 secondary
ip address 10.4.4.4. 255.255.255.0 secondary
standby ip 10.1.1.254
standby ip 10.2.2.254 secondary
standby ip 10.3.3.254 secondary

standby mac-address

To specify a virtual Media Access Control (MAC) address for the Hot Standby Router Protocol (HSRP), use the standby mac-address command in interface configuration mode. To revert to the standard virtual MAC address (000.0C07.ACxy), use the no form of this command.

standby [group-number] mac-address mac-address

no standby [group-number] mac-address

Syntax Description

group-number

(Optional) Group number on the interface for which HSRP is being activated. The default is 0.

mac-address

MAC address.


Command Default

If this command is not configured, and the standby use-bia command is not configured, the standard virtual MAC address is used: 0000.0C07.ACxy, where xy is the group number in hexadecimal. This address is specified in RFC 2281, Cisco Hot Standby Router Protocol (HSRP).

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.2

This command was introduced.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

This command cannot be used on a Token Ring interface.

HSRP is used to help end stations locate the first-hop gateway for IP routing. The end stations are configured with a default gateway. However, HSRP can provide first-hop redundancy for other protocols. Some protocols, such as Advanced Peer-to-Peer Networking (APN), use the MAC address to identify the first hop for outing purposes. In this case, it is often necessary to be able to specify the virtual MAC address; the virtual IP address is unimportant for these protocols. Use the standby mac-address command to specify the virtual MAC address.

The MAC address specified is used as the virtual MAC address when the router is active.

This command is intended for certain APPN configurations. The parallel terms are shown in Table 152.

Table 152 Parallel Terms Between APPN and IP

APPN
IP

End node

Host

Network Node

Router or gateway


In an APPN network, an end node is typically configured with the MAC address of the adjacent network node. Use the standby mac-address command in the routers to set the virtual MAC address to the value used in the end nodes.

Examples

If the end nodes are configured to use 4000.1000.1060 as the MAC address of the network node, the following example shows the command used to configure HSRP group 1 with the virtual MAC address:

Router(config-if)# standby 1 mac-address 4000.1000.1060

Related Commands

Command
Description

show standby

Displays HSRP information.

standby use-bia

Configures HSRP to use the burned-in address of the interface as its virtual MAC address.


standby mac-refresh

To change the interval at which packets are sent to refresh the Media Access Control (MAC) cache when the Hot Standby Router Protocol (HSRP) is running over FDDI, use the standby mac-refresh command in interface configuration mode. To restore the default value, use the no form of this command.

standby mac-refresh seconds

no standby mac-refresh

Syntax Description

seconds

Number of seconds in the interval at which a packet is sent to refresh the MAC cache. The maximum value is 255 seconds. The default is 10 seconds.


Defaults

seconds: 10 seconds

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

12.0

This command was introduced.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

This command applies to HSRP running over FDDI only. Packets are sent every 10 seconds to refresh the MAC cache on learning bridges or switches. By default, the MAC cache entries age out in 300 seconds (5 minutes).

All other routers participating in HSRP on the FDDI ring receive the refresh packets, although the packets are intended only for the learning bridge or switch. Use this command to change the interval. Set the interval to 0 if you want to prevent refresh packets (if you have FDDI but do not have a learning bridge or switch).

Examples

The following example changes the MAC refresh interval to 100 seconds. Therefore, a learning bridge would need to miss three packets before the entry ages out.

standby mac-refresh 100

standby preempt

To configure Hot Standby Router Protocol (HSRP) preemption and preemption delay, use the standby preempt command in interface configuration mode. To restore the default values, use the no form of this command.

standby [group-number] preempt [delay {minimum seconds | reload seconds | sync seconds}]

no standby [group-number] preempt [delay {minimum seconds | reload seconds | sync seconds}]

Syntax Description

group-number

(Optional) Group number on the interface to which the other arguments in this command apply.

delay

(Optional) Required if either the minimum, reload, or sync keywords are specified.

minimum seconds

(Optional) Specifies the minimum delay period in seconds. The seconds argument causes the local router to postpone taking over the active role for a minimum number of seconds since that router was last restarted. The range is from 0 to 3600 seconds (1 hour). The default is 0 seconds (no delay).

reload seconds

(Optional) Specifies the preemption delay, in seconds, after a reload only. This delay period applies only to the first interface-up event after the router has reloaded.

sync seconds

(Optional) Specifies the maximum synchronization period for IP redundancy clients in seconds.


Defaults

The default group number is 0.
The default delay is 0 seconds; if the router wants to preempt, it will do so immediately.
By default, the router that comes up later becomes the standby.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.3

This command was introduced.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

12.0(2)T

The minimum and sync keywords were added.

12.2

The behavior of the command changed such that standby preempt and standby priority must be entered as separate commands.

12.2

The reload keyword was added.

12.4(4)T

Support for IPv6 was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2(33)SXH

The behavior of the command changed such that standby preempt and standby priority must be entered as separate commands.


Usage Guidelines


Note Cisco IOS 12.2SX software releases earlier than Cisco IOS Release 12.2(33)SXH use the syntax from Cisco IOS Release 12.1, which supports preempt as a keyword for the standby priority command. Cisco IOS Release 12.2(33)SXH and later releases use Cisco IOS Release 12.2 syntax, which requires standby preempt and standby priority to be entered as separate commands.


When the standby preempt command is configured, the router is configured to preempt, which means that when the local router has a Hot Standby priority higher than the current active router, the local router should attempt to assume control as the active router. If preemption is not configured, the local router assumes control as the active router only if it receives information indicating no router is in the active state (acting as the designated router).

This command is separate from the standby delay minimum reload interface configuration command, which delays HSRP groups from initializing for the specified time after the interface comes up.

When a router first comes up, it does not have a complete routing table. If it is configured to preempt, it will become the active router, yet it is unable to provide adequate routing services. Solve this problem by configuring a delay before the preempting router actually preempts the currently active router.

When group number 0 is used, no group number is written to NVRAM, providing backward compatibility.

IP redundancy clients can prevent preemption from taking place. The standby preempt delay sync seconds command specifies a maximum number of seconds to allow IP redundancy clients to prevent preemption. When this expires, preemption takes place regardless of the state of the IP redundancy clients.

The standby preempt delay reload seconds command allows preemption to occur only after a router reloads. This provides stabilization of the router at startup. After this initial delay at startup, the operation returns to the default behavior.

The no standby preempt delay command will disable the preemption delay but preemption will remain enabled. The no standby preempt delay minimum seconds command will disable the minimum delay but leave any synchronization delay if it was configured.

When the standby follow command is used to configure an HSRP group to become an IP redundancy client of another HSRP group, the client group takes its state from the master group it is following. Therefore, the client group does not use its timer, priority, or preemption settings. A warning is displayed if these settings are configured on a client group:

Router(config-if)# standby 1 preempt delay minimum 300
    % Warning: This setting has no effect while following another group.




Examples

In the following example, the router will wait for 300 seconds (5 minutes) before attempting to become the active router:

interface ethernet 0
 standby ip 172.19.108.254
 standby preempt delay minimum 300 

standby priority

To configure Hot Standby Router Protocol (HSRP) priority, use the standby priority command in interface configuration mode. To restore the default values, use the no form of this command.

standby [group-number] priority priority

no standby [group-number] priority priority

Syntax Description

group-number

(Optional) Group number on the interface to which the other arguments in this command apply. The default group number is 0.

priority

Priority value that prioritizes a potential Hot Standby router. The range is from 1 to 255, where 1 denotes the lowest priority and 255 denotes the highest priority. The default priority value is 100. The router in the HSRP group with the highest priority value becomes the active router.


Defaults

The default group number is 0.
The default priority is 100.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.3

This command was introduced.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

12.2

The behavior of the command changed such that standby preempt and standby priority must be entered as separate commands.

12.4(4)T

Support for IPv6 was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2(33)SXH

The behavior of the command changed such that standby preempt and standby priority must be entered as separate commands.


Usage Guidelines


Note Cisco IOS 12.2SX software releases earlier than Cisco IOS Release 12.2(33)SXH use the syntax from Cisco IOS Release 12.1, which supports preempt as a keyword for the standby priority command. Cisco IOS Release 12.2(33)SXH and later releases use Cisco IOS Release 12.2 syntax, which requires standby preempt and standby priority to be entered as separate commands.


When group number 0 is used, the number 0 is written to NVRAM, providing backward compatibility.

The assigned priority is used to help select the active and standby routers. Assuming that preemption is enabled, the router with the highest priority becomes the designated active router. In case of ties, the primary IP addresses are compared, and the higher IP address has priority.

Note that the priority of the device can change dynamically if an interface is configured with the standby track command and another interface on the router or a tracked object goes down.

When the standby follow command is used to configure an HSRP group to become an IP redundancy client of another HSRP group, the client group takes its state from the master group it is following. Therefore, the client group does not use its timer, priority, or preemption settings. A warning is displayed if these settings are configured on a client group:

Router(config-if)# standby 1 priority 110
%Warning: This setting has no effect while following another group.

Examples

In the following example, the router has a priority of 120 (higher than the default value):

interface ethernet 0
 standby ip 172.19.108.254
 standby priority 120 
 standby preempt delay 300

Related Commands

Command
Description

standby track

Configures an interface so that the Hot Standby priority changes based on the availability of other interfaces.


standby redirect

To enable Hot Standby Router Protocol (HSRP) filtering of Internet Control Message Protocol (ICMP) redirect messages, use the standby redirect command in interface configuration mode. To disable the HSRP filtering of ICMP redirect messages, use the no form of this command.

standby redirect [timers advertisement holddown] [unknown]

no standby redirect [unknown]

Syntax Description

timers

(Optional) Adjusts HSRP router advertisement timers.

advertisement

(Optional) HSRP Router advertisement interval in seconds. This is an integer from 10 to 180. The default is 60 seconds.

holddown

(Optional) HSRP router holddown interval in seconds. This is an integer from 61 to 3600. The default is 180 seconds.

unknown

(Optional) Allows sending of ICMP packets when the next hop IP address contained in the packet is unknown in the HSRP table of real IP addresses and active virtual IP addresses. The no standby redirect unknown command stops the redirects from being sent.


Command Default

HSRP filtering of ICMP redirect messages is enabled if HSRP is configured on an interface.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

12.1(3)T

This command was introduced.

12.2

The following keywords and arguments were added to the command:

timers advertisement holdtime

unknown

12.3(2)T

The enable and disable keywords were deprecated.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.


Usage Guidelines

The standby redirect command can be configured globally or on a per-interface basis. When HSRP is first configured on an interface, the setting for that interface will inherit the global value. If the filtering of ICMP redirects is explicitly disabled on an interface, then the global command cannot reenable this functionality.

With the standby redirect command enabled, the real IP address of a router can be replaced with a virtual IP address in the next hop address or gateway field of the redirect packet. HSRP looks up the next hop IP address in its table of real IP addresses versus virtual IP addresses. If HSRP does not find a match, the HSRP router allows the redirect packet to go out unchanged. The host HSRP router is redirected to a router that is unknown, that is, a router with no active HSRP groups. You can specify the no standby redirect unknown command to stop these redirects from being sent.

Examples

The following example shows how to allow HSRP to filter ICMP redirect messages on interface Ethernet 0:

interface ethernet 0
 ip address 10.0.0.1 255.0.0.0
 standby redirect
 standby 1 ip 10.0.0.11

The following example shows how to change the HSRP router advertisement interval to 90 seconds and the holddown timer to 270 seconds on interface Ethernet 0:

interface ethernet 0
 ip address 10.0.0.1 255.0.0.0
 standby redirect timers 90 270
 standby 1 ip 10.0.0.11

Related Commands

Command
Description

show standby

Displays the HSRP information.

show standby redirect

Displays ICMP redirect information on interfaces configured with the HSRP.


standby timers

To configure the time between hello packets and the time before other routers declare the active Hot Standby or standby router to be down, use the standby timers command in interface configuration mode. To restore the timers to their default values, use the no form of this command.

standby [group-number] timers [msec] hellotime [msec] holdtime

no standby [group-number] timers [msec] hellotime [msec] holdtime

Syntax Description

group-number

(Optional) Group number on the interface to which the timers apply. The default is 0.

msec

(Optional) Interval in milliseconds. Millisecond timers allow for faster failover.

hellotime

Hello interval (in seconds). This is an integer from 1 to 254. The default is 3 seconds. If the msec option is specified, hello interval is in milliseconds. This is an integer from 15 to 999.

holdtime

Time (in seconds) before the active or standby router is declared to be down. This is an integer from x to 255. The default is 10 seconds. If the msec option is specified, holdtime is in milliseconds. This is an integer from y to 3000.

Where:

x is the hellotime + 50 milliseconds, then rounded up to the nearest
1 second

y is greater than or equal to 3 times the hellotime and is not less than
50 milliseconds.


Defaults

The default group number is 0.
The default hello interval is 3 seconds.
The default hold time is 10 seconds.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

10.0

This command was introduced.

11.2

The msec keyword was added.

12.2

The minimum values of hellotime and holdtime in milliseconds changed.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The standby timers command configures the time between standby hello packets and the time before other routers declare the active or standby router to be down. Routers or access servers on which timer values are not configured can learn timer values from the active or standby router. The timers configured on the active router always override any other timer settings. All routers in a Hot Standby group should use the same timer values. Normally, holdtime is greater than or equal to 3 times the value of hellotime. The range of values for holdtime force the holdtime to be greater than the hellotime. If the timer values are specified in milliseconds, the holdtime is required to be at least three times the hellotime value and not less than 50 milliseconds.

Some HSRP state flapping can occasionally occur if the holdtime is set to less than 250 milliseconds, and the processor is busy. It is recommended that holdtime values less than 250 milliseconds be used on Cisco 7200 platforms or better, and on Fast-Ethernet or FDDI interfaces or better. Setting the process-max-time command to a suitable value may also help with flapping.

The value of the standby timer will not be learned through HSRP hellos if it is less than 1 second.

When group number 0 is used, no group number is written to NVRAM, providing backward compatibility.

When the standby follow command is used to configure an HSRP group to become an IP redundancy client of another HSRP group, the client group takes its state from the master group it is following. Therefore, the client group does not use its timer, priority, or preemption settings. A warning is displayed if these settings are configured on a client group:

Router(config-if)# standby 1 timers 5 15
    % Warning: This setting has no effect while following another group.

Examples

The following example sets, for group number 1 on Ethernet interface 0, the time between hello packets to 5 seconds, and the time after which a router is considered to be down to 15 seconds:

interface ethernet 0
 standby 1 ip 
 standby 1 timers 5 15 

The following example sets, for the Hot Router interface located at 172.19.10.1 on Ethernet interface 0, the time between hello packets to 300 milliseconds, and the time after which a router is considered to be down to 900 milliseconds:

interface ethernet 0
 standby ip 172.19.10.1 
 standby timers msec 300 msec 900 

The following example sets, for the Hot Router interface located at 172.18.10.1 on Ethernet interface 0, the time between hello packets to 15 milliseconds, and the time after which a router is considered to be down to 50 milliseconds. Note that the holdtime is larger than three times the hellotime because the minimum holdtime value in milliseconds is 50.

interface ethernet 0
 standby ip 172.18.10.1 
 standby timers msec 15 msec 50 

standby track

To configure the Hot Standby Router Protocol (HSRP) to track an object and change the Hot Standby priority on the basis of the state of the object, use the standby track command in interface configuration mode. To remove the tracking, use the no form of this command.

Cisco IOS XE Release 2.1 and Later Releases

standby track {object-number | interface-type interface-number [decrement priority-decrement]} [shutdown]

no standby track {object-number | interface-type interface-number}

Cisco IOS Release 12.2(33)SXH, 12.2(33)SRB and Later Releases

standby track {object-number | interface-type interface-number [decrement priority-decrement]} [shutdown]

no standby track {object-number | interface-type interface-number}

Cisco IOS Release 12.4(9)T and Later Releases

standby track {object-number [priority-decrement] | interface-type interface-number [decrement priority-decrement]} [shutdown]

no standby track {object-number | interface-type interface-number}

Cisco IOS Release 12.2(15)T and Later Releases

standby track {object-number [priority-decrement] | interface-type interface-number [decrement priority-decrement]}

no standby track {object-number | interface-type interface-number}

Cisco IOS Releases 12.2(13)T, 12.2(14)SX, 12.2(17dSXB), 12.2(33)SRA, and Earlier Releases

standby track interface-type interface-number [interface-priority]

no standby track interface-type interface-number [interface-priority]

Syntax Description

object-number

Object number that represents the object to be tracked. The range is from 1 to 500. The default is 1.

interface-type

Interface type (combined with interface number) that will be tracked.

interface-number

Interface number (combined with interface type) that will be tracked.

decrement priority-decrement

(Optional) Amount by which the Hot Standby priority for the router is decremented (or incremented) when the tracked object goes down (or comes back up). The range is from 1 to 255. The default is 10.

shutdown

(Optional) Changes the HSRP group to the Init state on the basis of the state of a tracked object.

interface-priority

(Optional) Amount by which the Hot Standby priority for the router is decremented (or incremented) when the interface goes down (or comes back up). The range is from 0 to 255. The default is 10.

group-number

(Optional) Group number to which the tracking applies.


Command Default

There is no tracking.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

10.3

This command was introduced.

12.2(15)T

This command was enhanced to allow HSRP to track objects other than the interface line-protocol state.

12.2(14)SX

Support for this command was introduced on the Cisco 7600 series routers running a Supervisor Engine 720.

12.2(17d)SXB

This command was integrated into Cisco IOS release 12.2(17d)SXB.

12.2(25)S

This command was integrated into Cisco IOS Release 12.2(25)S.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.4(9)T

The shutdown keyword was added.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

Cisco IOS XE Release 2.1

This command was integrated into Cisco IOS XE Release 2.1.


Usage Guidelines

This command ties the Hot Standby priority of the router to the availability of its tracked objects. Use the track interface command or track ip route command to track an interface object or an IP-route object. The HSRP client can register its interest in the tracking process by using the standby track command and take action when the object changes.

When a tracked object goes down, the Hot Standby priority decreases by 10. If an object is not tracked, its state changes do not affect the Hot Standby priority. For each object configured for Hot Standby, you can configure a separate list of objects to be tracked.

The optional priority-decrement and interface-priority arguments specify how much to decrement the Hot Standby priority when a tracked object goes down. When the tracked object comes back up, the priority is incremented by the same amount.

When multiple tracked objects are down, the decrements are cumulative, whether configured with priority-decrement or interface-priority values or not.

The optional shutdown keyword configures the HSRP group to change to the Init state and become disabled rather than having its priority decremented when a tracked object goes down.

Use the no standby group-number track command to delete all tracking configuration for a group.

When group number 0 is used, no group number is written to NVRAM, providing backward compatibility.

The standby track command syntax prior to Cisco IOS Release 12.2(15)T is still supported. Using the older form of the command syntax will cause a tracked object to be created in the new tracking process. This tracking information can be displayed using the show track command.


Note Using the command syntax of standby track prior to Cisco IOS Release 12.2(15)T results in the same performance as using the new standby track command syntax.


If you configure HSRP to track an interface, and that interface is physically removed as in the case of an Online Insertion and Removal (OIR) operation, then HSRP regards the interface as always down. You cannot remove the HSRP interface-tracking configuration. To prevent this situation, use the no standby track command before you physically remove the interface.

If an object is already being tracked by an HSRP group, you cannot change the configuration to use the HSRP Group Shutdown feature that disables the HSRP group. You must first remove the tracking configuration using the no standby track command and then reconfigure it using the standby track command with the shutdown keyword.

Examples

In the following example, the tracking process is configured to track the IP-routing capability of serial interface 1/0. HSRP on Ethernet interface 0/0 then registers with the tracking process to be informed of any changes to the IP-routing state of serial interface 1/0. If the IP state on serial interface 1/0 goes down, the priority of the HSRP group is reduced by 10.

If both serial interfaces are operational, Router A will be the HSRP active router because it has the higher priority. However, if IP routing on serial interface 1/0 in Router A fails, the HSRP group priority will be reduced and Router B will take over as the active router, thus maintaining a default virtual gateway service to hosts on the 10.1.0.0 subnet.

Router A Configuration

track 100 interface serial1/0 ip routing
!
interface Ethernet0/0
 ip address 10.1.0.21 255.255.0.0
 standby 1 ip 10.1.0.1
 standby 1 preempt
 standby 1 priority 105
 standby 1 track 100 decrement 10

Router B Configuration

track 100 interface serial1/0 ip routing
!
interface Ethernet0/0
 ip address 10.1.0.22 255.255.0.0
 standby 1 ip 10.1.0.1
 standby 1 preempt
 standby 1 priority 11
 standby 1 track 100 decrement 10

The following example shows how to change the configuration of a tracked object to include the HSRP Group Shutdown feature:

no standby 1 track 101 decrement 10
standby 1 track 101 shutdown

Related Commands

Command
Description

show standby

Displays HSRP information.

show track

Displays information about objects that are tracked by the tracking process.

standby preempt

Configures HSRP preemption and preemption delay.

standby priority

Configures Hot Standby priority of potential standby routers.

track interface

Configures an interface to be tracked and enters tracking configuration mode.

track ip route

Tracks the state of an IP route and enters tracking configuration mode.


standby use-bia

To configure the Hot Standby Router Protocol (HSRP) to use the burned-in address of the interface as its virtual MAC address, instead of the preassigned MAC address (on Ethernet and FDDI) or the functional address (on Token Ring), use the standby use-bia command in interface configuration mode. To restore the default virtual MAC address, use the no form of this command.

standby use-bia [scope interface]

no standby use-bia

Syntax Description

scope interface

(Optional) Specifies that this command is configured just for the subinterface on which it was entered, instead of the major interface.


Command Default

HSRP uses the preassigned MAC address on Ethernet and FDDI, or the functional address on Token Ring.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.2

This command was introduced.

12.1

The behavior was modified to allow multiple standby groups to be configured for an interface configured with this command.

12.2(14)SX

Support for this command was added for the Cisco 7600 series routers loaded with a Supervisor Engine 720.

12.2(17d)SXB

Support for this command was extended into Cisco IOS Release 12.2(17d)SXBon the Cisco 7600 series routers loaded with a Supervisor Engine 720.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.


Usage Guidelines


Note This command is not supported on Cisco 7600 series routers that are configured with a Policy Feature Card, version 2 (PFC2). The PFC2 supports a maximum of 16 unique HSRP-group numbers. You can use the same HSRP-group numbers in different VLANs. If you configure more than 16 HSRP groups, this restriction prevents use of the VLAN number as the HSRP-group number.


For an interface with this command configured, multiple standby groups can be configured. Hosts on the interface must have a default gateway configured. We recommend that you set the no ip proxy-arp command on the interface. It is desirable to configure the standby use-bia command on a Token Ring interface if there are devices that reject ARP replies with source hardware addresses set to a functional address.

When HSRP runs on a multiple-ring, source-routed bridging environment and the HRSP routers reside on different rings, configuring the standby use-bia command can prevent confusion about the routing information field.

Without the scope interface keywords, the standby use-bia command applies to all subinterfaces on the major interface. The standby use-bia command may not be configured both with and without the scope interface keywords at the same time.


Note Identically numbered HSRP groups use the same virtual MAC address, which might cause errors if you configure bridge groups.


Examples

In the following example, the burned-in address of Token Ring interface 4/0 will be the virtual MAC address mapped to the virtual IP address:

Router(config)# interface token4/0
Router(config-if)# standby use-bia

subscriber redundancy

To configure broadband subscriber session redundancy policy for synchronization between high availability (HA) active and standby processors, use the subscriber redundancy command in global configuration mode. To delete the policy, use the no form of this command.

subscriber redundancy [{bulk dynamic} limit cpu percentage delay seconds allow value] [delay seconds] [rate sessions seconds]

no subscriber redundancy

Syntax Description

bulk

(Optional) Configures a bulk synchronization redundancy policy.

dynamic

(Optional) Configures a dynamic synchronization redundancy policy.

limit cpu percent

(Optional) Specifies a CPU busy threshold value as a percentage. Range is 100; default is 90.

delay seconds

(Optional) Specifies a delay in seconds before the cluster control manager (CCM) component synchronizes sessions after the CPU busy threshold is exceeded.

allow sessions

(Optional) Specifies the minimum number of sessions to synchronize once the CPU busy threshold is exceeded and the specified delay is met. Range is 1 to 2147483637; default is 25.

delay seconds

(Optional) Specifies minimum amount of time in seconds that a session must be ready before dynamic synchronization occurs. Range is 1 to 33550.

rate sessions seconds

(Optional) Specifies number of sessions per time period for bulk and dynamic synchronization.

sessions—Range 1 to 32000, default is 250.

seconds—Range is 1 to 33550, default is 1.


Command Default

Subscriber redundancy policy applies default values.

Command Modes

Global configuration

Command History

Release
Modification

12.2(31)SB2

This command was introduced.

12.2(33)SRC

This command was integrated into Cisco IOS Release 12.2(33)SRC.


Usage Guidelines

Cisco IOS HA functionality for broadband protocols and applications allows for stateful switchover (SSO) and in service software upgrade (ISSU) features that minimize planned and unplanned downtime and failures. HA uses the CCM to manage the capability to synchronize subscriber session initiation on the standby processor of a redundant processor system. Use the subscriber redundancy bulk command to create and modify redundancy policy used during bulk (startup) synchronization. Use the subscriber redundancy dynamic command to tune subscriber redundancy policies that throttle dynamic synchronization by monitoring CPU usage and synchronization rates. Use the subscriber redundancy delay command to establish session duration minimums for synchronization and manage dynamic synchronizing of short duration calls. Use the subscriber redundancy rate command to throttle the number of sessions to be synchronized per period.

Examples

The following example configures a 10 second delay when CPU usage exceeds 90 percent during bulk synchronization, after which 25 sessions will be synchronized before the CCM again checks CPU usage:

Router(config)# subscriber redundancy bulk limit cpu 90 delay 10 allow 25

The following example configures a minimum session duration of 15 seconds before dynamic synchronization to the standby processor:

Router(config)# subscriber redundancy dynamic 15

The following example configures 2000 sessions to be synchronized per second during bulk and dynamic synchronization:

Router(config)# subscriber redundancy rate 2000 1

Related Commands

Command
Description

show ccm sessions

Displays CCM session information.

show ppp subscriber statistics

Displays PPP subscriber statistics.

show pppatm statistics

Displays PPPoA statistics.

show pppoe statistics

Displays PPPoE statistics.


subscribe-to-alert-group

To subscribe a destination profile to an alert group, use the subscribe-to-alert-group command in destination profile configuration mode. To unsubscribe from an alert group or all alert groups, use the no form of this command.

subscribe-to-alert-group {all | configuration [periodic {daily hh:mm | monthly day hh:mm | weekly day hh:mm}] | diagnostic [severity level] | environment | inventory | syslog}

Syntax Description

all

Subscribes to all alert groups.

configuration

Subscribes to configuration information groups.

periodic daily hh:mm

(Optional) Specifies the time to begin daily Call Home messages. The valid values for the time are based on a 24-hour clock.

periodic monthly day hh:mm

(Optional) Specifies the time to begin monthly Call Home messages; the valid values are as follows:

day is 1 to 31.

hh:mm is based on a 24-hour clock.

periodic weekly day hh:mm

(Optional) Specifies the time to begin weekly Call Home messages; the valid values are as follows:

day is 1 to 31.

hh:mm is based on a 24-hour clock.

diagnostic

Subscribes to diagnostic information groups.

severity level

Specifies the severity level of the diagnostic.

environment

Subscribes to environmental information groups.

inventory

Subscribes to inventory information groups.

syslog

Subscribes to system logging (syslog) information groups.


Command Default

Destination profiles are not subscribed to alert groups by default.

Command Modes

Destination profile configuration

Command History

Release
Modification

12.2(33)SXH

This command was introduced.


Usage Guidelines

The valid values for the level argument are as follows:

catastrophic—Catastrophic event

critical—Critical event

debugging—Debugging event

disaster—Disaster event

fatal—Fatal event

major—Major event

minor—Minor event

normal—Normal event

notification—Notification event

warning—Warning event

Selecting the lowest severity level includes all higher severity events. The types of severity levels are as follows:

Catastrophic—A network-wide catastrophic failure (Highest severity)

Disaster—A significant network impact

Fatal—System is unusable (System log level 0)

Critical—Immediate attention needed (System log level 1)

Major—Major condition (System log level 2)

Minor—Minor condition (System log level 3)

Warning—Warning condition (System log level 4)

Notification—Informational message (System log level 5)

Normal—Signifying returning to normal state (System log level 6)

Debug—Debugging message (Lowest severity)

Examples

The following examples shows how to subscribe to all alert groups:

subscribe-to-alert-group all

time-period

To set the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive, use the time-period command in archive configuration mode. To disable this function, use the no form of this command.

time-period minutes

no time-period minutes

Syntax Description

minutes

Specifies how often, in minutes, to automatically save an archive file of the current running configuration in the Cisco IOS configuration archive.


Command Default

By default, no time increment is set.

Command Modes

Archive configuration (config-archive)

Command History

Release
Modification

12.3(7)T

This command was introduced.

12.2(25)S

This command was integrated into Cisco IOS Release 12.2(25)S.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was implemented on the Cisco 10000 series router.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

12.2(33)SB

This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series.


Usage Guidelines


Note Before using this command, you must configure the path command to specify the location and filename prefix for the files in the Cisco IOS configuration archive.


If this command is configured, an archive file of the current running configuration is automatically saved after the given time specified by the minutes argument. Archive files continue to be automatically saved at this given time increment until this function is disabled. Use the maximum command to set the maximum number of archive files of the running configuration to be saved.


Note This command saves the current running configuration to the configuration archive whether or not the running configuration has been modified since the last archive file was saved.


Examples

In the following example, a value of 20 minutes is set as the time increment for which to automatically save an archive file of the current running configuration in the Cisco IOS configuration archive:

Router# configure terminal
!
Router(config)# archive
Router(config-archive)# path disk0:myconfig
Router(config-archive)# time-period 20
Router(config-archive)# end

Related Commands

Command
Description

archive config

Saves a copy of the current running configuration to the Cisco IOS configuration archive.

configure confirm

Confirms replacement of the current running configuration with a saved Cisco IOS configuration file.

configure replace

Replaces the current running configuration with a saved Cisco IOS configuration file.

maximum

Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive.

path

Specifies the location and filename prefix for the files in the Cisco IOS configuration archive.

show archive

Displays information about the files saved in the Cisco IOS configuration archive.


timers graceful-restart purge-time

To set the route-hold timer to determine how long a nonstop forwarding (NSF)-aware router that is running Enhanced Interior Gateway Routing Protocol (EIGRP) will hold routes for an inactive peer, use the timers graceful-restart purge-time command in router configuration or address-family configuration mode. To return the route-hold timer to the default value, use the no form of this command.

timers graceful-restart purge-time seconds

no timers graceful-restart purge-time

Syntax Description

seconds

Time, in seconds, for which EIGRP will hold routes for an inactive peer. The configurable time range is from 20 to 300 seconds. The default is 240 seconds.


Command Default

EIGRP NSF awareness is enabled by default. The default value for the route-hold timer is 240 seconds.

Command Modes

Router configuration (config-router)
Address-family configuration (config-router-af)

Command History

Release
Modification

15.0(1)M

This command was introduced. This command replaces the timers nsf route-hold command.

12.2(33)SRE

This command was integrated into Cisco IOS Release 12.2(33)SRE.

12.2(33)XNE

This command was integrated into Cisco IOS Release 12.2(33)XNE.

Cisco IOS XE Release 2.5

This command was integrated into Cisco IOS XE Release 2.5.


Usage Guidelines

The route-hold timer sets the maximum period of time for which the NSF-aware router will hold known routes for an NSF-capable neighbor during a switchover operation or a well-known failure condition. The route-hold timer is configurable so that you can tune network performance and avoid undesired effects, such as "black holing" routes if the switchover operation takes too much time. When this timer expires, the NSF-aware router scans the topology table and discards any stale routes, allowing EIGRP peers to find alternate routes instead of waiting during a long switchover operation.

Examples

The following configuration example sets the route-hold timer value for an NSF-aware address family. In the example, the route-hold timer is set to 1 minute:

Router(config)# router eigrp virtual-name
Router(config-router)# address-family ipv4 autonomous-system 1
Router(config-router-af)# timers graceful-restart purge-time 60

Related Commands

Command
Description

debug eigrp nsf

Displays EIGRP NSF-specific events in the console of a router.

debug ip eigrp notifications

Displays EIGRP events and notifications in the console of the router.

show eigrp neighbors

Displays the neighbors discovered by IP EIGRP.

show ip protocols

Displays the parameters and current state of the active routing protocol process.


timers nsf converge

To adjust the maximum time that a restarting router will wait for the end of table (EOT) notification from a nonstop forwarding (NSF)-capable or NSF-aware peer, use the timers nsf converge command in router configuration mode or address-family configuration mode. To return the signal timer to the default value, use the no form of this command.

timers nsf converge seconds

no timers nsf converge

Syntax Description

seconds

Time, in seconds, for which a restarting router will wait for an EOT notification. Valid range is 60 to 180 seconds. The default is 120 seconds.


Command Default

Enhanced Interior Gateway Routing Protocol (EIGRP) NSF awareness is enabled by default. EIGRP NSF awareness uses 120 seconds as the default value if this command is not configured or if the no form of this command is entered.

Command Modes

Router configuration (config-router)
Address-family configuration (config-router-af)

Command History

Release
Modification

12.2(18)S

This command was introduced.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

15.0(1)M

This command was modified. Address-family configuration mode was added.

12.2(33)SRE

This command was modified. Address-family configuration mode was added.

12.2(33)XNE

This command was integrated into Cisco IOS Release 12.2(33)XNE.

Cisco IOS XE Release 2.5

This command was integrated into Cisco IOS XE Release 2.5.


Usage Guidelines

This command is entered only on an NSF-capable router. The converge timer is be used to wait for the last EOT update if all startup updates have not been received within the signal timer period. If an EIGRP process discovers no neighbor, or if it has received all startup updates from its neighbor within the signal timer period, the converge timer will not be started.

Examples

The following configuration example adjusts the converge timer on an NSF-capable router. In the example, the converge timer is set to 1 minute:

Router(config-router)# timers nsf converge 60 

The following EIGRP named configuration example adjusts the converge timer on an NSF-capable router. In the example, the converge timer is set to 1 minute:

Router(config)# router eigrp virtual-name
Router(config-router)# address-family ipv4 autonomous-system 1 
Router(config-router-af)# timers nsf converge 60

Related Commands

Command
Description

debug eigrp nsf

Displays notifications and information about NSF events for an EIGRP routing process.

debug ip eigrp notifications

Displays information and notifications for an EIGRP routing process. This output includes NSF notifications and events.

nsf (EIGRP)

Enables or disables EIGRP NSF on an NSF-capable router.

show ip protocols

Displays the parameters and current state of the active routing protocol process. The status of EIGRP NSF configuration and support is displayed in the output.

timers nsf graceful-restart purge-time

Sets the route-hold timer to determine how long a NSF-aware router that is running EIGRP will hold routes for an inactive peer.

timers nsf route-hold

Adjusts the maximum period of time that a supporting peer will hold known routes for an NSF-capable router during a restart operation or during a well-known failure condition.

timers nsf signal

Adjusts the maximum time for the initial restart period.


timers nsf route-hold


Note Effective with Cisco IOS Release 15.0(1)M and 12.2(33)SRE, the timers nsf route-hold command was replaced by the timers graceful-restart purge-time command. See the timers graceful-restart purge-time command for more information.


To set the route-hold timer to determine how long a nonstop forwarding (NSF)-aware router that is running Enhanced Interior Gateway Routing Protocol (EIGRP) will hold routes for an inactive peer, use the timers nsf route-hold command in router configuration mode. To return the route-hold timer to the default value, use the no form of this command.

timers nsf route-hold seconds

no timers nsf route-hold

Syntax Description

seconds

Time, in seconds, for which EIGRP will hold routes for an inactive peer. Valid range is 20 to 300 seconds. The default is 240 seconds.


Command Default

EIGRP NSF awareness is enabled by default. The default value for the route-hold timer is 240 seconds.

Command Modes

Router configuration (config-router)

Command History

Release
Modification

12.2(15)T

This command was introduced.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

15.0(1)M

This command was replaced by the timers graceful-restart purge-time command.

12.2(33)SRE

This command was replaced by the timers graceful-restart purge-time command.


Usage Guidelines

The route-hold timer sets the maximum period of time that the NSF-aware router will hold known routes for an NSF-capable neighbor during a switchover operation or a well-known failure condition. The route-hold timer is configurable so that you can tune network performance and avoid undesired effects, such as "black holing" routes if the switchover operation takes too much time. When this timer expires, the NSF-aware router scans the topology table and discards any stale routes, allowing EIGRP peers to find alternate routes instead of waiting during a long switchover operation.

Examples

The following configuration example sets the route-hold timer value for an NSF-aware router. In the example, the route-hold timer is set to 2 minutes:

Router(config-router)# timers nsf route-hold 120

Related Commands

Command
Description

debug eigrp nsf

Displays EIGRP NSF-specific events in the console of a router.

debug ip eigrp notifications

Displays EIGRP events and notifications in the console of the router.

show ip eigrp neighbors

Displays the neighbors discovered by IP EIGRP.

show ip protocols

Displays the parameters and current state of the active routing protocol process.


timers nsf signal

To adjust the maximum time for the initial signal timer restart period, use the timers nsf signal command in router configuration mode or address-family configuration mode. To return the signal timer to the default value, use the no form of this command.

timers nsf signal seconds

no timers nsf signal

Syntax Description

seconds

Time, in seconds, for which Enhanced Interior Gateway Routing Protocol (EIGRP) will hold routes for an inactive peer. Valid range is 10 to 30 seconds. The default is 20 seconds.


Command Default

EIGRP NSF awareness is enabled by default. EIGRP NSF awareness uses 20 seconds as the default value if this command is not configured or if the no form of this command is entered.

Command Modes

Router configuration (config-router)
Address-family configuration (config-router-af)

Command History

Release
Modification

12.2(15)T

This command was introduced.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(33)SXH

This command was integrated into Cisco IOS Release 12.2(33)SXH.

15.0(1)M

This command was modified. Address-family configuration mode was added.

12.2(33)SRE

This command was modified. Address-family configuration mode was added.

12.2(33)XNE

This command was integrated into Cisco IOS Release 12.2(33)XNE.

Cisco IOS XE Release 2.5

This command was integrated into Cisco IOS XE Release 2.5.


Usage Guidelines

This command is entered only on a nonstop forwarding (NSF)-capable router. The EIGRP process starts a signal timer when it is notified of a switchover event. Hello packets with the RS bit set are sent during this period.

The converge timer is used to wait for the last end of table (EOT) update if all startup updates have not been received within the signal timer period. If an EIGRP process discovers no neighbor, or if it has received all startup updates from its neighbor within the signal timer period, the converge timer will not be started.

Examples

The following configuration example adjusts the signal timer value on an NSF-capable router. In the example, the signal timer is set to 30 seconds:

Router(config-router)# timers nsf signal 30

The following EIGRP named configuration example adjusts the signal timer value on an NSF-capable router. In the example, the signal timer is set to 30 seconds:

Router(config)# router eigrp virtual-name
Router(config-router)# address-family ipv4 autonomous-system 1 
Router(config-router-af)# timers nsf signal 30

Related Commands

Command
Description

debug eigrp nsf

Displays notifications and information about NSF events for an EIGRP routing process.

debug ip eigrp notifications

Displays information and notifications for an EIGRP routing process. This output includes NSF notifications and events.

nsf (EIGRP)

Enables or disables EIGRP NSF on an NSF-capable router.

show ip protocols

Displays the parameters and current state of the active routing protocol process. The status of EIGRP NSF configuration and support is displayed in the output.

timers nsf converge

Adjusts the maximum time that restarting router will wait for the EOT notification from an NSF-capable or NSF-aware peer.

timers nsf graceful-restart purge-time

Sets the route-hold timer to determine how long a NSF-aware router that is running EIGRP will hold routes for an inactive peer.

timers nsf route-hold

Adjusts the maximum period of time that a supporting peer will hold known routes for an NSF-capable router during a restart operation or during a well-known failure condition.


track

To configure an interface to be tracked where the Gateway Load Balancing Protocol (GLBP) weighting changes based on the state of the interface, use the track command in global configuration mode. To remove the tracking, use the no form of this command.

track object-number interface type number {line-protocol | ip routing}

no track object-number interface type number {line-protocol | ip routing}

Syntax Description

object-number

Object number in the range from 1 to 500 representing the interface to be tracked.

interface type number

Interface type and number to be tracked.

line-protocol

Tracks whether the interface is up.

ip routing

Tracks whether IP routing is enabled, an IP address is configured on the interface, and the interface state is up, before reporting to GLBP that the interface is up.


Command Default

The state of the interfaces is not tracked.

Command Modes

Global configuration (config)

Command History

Release
Modification

12.2(14)S

This command was introduced.

12.2(15)T

This command was integrated into Cisco IOS Release 12.2(15)T.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

Use the track command in conjunction with the glbp weighting and glbp weighting track commands to configure parameters for an interface to be tracked. If a tracked interface on a GLBP router goes down, the weighting for that router is reduced. If the weighting falls below a specified minimum, the router will lose its ability to act as an active GLBP virtual forwarder.

Examples

In the following example, Fast Ethernet interface 0/0 tracks whether serial interfaces 2/0 and 3/0 are up. If either serial interface goes down, the GLBP weighting is reduced by the default value of 10. If both serial interfaces go down, the GLBP weighting will fall below the lower threshold and the router will no longer be an active forwarder. To resume its role as an active forwarder, the router must have both tracked interfaces back up, and the weighting must rise above the upper threshold.


track 1 interface serial 2/0 line-protocol 
track 2 interface serial 3/0 line-protocol 
interface FastEthernet 0/0 
ip address 10.21.8.32 255.255.255.0 
glbp 10 weighting 110 lower 95 upper 105 
glbp 10 weighting track 1 
glbp 10 weighting track 2

In the following example, Fast Ethernet interface 0/0 tracks whether serial interface 2/0 is enabled for IP routing, whether it is configured with an IP address, and whether the state of the interface is up. If serial interface 2/0 goes down, the GLBP weighting is reduced by a value of 20.

track 2 interface serial 2/0 ip routing 
interface FastEthernet 0/0 
ip address 10.21.8.32 255.255.255.0 
glbp 10 weighting 110 lower 95 upper 105 
glbp 10 weighting track 2 decrement 20 

Related Commands

Command
Description

glbp weighting

Specifies the initial weighting value of a GLBP gateway.

glbp weighting track

Specifies an object to be tracked that affects the weighting of a GLBP gateway.


tunnel mpls traffic-eng backup-bw

To specify what types of label-switched paths (LSPs) can use a backup tunnel or whether the backup tunnel should provide bandwidth protection, and if so, how much, use the tunnel mpls traffic-eng backup-bw command in interface configuration mode.

tunnel mpls traffic-eng backup-bw {kbps | [sub-pool {kbps | Unlimited}] [global-pool {kbps | Unlimited}]} {kbps | [class-type {kbps | Unlimited}]

Syntax Description

kbps

Amount of bandwidth in kilobits per second (kbps), that this