Network Management Command Reference . Command reference documentation for the Cisco IOS software feature “Service Assurance Agent (SAA)” can be found in the the Cisco IOS IP SLAs Command

Reference

•

Cisco IOS IFS Command Syntax, page 2

•

Obtaining Documentation Obtaining Support and Security Guidelines, page 4

Cisco IOS Configuration Fundamentals Command Reference

Introduction

Cisco IOS IFS Command Syntax

Cisco IOS IFS Command Syntax

Some commands in this book use URLs (uniform resource locators) as part of the command syntax. URLs used in the Cisco IOS Integrated File System (IFS) contain two parts: a file system or network prefix, and a file identification suffix. The following tables list URL keywords that can be used in the source-url and

destination-url arguments for all commands in this book. The prefixes listed below can also be used in the

filesystem arguments in this document.

The following table lists common URL network prefixes used to indicate a device on the network.

Table 1 Network Prefixes for Cisco IFS URLs

Prefix ftp: rcp: tftp:

Description

Specifies a File Transfer Protocol (FTP) network server.

Specifies an remote copy protocol (rcp) network server.

Specifies a TFTP server.

The following table lists the available suffix options (file indentification suffixes) for the URL prefixes used in the previous table.

Table 2 File ID Suffixes for Cisco IFS URLs

Prefix ftp: rcp: tftp:

Suffix Options

[[//[username[:password]@]location]/directory]/ filename

For example: ftp://network-config (prefix ://filename ) ftp://user1:[email protected]/configfiles rcp:[[//[username@]location]/directory]/filename tftp:[[//location]/directory]/filename

The following table lists common URL prefixes used to indicate memory locations on the system.

Table 3 File System Prefixes for Cisco IFS URLs

Prefix bootflash: disk0:

Description

Boot flash memory.

Rotating disk media.

Cisco IOS Configuration Fundamentals Command Reference

Introduction

Cisco IOS IFS Command Syntax

Prefix

flash: partition-number flh: null: nvram: slavebootflash: slavenvram: slaveslot0: slaveslot1: slot0: slot1: xmodem: ymodem:

Description

Flash memory. This prefix is available on all platforms. For platforms that do not have a device named flash:, the prefix flash: is aliased to slot0:.

Therefore, you can use the prefix flash: to refer to the main Flash memory storage area on all platforms.

Flash load helper log files.

Null destination for copies. You can copy a remote file to null to determine its size.

NVRAM. This is the default location for the running-configuration file.

Internal Flash memory on a slave RSP card of a router configured with Dual RSPs.

NVRAM on a slave RSP card.

First PCMCIA card on a slave RSP card.

Second PCMCIA card on a slave RSP card.

First PCMCIA Flash memory card.

Second PCMCIA Flash memory card.

Obtain the file from a network machine using the

Xmodem protocol.

Obtain the file from a network machine using the

Ymodem protocol.

For details about the Cisco IOS IFS, and for IFS configuration tasks, refer to the “Using the Cisco IOS

Integrated File System (IFS)” chapter in the latest Cisco IOS Configuration Fundamentals Configuration

Guide appropriate for your release version.

Cisco IOS Configuration Fundamentals Command Reference

Introduction

Obtaining Documentation Obtaining Support and Security Guidelines

Obtaining Documentation Obtaining Support and Security

Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What’s

New in Cisco Product Documentation , which also lists all new and revised Cisco technical documentation, at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Cisco IOS Configuration Fundamentals Command Reference

A through B

•

activation-character, page 6

•

alias, page 7

•

archive, page 11

•

archive config, page 13

•

archive log config persistent save, page 16

•

•

•

•

•

•

autoupgrade disk-cleanup, page 31

•

autoupgrade ida url, page 33

•

autoupgrade status email, page 35

•

banner exec, page 37

•

banner incoming, page 40

•

banner login, page 43

•

banner motd, page 46

•

banner slip-ppp, page 49

•

boot, page 52

•

boot bootldr, page 57

•

boot bootstrap, page 59

•

boot config, page 62

•

boot host, page 65

•

boot network, page 68

•

boot system, page 71

•

boot-end-marker, page 78

•

boot-start-marker, page 81

Cisco IOS Configuration Fundamentals Command Reference

A through B activation-character

activation-character

To define the character you ent er at a vacant terminal to begin a terminal session, use the activation-

character command in line configuration mode. To make any character activate a terminal, use the no form of this command.

activation-character ascii-number

no activation-character

Syntax Description ascii-number Decimal representation of the activation character.

Command Default Return (decimal 13)

Command Modes Line configuration (config-line)

Command History

Release

10.0

Modification

This command was introduced.

This command is supported in all Cisco IOS software Releases.

Usage Guidelines See the “ASCII Character Set and Hexadecimal Values” document for a list of ASCII characters.

Note If you are using the autoselect function, set the activation character to the default, Return, and execcharacter-bits to 7. If you change these defaults, the application will not recognize the activation request.

Examples The following example shows how to set the activation character for the console to Delete, which is decimal character 127:

Router(config)# line console

Router(config-line)# activation-character 127

Cisco IOS Configuration Fundamentals Command Reference

A through B alias

alias

To create a command alias, use the alias command in global configuration mode. To delete all aliases in a command mode or to delete a specific alias, and to revert to the original command syntax, use the no form of this command.

alias mode command-alias original-command

no alias mode [command-alias]

Syntax Description mode command-alias original-command

Command mode of the original and alias commands.

Command alias.

Original command syntax.

Command Default A set of six basic EXEC mode aliases are enabled by default. See the “Usage Guidelines” section of this command for a list of default aliases.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

15.0M

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The command alias ip-vrf has been replaced with

alias vrf-af.

Usage Guidelines You can use simple words or abbreviations as command aliases.

The table below lists the basic EXEC mode aliases that are enabled by default.

Table 4 Default Command Aliases

Command Alias h

Original Command help

Cisco IOS Configuration Fundamentals Command Reference

A through B alias s w p r

Command Alias lo

Original Command logout ping resume show where

The default aliases in the table above are predefined. These default aliases can be disabled with the no alias

exec command.

Common keyword aliases (which cannot be disabled) include running-config (keyword alias for

system:running-config) and startup-config (keyword alias for nvram:startup-config). See the description of the copy command for more information about these keyword aliases.

Note that aliases can be configured for keywords instead of entire commands. You can create, for example, an alias for the first part of any command and still enter the additional keywords and arguments as normal.

To determine the value for the mode argument, enter the command mode in which you would issue the original command (and in which you will issue the alias) and enter the ? command. The name of the command mode should appear at the top of the list of commands. For example, the second line in the following sample output shows the name of the command mode as “Interface configuration”:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# interface e0

Router(config-if)# ?

Interface configuration commands:

access-expression Build a bridge boolean access expression

To match the name of the command mode to the acceptable mode keyword for the alias command, issue the alias ? command. As shown in the following sample output, the keyword needed to create a command alias for the access-expression command is interface:

Router(config)# alias ?

accept-dialin VPDN group accept dialin configuration mode

accept-dialout VPDN group accept dialout configuration mode

address-family Address Family configuration mode

call-discriminator Call Discriminator Configuration

cascustom Cas custom configuration mode

clid-group CLID group configuration mode

configure Global configuration mode

congestion Frame Relay congestion configuration mode

controller Controller configuration mode

cptone-set custom call progress tone configuration mode

customer-profile customer profile configuration mode

dhcp DHCP pool configuration mode

dnis-group DNIS group configuration mode

exec Exec mode

flow-cache Flow aggregation cache config mode

fr-fr FR/FR connection configuration mode

interface Interface configuration mode

Router(config)# alias interface express access-expression

Cisco IOS Configuration Fundamentals Command Reference

A through B

Examples alias

When you use online help, command aliases are indicated by an asterisk (*), and displayed in the following format:

*command-alias =original-command

For example, the lo command alias is shown here along with other EXEC mode commands that start with

“lo”:

Router# lo?

*lo=logout lock login logout

When you use online help, aliases that contain multiple keyword elements separated by spaces are displayed in quotes, as shown here:

Router(config)#alias exec device-mail telnet device.cisco.com 25

Router(config)#end

Router#device-mail?

*device-mail=”telnet device.cisco.com 25"

To list only commands and omit aliases, begin your input line with a space. In the following example, the alias td is not shown, because there is a space before the t?command line.

Router(config)#alias exec td telnet device

Router(config)#end

Router# t? telnet terminal test tn3270 trace

To circumvent command aliases, use a space before entering the command. In the following example, the command alias express is not recognized because a space is used before the command.

Router(config-if)#exp?

*express=access-expression

Router(config-if)# express ?

% Unrecognized command

As with commands, you can use online help to display the arguments and keywords that can follow a command alias. In the following example,the alias td is created to represent the command telnet device.

The /debugand /lineswitchescan be added to telnet device to modify the command:

Router(config)#alias exec td telnet device

Router(config)#end

Router#td ?

/debug Enable telnet debugging mode

/line Enable telnet line mode

...

whois Whois port

<cr>

Router# telnet device

You must enter the complete syntax for the command alias. Partial syntax for aliases is not accepted. In the following example, the parser does not recognize the command t as indicating the alias td:

Router# t

% Ambiguous command: “t”

In the following example, the alias fixmyrtis configured for the clear iproute 192.168.116.16 EXEC mode command:

Router(config)#alias exec fixmyrt clear ip route 192.168.116.16

Cisco IOS Configuration Fundamentals Command Reference

A through B alias

In the following example, the alias express is configured for the first part of the access-expression interface configuration command:

Router#configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)#interface e0

Router(config-if)#?

Interface configuration commands:

access-expression Build a bridge boolean access expression

Router(config-if)#exit

Router(config)#alias ?

accept-dialin VPDN group accept dialin configuration mode

accept-dialout VPDN group accept dialout configuration mode

address-family Address Family configuration mode

call-discriminator Call Discriminator Configuration

cascustom Cas custom configuration mode

clid-group CLID group configuration mode

configure Global configuration mode

congestion Frame Relay congestion configuration mode

controller Controller configuration mode

cptone-set custom call progress tone configuration mode

customer-profile customer profile configuration mode

dhcp DHCP pool configuration mode

dnis-group DNIS group configuration mode

exec Exec mode

flow-cache Flow aggregation cache config mode

fr-fr FR/FR connection configuration mode

interface Interface configuration mode

Router(config)#alias interface express access-expression

Router(config)#int e0

Router(config-if)#exp?

*express=access-expression

Router(config-if)#express ?

input Filter input packets

output Filter output packets

!Note that the true form of the command/keyword alias appears on the screen after issuing

!the express ? command.

Router(config-if)#access-expression ?

input Filter input packets

output Filter output packets

Router(config-if)#ex?

*express=access-expression exit

!Note that in the following line, a space is used before the ex? command

!so the alias is not displayed.

Router(config-if)# ex? exit

!Note that in the following line, the alias cannot be recognized because

!a space is used before the command.

Router#(config-if)# express ?

% Unrecognized command

Router(config-if)# end

Router# show alias interface

Interface configuration mode aliases:

express access-expression

Related Commands

Command

show aliases

Description

Displays command aliases.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive

archive

To enter archive configuration mode, use the archive command in global configuration mode.

archive

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Global configuration

Command History

Release

12.3(4)T

12.2(25)S

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Examples The following example shows how to place the router in archive configuration mode:

Router# configure terminal

Router(config)# archive

Router(config-archive)#

Related Commands

Command

log config

logging enable

Description

Enters configuration change logger configuration mode.

Enables the logging of configuration changes.

Cisco IOS Configuration Fundamentals Command Reference

archive

Command maximum path time-period

A through B

Description

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

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

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive config

archive config

To save a copy of the current running configuration to the Cisco IOS configuration archive, use the archive

config command in privileged EXEC mode.

archive config

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

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 in order to specify the location and filename prefix for the files in the Cisco IOS configuration archive.

The Cisco IOS configuration archive is intended to provide a mechanism to store, organize, and manage an archive of Cisco IOS configuration files to enhance the configuration rollback capability provided by the

configure replace command. Before this feature was introduced, you could save copies of the running configuration using the copy running-config destination-url command, storing the target file either locally or remotely. However, this method lacked any automated file management. On the other hand, the

Cisco IOS Configuration Fundamentals Command Reference

A through B archive config

Configuration Replace and Configuration Rollback feature provides the capability to automatically save copies of the running configuration to the Cisco IOS configuration archive. These archived files serve as checkpoint configuration references and can be used by the configure replace command to revert to previous configuration states.

The archive config command allows you to save Cisco IOS configurations in the configuration archive using a standard location and filename prefix that is automatically appended with an incremental version number (and optional time stamp) as each consecutive file is saved. This functionality provides a means for consistent identification of saved Cisco IOS configuration files. You can specify how many versions of the running configuration are kept in the archive. After the maximum number of files has been saved in the archive, the oldest file is automatically deleted when the next, most recent file is saved. The show archive command displays information for all configuration files saved in the Cisco IOS configuration archive.

Examples The following example shows how to save the current running configuration to the Cisco IOS configuration archive using the archive config command. Before using the archive config command, you must configure the path command to specify the location and filename prefix for the files in the Cisco IOS configuration archive. In this example, the location and filename prefix are specified as disk0:myconfig as follows: configure terminal

archive

path disk0:myconfig

end

You then save the current running configuration in the configuration archive, as follows: archive config

The show archive command displays information on the files saved in the configuration archive as shown in the following sample output:

Router# show archive

There are currently 1 archive configurations saved.

The next archive file will be named disk0:myconfig-2

Archive # Name

1 disk0:myconfig-1 <- Most Recent

Related Commands

Command archive

configure confirm

Description

Enters archive configuration mode.

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

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command

configure replace maximum path

show archive time-period archive config

Description

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive log config persistent save

archive log config persistent save

To save the persisted commands in the configuration log to the Cisco IOS secure file system, use the

archive log config persistent save command in privileged EXEC mode.

archive log config persistent save

Syntax Description This command has no arguments or keywords.

Command Default If this command is not entered, the persisted configuration commands in the archive log are not saved to the

Cisco IOS secure file system.

Command Modes Privileged EXEC (#).

Command History

Release

12.2(33)SRA

12.4(11)T

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.4(11)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines If the router is in the persistent periodic mode, the persistent timer is restarted.

Examples The following example saves the persisted commands in the archive log to the Cisco IOS secure file system:

Router# archive log config persistent save

Cisco IOS Configuration Fundamentals Command Reference

A through B

Related Commands

Command

log config

logging enable

logging persistent archive log config persistent save

Description

Enters configuration change logger configuration mode.

Enables the logging of configuration changes.

Enables the configuration logging persistent feature.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive tar

archive tar

To create a TAR file, to list files in a TAR file, or to extract the files from a TAR file, use the archive tar command in privileged EXEC mode.

archive tar {/create destination-urlflash:/file-url | /table source-url | /xtract source-urlflash:/file-

url [dir/file...]}

Syntax Description

/create destination-url flash:/ file-url Creates a new TAR file on the local or network file system.

For destination-url, specify the destination URL alias for the local or network file system and the name of the TAR file to create. The following options are supported:

• flash: --Syntax for the local flash file system.

• ftp: [[// username[: password]@ location]/

directory]/ tar-filename.tar-- Syntax for FTP.

• rcp: [[// username @ location]/ directory]/

tar-filename.tar--Syntax for Remote Copy

Protocol (RCP).

• tftp: [[// location]/ directory]/ tar-

filename.tar--Syntax for TFTP.

The tar-filename.tar is the name of the TAR file to be created.

For flash:/ file-url, specify the location on the local flash file system from which the new TAR file is created.

An optional list of files or directories within the source directory can be specified to write to the new TAR file. If none is specified, all files and directories at this level are written to the newly created TAR file.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive tar

/table source-url

/xtract source-url flash:/ file-url [dir/file...]

Display the contents of an existing TAR file to the screen.

For source-url, specify the source URL alias for the local or network file system. The following options are supported:

• flash: --Syntax for the local flash file system.

• ftp: [[// username[: password]@ location]/

directory]/ tar-filename.tar-- Syntax for FTP.

• rcp: [[// username @ location]/ directory]/

tar-filename.tar--Syntax for Remote Copy

Protocol (RCP).

• tftp: [[// location]/ directory]/ tar-

filename.tar--Syntax for TFTP.

The tar-filename.tar is the name of the TAR file to be created.

Extracts files from a TAR file to the local file system.

For source-url, specify the source URL alias for the local file system. These options are supported:

• flash: --Syntax for the local flash file system.

• ftp: [[// username[: password]@ location]/

directory]/ tar-filename.tar-- Syntax for FTP.

• rcp: [[// username @ location]/ directory]/

tar-filename.tar--Syntax for Remote Copy

Protocol (RCP).

• tftp: [[// location]/directory]/tar-filename.tar--

Syntax for TFTP.

The tar-filename.tar is the name of the TAR file to be created.

Command Default The TAR archive file is not created.

Command Modes Privileged EXEC (#)

Command History

Release

12.1(13)AY

12.2(33)SXH

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Cisco IOS Configuration Fundamentals Command Reference

A through B archive tar

Release

12.4(22)YB

12.4(24)T

Modification

This command was integrated into Cisco IOS

Release 12.4(22)YB.

This command was integrated into Cisco IOS

Release 12.4(24)T.

Usage Guidelines Filenames, directory names, and image names are case sensitive.

The TAR file is an archive file from which you can extract files by using the archive tarcommand.

Examples

The following example shows how to create a TAR file. The command writes the contents of the newconfigs directory on the local flash device to a file named saved.tar on the TFTP server at 172.20.136.9.

Switch# archive tar /create tftp:172.20.136.9/saved.tar flash:/new-configs

The following example shows how to display the contents of the c2940-tv0-m.tar file that is in flash memory. The contents of the TAR file appear on the screen.

Switch# archive tar /table flash:c2940-tv0-m.tar info (219 bytes) c2940-tv0-mz-121/ (directory) c2940-tv0-mz-121/html/ (directory) c2940-tv0-mz-121/html/foo.html (0 bytes) c2940-tv0-mz-121/vegas-tv0-mz-121.bin (610856 bytes) c2940-tv0-mz-121/info (219 bytes) info.ver (219 bytes)

The following example shows how to extract the contents of a TAR file on the TFTP server at

172.20.10.30. This command extracts only the new-configs directory into the root directory on the local flash file system. The remaining files in the saved.tar file are ignored.

Switch# archive tar /xtract tftp:/172.20.10.30/saved.tar flash:/ new-configs

Cisco IOS Configuration Fundamentals Command Reference

A through B async-bootp

async-bootp

To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the

async-bootp command in global configuration mode. To restore the default, use the noform of this command.

async-bootp tag [:hostname] data

no async-bootp

Syntax Description tag

: hostname data

Item being requested; expressed as filename, integer, or IP dotted decimal address. See the table below for possible keywords.

(Optional) This entry applies only to the specified host. The :hostname argument accepts both an IP address and a logical host name.

List of IP addresses entered in dotted decimal notation or as logical host names, a number, or a quoted string.

Table 5

Keyword bootfile tag Keyword Options

subnet-mask mask

time-offset offset

gateway address

time-server address

IEN116-server address

nbns-server address

Description

Specifies use of a server boot file from which to download the boot program. Use the optional :hostname argument and the data argument to specify the filename.

Dotted decimal address specifying the network and local subnetwork mask (as defined by RFC 950).

Signed 32-bit integer specifying the time offset of the local subnetwork in seconds from Coordinated

Universal Time (UTC).

Dotted decimal address specifying the IP addresses of gateways for this subnetwork. A preferred gateway should be listed first.

Dotted decimal address specifying the IP address of time servers (as defined by RFC 868).

Dotted decimal address specifying the IP address of name servers (as defined by IEN 116).

Dotted decimal address specifying the IP address of

Windows NT servers.

Cisco IOS Configuration Fundamentals Command Reference

A through B async-bootp

Keyword

DNS-server address

log-server address

quote-server address

lpr-server address

impress-server address

rlp-server address

hostname name

bootfile-size value

Description

Dotted decimal address specifying the IP address of domain name servers (as defined by RFC 1034).

Dotted decimal address specifying the IP address of an MIT-LCS UDP log server.

Dotted decimal address specifying the IP address of

Quote of the Day servers (as defined in RFC 865).

Dotted decimal address specifying the IP address of

Berkeley UNIX Version 4 BSD servers.

Dotted decimal address specifying the IP address of

Impress network image servers.

Dotted decimal address specifying the IP address of

Resource Location Protocol (RLP) servers (as defined in RFC 887).

The name of the client, which may or may not be domain qualified, depending upon the site.

A two-octet value specifying the number of 512octet (byte) blocks in the default boot file.

Command Default If no extended BOOTP commands are entered, the Cisco IOS software generates a gateway and subnet mask appropriate for the local network.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use the show async-bootp EXEC command to list the configured parameters. Use the no async-bootp command to clear the list.

Cisco IOS Configuration Fundamentals Command Reference

A through B async-bootp

Examples The following example illustrates how to specify different boot files: one for a PC, and one for a

Macintosh. With this configuration, a BOOTP request from the host on 172.30.1.1 results in a reply listing the boot filename as pcboot. A BOOTP request from the host named “mac” results in a reply listing the boot filename as “macboot.” async-bootp bootfile :172.30.1.1 “pcboot” async-bootp bootfile :mac “macboot”

The following example specifies a subnet mask of 255.255.0.0: async-bootp subnet-mask 255.255.0.0

The following example specifies a negative time offset of the local subnetwork of 3600 seconds: async-bootp time-offset -3600

The following example specifies the IP address of a time server: async-bootp time-server 172.16.1.1

Related Commands

Command

show async bootp

Description

Displays the extended BOOTP request parameters that have been configured for asynchronous interfaces.

Cisco IOS Configuration Fundamentals Command Reference

A through B attach

attach

To connect to a specific line card or module from a remote location for the purpose of executing monitoring and maintenance commands on that line card or module, use the attach command in privileged

EXEC mode. To exit from the Cisco IOS software image on the line card and return to the Cisco IOS image on the main (Supervisor) module, use the exit command.

Cisco 12000 Series

attach slot-number

Cisco 7600 Series and Catalyst 6500 Series

attach module-number

Syntax Description slot-number module-number

Slot number of the line card to which you wish to connect.

If you omit the slot number, you will be prompted for it.

Module number; see the “Usage Guidelines” section for valid values.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History

Release

11.2GS

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced on the Cisco 12000 series.

This command was implemented on the Supervisor

Engine 720.

Support was added for the Supervisor Engine 2.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

A through B attach

Usage Guidelines Cisco 12000 Series

You must first use the attach privileged EXEC command to access the Cisco IOS software image on a line card before using line card-specific show EXEC commands. Alternatively, you can use the execute-on privileged EXEC command to execute a show command on a specific line card.

After you connect to the Cisco IOS image on the line card using the attach command, the prompt changes to LC-Slotx# , where x is the slot number of the line card.

The commands executed on the line card use the Cisco IOS image on that line card.

You can also use the execute-on slot privileged EXEC command to execute commands on one or all line cards.

Note Do not execute the configEXEC command from the Cisco IOS software image on the line card.

Cisco 7600 Series and Catalyst 6500 Series

Caution After you enter the attach or remote login command to access another console from your switch, if you enter global or interface configuration mode commands, the switch might reset.

Th e v alid values for the module-number argument depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13.

This command is supported on Distributed Forwarding Card (DFC)-equipped modules, FlexWan modules, and the supervisor engine only.

When you execute the attach module-number command, the prompt changes to Router-dfcx# or Switchsp#, depending on the type of module to which you are connecting.

The behavior of the attach command is identical to that of the remote login module numcommand.

There are two ways to end this session:

• You can enter the exit command as follows:

Router-dfc3# exit

[Connection to Switch closed by foreign host]

Router#

• You can press Ctrl-C three times as follows:

Router-dfc3# ^C

Terminate remote login session? [confirm] y

[Connection to Switch closed by local host]

Router#

Examples In the following example, the user connects to the Cisco IOS image running on the line card in slot 9, gets a list of valid show commands, and returns the Cisco IOS image running on the GRP:

Router# attach 9

Entering Console for 4 Port Packet Over SONET OC-3c/STM-1 in Slot: 9

Type exit to end this session

Press RETURN to get started!

Cisco IOS Configuration Fundamentals Command Reference

A through B attach

LC-Slot9# show ?

cef Cisco Express Forwarding

clock Display the system clock

context Show context information about recent crash(s)

history Display the session command history

hosts IP domain-name, lookup style, nameservers, and host table

ipc Interprocess communications commands

location Display the system location

sessions Information about Telnet connections

terminal Display terminal configuration parameters

users Display information about terminal lines

version System hardware and software status

LC-Slot9# exit

Disconnecting from slot 9.

Connection Duration: 00:01:04

Router#

Note Because not all statistics are maintained on line cards, the output from some of show commands may be inconsistent.

The following example shows how to log in remotely to the DFC-equipped module:

Console# attach 3

Trying Switch ...

Entering CONSOLE for Switch

Type "^C^C^C" to end this session

Router-dfc3#

Related Commands

Command

attach shelf

execute-on slot

remote login

Description

Connects you to a specific (managed) shelf for the purpose of remotely executing commands on that shelf only.

Executes commands remotely on a specific line card, or on all line cards simultaneously.

Accesses the Cisco 7600 series router console or a specific module.

Cisco IOS Configuration Fundamentals Command Reference

A through B autobaud

autobaud

To set the line for automatic baud rate detection (autobaud), use the autobaudcommand in line configuration mode. To disable automatic baud detection, use the noform of this command.

autobaud

no autobaud

Syntax Description This command has no arguments or keywords.

Command Default Autobaud detection is disabled. Fixed speed of 9600 bps.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The autobaud detection supports a range from 300 to 19200 baud. A line set for autobaud cannot be used for outgoing connections, nor can you set autobaud capability on a line using 19200 baud when the parity bit is set (because of hardware limitations).

Note Automatic baud detection must be disabled by using the no autobaud command prior to setting the txspeed, rxspeed, or speed commands.

Examples In the following example, the auxiliary port is configured for autobaud detection:

Router(config)# line aux

Router(config-line)# autobaud

Cisco IOS Configuration Fundamentals Command Reference

A through B auto-sync

auto-sync

To enable automatic synchronization of the configuration files in NVRAM, use the auto-sync command in main-cpu redundancy configuration mode. To disable automatic synchronization, use the no form of this command.

auto-sync {startup-config | config-register | bootvar | running-config | standard}

no auto-sync {startup-config | config-register | bootvar | standard}

Syntax Description startup-config config-register bootvar running-config standard

Specifies synchronization of the startup configuration files.

Specifies synchronization of the configuration register values.

Specifies synchronization of the following boot variables:

• BOOT--Set by the boot

systemdevice:filename command.

• CONFIG_FILE--Set by the boot

configdevice:filename command.

• BOOTLDR--Set by the boot

bootldrdevice:filename command.

Specifies synchronization of the running configuration files.

Specifies synchronization of all of the system files

(startup configuration, boot variables, and config configuration registers).

Command Default For the Performance Routing Engines (PREs) on the Cisco uBR10012 universal broadband router, the system defaults to synchronizing all system files on the (auto-sync standard).

For the Supervisor Engines on the Cisco 7600 series routers, the system defaults to synchronizing the running configuration. (running-config).

At the Cisco RF Gateway 10 chassis level, all the system files are synchronized by default.

Redundancy configuration (config-r)

Command Modes Main CPU redundancy configuration (config-r-mc)

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command History

Release

12.2(4)XF1

12.2(14)SX

12.2(17d)SXB

12.2(18)SXD

12.3BC

12.2(33)SCA

12.2(44)SQ auto-sync

Modification

This command was introduced on the Cisco uBR10012 universal broadband router.

This command was integrated into the Supervisor

Engine 720.

Support was added for the Supervisor Engine 2.

Support for this command on the Cisco 7600 series routers was removed.

This command was integrated into Cisco IOS

Release 12.3BC for the Cisco uBR10012 router.

This command is obsolete on the Cisco uBR10012 universal broadband router.

This command was integrated into Cisco IOS

Release 12.2(44)SQ. Support for the Cisco RF

Gateway 10 was added.

Usage Guidelines Cisco 7600 Series Routers

If you enter the no auto-sync standard command, no automatic synchronizations occur. If you want to enable any of the keywords, you have to enter the appropriate command for each keyword.

The auto-synccommand is not supported in RPR+ mode.

Cisco uBR10012 Universal Broadband Router

By default, the system synchronizes all system files, which is the typical setting for most applications.

However, you might want exclude certain files from synchronization for specialized applications.

For example, if you have configured the active and standby PRE1 (or PRE2) modules to run different versions of Cisco IOS software, you might want to use different configuration files as well. In this case, you would not synchronize the startup configuration file.

Cisco RF Gateway 10

We recommend that you use the auto-sync standard command to ensure that all system files are synchronized between the two Supervisor modules. The no auto-sync command is not used in production plants.

Examples

Cisco 7600 Series Routers

The following example shows how (from the default configuration) to enable automatic synchronization of the configuration register in the main CPU:

Router# configure terminal

Router (config)# redundancy

Cisco IOS Configuration Fundamentals Command Reference

A through B auto-sync

Router (config-r)# main-cpu

Router (config-r-mc)# no auto-sync standard

Router (config-r-mc)# auto-sync config-register

Cisco uBR10012 Universal Broadband Router

The following example shows the system being configured to synchronize only the startup configuration file: router(config)# redundancy router(config-r)# main-cpu router(config-r-mc)# auto-sync startup-config router(config-r-mc)# exit router(config-r)# exit

The following example shows how to configure the system to synchronize all system files except for the startup configuration file. This typically is done when the two PRE1 (or PRE2) modules are running different software images.

router(config)# redundancy router(config-r)# main-cpu router(config-r-mc)# no auto-sync startup-config router(config-r-mc)# auto-sync config-register router(config-r-mc)# auto-sync bootvar router(config-r-mc)# exit router(config-r)# exit

Cisco RF Gateway 10

The following example shows the synchronization of all system files on the Cisco RFGW-10 chassis:

Router#configure terminal

Router(config)#redundancy

Router(config-red)#main-cpu

Router(config-r-mc)#auto-sync standard

Router(config-r-mc)#exit

Router(config-red)#exit

Related Commands

Command redundancy main-cpu

Description

Enters redundancy configuration mode.

Enters main CPU redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

A through B autoupgrade disk-cleanup

autoupgrade disk-cleanup

To configure the Cisco IOS Auto-Upgrade Manager disk cleanup utility, use the autoupgrade disk-

cleanup command in global configuration mode. To disable this configuration, use the no form of this command.

autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable]

no autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable]

Syntax Description crashinfo core image irrecoverable

(Optional) Deletes crashinfo files during diskcleanup before an image is downloaded.

(Optional) Deletes core files during disk-cleanup before an image is downloaded.

(Optional) Deletes the Cisco IOS images, except the default boot image and the current image, during disk-cleanup before an image is downloaded.

(Optional) Deletes files irretrievably (in a filesystem that supports the undelete operation) during disk-cleanup before an image is downloaded.

Command Default By default, the crashinfo files, the core files, and the Cisco IOS software images are deleted by the Cisco

IOS Auto-Upgrade Manager disk cleanup utility, and the filesystems that support the undelete operation are not cleaned up.

Command Modes Global configuration (config)

Command History

Release

12.4(15)T

Modification

This command was introduced.

Examples The following example shows how to clean-up filesystems that support undelete operation:

Router(config)# autoupgrade disk-cleanup irrecoverable

The following example shows how to avoid deleting the Cisco IOS software images:

Router(config)# no autoupgrade disk-cleanup image

Cisco IOS Configuration Fundamentals Command Reference

autoupgrade disk-cleanup

Related Commands

Command

autoupgrade ida url

autoupgrade status email

upgrade automatic getversion

A through B

Description

Configures the URL of the server on www.cisco.com where the image download requests will be sent by Auto-Upgrade Manager.

Configures the address to which the status email is to be sent.

Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

A through B autoupgrade ida url

autoupgrade ida url

To configure the URL of the Intelligent Download Application (IDA) running on www.cisco.com, use the

autoupgrade ida url command in global configuration mode. The router will send the image download requests to the configured URL. To disable this URL, use the no form of this command.

autoupgrade ida url url

no autoupgrade ida url url

Syntax Description url URL of the IDA server.

Command Default Default URL: https://www.cisco.com/cgi-bin/ida/locator/locator.pl

Command Modes Global configuration (config)

Command History

Release

12.4(15)T

Modification

This command was introduced.

Usage Guidelines Use the autoupgrade ida url command to configure a new URL for the IDA server, if it is not present in the default location.

Examples The following example shows how to configure the URL for the IDA server:

Router(config)# autoupgrade ida url https://www.cisco.com/cgi-bin/ida/locator/locator.pl

Related Commands

Command

autoupgrade disk-cleanup

autoupgrade status email

Description

Configures the Cisco IOS Auto-Upgrade Manager disk cleanup utility.

Configures the address to which the status email is to be sent.

Cisco IOS Configuration Fundamentals Command Reference

autoupgrade ida url

Command

upgrade automatic getversion

A through B

Description

Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

A through B autoupgrade status email

autoupgrade status email

To configure the address to which status email is to be sent and the outgoing email server, use the

autoupgrade status email command in global configuration mode. To disable status email, use the no form of this command.

autoupgrade status email [recipient [email-address]] [smtp-server [smtp-server]]

no autoupgrade status email [recipient [email-address]] [smtp-server [smtp-server]]

Syntax Description

recipient smtp-server email-address

The address to which the Cisco IOS Auto-Upgrade

Manager (AUM) status is to be sent.

The outgoing email server to which the AUM email is sent.

The email address to which the AUM status is to be sent.

Command Default Status email is not sent unless the address is configured. The recipient email address and SMTP server have to be configured in order to receive AUM status email.

Command Modes Global configuration (config)

Command History

Release

12.4(15)T

Modification

This command was introduced.

Usage Guidelines Use this command to configure the email-address where AUM status email can be sent.

Examples The following example shows how to configure the address to which status email is to be sent:

Router(config)# autoupgrade status email recipient [email protected]

Router(config)# autoupgrade status email smtp-server smtpserver.abc.com

Cisco IOS Configuration Fundamentals Command Reference

autoupgrade status email

Related Commands

Command

autoupgrade disk-cleanup

autoupgrade ida url

upgrade automatic getversion

A through B

Description

Configures the Cisco IOS Auto-Upgrade Manager disk cleanup utility.

Configures the URL of the server running on www.cisco.com to which the router sends the image download requests.

Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner exec

banner exec

To specify and enable a message to be displayed when an EXEC process is created (an EXEC banner), use the banner exec command in global configuration mode. To delete the existing EXEC banner, use the no form of this command.

banner exec d message d

no banner exec

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the banner message.

Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in the table below.

Command Default Disabled (no EXEC banner is displayed).

Command Modes Global configuration

Command History

Release

10.0

11.3(7.5)AA

12.0(3)T

12.2(33)SRA

Modification

This command was introduced.

Token functionality was introduced.

Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command specifies a message to be displayed when an EXEC process is created (a line is activated, or an incoming connection is made to a vty). Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.

When a user connects to a router, the message-of-the-day (MOTD) banner appears first, followed by the login banner and prompts. After the user logs in to the router, the EXEC banner or incoming banner will be

Cisco IOS Configuration Fundamentals Command Reference

A through B banner exec displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.

To disable the EXEC banner on a particular line or lines, use the no exec-banner line configuration command.

To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current

Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in the table below.

Table 6 banner exec Tokens

Token

$(hostname)

$(domain)

$(line)

$(line-desc)

Information Displayed in the Banner

Displays the host name for the router.

Displays the domain name for the router.

Displays the vty or tty (asynchronous) line number.

Displays the description attached to the line.

Examples The following example sets an EXEC banner that uses tokens. The percent sign (%) is used as a delimiting character. Notice that the $(token ) syntax is replaced by the corresponding configuration variable.

Router(config)# banner exec %

Enter TEXT message. End with the character '%'.

Session activated on line $(line), $(line-desc). Enter commands at the prompt.

When a user logs on to the system, the following output is displayed:

User Access Verification

Username: joeuser

Password: <password>

Session activated on line 50, vty default line. Enter commands at the prompt.

Router>

Related Commands

Command

banner incoming

banner login

banner motd

banner slip-ppp

Description

Defines a customized banner to be displayed when there is an incoming connection to a terminal line from a host on the network.

Defines a customized banner to be displayed before the username and password login prompts.

Defines a customized message-of-the-day banner.

Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made.

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command exec-banner banner exec

Description

Controls (enables or disables) the display of EXEC banners and message-of-the-day banners on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner incoming

banner incoming

To define and enable a banner to be displayed when there is an incoming connection to a terminal line from a host on the network, use the banner incoming command in global configuration mode. To delete the incoming connection banner, use the no form of this command.

banner incoming d message d

no banner incoming

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the banner message.

Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in the table below.

Command Default Disabled (no incoming banner is displayed).

Command Modes Global configuration

Command History

Release

10.0

11.3(7.5)AA

12.0(3)T

12.2(33)SRA

Modification

This command was introduced.

Token functionality was introduced.

Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Follow the banner incomingcommand with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.

An incoming connection is one initiated from the network side of the router. Incoming connections are also called reverse Telnet sessions. These sessions can display MOTD banners and incoming banners, but they

Cisco IOS Configuration Fundamentals Command Reference

A through B banner incoming do not display EXEC banners. Use the no motd-banner line configuration command to disable the MOTD banner for reverse Telnet sessions on asynchronous lines.

When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, before the login prompt. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.

Incoming banners cannot be suppressed. If you do not want the incoming banner to appear, you must delete it with the no banner incoming command.

To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current

Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in the table below.

Table 7 banner incoming Tokens

Token

$(hostname)

$(domain)

$(line)

$(line-desc)

Information Displayed in the Banner

Displays the host name for the router.

Displays the domain name for the router.

Displays the vty or tty (asynchronous) line number.

Displays the description attached to the line.

Examples The following example sets an incoming connection banner. The pound sign (#) is used as a delimiting character.

Router(config)# banner incoming #

This is the Reuses router.

The following example sets an incoming connection banner that uses several tokens. The percent sign (%) is used as a delimiting character.

darkstar(config)# banner incoming %

Enter TEXT message. End with the character '%'.

You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %

When the incoming connection banner is executed, the user will see the following banner. Notice that the $

(token ) syntax is replaced by the corresponding configuration variable.

You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)

Related Commands

Command

banner exec

Description

Defines a customized banner to be displayed whenever the EXEC process is initiated.

Cisco IOS Configuration Fundamentals Command Reference

banner incoming

Command

banner login

banner motd

banner slip-ppp

A through B

Description

Defines a customized banner to be displayed before the username and password login prompts.

Defines a customized message-of-the-day banner.

Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner login

banner login

To define and enable a customized banner to be displayed before the username and password login prompts, use the banner login command in global configuration mode. To disable the login banner, use no form of this command.

banner login d message d

no banner login

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the banner message.

Message text. You can include tokens in the form $

(token) in the message text. Tokens will be replaced with the corresponding configuration variable.

Tokens are described in the table below.

Command Default Disabled (no login banner is displayed).

Command Modes Global configuration

Command History

Release

10.0

11.3(7.5)AA

12.0(3)T

12.2(14)SX

12.2(33)SRA

Modification

This command was introduced.

Token functionality was introduced.

Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

This command was integrated into Cisco IOS

Release 12.2(14)SX.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow the banner login command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner login

When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, followed by the login banner and prompts. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.

To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current

Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in the table below.

Table 8 banner login Tokens

Token

$(hostname)

$(domain)

$(line)

$(line-desc)

Information Displayed in the Banner

Displays the host name for the router.

Displays the domain name for the router.

Displays the vty or tty (asynchronous) line number.

Displays the description attached to the line.

Examples The following example sets a login banner. Double quotes (") are used as the delimiting character.

Router# banner login " Access for authorized users only. Please enter your username and password. "

The following example sets a login banner that uses several tokens. The percent sign (%) is used as the delimiting character.

darkstar(config)# banner login %

Enter TEXT message. End with the character '%'.

You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %

When the login banner is executed, the user will see the following banner. Notice that the $(token) syntax is replaced by the corresponding configuration variable.

You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)

Related Commands

Command

banner exec

banner incoming

banner motd

Description

Defines a customized banner to be displayed whenever the EXEC process is initiated.

Defines a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.

Defines a customized message-of-the-day banner.

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command

banner slip-ppp banner login

Description

Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner motd

banner motd

To define and enable a message-of-the-day (MOTD) banner, use the banner motd command in global configuration mode. To delete the MOTD banner, use the no form of this command.

banner motd d message d

no banner motd

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the banner message.

Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be replaced with the corresponding configuration variable.

Command Default

Disabled (no MOTD banner is displayed).

Command Modes Global configuration

Command History

Release

10.0

11.3(7.5)AA

12.0(3)T

12.2(33)SRA

Modification

This command was introduced.

Token functionality was introduced.

Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.

This MOTD banner is displayed to all terminals connected and is useful for sending messages that affect all users (such as impending system shutdowns). Use the no exec-banner or no motd-banner command to disable the MOTD banner on a line. The no exec-banner command also disables the EXEC banner on the line.

When a user connects to the router, the MOTD banner appears before the login prompt. After the user logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of

Cisco IOS Configuration Fundamentals Command Reference

A through B banner motd connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.

To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current

Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in the table below.

Table 9 banner motd Tokens

Token

$(hostname)

$(domain)

$(line)

$(line-desc)

Information Displayed in the Banner

Displays the host name for the router.

Displays the domain name for the router.

Displays the vty or tty (asynchronous) line number.

Displays the description attached to the line.

Examples The following example configures an MOTD banner. The pound sign (#) is used as a delimiting character.

Router# banner motd # Building power will be off from 7:00 AM until 9:00 AM this coming

Tuesday.

The following example configures an MOTD banner with a token. The percent sign (%) is used as a delimiting character.

darkstar(config)# banner motd %

Enter TEXT message. End with the character '%'.

Notice: all routers in $(domain) will be upgraded beginning April 20

When the MOTD banner is executed, the user will see the following. Notice that the $(token ) syntax is replaced by the corresponding configuration variable.

Notice: all routers in ourdomain.com will be upgraded beginning April 20

Related Commands

Command

banner exec

banner incoming

banner login

Description

Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.

Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.

Defines and enables a customized banner to be displayed before the username and password login prompts.

Cisco IOS Configuration Fundamentals Command Reference

banner motd

Command

banner slip-ppp exec-banner motd-banner

A through B

Description

Defines and enables a customized banner to be displayed when a serial-line IP or point-to-point connection is made.

Controls (enables or disables) the display of EXEC banners and message-of-the-day banners on a specified line or lines.

Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner slip-ppp

banner slip-ppp

To customize the banner that is displayed when a Serial Line Internet Protocol (SLIP) or PPP connection is made, use the banner slip-ppp command in global configuration mode. To restore the default SLIP or PPP banner, use the no form of this command.

banner slip-ppp d message d

no banner slip-ppp

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the banner message.

Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be replaced with the corresponding configuration variable.

Command Default The default SLIP or PPP banner message is:

Entering encapsulation mode.

Async interface address is unnumbered (Ethernet0)

Your IP address is 10.000.0.0 MTU is 1500 bytes

The banner message when using the service old-slip-prompt command is:

Entering encapsulation mode.

Your IP address is 10.100.0.0 MTU is 1500 bytes where encapsulation is SLIP or PPP.

Command Modes Global configuration

Command History

Release

12.0(3)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.

Cisco IOS Configuration Fundamentals Command Reference

A through B banner slip-ppp

Use this command to define a custom SLIP or PPP connection message. This is useful when legacy client applications require a specialized connection string. To customize the banner, use tokens in the form $

(token ) in the message text. Tokens will display current Cisco IOS configuration variables, such as the routers host name, IP address, encapsulation type, and Maximum Transfer Unit (MTU) size. The banner tokens are described in the table below.

Table 10 banner slip-ppp Tokens

Token

$(hostname)

$(domain)

$(peer-ip)

$(gate-ip)

$(encap)

$(encap-alt)

$(mtu)

Information Displayed in the Banner

Displays the host name of the router.

Displays the domain name of the router.

Displays the IP address of the peer machine.

Displays the IP address of the gateway machine.

Displays the encapsulation type (SLIP, PPP, and so on).

Displays the encapsulation type as SL/IP instead of

SLIP.

Displays the MTU size.

Examples The following example sets the SLIP/PPP banner using several tokens and the percent sign (%) as the delimiting character:

Router(config)# banner slip-ppp %

Enter TEXT message. End with the character '%'.

Starting $(encap) connection from $(gate-ip) to $(peer-ip) using a maximum packet size of

$(mtu) bytes... %

The new SLIP/PPP banner will now be displayed when the slip EXEC command is used. Notice that the $

(token ) syntax is replaced by the corresponding configuration variable.

Router# slip

Starting SLIP connection from 172.16.69.96 to 192.168.1.200 using a maximum packet size of 1500 bytes...

Related Commands

Command

banner exec

banner incoming

Description

Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.

Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command

banner motd ppp slip banner slip-ppp

Description

Defines and enables a customized message-of-theday banner.

Initiates a connection to a remote host using PPP.

Initiates a connection to a remote host using SLIP.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot

boot

To boot the router manually, use the bootcommand in ROM monitor mode. The syntax of this command varies according to the platform and ROM monitor version.

boot

boot file-url

boot filename [tftp-ip-address]

boot flash [flash-fs:] [partition-number:] [filename]

Cisco 7000 Series, 7200 Series, 7500 Series Routers

boot flash-fs : [filename]

Cisco 1600 and Cisco 3600 Series Routers

boot [flash-fs:] [partition-number:] [filename]

Cisco 1800 Series, 2800 Series, and 3800 Series Routers

boot usbflash0 [:filename]

Syntax Description file-url URL of the image to boot (for example, boot tftp://

172.16.15.112/routertest).

Cisco IOS Configuration Fundamentals Command Reference

A through B filename tftp-ip-address flash usbflash0 boot

When used in conjunction with the ip-address argument, the filename argument is the name of the system image file to boot from a network server.

The filename is case sensitive.

When used in conjunction with the flash keyword, the filename argument is the name of the system image file to boot from Flash memory.

On all platforms except the Cisco 1600 series,

Cisco 3600 series, and Cisco 7000 family routers, the system obtains the image file from internal

Flash memory.

On the Cisco 1600 series, Cisco 3600 series and

Cisco 7000 family routers, the flash-fs : argument specifies the Flash memory device from which to obtain the system image. (See the flash-fs : argument later in this table for valid device values.)

The filename is case sensitive. Without the

filenameargument , the first valid file in Flash memory is loaded.

If the filename is not specified, the first file in the partition or file system is used. (A USB Flash uses the first image in (compact) Flash as the boot loader and loads the image from USB Flash.)

(optional) IP address of the TFTP server on which the system image resides. If omitted, this value defaults to the IP broadcast address of

255.255.255.255.

Boots the router from Flash memory. Note that this keyword is required in some boot images.

Boot the first file in USB Flash 0. If the optional filename argument is used, the router boots the specified image from USB Flash.

Note This option uses the first image in (compact)

Flash as the boot loader and loads the image from USB Flash.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot

flash-fs :

partition-number :

(Optional) Specifying the Flash file system is optional for all platforms except the Cisco 7500 series routers. Possible file systems are:

• flash: --Internal Flash memory.

• bootflash: --Internal Flash memory on the

Cisco 7000 family.

• slot0: --Flash memory card in the first

PCMCIA slot on the Cisco 7000 family and

Cisco 3600 series routers.

• slot1: --Flash memory card in the second

PCMCIA slot on the Cisco 7000 family and

Cisco 3600 series routers.

(Optional) Specifies the partition number of the file system the file should be loaded from. This argument is not available on all platforms. If the

partition-number is not specified, the first partition is used.

Command Default

For most platforms, if you enter the boot command and press Enter, the router boots from ROM by default.

However, for some platforms, such as the Cisco 3600 series routers, if you enter the boot command and press Enter, the router boots the first image in Flash memory. Refer to the documentation for your platform for information about the default image.

Command Modes

ROM monitor

Command History

Release

10.3

12.3(14)T

12.2(33)SRA

Modification

The command was introduced.

The usbflash0keyword was added to support booting an image from an external USB Flash drive.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

To determine which form of this command to use, refer to the documentation for your platform or use the

CLI help (?) feature.

Use this command only when your router cannot find the boot configuration information needed in

NVRAM. To enter ROM monitor mode, use one of the following methods:

• Enter the reload EXEC command, then press the Break key during the first 60 seconds of startup.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot

• Set the configuration register bits 0 to 3 to zero (for example, set the configuration register to 0x0) and enter the reload command.

The ROM Monitor prompt is either “>” or, for newer platforms, “rommon x >”. Enter only lowercase commands.

These commands work only if there is a valid image to boot. Also, from the ROM monitor prompt, issuing a prior reset command is necessary for the boot to be consistently successful.

In Cisco IOS Release 12.3(4)T, MONLIB was modified to search in media for a valid Cisco IOS image.

This change prevents boot failures that result when the first file read in disk or flash is not a valid Cisco

IOS image.

Refer to your hardware documentation for information on correct jumper settings for your platform.

Note For some platforms the flash keyword is now required. If your attempts to use the boot command are failing using the older boot flash:x:[filename ] syntax, try using the boot flash flash:x:[filename ] syntax.

Examples

In the following example, a router is manually booted from ROM:

> boot

F3:

(ROM Monitor copyrights)

In the following example, a router boots the file named routertest from a network server with the IP address

172.16.15.112 using the file-url syntax:

> boot tftp://172.16.15.112/routertest

(ROM Monitor copyrights)

The following example shows the boot flash command without the filename argument. The first valid file in Flash memory is loaded.

> boot flash

F3: 1858656+45204+166896 at 0x1000

Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR

RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR

RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]

F3: 1858676+45204+166896 at 0x1000

(ROM Monitor copyrights)

The following example boots from Flash memory using the file named gs7-k:

> boot flash gs7-k

F3: 1858656+45204+166896 at 0x1000

Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR

RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR

RRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]

F3: 1858676+45204+166896 at 0x1000

(ROM Monitor copyrights)

Cisco IOS Configuration Fundamentals Command Reference

A through B boot

In the following example, the boot flash flash: command boots the relocatable image file named igs-bpx-l from partition 2 in Flash memory:

> boot flash flash:2:igs-bpx-l

F3: 3562264+98228+303632 at 0x30000B4

(ROM Monitor copyrights)

In the following command, the Cisco 7000 family router accepts the flash keyword for compatibility but ignores it, and boots from slot 0:

> boot flash slot0:gs7-k-mz.103-9

F3: 8468+3980384+165008 at 0x1000

In the following example, the command did not function because it must be entered in lowercase: rommon 10 > BOOT command “BOOT” not found

The following example boots the first file in the first partition of internal Flash memory of a Cisco 3600 series router:

> boot flash:

The following example boots the first image file in the first partition of the Flash memory card in slot 0 of a

Cisco 3600 series router:

> boot slot0:

The following example shows the ROM monitor booting the first file in the first Flash memory partition on a Cisco 1600 series router:

> boot flash:

Related Commands

Command continue

Description

Returns to EXEC mode from ROM monitor mode by completing the boot process.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot bootldr

boot bootldr

To specify the location of the boot image that ROM uses for booting, use the boot bootldr command in global configuration mode. To remove this boot image specification, use the no form of this command.

boot bootldr file-url boot bootldr command

no boot bootldr

Syntax Description file-url URL of the boot image on a Flash file system.

Command Default Refer to your platform documentation for the location of the default boot image.

Command Modes Global configuration (config)

Command History

Release

11.0

12.2(33)SRA

Modification

The command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The boot bootldr command sets the BOOTLDR variable in the current running configuration. You must specify both the Flash file system and the filename.

Note When you use this global configuration command, you affect only the running configuration. You must save the variable setting to your startup configuration to place the information under ROM monitor control and to have the variable function as expected. Use the copy system:running-config nvram:startup-config command to save the variable from your running configuration to your startup configuration.

Note The default length of the bootstring filename is 64 characters. Depending on the platform a longer bootstring filename can be used and supported.

The no form of the command sets the BOOTLDR variable to a null string. On the Cisco 7000 family routers , a null string causes the first image file in boot Flash memory to be used as the boot image that

ROM uses for booting.

Use the show boot command to display the current value for the BOOTLDR variable.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot bootldr

Examples In the following example, the internal Flash memory contains the boot image: boot bootldr bootflash:boot-image

The following example specifies that the Flash memory card inserted in slot 0 contains the boot image: boot bootldr slot0:boot-image

Related Commands

Command

copy system:running-config nvram:startup- config

show (flash file system)

show bootvar

Description

Copies any file from a source to a destination.

Displays the layout and contents of a Flash memory file system.

Displays the contents of the BOOT variable, the name of the configuration file pointed to by the

CONFIG_FILE variable, the contents of the

BOOTLDR variable, and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot bootstrap

boot bootstrap

To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap command in global configuration mode. To disable booting from a secondary bootstrap image, use the no form of this command.

boot bootstrap file-url

no boot bootstrap file-url

boot bootstrap flash [filename]

no boot bootstrap flash [filename]

boot bootstrap [tftp] filename [ip-address]

no boot bootstrap [tftp] filename [ip-address]

boot bootstrap mop filename [interface-type interface-number]

no boot bootstrap mop filename [interface-type interface-number]

Syntax Description file-url flash filename tftp ip-address mop interface-type interface-number

URL of the bootstrap image.

Boots the router from flash memory.

(Optional with flash) Name of the system image to boot from a network server or from flash memory.

If you omit the filename when booting from flash memory, the router uses the first system image stored in flash memory.

(Optional) Boots the router from a system image stored on a TFTP server.

(Optional) IP address of the TFTP server on which the system image resides. If the ip-address argument is omitted, this value defaults to the IP broadcast address of 255.255.255.255.

Boots the router from a DECnet Maintenance

Operation Protocol (MOP) server.

(Optional) Interface type. For more information, use the question mark (?) online help function.

(Optional) Interface or subinterface number. For more information about the numbering syntax for your networking device, use the question mark (?) online help function.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot bootstrap

Command Default No secondary bootstrap is configured.

Command Modes Global configuration (config)

Command History

Release

10.0

12.2(33)SRA

15.0(1)M

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified in a release earlier than Cisco IOS Release 15.0(1)M. The

mopkeyword and interface-type interface-

numberarguments were added.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines

The boot bootstrap command causes the router to load a secondary bootstrap image from the specied

URL, such as from a remote server. After the bootstrap image is loaded, the bootstrap image loads the specified system image file. See the appropriate hardware installation guide for details on setting the configuration register and secondary bootstrap filename.

Use this command when you have attempted to load a system image but have run out of memory even after compressing the system image. Secondary bootstrap images allows you to load a larger system image through a smaller secondary image.

Examples

The following example shows how to load the system image file named sysimage-2 by using a secondary bootstrap image:

Router# configure terminal

Router(config)# boot bootstrap bootflash:sysimage-2

Related Commands

Command boot

Description

Boots the router manually.

Cisco IOS Configuration Fundamentals Command Reference

A through B

Command

boot system boot bootstrap

Description

Specifies the system image that the router loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot config

boot config

To s pecify the device and filename of the configuration file from which the system configures itself during initialization (startup), use the boot config command in global configuration mode. To return to the default location for the configuration file, use the no form of this command.

Platforms Other than Cisco 7600 Series Router

boot config file-system-prefix : [directory/] filename [nvbypass]

no boot config

Cisco 7600 Series Router

boot config device : filename [nvbypass]

no boot config

Syntax Description

file-system-prefix :

directory/ filename

device : nvbypass

File system, followed by a colon (for example,

nvram:, flash:, slot0:, usbflash 0 9 :, or usbtoken

0 9 :). The default is nvram:.

(Optional) File system directory where the configuration file is located, followed by a forward slash (/).

Name of the configuration file.

Device identification, followed by a colon; see the

“Usage Guidelines” section for a list of the valid values.

(Optional) Specifies that the distilled configuration is not written to nonvolatile random access memory

(NVRAM).

Command Default The default location for the configuration file is NVRAM (nvram:).

Command Modes Global configuration (config)

Command History

Release

12.2(33)SRA

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot config

Release

12.2(14)SX

12.2(17d)SXB

11.0

12.3(14)T

Modification

Support for this command was added for the Cisco

7600 Supervisor Engine 720.

Support for this command on the cisco 7600

Supervisor Engine 2 was extended to Release

12.2(17d)SXB.

This command was introduced.

Support for Class B file system platforms and the following file system prefix options were added:

usbflash 0 9 :and usbtoken 0 9 :

Supported Platforms Other than Cisco 7600 Series Router

This command is available only on Class A and Class B file system platforms.

You set the CONFIG_FILE environment variable in the current running memory when you use the boot

config command. This variable specifies the configuration file used for initialization (startup). The configuration file must be an ASCII file located in either NVRAM or flash memory.

Cisco 7600 Series Router

The valid values for the device :argument and colonare as follows:

• For systems that are configured with a Supervisor Engine 2, the valid values are bootflash:,

const_nvram:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:

• For systems that are configured with a Supervisor Engine 720, the valid values are disk0: and disk1:

The configuration file must be an ASCII file that is located in the specified file system.

The disk0: and disk1: keywords are for Class C file systems.

The bootflash:, slot0:, and sup-bootflash: keywords are for Class A file systems.

For Class A flash file systems, the CONFIG_FILE environment variable specifies the file system and filename of the configuration file to use for initialization (startup). You set the CONFIG_FILE environment variable in the current running memory when you use the boot config command. This variable specifies the configuration file used for initialization (startup).

All Supported Platforms

When you use the boot config command, you affect only the running configuration. You must save the environment variable setting to your startup configuration to place the information under ROM monitor control and to have the environment variable function as expected. Use the copy system:running-config

nvram:startup-config command to save the environment variable from your running configuration to your startup configuration.

The software displays an error message and does not update the CONFIG_FILE environment variable in the following situations:

• You specify nvram: as the file system, and it contains only a distilled version of the configuration. (A distilled configuration is one that does not contain access lists.)

• You specify a configuration file in the filename argument that does not exist or is not valid.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot config

The router uses the NVRAM configuration during initialization when the CONFIG_FILE environment variable does not exist or when it is null (such as at first-time startup). If the software detects a problem with NVRAM or the configuration it contains, the device enters setup mode.

When you use the no form of this command, the router returns to using the default NVRAM configuration file as the startup configuration.

You can display the contents of the BOOT, BOOTLDR, and the CONFIG_FILE environment variables using the show bootvar command. This command displays the settings for these variables as they exist in the startup configuration and in the running configuration if a running configuration setting differs from a startup configuration setting.

When the boot config command is used, the distilled configuration is written into NVRAM and the system configuration is written into the file specified by the boot config command. If the distilled configuration exceeds the size of NVRAM, the system configuration gets truncated. Use the nvbypass keyword to prevent the system configuration from being truncated when the distilled configuration is larger than the size of NVRAM.

Examples The following example shows how to set the configuration file that is located in internal flash memory to configure itself during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload.

Router(config)# boot config flash:router-config

Router(config)# end

Router# copy system:running-config nvram:startup-config

The following example instructs a Cisco 7500 series router to use the configuration file named routerconfig located on the flash memory card inserted in the second Personal Computer Memory Card Industry

Association (PCMCIA) slot of the Route Switch Processor (RSP) card during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload.

Router (config)# boot config slot1:router-config

Router (config)# end

Router# copy system:running-config nvram:startup-config

Related Commands

Command

copy system:running-config nvram:startup- config

show bootvar

Description

Saves the environment variable from the running configuration to the startup configuration.

Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot host

boot host

To specify the host-specific configuration file to be used at the next system startup, use the boot host command in global configuration mode. To restore the host configuration filename to the default, use the

no form of this command.

boot host commandboot host remote-url

no boot host remote-url

Syntax Description remote-url Location of the configuration file. Use the following syntax:

• ftp: [[[//[username[: password]@]location]/

directory]/ filename]

• rcp: [[[//[username @]location]/ directory]/

filename]

• tftp: [[[// location]/ directory]/ filename]

Command Default If you do not specify a filename using this command, the router uses its configured host name to request a configuration file from a remote server. To form the configuration filename, the router converts its name to all lowercase letters, removes all domain information, and appends -confg or -config.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command instructs the system to “Boot using host-specific configuration file x ,” where x is the filename specified in the remote-url argument. In other words, this command specifies the remote location and filename of the host-specific configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file.

Before using the boot host command, use the service config global configuration command to enable the loading of the specified configuration file at reboot time. Without this command, the router ignores the

boot host command and uses the configuration information in NVRAM. If the configuration information in

NVRAM is invalid or missing, the service config command is enabled automatically.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot host

The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot

network command to identify the network configuration file. The second is the host configuration file containing commands that apply to one network server in particular. Use the boot host command to identify the host configuration file.

Note Usually, the service config command is used in conjunction with the boot host or boot network command.

You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T ,

12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active. If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is routerconfg.

Loading a Configuration File Using rcp

The rcp software requires that a client send the remote username on each rcp request to the network server.

If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username.

When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list:

1 The username specified in the file-URL, if a username is specified.

2 The username set by the ip rcmd remote-username command, if the command is configured.

3 The router host name.

Note An account for the username must be defined on the destination server. If the network administrator of the destination server did not establish an account for the username, this command will not execute successfully.

Loading a Configuration File Using FTP

The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory is associated with the username on the server. Refer to the documentation for your FTP server for more details.

When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list:

1 The username specified in the boot host command, if a username is specified.

2 The username set by the ip ftp username command, if the command is configured.

3 Anonymous.

The router sends the first valid password in the following list:

1 The password specified in the boot host command, if a password is specified.

2 The password set by the ip ftp password command, if the command is configured.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot host

3 The router forms a password username @routername .domain . The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router.

Examples The following example sets the host filename to wilma-confg at address 192.168.7.19:

Router(config)# boot host tftp://192.168.7.19/usr/local/tftpdir/wilma-confg

Router(config)# service config

Related Commands

Command

boot network

service config

Description

Specifies the remote location and filename of the network configuration file to be used at the next system boot (startup).

Enables autoloading of configuration files from a network server.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot network

boot network

To change the default name of the network configuration file from which to load configuration commands, use the boot network command in global configuration mode. To restore the network configuration filename to the default, use the no form of this command.

boot network remote-url

no boot network remote-url

Syntax Description remote-url Location of the configuration file. Use the following syntax:

• ftp: [[[//[username[: password]@]location]/

directory]/ filename]

• rcp: [[[//[username @]location]/ directory]/

filename]

• tftp: [[[// location]/ directory]/ filename]

Command Default The default filename is network-config.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command instructs the system to “Boot using network configuration file x ,” where x is the filename specified in the remote-url argument. This command specifies the remote location and filename of the network configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file.

When booting from a network server, routers ignore routing information, static IP routes, and bridging information. As a result, intermediate routers are responsible for handling FTP, rcp, or TFTP requests.

Before booting from a network server, verify that a server is available by using the ping command.

Use the service config command to enable the loading of the specified configuration file at reboot time.

Without this command, the router ignores the boot network command and uses the configuration

Cisco IOS Configuration Fundamentals Command Reference

A through B boot network information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service

config command is enabled automatically.

Note Usually, the service config command is used in conjunction with the boot host or boot network command.

Loading a Configuration File Using rcp

The rcp software requires that a client send the remote username on each rcp request to the network server.

If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username.

When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list:

1 The username specified in the file-URL, if a username is specified.

2 The username set by the ip rcmd remote-username command, if the command is configured.

3 The router host name.

Loading a Configuration File Using FTP

The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory associated with the username on the server. Refer to the documentation for your FTP server for more details.

When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list:

1 The username specified in the boot network command, if a username is specified.

2 The username set by the ip ftp username command, if the command is configured.

3 Anonymous.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot network

The router sends the first valid password in the following list:

1 The password specified in the boot network command, if a password is specified.

2 The password set by the ip ftp password command, if the command is configured.

Examples The following example changes the network configuration filename to bridge_9.1 and uses the default broadcast address:

Router(config)# boot network tftp:bridge_9.1

Router(config)# service config

The following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the network configuration file resides:

Router(config)# service config

Router(config)# boot network rcp://172.16.1.111/bridge_9.1

Related Commands

Command

boot host

service config

Description

Specifies the remote location and filename of the host-specific configuration file to be used at the next system boot (startup).

Enables autoloading of configuration files from a remote host.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot system

boot system

To specify the system image that the router loads at startup, use one of the following boot system command in global configuration mode. To remove the startup system image specification, use the no form of this command.

Loading System Image from a URL or a TFTP File

boot system {file-url | filename}

no boot system {file-url | filename}

Booting from a System Image in Internal Flash

boot system flash [flash-fs:] [partition-number:] [filename]

no boot system flash [flash-fs:] [partition-number:] [filename]

Booting from a MOP Server

boot system mop filename [mac-address] [interface]

no boot system mop filename [mac-address] [interface]

Booting from ROM

boot system rom

no boot system rom

Booting a System Image from a Network, TFTP, or FTP Server

boot system {rcp | tftp | ftp} filename [ip-address]

no boot system {rcp | tftp | ftp} filename [ip-address]

Syntax Description file-url filename

The URL of the system image to load at system startup.

The TFTP filename of the system image to load at system startup.

Cisco IOS Configuration Fundamentals Command Reference

boot system flash

flash-fs :

partition-number :

Cisco IOS Configuration Fundamentals Command Reference

A through B

On all platforms except the Cisco 1600 series,

Cisco 3600 series, and Cisco 7000 family routers, this keyword boots the router from internal flash memory. If you omit all arguments that follow this keyword, the system searches internal Flash for the first bootable image.

On the Cisco 1600 series, Cisco 3600 series, and

Cisco 7000 family routers, this keyword boots the router from the flash system specified by the flash-

fs : argument. On the Cisco 1600 series and Cisco

3600 series routers, if you omit all optional arguments, the router searches internal flash memory for the first bootable image. On the Cisco

7000 family routers, when you omit all arguments that follow this keyword, the system searches the

Personal Computer Memory Card Industry

Association (PCMCIA) slot 0 for the first bootable image.

(Optional) Flash file system containing the system image to load at startup. The colon is required.

Valid file systems are as follows:

• flash: --Internal flash memory on the Cisco

1600 series and Cisco 3600 series routers. For the Cisco 1600 series and Cisco 3600 series routers, this file system is the default if you do not specify a file system. This is the only valid file system for the Cisco 1600 series.

• bootflash: --Internal flash memory in the

Cisco 7000 family.

• slot0: --First PCMCIA slot on the Cisco 3600 series and Cisco 7000 family routers . For the

Cisco 7000 family routers , this file system is the default if you do not specify a file system.

• slot1: --Flash memory card in the second

PCMCIA slot on the Cisco 3600 series and

Cisco 7000 family routers.

On the Cisco 2600 series routers, a file system should be specified. Otherwise, the router may attempt to load the Cisco IOS software twice with unexpected results.

(Optional) Number of the flash memory partition that contains the system image to boot, specified by the optional filename argument. If you do not specify a filename, the router loads the first valid file in the specified partition of flash memory. This argument is valid only on routers that can be partitioned.

A through B filename rom rcp tftp ftp ip-address mop mac-address interface boot system

(Optional when used with the boot system flash command) Name of the system image to load at startup. This argument is case sensitive. If you do not specify a value for the filenameargument, the router loads the first valid file in the following:

• The specified flash file system

• The specified partition of flash memory

• The default flash file system if you also omitted the flash-fs : argument

Boots the router from a system image stored on a

DECNET Maintenance Operations Protocol (MOP) server. Do not use this keyword with the Cisco

3600 series or Cisco 7000 family routers .

(Optional) MAC address of the MOP server containing the specified system image file. If you do not include the MAC address argument, the router sends a broadcast message to all MOP boot servers. The first MOP server to indicate that it has the specified file is the server from which the router gets the boot image.

(Optional) Interface the router uses to send out

MOP requests to the MOP server. The interface options are async, dialer, ethernet, serial, and

tunnel. If you do not specify the interface argument, the router sends a request out on all interfaces that have MOP enabled. The interface that receives the first response is the interface the router uses to load the software.

Boots the router from ROM. Do not use this keyword with the Cisco 3600 series or the Cisco

7000 family routers .

Boots the router from a system image stored on a network server using rcp.

Boots the router from a system image stored on a

TFTP server.

Boots the router from a system image stored on an

FTP server.

(Optional) IP address of the server containing the system image file. If omitted, this value defaults to the IP broadcast address of 255.255.255.255.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot system

Command Default If you configure the router to boot from a network server but do not specify a system image file with the

boot system command, the router uses the configuration register settings to determine the default system image filename. The router forms the default boot filename by starting with the word cisco and then appending the octal equivalent of the boot field number in the configuration register, followed by a hyphen

(-) and the processor type name (cisconn-cpu). Refer to the appropriate hardware installation guide for details on the configuration register and default filename. See also the config-register or confreg command.

Command Modes Global configuration

Command History

Release

10.0

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

Modification

This command was introduced.

Support for this command was added for the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(31)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Usage Guidelines

For this command to work, the config-register command must be set properly.

Create a comma-delimited list of several boot system commands to provide a fail-safe method for booting your router. The router stores and executes the boot system commands in the order in which you enter them in the configuration file. If you enter multiple boot commands of the same type--for example, if you enter two commands that instruct the router to boot from different network servers--the router tries them in the order in which they appear in the configuration file. If a boot system command entry in the list specifies an invalid device, the router omits that entry. Use the boot system rom command to specify use of the ROM system image as a backup to other boot system commands in the configuration.

Note After a list of several images are specified with the boot system command, running the command again results in the list being appended, not removed.

For some platforms, the boot image must be loaded before the system image is loaded. However, on many platforms, the boot image is loaded only if the router is booting from a network server or if the flash file system is not specified. If the file system is specified, the router will boot faster because it need not load the boot image first.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot system

This section contains the following topics:

• Changing the List of Boot System Commands

• Booting Compressed Images

• Understanding rcp

• Understanding TFTP

• Understanding FTP

• Stopping Booting and Entering ROM Monitor Mode

• Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes

Changing the List of Boot System Commands

To remove a single entry from the bootable image list, use the no form of the command with an argument.

For example, to remove the entry that specifies a bootable image on a flash memory card inserted in the second slot, use the no boot system flash slot1: filename] command. All other entries in the list remain.

To eliminate all entries in the bootable image list, use the no boot system command. At this point, you can redefine the list of bootable images using the previous boot system commands. Remember to save your changes to your startup configuration by issuing the copy system:running-config nvram:startup-config command.

Each time you write a new software image to flash memory, you must delete the existing filename in the configuration file with the no boot system flash filename command. Then add a new line in the configuration file with the boot system flash filename command.

Note If you want to rearrange the order of the entries in the configuration file, you must first issue the no boot

system command and then redefine the list.

Booting Compressed Images

You can boot the router from a compressed image on a network server. When a network server boots software, both the image being booted and the running image must be able to fit into memory. Use compressed images to ensure that enough memory is available to boot the router. You can compress a software image on any UNIX platform using the compress command. Refer to your UNIX platform’s documentation for the exact usage of the compress command. (You can also uncompress data with the

UNIX uncompress command.)

Understanding rcp

The rcp requires that a client send the remote username in an rcp request to a server. When the router executes the boot system rcp command, the Cisco IOS software sends the hostname as both the remote and local usernames by default. Before the rcp can execute properly, an account must be defined on the network server for the remote username configured on the router.

If the server has a directory structure, the rcp software searches for the system image to boot from the remote server relative to the directory of the remote username.

By default, the router software sends the hostname as the remote username. You can override the default remote username by using the ip rcmd remote-username command. For example, if the system image resides in the home directory of a user on the server, you can specify that user’s name as the remote username.

Understanding TFTP

You need a TFTP server running to retrieve the router image from the host.

Understanding FTP

Cisco IOS Configuration Fundamentals Command Reference

A through B boot system

Examples

You need an FTP server running to retrieve the router image from the host. You also need an account on the server or anonymous file access to the server.

Stopping Booting and Entering ROM Monitor Mode

During the first 60 seconds of startup, you can force the router to stop booting by pressing the Break key.

The router will enter ROM monitor mode, where you can change the configuration register value or boot the router manually.

Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes

For the Cisco 3600 series and Cisco 7000 family, the boot system command modifies the BOOT variable in the running configuration. The BOOT variable specifies a list of bootable images on various devices.

Note When you use the boot system command on the Cisco 1600 series, Cisco 3600 series, Cisco 7000 family, and Cisco 7600 series, you affect only the running configuration. You must save the BOOT variable settings to your startup configuration to place the information under ROM monitor control and to have the variable function as expected. Use the copy system:running-config nvram:startup-config privileged

EXEC command to save the variable from your running configuration to your startup configuration.

To display the contents of the BOOT variable, use the show bootvar EXEC command.

The following example illustrates a configuration that specifies two possible internetwork locations for a system image, with the ROM software being used as a backup:

Router(config)# boot system tftp://192.168.7.24/cs3-rx.90-1

Router(config)# boot system tftp://192.168.7.19/cs3-rx.83-2

Router(config)# boot system rom

The following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of the flash device:

Router(config)# boot system flash:2:igs-bpx-l

The following example instructs the router to boot from an image located on the flash memory card inserted in slot 0:

Router(config)# boot system slot0:new-config

The following example specifies the file named new-ios-image as the system image for a Cisco 3600 series router to load at startup. This file is located in the fourth partition of the flash memory card in slot 0.

Router(config)# boot system slot0:4:dirt/images/new-ios-image

This example boots from the image fi le named c1600-y-l in part ition 2 of flash memory of a Cisco 1600 series router:

Router(config)# boot system flash:2:c1600-y-l

Cisco IOS Configuration Fundamentals Command Reference

A through B boot system

Related Commands

Command boot config-register confreg copy

copy system:running-config nvram:startup- config

ip rcmd remote username

show bootvar

Description

Boots the router manually.

Changes the configuration register settings.

Changes the configuration register settings while in

ROM monitor mode.

Copies any file from a source to a destination.

Copies the running configuration to the startup configuration.

Configures the remote username to be used when requesting a remote copy using rcp.

Displays the contents of the BOOT variable, the name of the configuration file pointed to by the

CONFIG_FILE variable, the contents of the

BOOTLDR variable, and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot-end-marker

boot-end-marker

The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software configuration files, are not CLI commands. These markers are written to configuration files automatically to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these markers allow the router to more reliably load Cisco IOS images during bootup.

A boot statement is one or more lines in a configuration file that tells the router which software image to load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around any boot commands, including:

• boot bootstrap

• boot config

• boot host

• boot network

• boot system

Note, however, that these markers will always appear in the output of the show running-configor more

system:running-config commands, regardless of whether any actual boot commands have been entered.

This means that no boot commands will appear between the markers if no boot commands have been entered, or if all boot commands have been removed from the configuration, as shown in the “Examples” section.

The boot-start-marker and boot-end-markerflags cannot be removed or modified using the CLI. These markers are written to the startup configuration file whenever a copy running-config startup-config command is issued.

These flags were also introduced to circumvent errors in the configuration file, such as a leading space before a boot command (such as those sometimes introduced by manually edited configuration files), or the use of text strings that include the word “boot” in banners or other user-specified text.

If the “boot start-marker” flag is not found in the configuration file, the system will use the traditional method to identify the boot commands. However, if you are manually creating configuration files, or copying from older Cisco IOS software releases, the addition of these markers is recommended.

Command History

Release

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV,

12.3(3)B,

Modification

The boot-start-marker and boot-end-marker flags were introduced.

Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file:

Router# configure terminal

Enter configuration commands, one per line. End with the end command.

Router(config)# boot system slot0:

Router(config)# end

Router# copy running-config startup-config

Router# show startup-config

Cisco IOS Configuration Fundamentals Command Reference

A through B boot-end-marker

Using 1398 out of 129016 bytes

version 12.3

service timestamps debug uptime service timestamps log uptime no service password-encryption

hostname C3660-2

boot-start-marker boot system slot0: boot-end-marker

logging count

In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered:

Router# show running-configuration

Current configuration :3055 bytes

! No configuration change since last restart

version 12.3

service timestamps debug datetime msec service timestamps log datetime msec

no service password-encryption

hostname Router

boot-start-marker boot-end-marker

Related Commands

Command

boot bootstrap

boot config

boot host

boot network

boot system

Description

Specifies the filename and location of a secondary bootstrap image (to be used if a valid software image cannot be loaded).

Specifies the device and filename of the configuration file from which the router boots during startup (for Class A filesytems).

Specifies a remote host location for the hostspecific (router-specific) configuration file to be used at the next system startup.

Specifies a remote location for the network

(network-wide) configuration file to be used at the next system startup.

Specifies the system software image that the router loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

boot-end-marker

A through B

Cisco IOS Configuration Fundamentals Command Reference

A through B boot-start-marker

boot-start-marker

• boot bootstrap

• boot config

• boot host

• boot network

• boot system

Note, however, that these markers will always appear in the output of the show running-configor more

system:running-config commands, regardless of whether any actual boot commands have been entered.

Command History

Release Modification

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B The boot-start-marker and boot-end-marker flags were introduced.

Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file:

Router# configure terminal

Enter configuration commands, one per line. End with the end command.

Router(config)# boot system slot0:

Router(config)# end

Router# copy running-config startup-config

Router# show startup-config

Cisco IOS Configuration Fundamentals Command Reference

A through B boot-start-marker

Using 1398 out of 129016 bytes

version 12.3

service timestamps debug uptime service timestamps log uptime no service password-encryption

hostname C3660-2

boot-start-marker boot system slot0: boot-end-marker

logging count

In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered:

Router# show running-configuration

Current configuration :3055 bytes

! No configuration change since last restart

version 12.3

service timestamps debug datetime msec service timestamps log datetime msec

no service password-encryption

hostname Router

boot-start-marker boot-end-marker

Related Commands

Command

boot bootstrap

boot config

boot host

boot network

boot system

Description

Specifies the filename and location of a secondary bootstrap image (to be used if a valid software image cannot be loaded).

Specifies the device and filename of the configuration file from which the router boots during startup (for Class A filesytems).

Specifies a remote host location for the hostspecific (router-specific) configuration file to be used at the next system startup.

Specifies a remote location for the network

(network-wide) configuration file to be used at the next system startup.

Specifies the system software image that the router loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

A through B boot-start-marker

Cisco IOS Configuration Fundamentals Command Reference

boot-start-marker

A through B

Cisco IOS Configuration Fundamentals Command Reference

C commands

•

cd, page 87

•

clear archive log config, page 89

•

clear catalyst6000 traffic-meter, page 91

•

clear configuration lock, page 92

•

clear diagnostic event-log, page 94

•

clear ip http client cache, page 96

•

clear logging, page 98

•

clear logging system, page 100

•

clear logging xml, page 102

•

clear memory low-water-mark, page 104

•

clear mls statistics, page 105

•

clear parser cache, page 107

•

clear parser statistics, page 109

•

clear platform netint, page 111

•

clear processes interrupt mask, page 112

•

clear scp accounting, page 114

•

clear tcp, page 115

•

clear vlan counters, page 117

•

clock, page 118

•

clock initialize nvram, page 120

•

config-register, page 121

•

configure check syntax, page 123

•

configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.), page 124

•

configure confirm, page 131

•

configure memory, page 133

•

configure network, page 135

•

configure overwrite-network, page 136

•

configure replace, page 137

•

configure revert, page 142

•

configure terminal, page 144

•

confreg, page 147

•

continue (ROM monitor), page 149

•

copy, page 151

•

copy erase flash, page 170

Cisco IOS Configuration Fundamentals Command Reference

•

copy http, page 171

•

copy https, page 172

•

copy logging system, page 173

•

copy xmodem, page 175

•

copy ymodem, page 177

•

copy noverify, page 179

C commands

Cisco IOS Configuration Fundamentals Command Reference

C commands cd

cd

To change the default directory or file system, use the cd command in user EXEC or privileged EXEC mode.

cd [filesystem:] [directory]

Syntax Description

filesystem : directory

(Optional) The URL or alias of the directory or file systems followed by a colon.

(Optional) Name of the directory.

Command Default The initial default file system is flash:. For platforms that do not have a physical device named flash:, the keyword flash: is aliased to the default Flash device.

For the Supervisor Engine, the initial default file system is disk0 :

If you do not specify a directory on a file system, the default is the root directory on that file system.

Command Modes User EXEC

Privileged EXEC

Command History

Release

11.0

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(14)SX, and support was introduced on the Supervisor Engine 720.

Support was added for the Supervisor Engine 2.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The valid values for filesystem :are as follows:

• For systems that are configured with a Supervisor Engine 2, valid values are bootflash:,

const_nvram:, disk0:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:

• For systems that are configured with a Supervisor Engine 720, valid values are disk0: and disk1:

For all EXEC commands that have an optional filesystemargument, the system uses the file system specified by the cd command when you omit the optional filesystemargument. For example, the

Cisco IOS Configuration Fundamentals Command Reference

C commands cd

dircommand, which displays a list of files on a file system, contains an optional filesystemargument. When you omit this argument, the system lists the files on the file system specified by the cd command.

If you do not specify a directory on a file system, the default is the root directory on that file system.

Examples

In the following example, the cd command is used to set the default file system to the Flash memory card inserted in slot 0:

Router# pwd bootflash:/

Router# cd slot0:

Router# pwd slot0:/

Cisco 7600 Series

This example sets the default file system to the Flash PC card that is inserted in disk 0:

Router# cd disk0:

Router# pwd disk0:/

Related Commands

Command copy delete dir

mkdir disk0: pwd

show file systems undelete

Description

Copies any file from a source to a destination.

Deletes a file on a Flash memory device.

Displays a list of files on a file system.

Creates a new directory in a Flash file system.

Displays the current setting of the cd command.

Lists available file systems and their alias prefix names.

Recovers a file marked “deleted” on a Class A or

Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

C commands clear archive log config

clear archive log config

To purge the configuration logging database entries, use the clear archive log configcommand in privileged EXEC mode.

clear archive log config [force | persistent]

Syntax Description force persistent

(Optional) Eliminates the confirm step before the contents of the archive log are cleared.

(Optional) Purges the configuration logging persistent-command database entries.

Command Default If this command is not used, the database entries accumulate in the archive log.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SRA

12.4(11)T

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.4(11)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines

When the clear archive log configcommand is entered, only the entries in the configuration logging database file are deleted. The file itself is not deleted; it will be used in the future to log new entries as they occur.

Examples The following example clears the database entries that have been saved to the config log without asking you to confirm the action before the entries are cleared:

Router# clear archive log config force

Cisco IOS Configuration Fundamentals Command Reference

C commands clear archive log config

Related Commands

Command

show archive log config all persistent

Description

Displays the persisted commands in configlet format.

Cisco IOS Configuration Fundamentals Command Reference

C commands clear catalyst6000 traffic-meter

clear catalyst6000 traffic-meter

To clear the traffic meter counters, use the clear catalyst6000 traffic-metercommand in privileged EXEC mode.

clear catalyst6000 traffic-meter

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(17a)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples

This example shows how to clear the traffic meter counters:

Router# clear catalyst6000 traffic-meter

Router#

Cisco IOS Configuration Fundamentals Command Reference

C commands clear configuration lock

clear configuration lock

To clear the lock on the running configuration file, use the clear configuration lockcommand in privileged

EXEC mode.

clear configuration lock

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

12.2(25)S

12.3(14)T

12.0(31)S

12.2(28)SB

12.2(33)SRA

12.2(33)SXH

Modification

This command was introduced.

This command was enhanced to allow the exclusive configuration lock to be cleared during erratic or abnormal behavior.

This command was integrated into Cisco IOS

Release 12.0(31)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(31)SXH.

Examples The following is sample output from the clear configuration lockcommand when the running configuration file is not locked by the configure replace command:

Router# clear configuration lock

Parser Config not locked.

The following is sample output from the clear configuration lockcommand when the running configuration file is locked by the configure replace command:

Router# clear configuration lock

Process <3> is holding the EXCLUSIVE lock !

Do you want to clear the lock?[confirm] y

Cisco IOS Configuration Fundamentals Command Reference

C commands clear configuration lock

The following example shows how to use the clear configuration lock command to display the owner or process ID of the lock and prompt the user for confirmation:

Router# clear configuration lock

Process <46> is holding the EXCLUSIVE lock.

Do you want to clear the lock?[confirm] y

After the lock is cleared, a message will be sent to the terminal if the owner of the lock is a TTY user:

Router(config)# The configuration lock was cleared by user <steve> from terminal <5>

Related Commands

Command

configuration mode exclusive

debug configuration lock

show configuration lock

Description

Enables single-user (exclusive) access functionality for the Cisco IOS CLI.

Enables debugging of the Cisco IOS configuration lock.

Displays information about the lock status of the running configuration file during a configuration replace operation.

Cisco IOS Configuration Fundamentals Command Reference

C commands clear diagnostic event-log

clear diagnostic event-log

To clear the diagnostic event logs for a specific module or event type, use the clear diagnostic event-

logcommand in privileged EXEC mode.

clear diagnostic event-log {event-type {error | info | warning} | module {num | slot subslot | all}}

Syntax Description

event-type error

event-type info

event-type warning

module num | slot subslot

module all

Specifies clearing error events.

Specifies clearing informative events.

Specifies clearing warning events.

Specifies clearing events for a specific module.

Specifies clearing all linecards.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SXH

Modification

This command was introduced on the Supervisor

Engine 720.

Usage Guidelines The clear diagnostic event-log command clears all the events for all the modules.

The clear diagnostic event-log module num command clears events only for a specific module.

The clear diagnostic event-log event-typecommand clears only specific event types such as error, informative, or warning events.

Examples This example shows how to clear error event logs:

Router# clear diagnostic event-log event-type error

This example shows how to clear event logs on module 3:

Router# clear diagnostic event-log module 3

Cisco IOS Configuration Fundamentals Command Reference

C commands clear diagnostic event-log

This example shows how to clear error event logs on all the modules:

Router# clear diagnostic event-log module all

Related Commands

Command

show diagnostic events

Description

Displays the diagnostic event log

Cisco IOS Configuration Fundamentals Command Reference

C commands clear ip http client cache

clear ip http client cache

To remove information from the HTTP client cache, use the clear ip http client cache command in privileged EXEC mode.

clear ip http client cache {all | session session-name | url complete-url}

Syntax Description

cache all

cache session session-name

cache url complete-url

Removes all HTTP client cache entries.

Removes HTTP client cache entries of the HTTP client application session specified by the session-

name argument.

Removes the HTTP client cache entry whose location is specified by the complete-url argument, a Cisco IOS File System (IFS) Uniform Resource

Locator (URL), and that consists of HTML files used by an HTTP server.

Command Default None

Command Modes Privileged EXEC

Command History

Release

12.2(31)SB2

Modification

This command was introduced.

Usage Guidelines Use this command to clear entries from the HTTP client cache pool: all the entries, all the entries owned by a specific session, or only the entry associated with a specific request from an HTTP server.

Examples The following example clears all entries in the HTTP client cache:

Router# clear ip http client cache all

The following example removes HTTP client cache entries that belong to the HTTP Client File System

(CFS) application:

Router# clear ip http client cache session HTTP CFS

Cisco IOS Configuration Fundamentals Command Reference

C commands clear ip http client cache

The following example removes HTTP client cache entries at the location http://myrouter.cisco.com/flash:/:

Router# clear ip http client cache url http://myrouter.cisco.com/flash:/

Related Commands

Command

ip http path

show ip http client

Description

Specifies the base path used to locate files for use by the HTTP server.

Displays a report about the HTTP client.

Cisco IOS Configuration Fundamentals Command Reference

C commands clear logging

clear logging

To clear messages from the logging buffer, use the clear logging command in privileged EXEC mode.

clear logging [persistent [url filesystem:/directory]]

Syntax Description persistent url

filesystem:

/directory

(Optional) Deletes persistent logging files.

(Optional) Specifies the URL for storing logging messages.

The file system followed by a colon.

The directory on the filesystem. The slash is required.

Command Modes Privileged EXEC (#)

Command History

Release

11.2

12.2(33)SRA

Cisco IOS XE Release 2.4

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified. The persistentand

url keywords, and the filesystem:/directory arguments were added.

Usage Guidelines

The clear logging persistent command is used to remove stored audit records. This action can be performed by the audit administrator only. The clear logging persistentcommand clears only log files stored in the directory but does not remove the directory itself. If no log URL is not specified for logging, this command clears files from the location as specified in the logging persistent command.

Examples In the following example, the logging buffer is cleared:

Router# clear logging

Clear logging buffer [confirm]

The following example shows how to clear persistent logging files:

Router# clear logging persistent

Cisco IOS Configuration Fundamentals Command Reference

C commands clear logging

Delete persistent logging files from bootflash:/audit_log ? [confirm]

Router# dir bootflash:/audit_log

Directory of bootflash:/audit_log/

No files in directory

The following example shows how to clear persistent logging files from a specific directory:

Router# clear logging persistent url harddisk:/log-persistant

Delete persistent logging files from harddisk:/log-persistent ? [confirm]

Router# dir harddisk:/log-persistant

Directory of harddisk:////log-persistent/

No files in directory

Related Commands

Command

logging buffered

logging persistent

show logging

Description

Logs messages to an internal buffer.

Enables the storage of logging messages on the router’s ATA disk.

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

C commands clear logging system

clear logging system

To clear event records stored in the System Event Archive (SEA) log file sea_log.dat, use the clear logging

system command in user EXEC mode.

clear logging system [disk name]

Syntax Description

disk name (Optional) Stores the system event log in the specified disk.

Command Default

This command has no default settings.

Command Modes User EXEC (>)

Command History

Release

12.2(33)SXH

12.2(33)SCC

Modification

This command was introduced.

This command was introduced for the Cisco uBR10012 router in the Cisco IOS Software

Release 12.2(33)SCC.

Usage Guidelines SEA is supported on switches that have a Supervisor Engine 32 or Supervisor Engine 720 with a compact flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine 720).

Cisco Universal Broadband Router 10012

The SEA feature is used to address debug trace and system console constraints. SEA is a logging feature that allows the modules in the system to report major and critical events to the route processor (RP). The events occurring on the line card or jacket card are also sent to the RP using Inter-Process Communication

(IPC) capability. Use the clear logging system command to clear the event records stored in the SEA log file.

Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in compact flash adapter for PRE2.

100

Cisco IOS Configuration Fundamentals Command Reference

C commands clear logging system

Examples This example shows how to clear the SEA:

Router# clear logging system

Clear logging system operation will take a while.

Do you want to continue? [no]: yes

Router#

Related Commands

copy logging system

logging system

show logging system

Copies the archived system events to another location.

Enables or disables the SEA logging system.

Displays the SEA logging system disk.

Cisco IOS Configuration Fundamentals Command Reference

101

C commands clear logging xml

clear logging xml

To clear the contents of the XML system message logging (syslog) buffer, use the clear logging xml command in User EXEC or Priviledged EXEC mode..

clear logging xml

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(15)T

12.2(28)SB

12.2(33)SRE

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRE .

Usage Guidelines

This command clears the contents of the XML-formatted logging buffer, but does not clear the contents of the standard logging buffer. The system will prompt you to confirm the action before clearing the buffer.

Examples In the following example, the XML-specific buffer is cleared:

Router# clear logging xml

Clear XML logging buffer [confirm]?y

Related Commands

Command

logging buffered xml

Description

Enables system message logging (syslog) to the

XML-specific buffer in XML format.

102

Cisco IOS Configuration Fundamentals Command Reference

C commands

Command

show logging xml clear logging xml

Description

Displays the state of XML-formatted system message logging, followed by the contents of the

XML-specific buffer.

Cisco IOS Configuration Fundamentals Command Reference

103

C commands clear memory low-water-mark

clear memory low-water-mark

To clear the low-water-mark memory, use the clear memory low-water-markcommand in privilegedEXEC mode.

clear memory low-water-mark

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

15.0(1)M

12.2(33)SRB

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced into a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRB.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines This command clears all processor threshold values and the input/output memory threshold values, if any.

Examples The following example shows how to clear the low-water-mark memory:

Router# clear memory low-water-mark

Related Commands

Command

memory free low-watermark

Description

Configures a router to issue system logging message notifications when available memory falls below a specified threshold.

104

Cisco IOS Configuration Fundamentals Command Reference

C commands clear mls statistics

clear mls statistics

To reset the Multilayer Switching (MLS) statistics counters, use the clear mls statistics command in privileged EXEC mode.

clear mls statistics [module num]

Syntax Description module num (Optional) Specifies the module number.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.(17d)SXB1

12.2(17d)SXB5

12.2(33)SRA

Modification

This command was introduced on the Supervisor

Engine 720 and the Supervisor Engine 2.

The module num keyword and argumen t pair were added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command replaces the clear mls stats command, which was introduced on the Supervisor Engine 720 in Cisco IOS Release 12.2(17a)SX, and on the Supervisor Engine 2 in Cisco IOS Release 12.2(17d)SXB.

Examples This example shows how to reset the MLS statistics counters for all modules:

Router# clear mls statistics

Router#

This example shows how to reset the MLS statistics counters for a specific module:

Router# clear mls statistics module 5

Router#

Cisco IOS Configuration Fundamentals Command Reference

105

clear mls statistics

Related Commands

Command

show mls statistics

C commands

Description

Displays the MLS statistics for the IP, IPX, multicast, Layer 2 protocol, and QoS.

106

Cisco IOS Configuration Fundamentals Command Reference

C commands clear parser cache

clear parser cache

To clear the parse cache entries and hit/miss statistics stored for the Parser Cache feature, use the clear

parser cachecommand in privileged EXEC mode.

clear parser cache

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History

Release

12.1(5)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Parser Cache feature optimizes the parsing (translation and execution) of Cisco IOS software configuration command lines by remembering how to parse recently encountered command lines, decreasing the time required to process large configuration files.

The clear parser cache command will free the system memory used by the Parser Cache feature and will erase the hit/miss statistics stored for the output of the show parser statistics EXEC command. This command is only effective when the Parser Cache feature is enabled.

Examples The following example shows the clearing of the parser cache:

Router# show parser statistics

Last configuration file parsed:Number of Commands:1484, Time:820 ms

Parser cache:enabled, 1460 hits, 26 misses

Router# clear parser cache

Router# show parser statistics

Last configuration file parsed:Number of Commands:1484, Time:820 ms

Parser cache:enabled, 0 hits, 1 misses

Cisco IOS Configuration Fundamentals Command Reference

107

clear parser cache

Related Commands

Command

parser cache

show parser statistics

C commands

Description

Enables or disables the Parser Cache feature.

Displays statistics about the last configuration file parsed and the status of the Parser Cache feature.

108

Cisco IOS Configuration Fundamentals Command Reference

C commands clear parser statistics

clear parser statistics

To clear the parser performance statistics, use the clear parser statisticscommand in privileged EXEC mode.

clear parser statistics

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History

Release

15.0S

Modification

This command was introduced.

Usage Guidelines The clear parser statistics command will free the system memory used for recording parser performance statistics stored for the output of the show parser statistics EXEC command..

Examples The following example shows the clearing parser statistics:

Router# show parser statistics

Last configuration file parsed: Number of Commands: 1, Time: 31 ms

Parser cache: enabled, 129 hits, 46 misses

Active startup time: 0

Standby startup time: 186

Copy to running-config time:0

Bulksync time:0

Top 10 slowest command:

Function Time (ms) Command

0xE71F90 7 shutdown

0x1235280 11 no ip address

0x1235280 12 no ip address

0xD6C940 6170 show run

Parser last bootup cache hits:

Cisco IOS Configuration Fundamentals Command Reference

109

C commands clear parser statistics

Bootup hits:125

Bootup misses:43

Bootup clear parser cache:0

Router# clear parser statistics func=E01730, duration=0 cmd= clear parser statistics

Router# show parser statistics

Last configuration file parsed: Number of Commands: 0, Time: 0 ms

Parser cache: enabled, 130 hits, 47 misses

Active startup time: 0

Standby startup time: 0

Copy to running-config time:0

Bulksync time:0

Top 10 slowest command:

Function Time (ms) Command

Parser last bootup cache hits:

Bootup hits:0

Bootup misses:0

Bootup clear parser cache:0

Related Commands

Command

parser cache

show parser statistics

Description

Enables or disables the Parser Cache feature.

Displays statistics about the last configuration file parsed and the status of the Parser Cache feature.

110

Cisco IOS Configuration Fundamentals Command Reference

C commands clear platform netint

clear platform netint

To clear the interrupt-throttling counters for the platform, use the clear platform netint command in privileged EXEC mode.

clear platform netint

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(17b)SXA

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples

This example shows how to clear the interrupt-throttling counters for the platform:

Router# clear platform netint

Router#

Related Commands

Command

show platform netint

Description

Displays the platform network-interrupt information.

Cisco IOS Configuration Fundamentals Command Reference

111

C commands clear processes interrupt mask

clear processes interrupt mask

To clear interrupt mask details for all processes in the interrupt mask buffer, use the clear processes

interrupt mask detailcommand in privileged EXEC mode.

clear processes interrupt mask detail

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

12.4(2)T

Modification

This command was introduced as part of the

Process Interrupt Mask Profiler Enhancement feature.

Usage Guidelines

See the documentation of the scheduler interrupt mask commands (listed in the Related Commands table) for further details on process interrupt mask profiling.

Examples The following example demonstrates how to the clear interrupt mask statistics from system memory for all processes:

Router# clear processes interrupt mask detail

Related Commands

Command

scheduler interrupt mask profile

scheduler interrupt mask size

scheduler interrupt mask time

show process interrupt mask buffer

Description

Starts interrupt mask profiling for all processes running on the system

Configures the maximum number of entries that can exist in the interrupt mask buffer.

Configures the maximum time that a process can run with interrupts masked.

Displays the information stored in the interrupt mask buffer.

112

Cisco IOS Configuration Fundamentals Command Reference

C commands

Command

show processes interrupt mask detail clear processes interrupt mask

Description

Displays interrupt masked details for the specified processes or all processes in the system.

Cisco IOS Configuration Fundamentals Command Reference

113

C commands clear scp accounting

clear scp accounting

To clear the Switch-Module Configuration Protocol (SCP) accounting information, use the clear scp

accountingcommand in privilegedEXEC mode.

clear scp accounting

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

15.0(1)M

12.2(33)SXI

Modification

This command was introduced into a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to clear the SCP accounting information:

Router# clear scp accounting

Related Commands

Command

show scp

Description

Displays SCP information.

114

Cisco IOS Configuration Fundamentals Command Reference

C commands clear tcp

clear tcp

To clear a TCP connection, use the clear tcpcommand in privileged EXEC mode.

clear tcp {line line-number | local hostname port remote hostname port | tcb address}

Syntax Description

line line-number

local hostname port remote hostname port

tcb address

Line number of the TCP connection to clear.

Host name of the local router and port and host name of the remote router and port of the TCP connection to clear.

Transmission Control Block (TCB) address of the

TCP connection to clear. The TCB address is an internal identifier for the endpoint.

Command Modes Privileged EXEC

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The clear tcp command is particularly useful for clearing hung TCP connections.

The clear tcp line line-numbercommand terminates the TCP connection on the specified tty line.

Additionally, all TCP sessions initiated from that tty line are terminated.

The clear tcp local hostname port remote hostname portcommand terminates the specific TCP connection identified by the host name and port pair of the local and remote router.

The clear tcp tcb address command terminates the specific TCP connection identified by the TCB address.

Examples The following example clears a TCP connection using its tty line number. The show tcp command displays the line number (tty2) that is used in the clear tcp command.

Router# show tcp

tty2, virtual tty from host router20.cisco.com

Connection state is ESTAB, I/O status: 1, unread input bytes: 0

Local host: 171.69.233.7, Local port: 23

Foreign host: 171.69.61.75, Foreign port: 1058

Cisco IOS Configuration Fundamentals Command Reference

115

C commands clear tcp

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

Event Timers (current time is 0x36144):

Timer Starts Wakeups Next

Retrans 4 0 0x0

TimeWait 0 0 0x0

AckHold 7 4 0x0

SendWnd 0 0 0x0

KeepAlive 0 0 0x0

GiveUp 0 0 0x0

PmtuAger 0 0 0x0

iss: 4151109680 snduna: 4151109752 sndnxt: 4151109752 sndwnd: 24576

irs: 1249472001 rcvnxt: 1249472032 rcvwnd: 4258 delrcvwnd: 30

SRTT: 710 ms, RTTO: 4442 ms, RTV: 1511 ms, KRTT: 0 ms

minRTT: 0 ms, maxRTT: 300 ms, ACK hold: 300 ms

Router# clear tcp line 2

[confirm]

[OK]

The following example clears a TCP connection by specifying its local router host name and port and its remote router host name and port. The show tcp brief command displays the local (Local Address) and remote (Foreign Address) host names and ports to use in the clear tcp command.

Router# show tcp brief

TCB Local Address Foreign Address (state)

60A34E9C router1.cisco.com.23 router20.cisco.1055 ESTAB

Router# clear tcp local router1 23 remote router20 1055

[confirm]

[OK]

The following example clears a TCP connection using its TCB address. The show tcp brief command displays the TCB address to use in the clear tcp command.

Router# show tcp brief

TCB Local Address Foreign Address (state)

60B75E48 router1.cisco.com.23 router20.cisco.1054 ESTAB

Router# clear tcp tcb 60B75E48

[confirm]

[OK]

Related Commands

Command

show tcp

show tcp brief

Description

Displays the status of TCP connections.

Displays a concise description of TCP connection endpoints.

116

Cisco IOS Configuration Fundamentals Command Reference

C commands clear vlan counters

clear vlan counters

To clear the software-cached counter values to start from zero again for a specified VLAN or all existing

VLANs, use the clear vlan counters command in privileged EXEC mode.

clear vlan [vlan-id] counters

Syntax Description vlan-id (Optional) The ID of a specific VLAN. Range: 1 to

4094.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you do not specify a vlan-id; the software-cached counter values for all existing VLANs are cleared.

Examples This example shows how to clear the software-cached counter values for a specific VLAN:

Router# clear vlan 10 counters

Clear "show vlan" counters on this vlan [confirm]y

Router#

Related Commands

Command

show vlan counters

Description

Displays the software-cached counter values.

Cisco IOS Configuration Fundamentals Command Reference

117

C commands clock

clock

To configure the port clocking mode for the 1000BASE-T transceivers, use the clock command in interface configuration mode. To return to the default settings,use the no form of this command.

clock {auto | active [prefer] | passive [prefer]}

no clock

Syntax Description auto active prefer passive

Enables the automatic-clock configuration.

Enables the active operation.

(Optional) Negotiates the specified mode with the far end of the link.

Enables the passive operation.

Command Default auto

Command Modes Interface configuration

Command History

Release

12.2(17a)SX

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on the 1000BASE-T transceivers only.

If the clock mode of the near end of a link does not match the clock mode of the far end, the line protocol does not come up.

The active and passive clock status is determined during the auto negotiation process before the transmission link is established.

The clock command supports the following configurations:

• auto --Auto negotiates with the far end of the link but preference is given to the active-clock switch.

• active --Uses a local clock to determine transmitter-operation timing.

118

Cisco IOS Configuration Fundamentals Command Reference

C commands clock

• passive --Recovers the clock from the received signal and uses the recovered clock to determine transmitter-operation timing.

• active prefer --Auto negotiates with the far end of the link but preference is given to the active-clock switch.

• passive prefer --Auto negotiates with the far end of the link but preference is given to the passiveclock switch.

Enter the show running-config interface command to display the current clock mode.

Enter the show interfaces command to display the clock mode that is negotiated by the firmware.

Examples This example shows how to enable the active-clock operation:

Router(config-if)# clock active

Router(config-if)#

Related Commands

Command

show interfaces

show running-config interface

Description

Displays traffic that is seen by a specific interface.

Displays the status and configuration of the module or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

119

C commands clock initialize nvram

clock initialize nvram

To restart the system clock from the last known system clock value, use the clock initialize

nvramcommand in global configuration mode. To disable the restart of the system clock from the last known system clock value, use the no form of this command.

clock initialize nvram

no clock initialize nvram

Syntax Description This command has no arguments or keywords.

Command Default By default, the system clock is set to restart from the last known system clock value for platforms that have no hardware calendar.

Command Modes Global configuration (config)

Command History

Release

12.3(4)T

Modification

This command was introduced.

Usage Guidelines For platforms that have hardware calendars, the clock initialize nvram command is not available. When the no form of the command is configured, the system clock gets initialized to default standard values. The default values can be either 1MAR1993 or 1MAR2002.

Examples The following example shows how to set the system clock to restart from the last known system clock value:

Router(config)# clock initialize nvram

120

Cisco IOS Configuration Fundamentals Command Reference

C commands config-register

config-register

To change the configuration register settings, use the config-register command in global configuration mode.

config-register value

Syntax Description value Hexadecimal or decimal value that represents the

16-bit configuration register value that you want to use the next time the router is restarted. The value range is from 0x0 to 0xFFFF (0 to 65535 in decimal).

Command Default Refer to the documentation for your platform for the default configuration register value. For many newer platforms, the default is 0x2102, which causes the router to boot from Flash memory and the Break key to be ignored.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(31)SB2.

This command was integrated into Cisco IOS

Release 12.2(31)SXH.

Usage Guidelines This command applies only to platforms that use a software configuration register.

The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network.

To change the boot field value and leave all other bits set to their default values, follow these guidelines:

• If you set the configuration register boot field value to 0x0, you must boot the operating system manually with the boot command.

Cisco IOS Configuration Fundamentals Command Reference

121

C commands config-register

• If you set the configuration register boot field value to 0x1, the router boots using the default ROM software.

• If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot field value to form a default boot filename for booting from a network server.

For more information about the configuration register bit settings and default filenames, refer to the appropriate router hardware installation guide.

Note In a virtual switch application, If you have configured your config-register with a value that would skip file parsing during the bootup process, your change to either a standalone or virtual switch will not take place until you reconfigure your config-register. The config-register must be allowed to parse files in order to ensure the conversion from either a standalone or virtual switch.

Examples In the following example, the configuration register is set to boot the system image from Flash memory: config-register 0x2102

Related Commands

Command

boot system confreg o

show version

Description

Specifies the system image that the router loads at startup.

Changes the configuration register settings while in

ROM monitor mode.

Lists the value of the boot field (bits 0 to 3) in the configuration register.

Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.

122

Cisco IOS Configuration Fundamentals Command Reference

C commands configure check syntax

configure check syntax

To check the syntax configuration, use the configure check syntax commandinprivilegedEXEC mode.

configure check syntax [source-location]

Syntax Description source-location (Optional) Location or the address of the source to be checked.

Command Default The syntax configuration is not checked.

Command Modes Privileged EXEC (#)

Command History

Release

15.0(1)M

12.2(33)SRB

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRB.

Examples

The following example shows how to check the syntax configuration using the configure check syntax command:

Router# configure check syntax revrcsf:

Related Commands

Command

configure revert

Description

Cancels the timed rollback and triggers the rollback immediately, or resets the parameters for the timed rollback.

Cisco IOS Configuration Fundamentals Command Reference

123

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

configuration mode exclusive (Deprecated as of the 15.0S and

T releases. It's still available on the M train.)

Note Effective with Cisco IOS XE Release 3.1S, the configuration mode exclusive command is replaced by the

parser command serializer command. See the parser command serializer command for more information.

To enable single-user (exclusive) access functionality for the Cisco IOS command-line interface (CLI), use the configuration mode exclusive command in global configuration mode. To disable the single-user access (configuration locking) feature, use the no form of this command.

configuration mode exclusive {auto | manual} [expire seconds] [lock-show] [interleave]

[terminate] [config-wait seconds] [retry-wait seconds]

no configuration mode exclusive

Syntax Description auto manual

expire seconds lock-show interleave terminate

Automatically limits configuration to single-user mode.

Allows you to manually limit the configuration file to single-user mode.

(Optional) Specifies the number of seconds in which the configuration lock is released after the user stops making configuration changes.

(Optional) Gives priority to configuration commands being executed from the exclusive configuration session, and prevents the execution of

show commands.

(Optional) Allows show commands from sessions that are not holding the configuration lock to be executed when the user in the session holding the configuration lock is not making configuration changes.

Note If you entered the lock-showkeyword, you should enter this keyword.

(Optional) Causes the configuration command executed from the exclusive configuration session to terminate show and clear commands being executed in other sessions.

124

Cisco IOS Configuration Fundamentals Command Reference

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

config-wait seconds

retry-wait seconds

(Optional) Specifies the amount of time, in seconds, that a configuration command entered by a user in single user mode waits for show commands entered by other users to finish being executed. If the show command is still being executed when the timer expires and if the terminate option is set, the configuration command terminates the show command. If the configuration command completes execution before the specified number of seconds, the show command begins execution.

(Optional) Specifies the amount of time, in seconds, that show and clear EXEC commands will wait for a configuration command entered by a user in exclusive configuration mode to complete execution.

If the configuration command is still being executed when the specified amount of time has passed, the EXEC commands generate an error message and are terminated.

If execution of the configuration command is completed before the specified number of seconds, the EXEC commands are executed.

Command Default Single-user mode is disabled.

Command Modes Global configuration (config)

Command History

Release

12.3(14)T

12.0(31)S

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.0(31)S. The following keywords were added: config-wait, expire, interleave, lock-

show,retry-wait,and terminate. New functionality was added, including Access Session Locking.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

Cisco IOS Configuration Fundamentals Command Reference

125

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Release

12.2(33)SXI

15.0(1)S

Cisco IOS XE Release 3.1S

Modification

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was deprecated for Cisco IOS

Release 15.0(1)S.

This command was replaced by the parser

command serializer command.

Usage Guidelines

Note As of the 15.0 release, the configuration mode exclusive command is no longer available on the S and T trains.

The configuration mode exclusive command enables the exclusive configuration lock feature. The exclusive configuration lock allows single-user access to configuration modes using single-user configuration mode. While the device configuration is locked, no other users can enter configuration commands.

Users accessing the device using the state-full, session-based transports (telnet, Secure Shell (SSH) are able to enter single-user configuration mode. The user enters single-user configuration mode by acquiring the exclusive configuration lock using the configure terminal lock privileged EXEC mode command. The configuration lock is released when the user exits configuration mode by using the end or exit command, or by pressing Ctrl-Z. While a user is in single-user configuration mode, no other users can configure the device. Users accessing Command Line Interface (CLI) options through stateless protocols (that is, the

HTTP web-based user interface) cannot access single-user configuration mode. (However, an Application

Programming Interface (API) allows the stateless transports to lock the configuration mode, complete its operations, and release the lock.)

Examples The following example shows how to configure the configuration file for single-user autoconfiguration mode by using the configuration mode exclusive auto command. Use the configuration terminal command to enter global configuration mode and lock the configuration mode exclusively. After the Cisco

IOS configuration mode is locked exclusively, you can verify this configuration by entering the show

configuration lockcommand.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# configuration mode exclusive auto

Router(config)# end

Router# show running-configuration

| include config

Building configuration...

Current configuration : 2296 bytes configuration mode exclusive auto <========== auto policy

Router# configure terminal ?

<======== lock option not displayed when in auto policy

Router# configure terminal

<======= acquires the lock

126

Cisco IOS Configuration Fundamentals Command Reference

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

The configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode by entering the end or exitcommand.

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)#

Router(config)# show configuration lock

Parser Configure Lock

---------------------

Owner PID : 3

User : unknown

TTY : 0

Type : EXCLUSIVE

State : LOCKED

Class : EXPOSED

Count : 1

Pending Requests : 0

User debug info : configure terminal

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 6

Lock Expiration timer (in Sec) : 593

Router(config)#

Router(config)# end

<========= releases the lock

Router#

Router# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 0

Lock Expiration timer (in Sec) : 0

The following example shows how to enable the exclusive locking feature in manual mode by using the

configuration mode exclusive manual command. Once you have configured manual exclusive mode, you can lock the configuration mode by using the configure terminal lock command. In this mode, the

configure terminal command does not automatically lock the parser configuration mode. The lock is cleared after you exit from configuration mode by entering the end or exit command.

Router# configure terminal

Configuration mode locked exclusively. The lock will be cleared once you exit out of configuration mode using end/exit

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# configuration mode exclusive manual

Router(config)# end

Router#

Router# show running-configuration

| include configuration

Cisco IOS Configuration Fundamentals Command Reference

127

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Building configuration...

Current configuration : 2298 bytes configuration mode exclusive manual <==== 'manual' policy

Router# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 0

Lock Expiration timer (in Sec) : 0

Router#

Router# configure terminal ? lock Lock configuration mode <========= 'lock' option displayed in 'manual' policy

Router# configure terminal <============ ‘configure terminal’ won't acquire lock automatically

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 0

Lock Expiration timer (in Sec) : 0

Router(config)# end

Router# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 0

128

Cisco IOS Configuration Fundamentals Command Reference

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Lock Expiration timer (in Sec) : 0

Router#

Router# configure

Router# configure terminal

Router# configure terminal ? lock Lock configuration mode <======= 'lock' option displayed when in 'manual' policy

Router# configure terminal lock

<============ acquires exclusive configuration lock

Configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode by entering the end or exit command. Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# show configuration lock

Parser Configure Lock

---------------------

Owner PID : 3

User : unknown

TTY : 0

Type : EXCLUSIVE

State : LOCKED

Class : EXPOSED

Count : 1

Pending Requests : 0

User debug info : configure terminal lock

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 5

Lock Expiration timer (in Sec) : 594

Router(config)# end

<================ 'end' releases exclusive configuration lock

Router# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 0

Lock Expiration timer (in Sec) : 0

Router#

Related Commands

Command

configure terminal

Description

Enters global configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

129

C commands configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Command

debug configuration lock

show configuration lock

Description

Enables debugging of the Cisco IOS configuration lock.

Displays information about the lock status of the running configuration file during a configuration replace operation.

130

Cisco IOS Configuration Fundamentals Command Reference

C commands configure confirm

configure confirm

To confirm replacement of the current running configuration with a saved Cisco IOS configuration file, use the configure confirm command in privileged EXEC mode.

configure confirm

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(33)SXH

12.2(33)SB

12.2(33)SXI

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2S.

This command was integrated into Cisco IOS

Release 12.2SB.

This command was integrated into Cisco IOS

Release 12.2SR.

This command was integrated into Cisco IOS

Release 12.2SX.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines The configure confirm command is used only if the time seconds keyword and argument of the configure

replace command are specified. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure

replace command).

Cisco IOS Configuration Fundamentals Command Reference

131

C commands configure confirm

Examples The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file:

Router# configure replace nvram:startup-config time 120

This will apply all necessary additions and deletions to replace the current running configuration with the contents of the specified configuration file, which is assumed to be a complete configuration, not a partial configuration. Enter Y if you are sure you want to proceed. ? [no]: Y

Total number of passes: 1

Rollback Done

Router# configure confirm

Related Commands

Command

archive config

configure replace maximum

path (config-archive)

show archive time-period

Description

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

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

132

Cisco IOS Configuration Fundamentals Command Reference

C commands configure memory

configure memory

To configure the system from the system memory, use the configure memory command in privileged

EXEC mode.

configure memory

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines On all platforms except Class A Flash file system platforms, this command executes the commands located in the configuration file in NVRAM (the “startup configuration file”).

On Class A Flash file system platforms, if you specify the configure memory command, the router executes the commands pointed to by the CONFIG_FILE environment variable. The CONFIG_FILE environment variable specifies the location of the configuration file that the router uses to configure itself during initialization. The file can be located in NVRAM or any of the Flash file systems supported by the platform.

When the CONFIG_FILE environment variable specifies NVRAM, the router executes the NVRAM configuration only if it is an entire configuration, not a distilled version. A distilled configuration is one that does not contain access lists.

To view the contents of the CONFIG_FILE environment variable, use the show bootvar EXEC command.

To modify the CONFIG_FILE environment variable, use the boot config command and then save your changes by issuing the copy system:running-config nvram:startup-config command.

Examples In the following example, a router is configured from the configuration file in the memory location pointed to by the CONFIG_FILE environment variable:

Router# configure memory

Cisco IOS Configuration Fundamentals Command Reference

133

C commands configure memory

Related Commands

Command

boot config

copy system:running-config nvram:startup- config

show bootvar

Description

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Saves the running configuration as the startup configuration file.

134

Cisco IOS Configuration Fundamentals Command Reference

C commands configure network

configure network

The configure network command was replaced by the copy{rcp| tftp} running-config command in Cisco

IOS Release 11.0. To maintain backward compatibility, the configure network command continues to function in Cisco IOS Release 12.2(11)T for most systems, but support for this command may be removed in a future release.

The copy{rcp| tftp} running-config command was replaced by the copy {ftp: | rcp: | tftp:}[filename]

system: running-config command in Cisco IOS Release 12.1.

The copy {ftp: | rcp: | tftp:}[filename] system: running-config command specifies that a configuration file should be copied from a FTP, rcp, or TFTP source to the running configuration. See the description of the copy command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

135

C commands configure overwrite-network

configure overwrite-network

The configure overwrite-network has been replaced by the copy {ftp-url | rcp-url | tftp-url

nvram:startup-config command. See the description of the copycommand in the Cisco IOS File System

Commands chapter for more information.

136

Cisco IOS Configuration Fundamentals Command Reference

C commands configure replace

configure replace

To replace the current running configuration with a saved Cisco IOS configuration file, use the configure

replace command in privileged EXEC mode.

configure replace target-url [nolock] list force ignorecase [revert trigger [error] [timer minutes] |

time minutes]

Syntax Description target-url nolock list force ignorecase

revert trigger

URL (accessible by the Cisco IOS file system) of the saved Cisco IOS configuration file that is to replace the current running configuration.

(Optional) Disables the locking of the running configuration file that prevents other users from changing the running configuration during a configuration replace operation.

(Optional) Displays a list of the command lines applied by the Cisco IOS software parser during each pass of the configuration replace operation.

The total number of passes performed is also displayed.

(Optional) Replaces the current running configuration file with the specified saved Cisco

IOS configuration file without prompting you for confirmation.

(Optional) Instructs the configuration to ignore the case of the configuration confirmation.

(Optional) Sets the triggers for reverting to the original configuration.

• error --Reverts to the original configuration upon error.

• timer minutes --Reverts to the original configuration if the specified time elapses.

Cisco IOS Configuration Fundamentals Command Reference

137

C commands configure replace

time minutes (Optional) Time (in minutes) within which you must enter the configure confirm command to confirm replacement of the current running configuration file. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the

configure replace command).

Command Modes Privileged EXEC (#)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

12.2(33)SXI

12.4(20)T

12.2(33)SRC

12.2(33)SB

Modification

This command was introduced.

The nolock keyword was added.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

The revert and trigger keywords were added.

The ignorecase keyword was added.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines When configuring more than one keyword option, the following rules apply:

• The list keyword must be entered before the force and time keywords.

• The force keyword must be entered before the time keyword.

138

Cisco IOS Configuration Fundamentals Command Reference

C commands

Examples configure replace

If the current running configuration is replaced with a saved Cisco IOS configuration file that contains commands unaccepted by the Cisco IOS software parser, an error message is displayed listing the commands that were unaccepted. The total number of passes performed in the configuration replace operation is also displayed.

In Cisco IOS Release 12.2(25)S, a locking feature for the configuration replace operation was introduced.

When the configure replace command is enabled, the Cisco IOS running configuration file is locked by default for the duration of the configuration replace operation. This locking mechanism prevents other users from changing the running configuration while the replace operation is taking place, which might otherwise cause the replace operation to terminate unsuccessfully. You can disable the locking of the running configuration using the configure replace nolock command.

The running configuration lock is automatically cleared at the end of the configuration replace operation. It is not expected that you should need to clear the lock manually during the replace operation, but as a protection against any unforeseen circumstances, you can manually clear the lock using the clear

configuration lock command. You can also display any locks that may be currently applied to the running configuration using the show configuration lock command.

This section contains the following examples:

•

configure replace, page 137

•

configure replace, page 137

•

configure replace, page 137

•

configure replace, page 137

Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File

The following example shows how to replace the current running configuration with a saved Cisco IOS configuration file named disk0:myconfig. Note that the configure replace command interactively prompts you to confirm the operation.

Router# configure replace disk0:myconfig

Total number of passes: 1

Rollback Done

In the following example, the list keyword is specified to display the command lines that were applied during the configuration replace operation:

Router# configure replace disk0:myconfig list

!Pass 1

!List of Commands: no snmp-server community public ro snmp-server community mystring ro end

Total number of passes: 1

Rollback Done

Cisco IOS Configuration Fundamentals Command Reference

139

C commands configure replace

Reverting to the Startup Configuration File

The following example shows how to revert to the Cisco IOS startup configuration file. This example also shows the use of the optional force keyword to override the interactive user prompt.

Router# configure replace nvram:startup-config force

Total number of passes: 1

Rollback Done

Performing a Configuration Replace Operation with the configure confirm Command

The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command).

Router# configure replace nvram:startup-config time 120

Total number of passes: 1

Rollback Done

Router# configure confirm

Performing a Configuration Rollback Operation

The following example shows how to make changes to the current running configuration and then roll back the changes. As part of the configuration rollback operation, you must save the current running configuration before making changes to the file. In this example, the archive config command is used to save the current running configuration. Note that the generated output of the configure replace command indicates that only one pass was performed to complete the rollback operation.

Note The path command must be configured before using the archive config command.

You first save the current running configuration in the configuration archive as follows:

Router# archive config

You then enter configuration changes as shown in the following example:

Router# configure terminal

Router(config)# user netops2 password rain

Router(config)# user netops3 password snow

Router(config)# exit

After making changes to the running configuration file, you might want to roll back these changes and revert to the configuration that existed before the changes were made. The show archive command is used to verify the version of the configuration to be used as a target file. The configure replace command is then used to revert to the target configuration file as shown in the following example:

Router# show archive

There are currently 1 archive configurations saved.

The next archive file will be named disk0:myconfig-2

Archive # Name

140

Cisco IOS Configuration Fundamentals Command Reference

C commands configure replace

1 disk0:myconfig-1 <- Most Recent

Router# configure replace disk0:myconfig-1

Total number of passes: 1

Rollback Done

Related Commands

Command

archive config

configure confirm maximum path

show archive time-period

Description

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

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

141

C commands configure revert

configure revert

To cancel the timed rollback and trigger the rollback immediately, or to reset parameters for the timed rollback, use the configure revertcommand in privileged EXEC mode.

configure revert {now | timer {minutes | idle minutes}}

Syntax Description now timer minutes idle minutes

Cancels the timed rollback and reverts immediately.

Resets the confirmation timer.

Time in minutes (1-120).

Idle time in minutes (1-120) for which to wait before rollback.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SRC

12.2(33)SB

12.4(20)T

12.2(33)SXI

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.4(20)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines In order to use the configure revert command to configure a timed rollback, the Configuration Archive functionality must be enable first. The Configuration Archive APIs are used to store the current configuration before applying any changes or rolling back to the previous configuration.

In case of multi-user environments, only the user who enabled the timed rollback functionality will have the permission to perform the following operations:

• Confirm the configuration change

• Reset the timer

• Cancel the timer and trigger rollback immediately

142

Cisco IOS Configuration Fundamentals Command Reference

C commands configure revert

Examples The following example shows how to cancel the timed rollback and revert to the saved configuration immediately:

Rourter(config)# archive

Router(config-archive)# path disk0:abc

Router# configure revert now

Related Commands

Command

archive config

configure replace maximum

path (config-archive)

show archive time-period

Description

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

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

143

C commands configure terminal

configure terminal

To enter global configuration mode, use the configure terminal command in privileged EXEC mode.

configure terminal

Cisco IOS Releases 12.3(14)T and Subsequent Releases:

configure terminal [lock]

Cisco IOS Releases 12.2(33)SRC and Subsequent Releases:

configure terminal [revert {timer minutes | idle minutes}]

Syntax Description lock revert

timer minutes idle minutes

(Optional) Locks the running configuration into exclusive configuration mode for the duration of your configuration session. This keyword only functions if the configuration mode

exclusivecommand was previously enabled.

(Optional) Sets the parameters for reverting the configuration if confirmation of the new configuration is not received.

Time in minutes (1-120) for which to wait for confirmation.

Idle time in minutes (1-120) for which to wait for confirmation.

Command Modes Privileged EXEC (#)

Command History

Release

10.0

12.3(14)T

12.0(31)S

12.2(33)SRA

Modification

This command was introduced.

The lock keyword option was added.

This command was integrated into Cisco IOS

Release 12.0(31)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

144

Cisco IOS Configuration Fundamentals Command Reference

C commands configure terminal

Release

12.4(20)T

12.2(33)SB

12.2(33)SXI

Modification

The revertkeyword option was added, along with the timer parameters of idle and minutes.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines Use this command to enter global configuration mode. Note that commands in this mode are written to the running configuration file as soon as you enter them (using the Enter key/Carriage Return).

After you enter the configure terminalcommand, the system prompt changes from <router-name># to

<router-name>(config)# , indicating that the router is in global configuration mode. To leave global configuration mode and return to privileged EXEC mode, type exit or press Ctrl-Z.

To view the changes to the configuration you have made, use the more system:running-config command or show running-config command in user EXEC or privileged EXEC mode.

Configuration Locking

The first user to enter the configure terminal lockcommand acquires the configuration lock (exclusive configuration mode).

Examples The following example shows how to enter global configuration mode and lock the Cisco IOS software in exclusive mode:

Router(config)# configure terminal lock

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)#

Related Commands

Command

boot config

configuration mode exclusive

copy running-config startup-config or

copy system:running-config nvram:startup- config

Description

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Enables locking of the configuration file for single user access.

Saves the running configuration as the startup configuration file.

Cisco IOS Configuration Fundamentals Command Reference

145

configure terminal

Command

show running-config or

more system:running-config

C commands

Description

Displays the currently running configuration.

146

Cisco IOS Configuration Fundamentals Command Reference

C commands confreg

confreg

To change the configuration register settings while in ROM monitor mode, use the confreg command in

ROM monitor mode.

confreg [value]

Syntax Description value (Optional) Hexadecimal value that represents the

16-bit configuration register value that you want to use the next time the router is restarted. The value range is from 0x0 to 0xFFFF.

Command Default Refer to your platform documentation for the default configuration register value.

Command Modes ROM monitor

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Not all versions in the ROM monitor support this command. Refer to your platform documentation for more information on ROM monitor mode.

If you use this command without specifying the configuration register value, the router prompts for each bit of the configuration register.

The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network.

To change the boot field value and leave all other bits set to their default values, follow these guidelines:

• If you set the configuration register boot field value to 0x0, you must boot the operating system manually with the boot command.

• If you set the configuration register boot field value to 0x1, the router boots using the default ROM software.

• If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot field value to form a default boot filename for booting from a network server.

For more information about the configuration register bit settings and default filenames, refer to the appropriate router hardware installation guide.

Cisco IOS Configuration Fundamentals Command Reference

147

C commands confreg

Examples In the following example, the configuration register is set to boot the system image from Flash memory: confreg 0x210F

In the following example, no configuration value is entered, so the system prompts for each bit in the register: rommon 7 > confreg

Configuration Summary enabled are: console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n [n]: y enable "diagnostic mode"? y/n [n]: y enable "use net in IP bcast address"? y/n [n]: enable "load rom after netboot fails"? y/n [n]: enable "use all zero broadcast"? y/n [n]: enable "break/abort has effect"? y/n [n]: enable "ignore system config info"? y/n [n]: change console baud rate? y/n [n]: y enter rate: 0 = 9600, 1 = 4800, 2 = 1200, 3 = 2400 [0]: 0 change the boot characteristics? y/n [n]: y enter to boot:

0 = ROM Monitor

1 = the boot helper image

2-15 = boot system

[0]: 0

Configuration Summary enabled are: diagnostic mode console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n [n]:

You must reset or power cycle for new config to take effect.

rommon 8>

148

Cisco IOS Configuration Fundamentals Command Reference

C commands continue (ROM monitor)

continue (ROM monitor)

To return to EXEC mode from ROM monitor mode, use the continue command in ROM monitor mode.

continue

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes ROM monitor

Command History

Release

11.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to return to EXEC mode from ROM monitor mode, to use the system image instead of reloading. On older platforms, the angle bracket (< >) indicates that the router is in ROM monitor mode.

On newer platforms, rommon number> is the default ROM monitor prompt. Typically, the router is in

ROM monitor mode when you manually load a system image or perform diagnostic tests. Otherwise, the router will most likely never be in this mode.

Caution While in ROM monitor mode, the Cisco IOS system software is suspended until you issue either a reset or the continue command.

Examples In the following example, the continue command switches the router from ROM monitor to EXEC mode:

> continue

Router#

Cisco IOS Configuration Fundamentals Command Reference

149

continue (ROM monitor)

Related Commands

Command boot

Description

Boots the router manually.

C commands

150

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

copy

To copy any file from a source to a destination, use the copy command in privileged EXEC or diagnostic mode.

copy [/erase] [/verify | /noverify] source-url destination-url

Syntax Description

/erase

/verify

/noverify source-url destination-url

(Optional) Erases the destination file system before copying.

Note This option is typically provided on platforms with limited memory to allow for an easy way to clear local flash memory space.

(Optional) Verifies the digital signature of the destination file. If verification fails, the file is deleted from the destination file system. This option applies to Cisco IOS software image files only.

(Optional) If the file being copied is an image file, this keyword disables the automatic image verification that occurs after an image is copied.

Note This keyword is often issued if the file

verify auto command is enabled, which automatically verifies the digital signature of all images that are copied.

The location URL (or alias) of the source file or directory to be copied. The source can be either local or remote, depending upon whether the file is being downloaded or uploaded.

The destination URL (or alias) of the copied file or directory. The destination can be either local or remote, depending upon whether the file is being downloaded or uploaded.

The exact format of the source and destination URLs varies according to the file or directory location. You may enter either an alias keyword for a particular file or a filename that follows the standard Cisco IOS file system syntax (filesystem :[/filepath ][/filename ]).

The table below shows two keyword shortcuts to URLs.

Cisco IOS Configuration Fundamentals Command Reference

151

copy

C commands

Table 11

Keyword running-config

Common Keyword Aliases to URLs startup-config

Source or Destination

(Optional) Keyword alias for the system:running-

config URL. The system:running-config keyword represents the current running configuration file.

This keyword does not work in more and show file

EXEC command syntaxes.

(Optional) Keyword alias for the nvram:startup-

configURL. The nvram:startup-config keyword represents the configuration file used during initialization (startup). This file is contained in

NVRAM for all platforms except the Cisco 7000 family, which uses the CONFIG_FILE environment variable to specify the startup configuration. The

Cisco 4500 series cannot use the copy running-

config startup-configcommand. This keyword does not work in more and show file EXEC command syntaxes.

The following tables list URL prefix keywords by file system type. The available file systems will vary by platform. If you do not specify a URL prefix keyword, the router looks for a file in the current directory.

The table below lists URL prefix keywords for Special (opaque) file systems.

Table 12 URL Prefix Keywords for Special File Systems

Keyword cns: flh: logging modem: null: nvram: obfl: stby-nvram:

Source or Destination

Source URL for Cisco Networking Services files.

Source URL for flash load helper log files.

Source URL which copies messages from the logging buffer to a file.

Destination URL for loading modem firmware on to supported networking devices.

Null destination for copies or files. You can copy a remote file to null to determine its size.

Router NVRAM. You can copy the startup configuration to NVRAM or from NVRAM.

Source or destination URL for Onboard Failure

Logging files.

Router NVRAM on the standby hardware. You can copy the startup configuration to NVRAM or from

NVRAM.

152

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Keyword stby-obfl: system: tar: tmpsys: xmodem: ymodem:

Source or Destination

Source or destination URL for Onboard Failure

Logging files on the standby hardware.

Source or destination URL for system memory, which includes the running configuration.

Source URL for the archive file system.

Source or destination URL for the temporary system files.

Source or destination for a file from a network machine that uses the Xmodem protocol.

Source or destination for a file from a network machine that uses the Ymodem protocol.

The table belows lists URL prefix keywords for remote file systems.

Table 13 URL Prefix Keywords for Remote File Systems

Keyword ftp: http:// https:// rcp: scp:

Source or Destination

Source or destination URL for FTP network server.

The syntax for this alias is as follows:ftp:[[[// username [:password]@]location]/directory]/ filename.

Source or destination URL for an HTTP server

(also called a web server). The syntax for this alias is as follows: http:// [[username:password]@]

{hostname | host-ip}[/ filepath]/ filename

Source or destination URL for a Secure HTTP

(HTTPS) server. HTTPS uses Secure Socket Layer

(SSL) encryption. The syntax for this alias is as follows:https://[[username:password]@]{hostname

| host-ip}[/ filepath]/ filename

Source or destination URL for a remote copy protocol (rcp) network server. The syntax for this alias is as follows:rcp:[[[//username@ ] location]/ directory]/filename

Source or destination URL for a network server that supports Secure Shell (SSH) and accepts copies of files using the secure copy protocol (scp). The syntax for this alias is as follows:scp://

username@location[/directory][/filename]

Cisco IOS Configuration Fundamentals Command Reference

153

copy

C commands

Keyword tftp:

Source or Destination

Source or destination URL for a TFTP network server. The syntax for this alias is as follows:tftp:

[[//location]/directory]/filename.

The table below lists URL prefix keywords for local writable storage file systems.

Table 14 URL Prefix Keywords for Local Writable Storage File Systems

Alias bootflash:

disk0: and disk1: flash: harddisk: slavebootflash: slaveram: slaveslot0: slaveslot1: slot0: slot1: stby-bootflash: stby-harddisk:

Source or Destination

Source or destination URL for boot flash memory.

Source or destination URL of disk-based media.

Source or destination URL for flash memory. This alias is available on all platforms. For platforms that lack a flash: device, note that flash: is aliased to slot0:, allowing you to refer to the main flash memory storage area on all platforms.

Source or destination URL of the active harddisk file system.

Source or destination URL for internal flash memory on the slave RSP card of a router configured for HSA.

NVRAM on a slave RSP card of a router configured for HSA.

Source or destination URL of the first Personal

Computer Memory Card International Association

(PCMCIA) card on a slave RSP card of a router configured for HSA.

Source or destination URL of the second PCMCIA slot on a slave RSP card of a router configured for

HSA.

Source or destination URL of the first PCMCIA flash memory card.

Source or destination URL of the second PCMCIA flash memory card.

Source or destination URL for boot flash memory in standby RP.

Source or destination URL for the standby harddisk.

154

Cisco IOS Configuration Fundamentals Command Reference

C commands

Alias stby-usb [ 0-1 ] : usb [ 0-1 ] :

usbflash 0 9 : usbtoken [0 9] :

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

11.3T

12.3(2)T

12.2(14)S

12.2(18)S

12.0(26)S

12.3(4)T

12.3(7)T

12.3(14)T copy

Source or Destination

Source or destination URL for the Universal Serial

Bus (USB) flash drive that has been plugged into the router and is located on the standby RP.

Source or destination URL for the Universal Serial

Bus (USB) flash drive that has been plugged into the router and is located on the active RP.

Source or destination URL for the Universal Serial

Bus (USB) flash drive that has been plugged into the router.

Source or destination URL for the USB eToken that has been plugged into the router.

Modification

This command was introduced.

• The http:// and https:// keywords were added as supported remote source locations (file system URL prefixes) for files.

• This command was enhanced to support copying files to servers that support SSH and the scp.

This command was integrated into Cisco IOS

Release 12.2(14)S.

The /verifyand /noverify keywords were added.

The /verifyand /noverify keywords were integrated into Cisco IOS Release 12.0(26)S.

The /verifyand /noverify keywords were integrated into Cisco IOS Release 12.3(4)T.

The http:// and https:// keywords were enhanced to support file uploads.

The usbflash 0 9 :and usbtoken 0 9 :keywords were added to support USB storage.

Cisco IOS Configuration Fundamentals Command Reference

155

C commands copy

Release

12.2(28)SB

12.2(25)SG

12.4(11)T

12.2(33)SXH

Cisco IOS XE Release 2.1

Modification

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(25)SG.

This command was integrated into the Cisco

7200VXR NPE-G2 platform.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

The Cisco ASR1000 series routers became available, and introduced the copy command in diagnostic mode.

Usage Guidelines

The fundamental function of the copy command is to allow you to copy a file (such as a system image or configuration file) from one location to another location. The source and destination for the file is specified using a Cisco IOS File System URL, which allows you to specify any supported local or remote file location. The file system being used (such as a local memory source, or a remote server) dictates the syntax used in the command.

You can enter on the command line all necessary source- and destination-URL information and the username and password to use, or you can enter the copy command and have the router prompt you for any missing information.

For local file systems, two commonly used aliases exist for the system:running-config and

nvram:startup-config files; these aliases are running-config and startup-config, respectively.

Timesaver Aliases are used to reduce the amount of typing you need to perform. For example, it is easier to type copy

run start (the abbreviated form of the copy running-config startup-config command) than it is to type

copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-

configcommand). These aliases also allow you to continue using some of the common commands used in previous versions of Cisco IOS software.

The entire copying process may take several minutes and differs from protocol to protocol and from network to network.

The colon is required after the file system URL prefix keywords (such as flash). In some cases, file system prefixes that did not require colons in earlier software releases are allowed for backwards compatibility, but use of the colon is recommended.

In the URL syntax for ftp:, http:, https:, rcp:, scp: and tftp:, the location is either an IP address or a host name. The filename is specified relative to the directory used for file transfers.

The following sections contain usage guidelines for the following topics:

Understanding Invalid Combinations of Source and Destination

Some invalid combinations of source and destination exist. Specifically, you cannot copy:

• From a running configuration to a running configuration

156

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

• From a startup configuration to a startup configuration

• From a device to the same device (for example, the copy flash: flash: command is invalid)

Understanding Character Descriptions

The table below describes the characters that you may see during processing of the copycommand.

Table 15 copy Character Descriptions

Character

O e

Description

For network transfers, an exclamation point indicates that the copy process is taking place. Each exclamation point indicates the successful transfer of ten packets (512 bytes each).

For network transfers, a period indicates that the copy process timed out. Many periods in a row typically mean that the copy process may fail.

For network transfers, an uppercase O indicates that a packet was received out of order and the copy process may fail.

For flash erasures, a lowercase e indicates that a device is being erased.

An uppercase E indicates an error. The copy process may fail.

A series of uppercase Vs indicates the progress during the verification of the image checksum.

Understanding Partitions

You cannot copy an image or configuration file to a flash partition from which you are currently running.

For example, if partition 1 is running the current system image, copy the configuration file or image to partition 2. Otherwise, the copy operation will fail.

You can identify the available flash partitions by entering the show file system EXECcommand.

Using rcp

The rcp requires a client to send a remote username upon each rcp request to a server. When you copy a configuration file or image between the router and a server using rcp, the Cisco IOS software sends the first valid username it encounters in the following sequence:

1 The remote username specified in the copy command, if a username is specified.

2 The username set by the ip rcmd remote-username global configuration command, if the command is configured.

3 The remote username associated with the current tty (terminal) process. For example, if the user is connected to the router through Telnet and was authenticated through the username command, the router software sends the Telnet username as the remote username.

4 The router host name.

For the rcp copy request to process, an account must be defined on the network server for the remote username. If the network administrator of the destination server did not establish an account for the remote

Cisco IOS Configuration Fundamentals Command Reference

157

C commands copy username, this command will not run. If the server has a directory structure, the configuration file or image is written to or copied from the directory associated with the remote username on the server. For example, if the system image resides in the home directory of a user on the server, specify that username as the remote username.

If you are writing to the server, the rcp server must be properly configured to accept the rcp write request from the user on the router. For UNIX systems, add an entry to the .rhosts file for the remote user on the rcp server. Suppose the router contains the following configuration lines: hostname Rtr1 ip rcmd remote-username User0

If the router IP address translates to Router1.company.com, then the .rhosts file for User0 on the rcp server should contain the following line:

Router1.company.com Rtr1

Refer to the documentation for your rcp server for more details.

If you are using a personal computer as a file server, the computer must support the remote shell protocol

(rsh).

Using FTP

The FTP protocol requires a client to send a username and password with each FTP request to a remote

FTP server. Use the ip ftp username and ip ftp password global configuration commands to specify a default username and password for all copy operations to or from an FTP server. Include the username in the copy command syntax if you want to specify a username for that copy operation only.

When you copy a file from the router to a server using FTP, the Cisco IOS software sends the first valid username that it encounters in the following sequence:

1 The username specified in the copy command, if a username is specified.

2 The username set by the ip ftp username command, if the command is configured.

3 Anonymous.

The router sends the first valid password in the following list:

1 The password specified in the copy command, if a password is specified.

2 The password set by the ip ftp password command, if the command is configured.

3 The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router.

The username and password must be associated with an account on the FTP server. If you are writing to the server, the FTP server must be properly configured to accept the FTP write request from the user on the router.

Note The Syslog message will display 'xxxx' in place of the password entered in the syntax of the copy {ftp:} command.

If the server has a directory structure, the configuration file or image is written to or copied from the directory associated with the username on the server. For example, if the system image resides in the home directory of a user on the server, specify that username as the remote username.

Refer to the documentation for your FTP server for details on setting up the server.

Using HTTP or HTTPS

158

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Copying a file to or from a remote HTTP or HTTPS server, to or from a local file system, is performed using the embedded Secure HTTP client that is integrated in Cisco IOS software. The HTTP client is enabled by default.

Downloading files from a remote HTTP or HTTPS server is performed using the HTTP client integrated in

Cisco IOS software.

If a username and password are not specified in the copy command syntax, the system uses the default

HTTP client username and password, if configured.

When you copy a file from a remote HTTP or HTTPS server, the Cisco IOS software sends the first valid username that it encounters in the following sequence:

1 The username specified in the copy command, if a username is specified.

2 The username set by the ip http client username command, if the command is configured.

3 Anonymous.

The router sends the first valid password in the following list:

1 The password specified in the copy command, if a password is specified.

2 The password set by the ip http client password command, if the command is configured.

3 The router forms the password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router.

Storing Images on Servers

Use the copy flash: destination-urlcommand (for example, copy flash: tftp:) to copy a system image or boot image from flash memory to a network server. You can use the copy of the image as a backup copy.

Also, you can also use the image backup file to verify that the image in flash memory is the same as that in the original file.

Copying from a Server to Flash Memory

Use the copy destination-url flash: command (for example, copy tftp: flash:) to copy an image from a server to flash memory.

On Class B file system platforms, the system provides an option to erase existing flash memory before writing onto it.

Note Verify the image in flash memory before booting the image.

Verifying Images

When copying a new image to your router, you should confirm that the image was not corrupted during the copy process. You can verify the integrity of the image in any of the following ways:

• Depending on the destination file system type, a checksum for the image file may be displayed when the copy command completes. You can verify this checksum by comparing it to the checksum value provided for your image file on Cisco.com.

Cisco IOS Configuration Fundamentals Command Reference

159

C commands copy

Caution If the checksum values do not match, do not reboot the router. Instead, reissue the copycommand and compare the checksums again. If the checksum is repeatedly wrong, copy the original image back into flash memory beforeyou reboot the router from flash memory. If you have a corrupted image in flash memory and try to boot from flash memory, the router will start the system image contained in ROM (assuming booting from a network server is not configured). If ROM does not contain a fully functional system image, the router might not function and will need to be reconfigured through a direct console port connection.

• Use the /verifykeyword.

• Enable automatic image verification by default by issuing the file verify auto command. This command will automatically check the integrity of each file that is copied via the copy command

(without specifying the /verifyoption) to the router unless the /noverify keyword is specified.

• Use the UNIX 'diff' command. This method can also be applied to file types other than Cisco IOS images. If you suspect that a file is corrupted, copy the suspect file and the original file to a UNIX server. (The file names may need to be modified if you try to save the files in the same directory.)

Then run the UNIX 'diff' command on the two files. If there is no difference, then the file has not been corrupted.

Copying a Configuration File from a Server to the Running Configuration

Use the copy {ftp: | rcp: | scp: | tftp: running-configcommand to load a configuration file from a network server to the running configuration of the router. (Note that running-config is the alias for the

system:running-config keyword.) The configuration will be added to the running configuration as if the commands were typed in the command-line interface (CLI). Thus, the resulting configuration file will be a combination of the previous running configuration and the loaded configuration file, with the loaded configuration file having precedence.

You can copy either a host configuration file or a network configuration file. Accept the default value of

host to copy and load a host configuration file containing commands that apply to one network server in particular. Enter network to copy and load a network configuration file containing commands that apply to all network servers on a network.

Copying a Configuration File from a Server to the Startup Configuration

Use the copy {ftp: | rcp: | scp: | tftp:} nvram:startup-configcommand to copy a configuration file from a network server to the router startup configuration. These commands replace the startup configuration file with the copied configuration file.

Storing the Running or Startup Configuration on a Server

Use the copy system:running-config {ftp: | rcp: | scp: | tftp:} command to copy the current configuration file to a network server using FTP, rcp, scp, or TFTP. Use the copy nvram:startup-config {ftp: | rcp: |

scp: | tftp:} command to copy the startup configuration file to a network server.

The configuration file copy can serve as a backup copy.

Saving the Running Configuration to the Startup Configuration

Use the copy system:running-config nvram:startup-config command to copy the running configuration to the startup configuration.

160

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Note Some specific commands might not get saved to NVRAM. You will need to enter these commands again if you reboot the machine. These commands are noted in the documentation. We recommend that you keep a listing of these settings so you can quickly reconfigure your router after rebooting.

If you issue the copy system:running-config nvram:startup-configcommand from a bootstrap system image, a warning will instruct you to indicate whether you want your previous NVRAM configuration to be overwritten and configuration commands to be lost. This warning does not appear if NVRAM contains an invalid configuration or if the previous configuration in NVRAM was generated by a bootstrap system image.

On all platforms except Class A file system platforms, the copy system:running-config nvram:startup-

config command copies the currently running configuration to NVRAM.

On the Class A flash file system platforms, the copy system:running-config nvram:startup-config command copies the currently running configuration to the location specified by the CONFIG_FILE environment variable. This variable specifies the device and configuration file used for initialization. When the CONFIG_FILE environment variable points to NVRAM or when this variable does not exist (such as at first-time startup), the software writes the current configuration to NVRAM. If the current configuration is too large for NVRAM, the software displays a message and stops executing the command.

When the CONFIG_FILE environment variable specifies a valid device other than nvram: (that is, flash:,

bootflash:, slot0:, or slot1:), the software writes the current configuration to the specified device and filename, and stores a distilled version of the configuration in NVRAM. A distilled version is one that does not contain access list information. If NVRAM already contains a copy of a complete configuration, the router prompts you to confirm the copy.

Using CONFIG_FILE, BOOT, and BOOTLDR Environment Variables

For the Class A flash file system platforms, specifications are as follows:

• The CONFIG_FILE environment variable specifies the configuration file used during router initialization.

• The BOOT environment variable specifies a list of bootable images on various devices.

• The BOOTLDR environment variable specifies the flash device and filename containing the rxboot image that ROM uses for booting.

• Cisco 3600 routers do not use a dedicated boot helper image (rxboot), which many other routers use to help with the boot process. Instead, the BOOTLDR ROM monitor environment variable identifies the flash memory device and filename that are used as the boot helper; the default is the first system image in flash memory.

To view the contents of environment variables, use the show bootvar EXEC command. To modify the

CONFIG_FILE environment variable, use the boot config global configuration command. To modify the

BOOTLDR environment variable, use the boot bootldr global configuration command. To modify the

BOOT environment variable, use the boot system global configuration command. To save your modifications, use the copy system:running-config nvram:startup-configcommand.

When the destination of a copy command is specified by the CONFIG_FILE or BOOTLDR environment variable, the router prompts you for confirmation before proceeding with the copy. When the destination is the only valid image in the BOOT environment variable, the router also prompts you for confirmation before proceeding with the copy.

Using the Copy Command with the Dual RSP Feature

The Dual RSP feature allows you to install two Route Switch Processor (RSP) cards in a single router on the Cisco 7507 and Cisco 7513 platforms.

Cisco IOS Configuration Fundamentals Command Reference

161

C commands copy

Examples

On a Cisco 7507 or Cisco 7513 router configured for Dual RSPs, if you copy a file to nvram:startup-

configuration with automatic synchronization disabled, the system prompts whether you also want to copy the file to the slave startup configuration. The default answer is yes. If automatic synchronization is enabled, the system automatically copies the file to the slave startup configuration each time you use a

copy command with nvram:startup-configuration as the destination.

Using the copy command with the ASR1000 Series Routers

The copy command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 series routers. Because the copycommand is available in diagnostic mode, it can be used to copy all types of files between directories and remote locations even in the event of an IOS failure.

The following examples illustrate uses of the copy command:

Verifying the Integrity of the Image Before It Is Copied Example

The following example shows how to specify image verification before copying an image:

Router# copy /verify tftp://10.1.1.1/cisco/c7200-js-mz disk0:

Destination filename [c7200-js-mz]?

Accessing tftp://10.1.1.1/cisco/c7200-js-mz...

Loading cisco/c7200-js-mz from 10.1.1.1 (via FastEthernet0/0):!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

[OK - 19879944 bytes]

19879944 bytes copied in 108.632 secs (183003 bytes/sec)

Verifying file integrity of disk0:/c7200-jsmz ...................................................

..........................................................................................

.........

..........................................................................................

.........

.......................................Done!

Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCD

Computed Hash MD5 :CFA258948C4ECE52085DCF428A426DCD

CCO Hash MD5 :44A7B9BDDD9638128C35528466318183

Signature Verified

Copying an Image from a Server to Flash Memory Examples

The following examples use a copy rcp:, copy tftp:, or copy ftp: command to copy an image file from a server to flash memory:

Copying an Image from a Server to Flash Memory Example

The following example copies a system image named file1 from the remote rcp server with an IP address of

172.16.101.101 to flash memory. On Class B file system platforms, the Cisco IOS software allows you to first erase the contents of flash memory to ensure that enough flash memory is available to accommodate the system image.

Router# copy rcp://[email protected]/file1 flash:file1

Destination file name [file1]?

Accessing file 'file1' on 172.16.101.101...

Loading file1 from 172.16.101.101 (via Ethernet0): ! [OK]

Erase flash device before writing? [confirm]

Flash contains files. Are you sure you want to erase? [confirm]

Copy 'file1' from server

as 'file1' into Flash WITH erase? [yes/no] yes

162

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee...erased

Loading file1 from 172.16.101.101 (via Ethernet0): !

[OK - 984/8388608 bytes]

Verifying checksum... OK (0x14B3)

Flash copy took 0:00:01 [hh:mm:ss]

Copying an Image from a Server to a Flash Memory Using Flash Load Helper Example

The following example copies a system image into a partition of flash memory. The system will prompt for a partition number only if there are two or more read/write partitions or one read-only and one read/write partition and dual flash bank support in boot ROMs. If the partition entered is not valid, the process terminates. You can enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (? number) for directory display of a particular partition. The default is the first read/write partition. In this case, the partition is read-only and has dual flash bank support in boot

ROM, so the system uses flash Load Helper.

Router# copy tftp: flash:

System flash partition information:

Partition Size Used Free Bank-Size State Copy-Mode

1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH

2 4096K 2048K 2048K 2048K Read/Write Direct

[Type ?<no> for partition directory; ? for full directory; q to abort]

Which partition? [default = 2]

**** NOTICE ****

Flash load helper v1.0

This process will accept the copy options and then terminate the current system image to use the ROM based image for the copy.

Routing functionality will not be available during that time.

If you are logged in via telnet, this connection will terminate.

Users with console access can see the results of the copy operation.

---- ******** ----

Proceed? [confirm]

System flash directory, partition 1:

File Length Name/status

1 3459720 master/igs-bfpx.100-4.3

[3459784 bytes used, 734520 available, 4194304 total]

Address or name of remote host [255.255.255.255]? 172.16.1.1

Source file name? master/igs-bfpx-100.4.3

Destination file name [default = source name]?

Loading master/igs-bfpx.100-4.3 from 172.16.1.111: !

Erase flash device before writing? [confirm]

Flash contains files. Are you sure? [confirm]

Copy 'master/igs-bfpx.100-4.3' from TFTP server as 'master/igs-bfpx.100-4.3' into Flash WITH erase? [yes/no] yes

Copying an Image from a Server to a Flash Memory Card Partition Example

The following example copies the file c3600-i-mz from the rcp server at IP address 172.23.1.129 to the flash memory card in slot 0 of a Cisco 3600 series router, which has only one partition. As the operation progresses, the Cisco IOS software prompts you to erase the files on the flash memory PC card to accommodate the incoming file. This entire operation takes 18 seconds to perform, as indicated at the end of the example.

Router# copy rcp: slot0:

PCMCIA Slot0 flash

Partition Size Used Free Bank-Size State Copy Mode

1 4096K 3068K 1027K 4096K Read/Write Direct

2 4096K 1671K 2424K 4096K Read/Write Direct

3 4096K 0K 4095K 4096K Read/Write Direct

4 4096K 3825K 270K 4096K Read/Write Direct

[Type ?<no> for partition directory; ? for full directory; q to abort]

Which partition? [default = 1]

Cisco IOS Configuration Fundamentals Command Reference

163

C commands copy

PCMCIA Slot0 flash directory, partition 1:

File Length Name/status

1 3142288 c3600-j-mz.test

[3142352 bytes used, 1051952 available, 4194304 total]

Address or name of remote host [172.23.1.129]?

Source file name? /tftpboot/images/c3600-i-mz

Destination file name [/tftpboot/images/c3600-i-mz]?

Accessing file '/tftpboot/images/c3600-i-mz' on 172.23.1.129...

Connected to 172.23.1.129

Loading 1711088 byte file c3600-i-mz: ! [OK]

Erase flash device before writing? [confirm]

Flash contains files. Are you sure you want to erase? [confirm]

Copy '/tftpboot/images/c3600-i-mz' from server

as '/tftpboot/images/c3600-i-mz' into Flash WITH erase? [yes/no] yes

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

Connected to 172.23.1.129

Loading 1711088 byte file c3600-imz: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Verifying checksum... OK (0xF89A)

Flash device copy took 00:00:18 [hh:mm:ss]

Saving a Copy of an Image on a Server Examples

The following examples use copy commands to copy image files to a server for storage:

Copy an Image from Flash Memory to an rcp Server Example

The following example copies a system image from flash Memory to an rcp server using the default remote username. Because the rcp server address and filename are not included in the command, the router prompts for it.

Router# copy flash: rcp:

IP address of remote host [255.255.255.255]? 172.16.13.110

Name of file to copy? gsxx writing gsxx - copy complete

Copy an Image from Flash Memory to an SSH Server Using scp Example

The following example shows how to use scp to copy a system image from flash memory to a server that supports SSH:

Router# copy flash:c4500-ik2s-mz.scp scp://user1@host1/

Address or name of remote host [host1]?

Destination username [user1]?

Destination filename [c4500-ik2s-mz.scp]?

Writing c4500-ik2s-mz.scp

Password:

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Before you can use the server-side functionality, SSH, authentication, and authorization must be properly configured so the router can determine whether a user is at the right privilege level. The scp server-side functionality is configured with the ip scp server enable command.

Copy an Image from a Partition of Flash Memory to a Server Example

The following example copies an image from a particular partition of flash memory to an rcp server using a remote username of netadmin1.

164

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

The system will prompt if there are two or more partitions. If the partition entered is not valid, the process terminates. You have the option to enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (? number) for a directory display of a particular partition.

The default is the first partition.

Router# configure terminal

Router# ip rcmd remote-username netadmin1

Router# end

Router# copy flash: rcp:

System flash partition information:

Partition Size Used Free Bank-Size State Copy-Mode

1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH

2 4096K 2048K 2048K 2048K Read/Write Direct

[Type ?<number> for partition directory; ? for full directory; q to abort]

Which partition? [1] 2

System flash directory, partition 2:

File Length Name/status

1 3459720 master/igs-bfpx.100-4.3

[3459784 bytes used, 734520 available, 4194304 total]

Address or name of remote host [ABC.CISCO.COM]?

Source file name? master/igs-bfpx.100-4.3

Destination file name [master/igs-bfpx.100-4.3]?

Verifying checksum for 'master/igs-bfpx.100-4.3' (file # 1)... OK

Copy 'master/igs-bfpx.100-4.3' from Flash to server as 'master/igs-bfpx.100-4.3'? [yes/no] yes

!!!!...

Upload to server done

Flash copy took 0:00:00 [hh:mm:ss]

Copying an Image from a Flash Memory File System to an FTP Server Example

The following example copies the file c3600-i-mz from partition 1 of the flash memory card in slot 0 to an

FTP server at IP address 172.23.1.129:

Router# show slot0: partition 1

PCMCIA Slot0 flash directory, partition 1:

File Length Name/status

1 1711088 c3600-i-mz

[1711152 bytes used, 2483152 available, 4194304 total]

Router# copy slot0:1:c3600-i-mz ftp://myuser:[email protected]/c3600-i-mz

Verifying checksum for '/tftpboot/cisco_rules/c3600-i-mz' (file # 1)... OK

Copy '/tftpboot/cisco_rules/c3600-i-mz' from Flash to server

as 'c3700-i-mz'? [yes/no] yes

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Upload to server done

Flash device copy took 00:00:23 [hh:mm:ss]

Copying an Image from Boot Flash Memory to a TFTP Server Example

The following example copies an image from boot flash memory to a TFTP server:

Router# copy bootflash:file1 tftp://192.168.117.23/file1

Verifying checksum for 'file1' (file # 1)... OK

Copy 'file1' from Flash to server

as 'file1'? [yes/no]y

!!!!...

Upload to server done

Flash copy took 0:00:00 [hh:mm:ss]

Cisco IOS Configuration Fundamentals Command Reference

165

copy

C commands

Copying a Configuration File from a Server to the Running Configuration Example

The following example copies and runs a configuration filename host1-confg from the netadmin1 directory on the remote server with an IP address of 172.16.101.101:

Router# copy rcp://[email protected]/host1-confg system:running-config

Configure using host1-confg from 172.16.101.101? [confirm]

Connected to 172.16.101.101

Loading 1112 byte file host1-confg:![OK]

Router#

%SYS-5-CONFIG: Configured from host1-config by rcp from 172.16.101.101

Copying a Configuration File from a Server to the Startup Configuration Example

The following example copies a configuration file host2-confg from a remote FTP server to the startup configuration. The IP address is 172.16.101.101, the remote username is netadmin1, and the remote password is ftppass.

Router# copy ftp://netadmin1:[email protected]/host2-confg nvram:startup-config

Configure using rtr2-confg from 172.16.101.101?[confirm]

Connected to 172.16.101.101

Loading 1112 byte file rtr2-confg:![OK]

[OK]

Router#

%SYS-5-CONFIG_NV:Non-volatile store configured from rtr2-config by

FTP from 172.16.101.101

Copying the Running Configuration to a Server Example

The following example specifies a remote username of netadmin1. Then it copies the running configuration file named rtr2-confg to the netadmin1 directory on the remote host with an IP address of 172.16.101.101.

Router# configure terminal

Router(config)# ip rcmd remote-username netadmin1

Router(config)# end

Router# copy system:running-config rcp:

Remote host[]? 172.16.101.101

Name of configuration file to write [Rtr2-confg]?

Write file rtr2-confg on host 172.16.101.101?[confirm]

Building configuration...[OK]

Connected to 172.16.101.101

Copying the Startup Configuration to a Server Example

The following example copies the startup configuration to a TFTP server:

Router# copy nvram:startup-config tftp:

Remote host[]? 172.16.101.101

Name of configuration file to write [rtr2-confg]? <cr>

Write file rtr2-confg on host 172.16.101.101?[confirm] <cr>

![OK]

166

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Saving the Current Running Configuration Example

The following example copies the running configuration to the startup configuration. On a Class A flash file system platform, this command copies the running configuration to the startup configuration specified by the CONFIG_FILE variable.

copy system:running-config nvram:startup-config

The following example shows the warning that the system provides if you try to save configuration information from bootstrap into the system:

Router(boot)# copy system:running-config nvram:startup-config

Warning: Attempting to overwrite an NVRAM configuration written by a full system image. This bootstrap software does not support the full configuration command set. If you perform this command now, some configuration commands may be lost.

Overwrite the previous NVRAM configuration?[confirm]

Enter no to escape writing the configuration information to memory.

Moving Configuration Files to Other Locations Examples

On some routers, you can store copies of configuration files on a flash memory device. Five examples follow:

Copying the Startup Configuration to a Flash Memory Device Example

The following example copies the startup configuration file (specified by the CONFIG_FILE environment variable) to a flash memory card inserted in slot 0:

Router# copy nvram:startup-config slot0:router-confg

Copying the Running Configuration to a Flash Memory Device Example

The following example copies the running configuration from the router to the flash memory PC card in slot 0:

Router# copy system:running-config slot0:berlin-cfg

Building configuration...

5267 bytes copied in 0.720 secs

Copying to the Running Configuration from a Flash Memory Device Example

The following example copies the file named ios-upgrade-1 from the flash memory card in slot 0 to the running configuration:

Router# copy slot0:4:ios-upgrade-1 system:running-config

Copy

'ios-upgrade-1

' from flash device

as 'running-config' ? [yes/no] yes

Copying to the Startup Configuration from a Flash Memory Device Example

The following example copies the router-image file from the flash memory to the startup configuration:

Router# copy flash:router-image nvram:startup-config

Cisco IOS Configuration Fundamentals Command Reference

167

C commands copy

Copying a Configuration File from one Flash Device to Another Example

The following example copies the file running-config from the first partition in internal flash memory to the flash memory PC card in slot 1. The checksum of the file is verified, and its copying time of 30 seconds is displayed.

Router# copy flash: slot1:

System flash

Partition Size Used Free Bank-Size State Copy Mode

1 4096K 3070K 1025K 4096K Read/Write Direct

2 16384K 1671K 14712K 8192K Read/Write Direct

[Type ?<no> for partition directory; ? for full directory; q to abort]

Which partition? [default = 1]

System flash directory, partition 1:

File Length Name/status

1 3142748 dirt/images/mars-test/c3600-j-mz.latest

2 850 running-config

[3143728 bytes used, 1050576 available, 4194304 total]

PCMCIA Slot1 flash directory:

File Length Name/status

1 1711088 dirt/images/c3600-i-mz

2 850 running-config

[1712068 bytes used, 2482236 available, 4194304 total]

Source file name? running-config

Destination file name [running-config]?

Verifying checksum for 'running-config' (file # 2)... OK

Erase flash device before writing? [confirm]

Flash contains files. Are you sure you want to erase? [confirm]

Copy 'running-config' from flash: device

as 'running-config' into slot1: device WITH erase? [yes/no] yes

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

[OK - 850/4194304 bytes]

Flash device copy took 00:00:30 [hh:mm:ss]

Verifying checksum... OK (0x16)

Copying a File from a Remote Web Server Examples

In the following example, the file config1 is copied from a remote server to flash memory using HTTP:

Router# copy http:// www.example.com:8080/configs/config1 flash:config1

In the following example, a default username and password for HTTP Client communications is configured, and then the file sample.scr is copied from a secure HTTP server using HTTPS:

Router# configure terminal

Router(config)# ip http client username joeuser

Router(config)# ip http client password letmein

Router(config)# end

Router# copy https://www.example_secure.com/scripts/sample.scr flash:

In the following example, an HTTP proxy server is specified before using the copy http:// command:

Router# configure terminal

Router(config)# ip http client proxy-server edge2 proxy-port 29

Router(config)# end

Router# copy http:// www.example.com/configs/config3 flash:/configs/config3

168

Cisco IOS Configuration Fundamentals Command Reference

C commands copy

Copying an Image from the Master RSP Card to the Slave RSP Card Example

The following example copies the router-image file from the flash memory card inserted in slot 1 of the master RSP card to slot 0 of the slave RSP card in the same router:

Router# copy slot1:router-image slaveslot0:

Related Commands

Command

boot config

boot system cd

copy xmodem: flash:

copy ymodem: flash: delete dir erase

ip rcmd remote-username

ip scp server enable reload

show bootvar

show (flash file system)

slave auto-sync config

verify bootflash:

Description

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Specifies the system image that the router loads at startup.

Changes the default directory or file system.

Copies any file from a source to a destination.

Deletes a file on a flash memory device.

Displays a list of files on a file system.

Erases a file system.

Configures the remote username to be used when requesting a remote copy using rcp.

Enables scp server-side functionality.

Reloads the operating system.

Displays the layout and contents of a flash memory file system.

Turns on automatic synchronization of configuration files for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Backup.

File system or directory containing the files to list, followed by a colon.

Cisco IOS Configuration Fundamentals Command Reference

169

C commands copy erase flash

copy erase flash

The copy erase flash command has been replaced by the erase flash:command. See the description of the

erase command for more information.

O n some platforms, use can use the copy /erase source-url flash: syntax to erase the local Flash file system before copying a new file into Flash. See the desciption of the copy command for details on this option.

170

Cisco IOS Configuration Fundamentals Command Reference

C commands

copy http

The copy http:// command is documented as part of the copy command.

copy http

Cisco IOS Configuration Fundamentals Command Reference

171

copy https

copy https

The copy https:// command is documented as part of the copy command.

C commands

172

Cisco IOS Configuration Fundamentals Command Reference

C commands copy logging system

copy logging system

To copy archived system events to a destination file system, use the copy logging systemcommand in privileged EXEC mode. To stop copying the archived system events, use the no form of the command.

copy logging system target : filename

no copy logging system

Syntax Description

target : filename

Specifies the destination file system; Valid values are as follows:

• bootflash:

• disk0:

• disk1:

• ftp:

• http:

• https:

• rcp:

• slavebootflash:

• slavedisk0:

• slavedisk1:

• slavesup-bootdisk:

• slavesup-bootflash:

• sup-bootdisk:

• sup-bootflash:

• tftp:

Name of the file.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SXH

Modification

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

173

C commands copy logging system

Release

12.2(33)SCC

Modification

The command was introduced for the Cisco uBR10012 router in the Cisco IOS Software

Release 12.2(33)SCC.

Usage Guidelines System Event Archive (SEA) is supported on switches that have a Supervisor Engine 32 or Supervisor

Engine 720 with a compact flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine

720).

Cisco Universal Broadband Router 10012

The System Event Archive (SEA) feature is used to address the debug trace and system console constraints.

Use the copy logging systemcommand to copy the major and critical events stored in the sea_log.dat file, to the destination file system.

Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in compact flash adapter for PRE2.

The following example shows how to copy the SEA to the file system of disk0:

Router# copy logging system disk0:

Destination filename [sea_log.dat]?

The following example shows how to copy the SEA using the remote file copy function (rcp):

Router# copy logging system rcp:

Address or name of remote host []? 192.0.2.1

Destination username [Router]? username1

Destination filename [sea_log.dat]? /auto/tftpboot-users/username1/sea_log.dat

Related Commands

clear logging system

logging system

show logging system

Clears the event records stored in the SEA.

Enables or disables SEA logging system.

Displays the SEA logging system disk.

174

Cisco IOS Configuration Fundamentals Command Reference

C commands copy xmodem

copy xmodem

To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Xmodem protocol, use the copy

xmodem: command in EXEC mode.

copy xmodem: flashfilesystem:

Syntax Description

flash-filesystem : Destination of the copied file, followed by a colon.

Command Modes

EXEC

Command History

Release

11.2 P

12.2(15)T

12.2(33)SRA

Modification

This command was introduced.

This command is no longer supported in Cisco IOS

Mainline or Technology-based (T) releases. It may continue to appear in Cisco IOS 12.2S-family releases.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command is a form of the copy command. The copy xmodem: and copy xmodem commands are identical. See the description of the copy command for more information.

Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Xmodem. Use the copy

xmodem: command only if you do not have access to an FTP, TFTP, or rcp server.

This copy operation is performed through the console or AUX port. The AUX port, which supports hardware flow control, is recommended.

No output is displayed on the port over which the transfer is occurring. You can use the logging buffered command to log all router messages sent to the console port during the file transfer.

Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash memory using the Xmodem protocol: copy xmodem: flash:

Cisco IOS Configuration Fundamentals Command Reference

175

copy xmodem

Related Commands

Command copy copy ymodem:

C commands

Description

Copies any file from a source to a destination.

Copies a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Ymodem protocol.

176

Cisco IOS Configuration Fundamentals Command Reference

C commands copy ymodem

copy ymodem

To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Ymodem protocol, use the copy

ymodem: command in EXEC mode.

copy ymodem: flashfilesystem:

Syntax Description

flash-filesystem : Destination of the copied file, followed by a colon.

Command Modes EXEC

Command History

Release

11.2 P

12.2(15)T

12.2(33)SRA

Modification

This command was introduced.

This command is no longer supported in Cisco IOS

Mainline or Technology-based (T) releases. It may continue to appear in Cisco IOS 12.2S-family releases.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The copy ymodem: and copy ymodem commands are identical. See the description of the copycommand for more information.

Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Ymodem. Use the copy

ymodem: command only if you do not have access to an FTP, rcp, or TFTP server.

This copy operation is performed through the console or AUX port. The AUX port, which supports hardware flow control, is recommended.

No output is displayed on the port over which the transfer is occurring. You can use the logging buffered command to log all router messages sent to the console port during the file transfer.

Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash memory using the Ymodem protocol: copy ymodem: flash:

Cisco IOS Configuration Fundamentals Command Reference

177

copy ymodem

Related Commands

Command copy xmodem:

C commands

Description

Copies a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Xmodem protocol.

178

Cisco IOS Configuration Fundamentals Command Reference

C commands copy noverify

copy noverify

To disable the automatic image verification for the current copy operation, use the copy /

noverifycommand.

copy /noverify source-url destination-url

Syntax Description source-url destination-url

Location URL or alias of the source file or directory to be copied; see the “Usage Guidelines” section for additional information.

Destination URL or alias of the copied file or directory; see the “Usage Guidelines” section for additional information.

Command Default Verification is done automatically after completion of a copy operation.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The exact format of the source and destination URLs varies according to the file or directory location. You may enter either an alias keyword for a particular file or an alias keyword for a file system type (not a file within a type).

Cisco IOS Configuration Fundamentals Command Reference

179

C commands copy noverify

Timesaver Aliases are used to cut down on the amount of typing that you need to perform. For example, it is easier to type copy run start (the abbreviated form of the copy running-config startup-config command) than it is to type copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-

configcommand). These aliases allow you to continue using some of the common commands that are used in previous versions of Cisco IOS software.

The table below shows two keyword shortcuts to URLs.

Table 16 Common Keyword Aliases to URLs

Keyword running-config startup-config

Source or Destination

(Optional) Specifies the alias for the

system:running-config URL. This keyword does not work in the more and show file command syntaxes.

(Optional) Specifies the alias for the

nvram:startup-config URL.The nvram:startup-

config keyword represents the configuration file that is used during initialization (startup). This file is contained in NVRAM. This keyword does not work in more and show file EXEC command syntaxes.

The following tables list aliases by file system type. If you do not specify an alias, the system looks for a file in the current directory.

The table below lists the URL prefix aliases for special (opaque) file systems.

Table 17 URL Prefix Aliases for Special File Systems

Alias flh: nvram: null: system: xmodem: ymodem:

Source or Destination

Source URL for Flash load helper log files.

Router NVRAM. You can copy the startup configuration into or from NVRAM. You can also display the size of a private configuration file.

Null destination for copies or files. You can copy a remote file to null to determine its size.

Source or destination URL for system memory, which includes the running configuration.

Source destination for the file from a network device that uses the Xmodem protocol.

Source destination for the file from a network device that uses the Ymodem protocol.

180

Cisco IOS Configuration Fundamentals Command Reference

C commands copy noverify

The table below lists the URL prefix aliases for network file systems.

Table 18 URL Prefix Aliases for Network File Systems

Alias ftp: rcp: tftp:

Source or Destination

Source or destination URL for an FTP network server. The syntax for this alias is as follows:ftp:

[[[//username [:password]@]location]/directory]/ filename.

Source or destination URL for an rcp network server. The syntax for this alias is as follows: rcp:

[[[//username@ ] location]/directory]/filename.

Source or destination URL for a TFTP network server. The syntax for this alias is tftp:[[//location]/ directory]/filename.

The table below lists the URL prefix aliases for local writable storage file systems.

Table 19 URL Prefix Aliases for Local Writable Storage File Systems

Alias bootflash:

disk0: and disk1: flash: slavebootflash: slaveram: slavedisk0: slavedisk1:

Source or Destination

Source or destination URL for boot flash memory.

Source or destination URL of rotating media.

Source or destination URL for Flash memory. This alias is available on all platforms.

For platforms that lack a Flash: device, note that flash: is aliased to slot0:, allowing you to refer to the main Flash memory storage area on all platforms.

Source or destination URL for internal Flash memory on the slave RSP card of a device that is configured for HSA.

NVRAM on a slave RSP card of a device that is configured for HSA.

Source or destination URL of the first PCMCIA card on a slave RSP card of a device that is configured for HSA.

Source or destination URL of the second PCMCIA slot on a slave RSP card of a device that is configured for HSA.

Cisco IOS Configuration Fundamentals Command Reference

181

C commands copy noverify

Alias slaveslot0: slaveslot1: slot0: slot1:

Source or Destination

Source or destination URL of the first PCMCIA card on a slave RSP card of a router configured for

HSA--Available on systems that are configured with a Supervisor Engine 2.

Source or destination URL of the second PCMCIA slot on a slave RSP card of a router configured for

HSA--Available on systems that are configured with a Supervisor Engine 2.

Source or destination URL of the first PCMCIA

Flash memory card--Available on systems that are configured with a Supervisor Engine 2.

Source or destination URL of the second PCMCIA

Flash memory card--Available on systems that are configured with a Supervisor Engine 2.

You can enter on the command line all necessary source- and destination-URL information and the username and password to use, or you can enter the copy command and have the switch prompt you for any missing information.

If you enter information, choose one of the following three options: running-config, startup-config, or a file system alias (see the tables above). The location of a file system dictates the format of the source or destination URL.

The colon is required after the alias. However, earlier commands that do not require a colon remain supported but are unavailable in context-sensitive help.

The entire copying process may take several minutes and differs from protocol to protocol and from network to network.

In the alias syntax for ftp:, rcp:, and tftp:, the location is either an IP address or a hostname. The filename is specified for the directory that is used for file transfers.

Enter the file verify autocommand to set up verification globally.

Examples This example shows how to disable the automatic image verification for the current copy operation:

Router# copy /noverify tftp: sup-bootflash:

.................................................

[OK - 24301348 bytes]

24301348 bytes copied in 157.328 secs (154463 bytes/sec)

Router#

Related Commands

Command

file verify auto

Description

Verifies the compressed Cisco IOS image checksum.

182

Cisco IOS Configuration Fundamentals Command Reference

C commands

Command verify copy noverify

Description

Verifies the checksum of a file on a Flash memory file system or compute an MD5 signature for a file.

Cisco IOS Configuration Fundamentals Command Reference

183

copy noverify

C commands

184

Cisco IOS Configuration Fundamentals Command Reference

D through E

•

databits, page 187

•

data-character-bits, page 189

•

default-value data-character-bits, page 191

•

default-value exec-character-bits, page 193

•

default-value modem-interval, page 195

•

default-value special-character-bits, page 196

•

define interface-range, page 198

•

delete, page 200

•

diag, page 203

•

diagnostic bootup level, page 207

•

diagnostic cns, page 209

•

diagnostic event-log size, page 211

•

diagnostic level, page 213

•

diagnostic monitor, page 215

•

diagnostic ondemand, page 220

•

diagnostic schedule module, page 222

•

diagnostic start, page 225

•

diagnostic stop, page 230

•

dir, page 233

•

disable, page 237

•

disconnect-character, page 239

•

dispatch-character, page 240

•

dispatch-machine, page 242

•

dispatch-timeout, page 244

•

do, page 246

•

downward-compatible-config, page 248

•

editing, page 250

•

enable, page 254

•

enable last-resort, page 258

•

end, page 259

•

environment-monitor shutdown temperature, page 261

•

environment temperature-controlled, page 262

•

erase, page 264

•

erase bootflash, page 268

•

errdisable detect cause, page 269

Cisco IOS Configuration Fundamentals Command Reference

185

•

errdisable recovery, page 271

•

escape-character, page 274

•

exec, page 277

•

exec-banner, page 278

•

exec-character-bits, page 280

•

exec-timeout, page 282

•

execute-on, page 284

•

exit (EXEC), page 289

•

exit (global), page 291

D through E

186

Cisco IOS Configuration Fundamentals Command Reference

D through E databits

databits

To set the number of data bits per character that are interpreted and generated by the router hardware, use the databitscommand in line configuration mode. To restore the default value, use the no form of the command.

databits {5 | 6 | 7 | 8}

no databits

Syntax Description

Five data bits per character.

Six data bits per character.

Seven data bits per character.

Eight data bits per character. This is the default.

Command Default Eight data bits per character

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The databits line configuration command can be used to mask the high bit on input from devices that generate 7 data bits with parity. If parity is being generated, specify 7 data bits per character. If no parity generation is in effect, specify 8 data bits per character. The other keywords are supplied for compatibility with older devices and generally are not used.

Examples The following example sets the number of data bits per character to seven on line 4:

Router(config)# line 4

Router(config-line)# databits 7

Cisco IOS Configuration Fundamentals Command Reference

187

databits

Related Commands

Command data-character-bits

terminal databits

terminal data-character-bits

D through E

Description

Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software.

Changes the number of data bits per character for the current terminal line for this session.

Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session.

188

Cisco IOS Configuration Fundamentals Command Reference

D through E data-character-bits

data-character-bits

To set the number of data bits per character that are interpreted and generated by the Cisco IOS software, use the data-character-bitscommand in line configuration mode. To restore the default value, use the no form of this command.

data-character-bits {7 | 8}

no data-character-bits

Syntax Description

Seven data bits per character.

Eight data bits per character. This is the default.

Command Default

Eight data bits per character

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The data-character-bits line configuration command is used primarily to strip parity from X.25

connections on routers with the protocol translation software option. The data-character-bits line configuration command does not work on hard-wired lines.

Examples The following example sets the number of data bits per character to seven on virtual terminal line (vty) 1:

Router(config)# line vty 1

Router(config-line)# data-character-bits 7

Cisco IOS Configuration Fundamentals Command Reference

189

data-character-bits

Related Commands

Command

terminal data-character-bits

D through E

Description

Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session.

190

Cisco IOS Configuration Fundamentals Command Reference

D through E default-value data-character-bits

default-value data-character-bits

To configure the number of data bits per character that are generated and interpreted by Cisco software to either 7 bits or 8 bits, use the default-value data-character-bitscommand in global configuration mode.

To disable the configured size, use the no form of this command.

default-value data-character-bits {7 | 8}

no default-value data-character-bits

Syntax Description

Selects 7 bits as the default size.

Selects 8 bits as the default size.

Command Default 8 data bits per character are generated.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRB

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRB.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1.

Examples The following example shows how to set the default number of data character bits to 8:

Router# configure terminal

Router(config)# default-value data-character-bits 8

Cisco IOS Configuration Fundamentals Command Reference

191

default-value data-character-bits

Related Commands

Command

default-value exec-character-bits

default-value modem-signal

default-value special-character-bits

D through E

Description

Defines the EXEC character width to either 7 bits or 8 bits.

Configures the default frequency time to scan modem signals.

Configures the flow control default value from a 7bit width to an 8-bit width.

192

Cisco IOS Configuration Fundamentals Command Reference

D through E default-value exec-character-bits

default-value exec-character-bits

To define the EXEC character width for either 7 bits or 8 bits, use the default-value exec-character-bits command in global configuration mode. To restore the default value, use the no form of this command.

default-value exec-character-bits {7 | 8}

no default-value exec-character-bits

Syntax Description

Selects the 7-bit ASCII character set. This is the default.

Selects the full 8-bit ASCII character set .

Command Default

7-bit ASCII character set

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Configuring the EXEC character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can also cause failures. If a user on a terminal that is sending parity enters the help command, an “unrecognized command” message appears because the system is reading all 8 bits, although the eighth bit is not needed for the helpcommand.

Examples The following example selects the full 8-bit ASCII character set for EXEC banners and prompts:

Router(config)# default-value exec-character-bits 8

Cisco IOS Configuration Fundamentals Command Reference

193

default-value exec-character-bits

Related Commands

Command

default-value special-character-bits exec-character-bits length

terminal exec-character-bits

terminal special-character-bits

D through E

Description

Configures the flow control default value from a 7bit width to an 8-bit width.

Configures the character widths of EXEC and configuration command characters.

Sets the terminal screen length.

Locally changes the ASCII character set used in

EXEC and configuration command characters for the current session.

Changes the ASCII character widths to accept special characters for the current terminal line and session.

194

Cisco IOS Configuration Fundamentals Command Reference

D through E default-value modem-interval

default-value modem-interval

To configure the default frequency time to scan modem signals, use the default-value modem-

intervalcommand in global configuration mode. To disable the configured frequency, use the no form of this command.

default-value modem-interval milliseconds

no default-value modem-interval

Syntax Description milliseconds Time frequency, in milliseconds (ms). The range is from 0 to 1000.

Command Default The frequency time to scan modem signals is 50 ms.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Examples The following example shows how to set the default time to scan the modem signal to 345 ms:

Router# configure terminal

Router(config)# default-value modem-signal 345

Related Commands

Command

default-value data-character-bits

default-value exec-character-bits

default-value special-character-bits

Description

Configures the default size of bits handled to either

7 bits or 8 bits.

Defines the EXEC character width to either 7 bits or 8 bits.

Configures the flow control default value from a 7bit width to an 8-bit width.

Cisco IOS Configuration Fundamentals Command Reference

195

D through E default-value special-character-bits

default-value special-character-bits

To configure the flow control default value from a 7-bit width to an 8-bit width, use the default-value

special-character-bits command in global configuration mode. To restore the default value, use the no form of this command.

default-value special-character-bits commanddefault-value special-character-bits {7 | 8}

no default-value special-character-bits

Syntax Description

Selects the 7-bit character set. This is the default.

Selects the full 8-bit character set.

Command Default 7-bit character set

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Configuring the special character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on.

Examples

The following example selects the full 8-bit special character set:

Router(config)# default-value special-character-bits 8

Related Commands

Command

default-value exec-character-bits

Description

Defines the EXEC character width for either 7 bits or 8 bits.

196

Cisco IOS Configuration Fundamentals Command Reference

D through E

Command exec-character-bits length

terminal exec-character-bits

terminal special-character-bits default-value special-character-bits

Description

Configures the character widths of EXEC and configuration command characters.

Sets the terminal screen length.

Locally changes the ASCII character set used in

EXEC and configuration command characters for the current session.

Changes the ASCII character widths to accept special characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

197

D through E define interface-range

define interface-range

To create an interface-range macro, use the define interface-range command in global configuration mode. To remove an interface-range macro, use the no form of this command.

define interface-range macro-name interface-range

Syntax Description macro-name interface-range

Name of the interface-range macro.

Type of interface range.

• For a list of valid values, see the “Usage

Guidelines” section.

Command Default Interface-range macro is not configured.

Command Modes Global configuration (config)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS XE

Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

• The define interface-range command applies a particular configuration on multiple interfaces and creates multiple logical, and sub interfaces.

• An interface range macro name can comprise up to 32 characters.

• An interface range for a macro can accept a maximum of five ranges. However, the subinterface range for a macro accepts only one range.

• An interface range cannot span slots.

• Use the interface-type slot/first-interface last-interface format to enter the interface range.

• Valid values for the interface-type argument are as follows:

◦ atm —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2

◦ ethernet

◦ fastethernet

198

Cisco IOS Configuration Fundamentals Command Reference

D through E define interface-range

◦ ge-wan —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2

◦ gigabitethernet

◦ loopback

◦ port-channel interface-number —Valid values are from 1 to 256

◦ pos —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2

◦ tengigabitethernet

◦ tunnel

◦ vlan vlan-id —Valid values are from 1 to 4094

Examples The following example shows how to create a multiple-interface macro:

Device(config)# define interface-range macro1 ethernet 1/2 - 5, fastethernet 5/5 - 10

The following example shows how to create multiple loopback interfaces:

Device(config)# define interface-range loopback1-10

Related Commands

Command

interface range

Description

Executes a command on multiple ports at the same time.

Cisco IOS Configuration Fundamentals Command Reference

199

D through E delete

delete

To delete a file on a Flash memory device or NVRAM, use the delete command in EXEC, privileged

EXEC, or diagnostic mode.

delete url [/force | /recursive]

Syntax Description url

/force

/recursive

Cisco IOS File System URL of the file to be deleted. Include the file system prefix, followed by a colon, and, optionally, the name of a file or directory. See the table below for a list of supported

URLs.

(Optional) Deletes the specified file or directory without prompting you for verification.

Note Use this keyword with caution: the system will not ask you to confirm the file deletion.

(Optional) Deletes all files in the specified directory, as well as the directory itself.

Command Modes EXEC (>)

Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

11.0

12.3(14)T

12.2(33)SRA

Modification

This command was introduced.

The usbflash 0 9 : and usbtoken 0 9 : options were added to the list of Cisco IOS File System URLs.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

200

Cisco IOS Configuration Fundamentals Command Reference

D through E delete

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced on the Cisco ASR

1000 Series Routers and the following enhancements were introduced:

• This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR1000 Series

Routers.

• The harddisk:, obfl:, stby-bootflash: stby-

harddisk:, stby-nvram: , stby-obfl:, stby-

usb[0-1]:, and usb[0 1]: url options were introduced.

Usage Guidelines If you attempt to delete the configuration file or image specified by the CONFIG_FILE or BOOTLDR environment variable, the system prompts you to confirm the deletion. Also, if you attempt to delete the last valid system image specified in the BOOT environment variable, the system prompts you to confirm the deletion. To accept the change, you may enter y, Y, or simply hit the Enter key. Entering ? will emit a help prompt.

When you delete a file in Flash memory, the software simply marks the file as deleted, but it does not erase the file. To later recover a “deleted” file in Flash memory, use the undeleteEXECcommand. You can delete and undelete a file up to 15 times.

To permanently delete all files marked “deleted” on a linear Flash memory device, use the squeeze EXEC command.

The table below contains a list of Cisco IOS File System URLs.

Table 20 URL File System Prefix Keywords

Prefix bootflash: flash: harddisk: nvram: obfl: slot0: stby-bootflash:

Filesystem

Delete the file from boot Flash memory.

Delete the file from Flash memory.

Delete the file from the harddisk file system.

Delete the from the router NVRAM.

Delete the file from the onboard failure logging file system.

Delete the file from the first PCMCIA Flash memory card.

Delete the file from the standby bootflash file system.

Cisco IOS Configuration Fundamentals Command Reference

201

D through E delete

Prefix stby-harddisk: stby-nvram: stby-obfl: stby-usb [ 0 - 1 ]: usb [ 0 - 1 ];

usbflash 0 9 :

usbtoken 0 9 :

Filesystem

Delete the file from the standby harddisk file system.

Delete the from the router NVRAM on the standby hardware.

Delete the file from the onboard failure logging file system on the standby hardware.

Delete the file from the standby USB Flash drive.

Delete the file from the USB Flash drive.

Delete the file from the USB eToken.

Examples The following example deletes the file named test from the Flash card inserted in slot 0:

Router# delete slot0:test

Delete slot0:test? [confirm]

Related Commands

Command cd dir

show bootvar squeeze undelete

Description

Changes the default directory or file system.

Displays a list of files on a file system.

Permanently deletes Flash files by squeezing a

Class A Flash file system.

Recovers a file marked “deleted” on a Class A or

Class B Flash file system.

202

Cisco IOS Configuration Fundamentals Command Reference

D through E diag

diag

To perform field diagnostics on a line card, on the Gigabit Route Processor (GRP), on the Switch Fabric

Cards (SFCs), and on the Clock Scheduler Card (CSC) in Cisco 12000 series Gigabit Switch Routers

(GSRs), use the diag command in privileged EXEC mode. To disable field diagnostics on a line card, use the no form of this command.

diag command diag slot-number [halt | previous | post | verbose [wait] | wait]

no diag slot-number

Syntax Description slot-number halt previous post

verbose [wait wait

Slot number of the line card you want to test. Slot numbers range from 0 to 11 for the Cisco 12012 and 0 to 7 for the Cisco 12008 router. Slot numbers for the CSC are 16 and 17, and for the FSC are 18,

19, and 20.

(Optional) Stops the field diagnostic testing on the line card.

(Optional) Displays previous test results (if any) for the line card.

(Optional) Initiates an EPROM-based extended power-on self-test (EPOST) only. The EPOST test suite is not as comprehensive as the field diagnostics, and a pass/fail message is the only message displayed on the console.

(Optional) Enables the maximum status messages to be displayed on the console. By default, only the minimum status messages are displayed on the console. If you specify the optional wait keyword, the Cisco IOS software is not automatically reloaded on the line card after the test completes.

(Optional) Stops the automatic reloading of the

Cisco IOS software on the line card after the completion of the field diagnostic testing. If you use this keyword, you must use the microcode

reload slot global configuration command, or manually remove and insert the line card (to power it up) in the slot so that the GRP will recognize the line card and download the Cisco IOS software image to the line card.

Command Default No field diagnostics tests are performed on the line card.

Cisco IOS Configuration Fundamentals Command Reference

203

D through E diag

Command Modes Privileged EXEC

Command History

Release

11.2 GS

12.2(33)SRA

Modification

This command was introduced to support the Cisco

12000 series GSR.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The diag command must be executed from the GRP main console port.

Perform diagnostics on the CSC only if a redundant CSC is in the router.

Diagnostics will stop and ask you for confirmation before altering the router’s configuration. For example, running diagnostics on a SFC or CSC will cause the fabric to go from full bandwidth to one-fourth bandwidth. Bandwidth is not affected by GRP or line card diagnostics.

The field diagnostic software image is bundled with the Cisco IOS software and is downloaded automatically from the GRP to the target line card prior to testing.

Caution Performing field diagnostics on a line card stops all activity on the line card. Before the diag EXEC command begins running diagnostics, you are prompted to confirm the request to perform field diagnostics on the line card.

In normal mode, if a test fails, the title of the failed test is displayed on the console. However, not all tests that are performed are displayed. To view all the tests that are performed, use the verbose keyword.

After all diagnostic tests are completed on the line card, a PASSED or TEST FAILURE message is displayed. If the line card sends a PASSED message, the Cisco IOS software image on the line card is automatically reloaded unless the wait keyword is specified. If the line card sends a TEST FAILURE message, the Cisco IOS software image on the line card is not automatically reloaded.

If you want to reload the line card after it fails diagnostic testing, use the microcode reload slot global configuration command.

Note When you stop the field diagnostic test, the line card remains down (that is, in an unbooted state). In most cases, you stopped the testing because you need to remove the line card or replace the line card. If that is not the case, and you want to bring the line card back up (that is, online), you must use the microcode

reload global configuration command or power cycle the line card.

If the line card fails the test, the line card is defective and should be replaced. In future releases this might not be the case because DRAM and SDRAM SIMM modules might be field replaceable units. For example, if the DRAM test failed you might only need to replace the DRAM on the line card.

For more information, refer to the Cisco 12000 series installation and configuration guides.

204

Cisco IOS Configuration Fundamentals Command Reference

D through E

Examples diag

In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3. After the line card passes all field diagnostic tests, the Cisco IOS software is automatically reloaded on the card. Before starting the diagnostic tests, you must confirm the request to perform these tests on the line card because all activity on the line card is halted. The total/indiv. timeout set to 600/220 sec. message indicates that 600 seconds are allowed to perform all field diagnostics tests, and that no single test should exceed 220 seconds to complete.

Router# diag 3

Running Diags will halt ALL activity on the requested slot. [confirm]

Router#

Launching a Field Diagnostic for slot 3

Running DIAG config check

RUNNING DIAG download to slot 3 (timeout set to 400 sec.) sending cmd FDIAG-DO ALL to fdiag in slot 3

(total/indiv. timeout set to 600/220 sec.)

Field Diagnostic ****PASSED**** for slot 3

Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3

last test failed was 0, error code 0 sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3

Board will reload

Router#

In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3 in verbose mode:

Router# diag 3 verbose

Running Diags will halt ALL activity on the requested slot. [confirm]

Router#

Launching a Field Diagnostic for slot 3

Running DIAG config check

RUNNING DIAG download to slot 3 (timeout set to 400 sec.) sending cmd FDIAG-DO ALL to fdiag in slot 3

(total/indiv. timeout set to 600/220 sec.)

FDIAG_STAT_IN_PROGRESS: test #1 R5K Internal Cache

FDIAG_STAT_PASS test_num 1

FDIAG_STAT_IN_PROGRESS: test #2 Sunblock Ordering

FDIAG_STAT_PASS test_num 2

FDIAG_STAT_IN_PROGRESS: test #3 Dram Datapins

FDIAG_STAT_PASS test_num 3

Field Diags: FDIAG_STAT_DONE

Field Diagnostic ****PASSED**** for slot 3

Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3

last test failed was 0, error code 0 sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3

Board will reload

Router#

Cisco IOS Configuration Fundamentals Command Reference

205

diag

Related Commands

Command

microcode reload

D through E

Description

Reloads the Cisco IOS image on a line card on the

Cisco 7000 series with RSP7000, Cisco 7500 series, or Cisco 12000 series routers after all microcode configuration commands have been entered.

206

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic bootup level

diagnostic bootup level

To set the diagnostic bootup level, use the diagnostic bootup levelcommand in global configuration mode.

To skip all diagnostic tests, use the no form of this command.

diagnostic bootup level {minimal | complete}

no diagnostic bootup level

Syntax Description minimal complete

Specifies minimal diagnostics. See the Usage

Guidelines section for additional information.

Specifies complete diagnostics. See the Usage

Guidelines section for additional information.

Command Default minimal

Command Modes Global configuration (config)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

12.2(33)SCC

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionalityfor Cisco UBR10012 Universal

Broadband Router.

Usage Guidelines Setting the diagnostic level determines the level of testing that occurs when the system or module is reset.

The two levels are as follows:

• Complete--Runs all tests.

• Minimal--Runs only EARL tests for the supervisor engine and loopback tests for all ports in the system.

Cisco IOS Configuration Fundamentals Command Reference

207

D through E diagnostic bootup level

Note Although the default is minimal, you can set the diagnostic level to complete for troubleshooting hardware problems.

In certain circumstances, you might want to skip the bootup online diagnostics completely. For example, you might skip the bootup online diagnostics to verify that a port is as bad as online diagnostics reports. To skip online diagnostic testing completely, use the no diagnostic bootup level command.

For information on the diagnostic test types, use the show diagnosticcommand.

The new level takes effect at the next reload or the next time that an online insertion and removal is performed.

Examples The following example shows how to set the diagnostic bootup level:

Router(config)# diagnostic bootup level complete

Related Commands

Command

show diagnostic bootup level

Description

Displays the coverage level for the configured bootup diagnostics.

208

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic cns

diagnostic cns

To configure the Cisco Networking Services (CNS) diagnostics, use the diagnostic cns command in global configuration mode. To disable sending diagnostic results to the CNS event bus., use the no form of this command.

diagnostic cns {publish | subscribe} [subject]

no diagnostic cns {publish | subscribe} [subject]

Syntax Description publish subscribe subject

Sends diagnostic results to a remote network application to make decisions and take corrective actions that are based on the diagnostic results.

Receives messages from remote network applications to perform diagnostic tests or retrieve diagnostic results.

(Optional) Event subject name.

Command Default The following are the default settings for diagnostic cns: diagnostic cns publish cisco.cns.device.diag_results

diagnostic cns subscribe cisco.cns.device.diag_commands

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The online diagnostics receive events by subscribing to an event subject name. The subject is the event that you subscribe (receive) or publish (generate) through the CNS bus.

Cisco IOS Configuration Fundamentals Command Reference

209

D through E diagnostic cns

The diagnostic cns publish command sends diagnostic results to a remote network application to make decisions and take corrective actions that are based on the diagnostic results.

The diagnostic cns subscribe command receives messages from remote network applications to perform diagnostic tests or retrieve diagnostic results.

Examples

This example shows how to enable the publishing of diagnostic results:

Router(config)# diagnostic cns publish my.cns.publish

Router(config)#

This example shows how to receive messages from remote network applications to perform diagnostic tests or retrieve diagnostic results:

Router(config)# diagnostic cns subscribe my.cns.subscribe

Router(config)#

This example shows how to set the default to publish:

Router(config)# default diagnostic cns publish

Router(config)#

Related Commands

Command

show diagnostic cns publish

show diagnostic cns subscribe

Description

Displays the publish information about the CNS subject.

Displays the subscribe information about the CNS subject.

210

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic event-log size

diagnostic event-log size

To modify the diagnostic event log size dynamically, use the diagnostic event-log size command in global configuration mode. To return to the default settings, use the no form of this command.

diagnostic event-log size size

no diagnostic event-log size

Syntax Description size Diagnostic event-log sizes. The valid values range from 1 to 10000 entries.

Command Default

The event log sizeis 500 entries.

Command Modes Global configuration (config)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA.

12.2(33)SCC

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionalityfor Cisco UBR10012 Universal

Broadband Router.

Usage Guidelines The events are dynamically allocated and stored in a circular queue.

You can enter either the default diagnostic event-log size command or the no diagnostic event-log size command to return to the default settings.

Cisco IOS Configuration Fundamentals Command Reference

211

D through E diagnostic event-log size

Examples The following example shows how to set the diagnostic event-log size:

Router(config)# diagnostic event-log size 600

Related Commands

Command

show diagnostic events

Description

Displays the event log for the diagnostic events.

212

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic level

diagnostic level

To turn on power-on diagnostic tests for the network service engines (NSEs) installed in a Cisco 7300 series router, use the diagnostic level command in privileged EXEC configuration mode. There is no no form of this command.

diagnostic level {power-on | bypass}

Syntax Description power-on bypass

Power-on diagnostic tests are performed at system bootup on the NSEs.

No diagnostic tests are performed. This is the default.

Command Default No diagnostic tests are performed.

Command Modes Privileged EXEC

Command History

Release

12.1(10)EX2

12.2(18)S

12.2(33)SRA

12.2SX

Modification

This command was introduced.

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

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

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 this command to enable power-on diagnostic tests to run on the installed NSEs of a Cisco 7300 series router when the system is booted. It is recommended that you issue this command only if you are experiencing problems with an NSE and are planning on rebooting the router. Issuing this command causes an increase in the boot time.

Cisco IOS Configuration Fundamentals Command Reference

213

D through E diagnostic level

Examples The following example shows how to enable diagnostic power-on tests: diagnostic level power-on

The following sample output shows the output that is displayed upon system bootup after a power cycle or router crash:

System Power On Diagnostics

DRAM Size ....................128 MB

Testing DRAM..................Passed

Level2 Cache .................Present

Testing Level2 Cache (256 KB)Passed

Level3 Cache .................Present

Testing Level3 Cache (1024 KB)Passed

System Power On Diagnostics Complete

Note This output is displayed when the system is booting, not when the command is issued.

Related Commands

Command

debug redundancy

show c7300

show redundancy (7300)

Description

Enables NSE redundancy debugging.

Displays the types of cards (NSE and line cards) installed in a Cisco 7300 series router.

Displays redundancy information for the active and standby NSEs.

214

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic monitor

diagnostic monitor

To configure health-monitoring diagnostic testing, use the diagnostic monitor command in global configuration mode. To disable testing, use the no form of this command.

diagnostic monitor intervalmodule number test {test-id | test-id-range | all} hh:mm:ss milliseconds days

diagnostic monitor syslog

diagnostic monitor module num test {test-id | test-id-range | all}

no diagnostic monitor {interval | syslog}

Cisco UBR10012 Router

diagnostic monitor {bay slot/bay | slot slot number | subslot slot/subslot} test {test-id | test-id-

range | all}

diagnostic monitor interval{bay slot/bay | slot slot-no | subslot slot/subslot} test {test-id | test-id-

range | all} hh:mm:ss milliseconds days

diagnostic monitor syslog

diagnostic monitor threshold {bay slot/bay | slot slot-no | subslot slot/subslot} test {test-id | test-

id-range | all} failure count failures [{runs | days | hours | minutes | seconds | milliseconds}

window_size]

Syntax Description interval

module number test test-id test-id-range all

hour hh

min mm

Sets the interval between testing.

Specifies the module number.

Specifies a test to run.

Identification number for the test to run. See the

“Usage Guidelines” section for additional information.

Range of identification numbers for tests to be run.

See the “Usage Guidelines” section for additional information.

Runs all the diagnostic tests.

(Optional) Specifies the number of hours between tests. See the “Usage Guidelines” section for formatting guidelines.

(Optional) Specifies the number of minutes between tests. See the “Usage Guidelines” section for formatting guidelines.

Cisco IOS Configuration Fundamentals Command Reference

215

diagnostic monitor

second ss

millisec ms syslog

bay slot/bay

slot slotnumber

subslot slot/subslot threshold

failure count failures hh:mm:ss milliseconds days

runs window_size

days window_size

hours window_size

minutes window_size

216

Cisco IOS Configuration Fundamentals Command Reference

D through E

(Optional) Specifies the number of seconds between tests. See the “Usage Guidelines” section for formatting guidelines.

(Optional) Specifies the number of milliseconds between tests; see the “Usage Guidelines” section for formatting guidelines.

Enables system logging messages when a healthmonitoring test fails.

Indicates the card slot and bay number where the diagnostic test is run periodically and monitored.

The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from

1 to 8 and 0 to 3 for the bay number.

Indicates the slot number of the full-height line card where the diagnostic test is run periodically and monitored. The slot keyword is used to refer a fullheight line card on the router. The valid range for the slot is from 1 to 8.

Indicates the slot and subslot number of half-height line card on which the diagnostic test is run periodically and monitored. The subslot keyword is used to refer a half-height line card on the router.

The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number.

Configures the failure threshold value for the specified bay, slot, or subslot.

Configures the count for maximum failures allowed after which the failed test results are displayed in the output of the show diagnostic resultscommand.

The range for number of allowed failures is 0 to 99.

Hours, minutes, and seconds interval configured to run the test again.

Number of milliseconds between tests.

Number of days between tests. The valid range is from 0 to 20.

Number of test-run count for the failure windowsize.

Number of days for the failure window-size.

Number of hours for the failure window-size.

Number of minutes for the failure window-size.

D through E diagnostic monitor

seconds window_size

milliseconds window_size

Number of seconds for the failure window-size.

Number of milliseconds for the failure windowsize.

Command Default The defaults are as follows:

• Depending on the test run, monitoring may be enabled or disabled.

• Depending on the test run, the default monitoring interval varies.

• syslog is enabled.

Command Modes Global configuration (config)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

12.2(33)SCC

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The command was integrated into Cisco IOS

Release 12.2(33)SCC to support Generic Online

Diagnostics (GOLD) functionalityfor Cisco

UBR10012 Universal Broadband Router. The keywords bay, slot, and subslot were added for the

Cisco UBR10012 Universal Broadband Router.

Usage Guidelines Use these guidelines when scheduling testing:

• test-id -- Enter the show diagnostic content command to display the test ID list .

• test-id-range -- Enter the show diagnostic content command to display the test ID list . Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6).

• hh-- Enter the hours from 1 to 24.

• mm-- Enter the minutes from 1 to 60.

• days-- Enter the number of days between tests.

• ss-- Enter the seconds from 1 to 60.

• ms-- Enter the milliseconds from 1 to 1000.

Enter the [no] diagnostic monitor test {test-id | test-id-range | all} command to enable or disable the specified health monitoring test.

Cisco IOS Configuration Fundamentals Command Reference

217

D through E diagnostic monitor

Examples

When entering the diagnostic monitor module number test {test-id | test-id-range | all} command, observe the following:

• Required

◦ Isolate network traffic by disabling all connected ports and do not pump test packets during the test.

◦ Remove all modules for testing FIB TCAM and SSRAM memory on the PFC of the supervisor engine.

◦ Reset the system or the test module before putting the system back into the normal operating mode.

• Recommended

◦ If the DFC module is present, remove all modules, and then reboot the system before starting the memory test on the central PFC3B of the supervisor engine.

◦ Turn off all background health-monitoring tests on the supervisor engine and the modules using the no diagnostic monitor module number test {test-id | test-id-range | all} command.

The FIB TCAM test for central PFC3BXL or PFC3B (on the supervisor engine) takes approximately 4 hours and 30 minutes.

The FIB TCAM test for the distributed PFC3BXL or PFC3B (on the DFC module) takes approximately 16 hours.

You can run the FIB TCAM test on multiple DFC3BX modules simultaneously.

Cisco UBR10012 Router

The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.

To monitor a diagnostic test periodically, you first need to configure the hours, minutes, and seconds interval to run the diagnostic test using the diagnostic monitor intervalcommand. An error message is displayed, if the interval is not configured before enabling the monitoring.

To store log details for failed tests, execute the diagnostic monitor syslogcommand. A threshold value to specify the maximum count for allowed failures is configured using the diagnostic monitor

thresholdcommand. The failed test results can be viewed using the show diagnostic resultscommand, after the number of failed test reaches the maximum number of allowed failures configured using the

diagnostic monitor thresholdcommand.

The following example shows how to run the specified test every 3 days:

Router(config)# diagnostic monitor interval module 5 test 7 09:07:05 45 3

The following example shows how to enable the generation of a syslog message when any healthmonitoring test fails:

Router(config)# diagnostic monitor syslog

218

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic monitor

Cisco UBR10012 Router

The following example shows a sample output of an error message displayed when monitoring is enabled before configuring the test interval:

Router(config)# diagnostic monitor bay 1/0 test 2

Aug 12 18:04:56.280: %DIAG-3-MONITOR_INTERVAL_ZERO: Bay 1/0: Monitoring interval is 0. Cannot enable monitoring for Test #2

The following example shows how to configure the periodic interval for running diagnostic tests on the the router before enabling monitoring:

Router(config)# diagnostic monitor interval bay 1/0 test 2 06:00:00 100 10

The following example shows how to enable the diagnostic monitoring on bay 1/0:

Router(config)# diangostic monitor bay 1/0 test 2

The following example shows how to enable logging of failed messages to syslog:

Router(config)# diangostic monitor syslog

The following example shows how to configure the failure threshold value after which the failed test results are displayed in the command output for show diagnostic results:

Router(config)# diagnostic monitor threshold bay 1/0 test 2 failure count 10

Related Commands

Command

show diagnostic content

Description

Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all modules.

Cisco IOS Configuration Fundamentals Command Reference

219

D through E diagnostic ondemand

diagnostic ondemand

To configure the on-demand diagnostics, use the diagnostic ondemand command in privileged EXEC mode.

diagnostic ondemand {iteration iteration-count | action-on-failure {continue error-count | stop}}

Syntax Description

iteration iteration-count action-on-failure continue stop error-count

Sets the number of times the same test to rerun when the command is issued . The valid range for iteration-count is between 1 to 999.

Sets the execution action when a failure is detected.

Continues testing when a test failure is detected.

Stops testing when a test failure is detected.

(Optional) Number of errors that are allowed before stopping. This argument is used with the continue optio n. The valid range for error-count is from 0 to

65534.

Command Default The default settings are as follows:

• iteration-count is 1

• action-on-error is continue

• error-count is 0

Command Modes Privileged EXEC (#)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

220

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic ondemand

Release

12.2(33)SCC

Modification

The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionalityfor Cisco UBR10012 Universal

Broadband Router.

Usage Guidelines

Entering 0 for the error-count sets the number of errors that are allowed to unlimited.

Examples The following example shows how to set the ondemand testing iteration count:

Router# diagnostic ondemand iteration 4

Router#

The following example shows how to set the execution action when an error is detected:

Router# diagnostic ondemand action-on-failure continue 2

Router#

Related Commands

Command

show diagnostic ondemand settings

Description

Displays the settings for on-demand diagnostics.

Cisco IOS Configuration Fundamentals Command Reference

221

D through E diagnostic schedule module

diagnostic schedule module

To set the scheduling of test-based diagnostic testing for a specific module or schedule a supervisor engine switchover, use the diagnostic schedule module command in global configuration mode. To remove the scheduling, use the no form of this command.

diagnostic schedule module {module-number | slot/subslot} test {test-id | all | complete | minimal |

non-disruptive | [per-port [port{interface-port-number | port-number-list | all}]]} {on month dd

yyyy hh:mm | daily hh:mm | weekly day-of-week hh:mm}

no diagnostic schedule module {module-number | slot/subslot} test {test-id | all | complete |

minimal | non-disruptive | [per-port [port{interface-port-number | port-number-list | all}]]} {on

month dd yyyy hh:mm | daily hh:mm | weekly day-of-week hh:mm}

Syntax Description module-number

slot / subslot test test-id all complete minimal non-disruptive per-port port interface-port- number

port-number-list all

on month dd yyyy hh : mm

daily hh : mm

Specifies the module number.

Specifies the slot number of the active supervisor engine.

Specifies the diagnostic test suite attribute.

Identification number for the test to be run; see the

“Usage Guidelines” section for additional information.

Runs all diagnostic tests.

Selects the complete bootup test suite.

Selects the minimal bootup test suite.

Selects the nondisruptive test suite.

Selects the per-port test suite.

(Optional) Specifies the port to schedule testing.

(Optional) Port number.

(Optional) Range of port numbers, separated by a hyphen.

(Optional) Specifies all ports.

Specifies the scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines.

Specifies the daily scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines.

222

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic schedule module

weekly day-of-week hh : mm Specifies the weekly scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines.

Command Default Test-based diagnostic testing for a specific module is not scheduled.

Command Modes Global configuration (config)

Command History

Release

12.2(14)SX

12.2(17b)SXA

12.2(17d)SXB

12.2(33)SRA

12.2(33)SRE

Modification

This command was introduced on the Supervisor

Engine 720.

This command was modified to support scheduled switchover for supervisor engines.

This command was modified to support the

Supervisor Engine 2.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified. The complete,

minimal, non-disruptive, and per-port keywords were added.

Usage Guidelines Use these guidelines when scheduling testing:

• test-id -- Enter the show diagnostic content command to display the test ID list .

• month-- Spell out the month such as january, february ... december (either uppercase or lowercase characters).

• dd-- Enter the day as a two-digit number.

• yyyy-- Enter the year as a four-digit number.

• hh : mm-- Enter the time as a two-digit number (for a 24-hour clock) for hours:minutes; the colon (:) is required.

• day-of-week-- Spell out the day of the week, such as monday, tuesday... sunday (either uppercase or lowercase characters).

• per-port is not supported when specifying a scheduled switchover.

You can use the diagnostic schedule module slot / subslot test test-id command to schedule a switchover from the active supervisor engine to the standby supervisor engine.

Enter the show diagnostic content module slot / subslot command to display the test ID list and look for the test ID in the ScheduleSwitchover field.

Cisco IOS Configuration Fundamentals Command Reference

223

D through E diagnostic schedule module

You can specify a periodic switchover (daily or weekly) or a single switchover occurrence at a specific time using these commands:

• diagnostic schedule module slot / subslot test test-id on mm dd yyyy hh:mm

• diagnostic schedule module slot / subslot test test-id daily hh:mm

• diagnostic schedule module slot / subslot test test-id weekly day-of-week hh:mm

Note To avoid system downtime in the event that the standby supervisor engine cannot switch over the system,

Cisco recommends that you schedule a switchover from the standby supervisor engine to the active supervisor engine 10 minutes after the switchover occurs.

Examples

The following example shows how to schedule the diagnostic testing on a specific month, date and time for a specific module:

Router(config)# diagnostic schedule module 1 test 5 on may 27 2010 10:30

The following example shows how to schedule the diagnostic testing to occur daily at a certain time for a specific module:

Router(config)# diagnostic schedule module 1 test 5 daily 12:25

The following example shows how to schedule the diagnostic testing to occur weekly on a certain day for a specific module:

Router(config)# diagnostic schedule module 1 test 5 weekly friday 09:23

Related Commands

Command

show diagnostic content

show diagnostic schedule

Description

Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all modules.

Displays the current scheduled diagnostic tasks.

224

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic start

diagnostic start

To run the specified diagnostic test, use the diagnostic startcommand in privileged EXEC mode.

diagnostic start module num test {test-id | test-id-range | minimal | complete | basic | per-port |

non-disruptive | all} [port{num | port#-range | all}]

diagnostic start system test all

Cisco UBR10012 Universal Broadband Router

diagnostic start {bay slot/bay | slot slot-no} test {test-id | test-id-range | all | complete | minimal |

non-disruptive}

diagnostic start subslot slot/subslot test {test-id | test-id-range | all | complete | minimal | non-

disruptive | [per-port [port{num | port#-range | all}]]}

Syntax Description

module num test test-id test-id-range minimal complete basic per-port non-disruptive all

port num

port port# range

port all

Specifies the module number.

Specifies a test to run.

Identification number for the test to run. See the

Usage Guidelines section for additional information.

Range of identification numbers for tests to run.

See the Usage Guidelines section for additional information.

Runs minimal bootup diagnostic tests.

Runs complete bootup diagnostic tests.

Runs basic on-demand diagnostic tests.

Runs per-port level tests.

Runs the non disruptive health-monitoring tests.

Runs all diagnostic tests.

(Optional) Specifies the interface port number.

(Optional) Specifies the interface port number range. See the Usage Guidelines section for additional information.

(Optional) Specifies all ports.

Cisco IOS Configuration Fundamentals Command Reference

225

diagnostic start system test all bay slot/bay slot slot-no subslot slot/sub-slot

Command Default None

Command Modes Privileged EXEC (#)

Command History

Release

12.2(14)SX

12.2(17a)SX

12.2(17d)SXB

12.2(33)SRA

12.2.(33)SXH

226

Cisco IOS Configuration Fundamentals Command Reference

D through E

Runs all disruptive and nondisruptive diagnostic tests at once. All test dependencies are handled automatically.

Indicates the card slot and bay number where the diagnostic test is executed. The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from 1 to 8 and 0 to 3 for the bay number.

Indicates the slot number of the full-height line card where the diagnostic test is executed. The slot keyword is used to refer a full-height line card on the router. The valid range for slot is from 1 to 8.

Indicates the slot and subslot number of half-height line card where the diagnostic test is executed. The subslot keyword is used to refer a half-height line card on the router. The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number.

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was changed to include the

complete and basic keywords.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was changed to include the system test all keywords.

D through E diagnostic start

Release

12.2(33)SCC

Modification

The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionalityfor Cisco UBR10012 Universal

Broadband Router. The keywords bay, slot, and

subslot were added for the Cisco UBR10012

Universal Broadband Router.

Usage Guidelines

Note Running all online diagnostic tests disrupts normal system operation. Reset the system after the diagnostic

start system test all command has completed. Do not insert, remove, or power down line cards or the supervisor while the system test is running. Do not issue any diagnostic command other than the diagnostic

stop system test all command while the system test is running. Make sure no traffic is running in background.

Note Do not enter the diagnostic start module x test all command on systems that are configured with a

DFC3A because this command causes the TCAM test to fail.

Enter the show diagnostic content command to display the test ID list .

Enter the test-id-range or port# range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6).

Use diagnostic stop command to stop the testing process.

Cisco UBR10012 Router

The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.

Note To start a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stopwith the

bay, slot or subslot keyword respectively.

The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low

Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and Guardian index leak tests.

Examples The following example shows how to run the specified diagnostic test at the specified slot:

Router# diagnostic start module 1 test 5

Module 1:Running test(s) 5 may disrupt normal system operation

Do you want to run disruptive tests? [no] yes

00:48:14:Running OnDemand Diagnostics [Iteration #1] ...

00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ...

00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfully

00:48:14:Running OnDemand Diagnostics [Iteration #2] ...

00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ...

00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfully

Router#

Cisco IOS Configuration Fundamentals Command Reference

227

D through E diagnostic start

This example shows how to start all online diagnostic tests:

Router# diagnostic start system test all

*************************************************************************

* WARNING: *

* 'diagnostic start system test all' will disrupt normal system *

* operation. The system requires RESET after the command *

* 'diagnostic start system test all' has completed prior to *

* normal use. *

* *

* IMPORTANT: *

* 1. DO NOT INSERT, OIR, or POWER DOWN Linecards or *

* Supervisor while system test is running. *

* *

* 2. DO NOT ISSUE ANY DIAGNOSTIC COMMAND except *

* "diagnostic stop system test all" while system test *

* is running. *

* *

* 3. PLEASE MAKE SURE no traffic is running in background. *

*************************************************************************

Do you want to continue? [no]:

Cisco UBR10012 Router

The following example shows how to run a diagnostic test with test id 2 on a SPA: ubr-122s-1# diagnostic start bay 1/0 test 2 ubr-122s-1#

Aug 5 09:24:42.019: %DIAG-6-TEST_RUNNING: Bay 1/0: Running TestModenaLLQDrops{I

D=2} ...

Aug 5 09:24:42.019: %DIAG-6-TEST_OK: Bay 1/0: TestModenaLLQDrops{ID=2} has comp leted successfully

Related Commands

Command

diagnostic schedule

show diagnostic description

diagnostic stop

show diagnostic content module

diagnostic bootup level

diagnostic event-log size

diagnostic monitor

diagnostic ondemand

show diagnostic bootup

show diagnostic events

Description

Sets the diagnostic test schedule for a particular bay, slot, or subslot.

Provides the description for the diagnostic tests.

Runs the specified diagnostic test.

Displays the available diagnostic tests.

Configures the diagnostic bootup level.

Modifies the diagnostic event-log size dynamically.

Configures the health-monitoring diagnostic testing.

Configures the on-demand diagnostics.

Displays the configured diagnostics level at bootup.

Displays the diagnostic event log.

228

Cisco IOS Configuration Fundamentals Command Reference

D through E

Command

show diagnostic ondemand settings

show diagnostic result

show diagnostic schedule

show diagnostic status diagnostic start

Description

Displays the settings for the on-demand diagnostics.

Displays the diagnostic test results for a module.

Displays the current scheduled diagnostic tasks.

Displays the running diagnostics tests.

Cisco IOS Configuration Fundamentals Command Reference

229

D through E diagnostic stop

diagnostic stop

To stop the testing process, use the diagnostic stop command in privileged EXEC mode.

diagnostic stop module num

Cisco UBR10012 Universal Broadband Router

diagnostic stop {bay slot/bay | slot slot-no | subslot slot/subslot}

Syntax Description

module num bay slot/bay slot slot-no subslot slot/subslot

Module number.

Indicates the card slot and bay number of the SPA for which the diagnostic test has stopped. The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from 1 to 8 and 0 to 3 for the bay number.

Indicates the slot number of full height line card for which the diagnostic test has to be stopped. The slot keyword is used to refer a full-height line card on the router. Valid range for the slot is from 1 to 8.

Indicates the slot and subslot number of half-height line card for which the diagnostic test has to be stopped. The subslot keyword is used to refer a half-height line card on the router. The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number.

Command Default None

Command Modes Privileged EXEC (#)

Command History

Release

12.2(14)SX

12.2(17d)SXB

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

230

Cisco IOS Configuration Fundamentals Command Reference

D through E diagnostic stop

Release

12.2(33)SRA

12.2(33)SCC

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionalityfor Cisco UBR10012 Universal

Broadband Router. The keywords bay, slot, and

subslot were added for the Cisco UBR10012

Universal Broadband Router.

Usage Guidelines Use the diagnostic start command to start the testing process.

Cisco UBR10012 Router

The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.

Note To stop a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stopwith the

bay, slot or subslot keyword respectively.

The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low

Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and line card index leak tests.

Examples This example shows how to stop the diagnostic test process:

Router# diagnostic stop module 3

Router#

This example shows how to stop the diagnostic test process for subslot 5/0 on the Cisco UBR10012

Universal Broadband Router:

Router# diagnostic stop subslot 5/0

Router#

Related Commands

Command

diagnostic schedule

show diagnostic description

diagnostic start

show diagnostic content module

Description

Sets the diagnostic test schedule for a particular bay, slot, or subslot.

Provides the description for the diagnostic tests.

Stops the specified diagnostic test.

Displays the available diagnostic tests.

Cisco IOS Configuration Fundamentals Command Reference

231

diagnostic stop

Command

diagnostic bootup level

diagnostic event-log size

diagnostic monitor

diagnostic ondemand

show diagnostic bootup

show diagnostic events

show diagnostic ondemand settings

show diagnostic result

show diagnostic schedule

show diagnostic status

D through E

Description

Configures the diagnostic bootup level.

Modifies the diagnostic event-log size dynamically.

Configures the health-monitoring diagnostic testing.

Configures the on-demand diagnostics.

Displays the configured diagnostics level at bootup.

Displays the diagnostic event log.

Displays the settings for the on-demand diagnostics.

Displays the diagnostic test results for a module.

Displays the current scheduled diagnostic tasks.

Displays the running diagnostics tests.

232

Cisco IOS Configuration Fundamentals Command Reference

D through E dir

dir

To display a list of files on a file system, use the dircommand in EXEC, privileged EXEC, or diagnostic mode.

dir [/all] [/recursive] [all-filesystems] [filesystem:] [file-url]

Syntax Description

/all

/recursive all-filesystems

filesystem: file-url

(Optional) Lists deleted files, undeleted files, and files with errors.

(Optional) Lists files recursively.

(Optional) Lists all files in all file systems on the router.

(Optional) File system or directory containing the files to list, followed by a colon.

(Optional) The name of the files to display on a specified device. The files can be of any type. You can use wildcards in the filename. A wildcard character (*) matches all patterns. Strings after a wildcard are ignored.

Command Default

When you omit the /all keyword, the Cisco IOS software displays only undeleted files.

Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History

Release

11.0

12.3

12.3(14)T

12.2(33)SRA

Modification

This command was introduced.

This command was modified. A timestamp that shows the offset from Coordinated Universal Time

(UTC) was added to the dir command display.

This command was modified. The usbflash 0

9 :and usbtoken 0 9 : options were added as available file systems.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

233

D through E dir

Release

12.4(11)T

Cisco IOS XE Release 2.1

15.0(1)M

15.0(01)XO

Modification

This command was modified. Support for this command was implemented on the Cisco 7200VXR

NPE-G2 platform.

This command was introduced on the Cisco ASR

1000 Series Routers, and the following enhancements were introduced:

• The command was made available in diagnostic mode.

• The /recursive option was introduced.

• The file systems available with the Cisco ASR

1000 Series Routers became available as

filesystem: options.

This command was modified. The output modifier was added.

Note added to explain different byte and usage calculations for show file systems and dir commands on cat4000 series routers.

Usage Guidelines Use the show file systemscommand to display more details about the files in a particular file system.

Note As of release 15.0(01)XO, on cat4000 series routers, the show(flash file system) and dirwill display slightly different byte count and usage information for the same file system. This is due to slight difference in how IOS computes these figures for this platform.

You can use the Cisco IOS software output modifiers to filter the output of the dir command, to display only those lines you are interested in.

The output modifier feature is invoked by using the pipe symbol (|). To use this feature, enter the dir command as normal but add a space and the pipe symbol at the end of the command line. Then add one of the keywords shown in the table below.

Table 21 Using Output Modifiers

Command

append regular expression

begin regular expression

include regular expression

Purpose

Appends redirected output to URL (only to the

URLs supporting the append operation).

Displays the first line that matches the regular expression, and then all other lines that follow that line.

Displays all lines that match the regular expression.

234

Cisco IOS Configuration Fundamentals Command Reference

D through E dir

Command

exclude regular expression

format regular expression

redirect regular expression

section regular expression

tee regular expression

Purpose

Displays all lines except those that match the regular expression.

Formats the output using the specification file.

Redirects the output to the URL.

Filters a section of the output.

Copies output to the URL.

Note The append, redirect and tee keywords do not support rcp in the display.

Examples The following is sample output from the dir command:

Router# dir slot0:

Directory of slot0:/

1 -rw- 4720148 Dec 29 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz

2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz

5 -rw- 639 Jan 03 2004 12:09:32 -08:00 rally

7 -rw- 639 Jan 03 2004 12:37:13 -08:00 the_time

20578304 bytes total (3104544 bytes free)

The following is sample output from the dir /allcommand:

Router# dir /all slot0:

Directory of slot0:/

1 -rw- 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz

2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz

3 -rw- 7982828 Jan 02 2004 18:48:14 -08:00 [rsp-jsv-mz]

4 -rw- 639 Jan 03 2004 12:09:17 -08:00 the_time]

5 -rw- 639 Jan 03 1994 12:09:32 -08:00 rally

6 -rw- 639 Jan 03 1994 12:37:01 -08:00 [the_time]

7 -rw- 639 Jan 03 1994 12:37:13 -08:00

The table below describes the significant fields shown in the displays.

Table 22 dir Field Descriptions

Field

-rw-

Description

Index number of the file.

Permissions. The file can be any or all of the following:

• d--directory

• r--readable

• w--writable

• x--executable

Cisco IOS Configuration Fundamentals Command Reference

235

D through E dir

Field

4720148

Dec 15 2003 17:49:36

-08:00 hampton/nitro/c7200-j-mz

Description

Size of the file, in bytes.

Last modification date.

Conversion to local time in hours from Coordinated

Universal Time (UTC). In the example, -08:00 indicates that the given time is 8 hours behind UTC or Pacific Standard Time (PST).

Filename. Deleted files are indicated by square brackets around the filename.

The following example shows how to use the output modifier feature with the exclude keyword and regular expression. The table above describes the significant fields shown in the output.

Routwe# dir | exclude asr

Directory of bootflash:/

12 drwx 4096 Jan 5 2005 01:34:50 +00:00 lost+found

59265 drwx 4096 Apr 20 2004 01:51:10 +00:00 .installer

14817 drwx 4096 Apr 20 2004 01:54:37 +00:00 .ssh

88897 drwx 4096 Jan 7 2005 22:13:26 +00:00 .prst_sync

Related Commands

Command cd delete undelete

Description

Changes the default directory or file system.

Deletes a file on a Flash memory device.

Recovers a file marked “deleted” on a Class A or

Class B flash file system.

236

Cisco IOS Configuration Fundamentals Command Reference

D through E

Examples disable

disable

To exit privileged EXEC mode and return to user EXEC mode, or to exit to a lower privilege level, enter the disable command in EXEC, privileged EXEC, or diagnostic mode.

disable [privilege-level]

Syntax Description privilege-level (Optional) Specific privilege level (other than user

EXEC mode).

Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History

Release

10.0

12.2(33)SRA

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco ASR

1000 Series Routers, and became available in diagnostic mode.

Usage Guidelines Up to 16 security levels can be configured using Cisco IOS software. If such levels are configured on a system, using this command with the privilege-level option allows you to exit to a lower security level. If a level is not specified, the user will exit to the user EXEC mode, which is the default.

Note Five EXEC commands are associated with privilege level 0: disable, enable, exit, help, and logout. If you configure a privilege level greater than 0, these five commands will not be included in the command set for that privilege level.

In the following example, the user enters privileged EXEC mode using the enable command, then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is >, and the prompt for privileged EXEC mode is #.

Router> enable

Password: <letmein>

Router# disable

Router>

Cisco IOS Configuration Fundamentals Command Reference

237

disable

Related Commands

Command enable

D through E

Description

Enables higher privilege level access, such as privileged EXEC mode.

238

Cisco IOS Configuration Fundamentals Command Reference

D through E disconnect-character

disconnect-character

To define a character to disconnect a session, use the disconnect-character command in line configuration mode. To remove the disconnect character, use the no form of this command.

disconnect-character ascii-number

no disconnect-character

Syntax Description ascii-number Decimal representation of the session disconnect character.

Command Default No disconnect character is defined.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters.

The Break character is represented by zero; NULL cannot be represented.

To use the session-disconnect character in normal communications, precede it with the escape character.

Examples The following example defines the disconnect character for virtual terminal line 4 as Escape, which is decimal character 27:

Router(config)# line vty 4

Router(config-line)# disconnect-character 27

Cisco IOS Configuration Fundamentals Command Reference

239

D through E dispatch-character

dispatch-character

To define a character that causes a packet to be sent, use the dispatch-charactercommand in line configuration mode. To remove the definition of the specified dispatch character, usethe noform of this command.

dispatch-character ascii-number1 [ascii-number2...]

no dispatch-character ascii-number1 [ascii-number2...]

Syntax Description ascii-number1

ascii-number2 . . .

Decimal representation of the desired dispatch character.

(Optional) Additional decimal representations of characters. This syntax indicates that you can define any number of characters as dispatch characters.

Command Default No dispatch character is defined.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters.

The dispatch-character command defines one or more dispatch characters that cause a packet to be sent even if the dispatch timer has not expired. Use of a dispatch character causes the Cisco IOS software to attempt to buffer characters into larger-sized packets for transmission to the remote host.

Enable the dispatch-character command from the session that initiates the connection, not from the incoming side of a streaming Telnet session.

This command can take multiple arguments, so you can define any number of characters as dispatch characters.

240

Cisco IOS Configuration Fundamentals Command Reference

D through E dispatch-character

Examples The following example defines the Return character (decimal 13) as the dispatch character for virtual terminal line (vty) line 4:

Router(config)# line vty 4

Router(config-line)# dispatch-character 13

Related Commands

Command dispatch-machine dispatch-timeout state-machine

terminal dispatch-character

Description

Specifies an identifier for a TCP packet dispatch state machine on a particular line.

Sets the character dispatch timer.

Specifies the transition criteria for the state of a particular state machine.

Defines a character that causes a packet to be sent for the current session.

Cisco IOS Configuration Fundamentals Command Reference

241

D through E dispatch-machine

dispatch-machine

To specify an identifier for a TCP packet dispatch state machine on a particular line, use the dispatch-

machine command in line configuration mode. To disable a state machine on a particular line, use the no form of this command.

dispatch-machine name

no dispatch-machine

Syntax Description name Name of the state machine that determines when to send packets on the asynchronous line.

Command Default No dispatch state machine identifier is defined.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

When the dispatch-timeout command is specified, a packet being built will be sent when the timer expires, and the state will be reset to zero.

Any dispatch characters specified using the dispatch-character command are ignored when a state machine is also specified.

If a packet becomes full, it will be sent regardless of the current state, but the state will not be reset. The packet size depends on the traffic level on the asynchronous line and the dispatch-timeout value. There is always room for 60 data bytes. If the dispatch-timeout value is greater than or equal to 100 milliseconds, a packet size of 536 (data bytes) is allocated.

Examples The following example specifies the name linefeedfor the state machine:

Router(config)# state-machine linefeed 0 0 9 0

Router(config)# state-machine linefeed 0 11 255 0

Router(config)# state-machine linefeed 0 10 10 transmit

242

Cisco IOS Configuration Fundamentals Command Reference

D through E dispatch-machine

Router(config)# line 1

Router(config-line)# dispatch-machine linefeed

Related Commands

Command dispatch-character dispatch-timeout state-machine

Description

Defines a character that causes a packet to be sent.

Sets the character dispatch timer.

Specifies the transition criteria for the state of a particular state machine.

Cisco IOS Configuration Fundamentals Command Reference

243

D through E dispatch-timeout

dispatch-timeout

To set the character dispatch timer, use the dispatch-timeoutcommand in line configuration mode. To remove the timeout definition, use the noform of this command.

dispatch-timeout milliseconds

no dispatch-timeout

Syntax Description milliseconds Integer that specifies the number of milliseconds

(ms) that the Cisco IOS software waits after putting the first character into a packet buffer before sending the packet. During this interval, more characters can be added to the packet, which increases the processing efficiency of the remote host.

Command Default No dispatch timeout is defined.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Use this command to increase the processing efficiency for the remote host.

The dispatch-timeout line configuration command causes the software to buffer characters into packets for transmission to the remote host. The Cisco IOS software sends a packet a specified amount of time after the first character is put into the buffer. You can use the dispatch-timeoutand dispatch-character line configuration commands together. In this case, the software dispatches a packet each time the dispatch character is entered, or after the specified dispatch timeout interval, depending on which condition is met first.

244

Cisco IOS Configuration Fundamentals Command Reference

D through E dispatch-timeout

Note The system response time might appear intermittent if the timeout interval is greater than 100 milliseconds and remote echoing is used. For lines with a reverse-Telnet connection, use a dispatch-timeout value less than 10 milliseconds.

Examples The following example sets the dispatch timer to 80 milliseconds for virtual terminal line (vty) lines 0 through 4:

Router(config)# line vty 0 4

Router(config-line)# dispatch-timeout 80

Related Commands

Command buffer-length dispatch-character dispatch-machine state-machine

terminal dispatch-timeout

Description

Specifies the maximum length of data streams forwarded on a line.

Defines a character that causes a packet to be sent.

Specifies an identifier for a TCP packet dispatch state machine on a particular line.

Specifies the transition criteria for the state of a particular state machine.

Sets the character dispatch timer for the current session.

Cisco IOS Configuration Fundamentals Command Reference

245

D through E do

do

To execute user EXEC or privileged EXEC commands from global configuration mode or other configuration modes or submodes, use the docommand in any configuration mode.

do command

Syntax Description command The user EXEC or privileged EXEC command to be executed.

Command Default A user EXEC or privileged EXEC command is not executed from a configuration mode.

Command Modes All configuration modes

Command History

Release

12.2(8)T

12.2(14)S

12.2(14)SX

12.2(17a)SX

12.2(17d)SXB

12.2(33)SRA

15.1(3)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(14)S.

Support for this command was added for the

Supervisor Engine 720.

This command was changed to support the copy command restriction.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 15.1(3)T.

Usage Guidelines

Use this command to execute user EXEC or privileged EXEC commands (such as show, clear, and debug commands) while configuring your routing device. After the EXEC command is executed, the system will return to the configuration mode you were using.

246

Cisco IOS Configuration Fundamentals Command Reference

D through E do

Tip This command can be useful for saving your configuration to the startup-config file without having to return to the user EXEC mode or privileged EXEC mode (do copy running-config startup-config) or for checking the status of a feature (using a do show command) while configuring the feature.

Caution Do not enter the do command in user EXEC mode or privileged EXEC mode. Interruption of service might occur.

You cannot use the do command to execute the configure terminal c ommand because entering the

configure terminal command changes the user EXEC mode or privileged EXEC mode to the global configuration mode.

You cannot use the do command to execute copy or write c ommands in the global configuration or any other configuration mode or submode.

Examples The following example shows how to enter the show interfaces serial privileged EXEC command from within global configuration mode:

Router(config)# do show interfaces serial 3/0

Serial3/0 is up, line protocol is up

Hardware is M8T-RS232

MTU 1500 bytes, BW 1544 Kbit, DLY 20000 usec, rely 255/255, load 1/255

Encapsulation HDLC, loopback not set, keepalive set (10 sec)

Last input never, output 1d17h, output hang never

Last clearing of “show interface” counters never

The following example shows how to enter the clear vpdn tunnel user EXEC or privileged EXEC command from within VPDN configuration mode:

Router(config-vpdn)# do clear vpdn tunnel

Related Commands

Command

clear vpdn tunne l

configure terminal copy

show interfaces

write core

Description

Shuts down a specified VPDN tunnel and all sessions within the tunnel.

Enters global configuration mode.

Copies any file from a source to a destination.

Displays statistics for all interfaces configured on the router or access server.

Tests the configuration of a core dump setup.

Cisco IOS Configuration Fundamentals Command Reference

247

D through E downward-compatible-config

downward-compatible-config

To generate a configuration that is compatible with an earlier Cisco IOS release, use the downward-

compatible-configcommand in global configuration mode. To disable this function, use the no form of this command.

downward-compatible-config version

no downward-compatible-config

Syntax Description version Cisco IOS release number, not earlier than Release

10.2.

Note You must have a period (.) in the version number. For example, 12.4.

Command Default

The configuration is not compatible with earlier Cisco IOS releases.

Command Modes Global configuration (config)

Command History

Release

11.1

12.2(33)SRA

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines In Cisco IOS Release 10.3, IP access lists changed format. Use the downward-compatible-

configcommand to regenerate a configuration in a format prior to Release 10.3 if you will downgrade from your software version to version 10.2 or 10.3. The earliest version value this command accepts is 10.2.

When this command is configured, the router attempts to generate a configuration that is compatible with the specified version. Note that this command affects only IP access lists.

Under some circumstances, the software might not be able to generate a fully backward-compatible configuration. In such a case, the software issues a warning message.

248

Cisco IOS Configuration Fundamentals Command Reference

D through E downward-compatible-config

Examples The following example shows how to generate a configuration file compatible with Cisco IOS Release 10.2

access lists:

Router(config)# downward-compatible-config 10.2

Related Commands

Command

access-list (extended)

access-list (standard)

Description

Provides extended access lists that allow more detailed access lists.

Defines a standard XNS access list.

Cisco IOS Configuration Fundamentals Command Reference

249

D through E editing

editing

To reen able Cisco IOS enhanced editing features for a particular line after they have been disabled, use the

editing command in line configuration mode. To disable these features, use the no form of this command.

editing

no editing

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Enhanced editing features are enabled by default. However, there may be situations in which you need to disable these features. The no form of this command disables these enhanced editing features, and the plain form of the command can be used to reenable these features.

The table below provides a description of the keys used to enter and edit commands when the editing features are enabled. Ctrl indicates the Control key, which must be pressed simultaneously with its associated letter key. Esc indicates the Escape key, which must be pressed first, followed by its associated letter key. A comma is used in the following table to indicate a key sequence (the comma key should not be pressed). Keys are not case sensitive. Many letters used for CLI navigation and editing were chosen to provide an easy way of remembering their functions. In the following table, characters are bolded in the

“Function Summary” column to indicate the relation between the letter used and the function.

250

Cisco IOS Configuration Fundamentals Command Reference

D through E editing

Table 23

Keys

Tab

Command Editing Keys and Functions

Function Summary

Complete command

Return (at the command line) Execute

Return (at the --More-- prompt) Continue

Space Bar (at the --More-prompt)

Delete or Backspace

Left Arrow 1 or Ctrl-B

Continue

Backspace

B ack character

Right Arrow1 or Ctrl-F

Esc, B

Esc, F

F orward character

B ack word

F orward word

1 The arrow keys function only with ANSI-compatible terminals.

Function Details

Completes a partial command name entry. When you enter a unique set of characters and press the Tab key, the system completes the command name. If you enter a set of characters that could indicate more than one command, the system beeps to indicate an error. To view the commands which match the set of characters you have entered, enter a question mark (?) immediately following the partial command

(no space). The CLI will then list the commands that begin with that string.

Executes the command.

Displays the next line of output.

Displays the next screen of output. The amount of output you see will depend on the screen depth setting of your terminal.

Erases the character to the left of the cursor.

Moves the cursor one character to the left. When you enter a command that extends beyond a single line, you can press the Left

Arrow or Ctrl-B keys repeatedly to scroll back toward the system prompt and verify the beginning of the command entry.

Moves the cursor one character to the right.

Moves the cursor back one word.

Moves the cursor forward one word.

Cisco IOS Configuration Fundamentals Command Reference

251

editing

D through E

Keys

Ctrl-A

Ctrl-E

Ctrl-D

Esc, D

Ctrl-W

Ctrl-K

Ctrl-U or Ctrl-X

Ctrl-T

Ctrl-R or Ctrl-L

Ctrl-V or Esc, Q

Up Arrow1 or Ctrl-P

Down Arrow1 or Ctrl-N (next)

Function Summary

Beginning of line

E nd of line

D elete character

D elete next word

Delete previous word

Delete line forward

Delete line backward

T ranspose characters

R edisplay line

Ignore editing

P revious command

N ext command

Function Details

Moves the cursor to the beginning of the line.

Moves the cursor to the end of the command line.

Deletes the character at the cursor.

Deletes from the cursor to the end of the word.

Deletes the word to the left of the cursor.

Deletes all characters from the cursor to the end of the command line.

Deletes all characters from the cursor back to the beginning of the command line.

Transposes the character to the left of the cursor with the character located at the cursor.

Redisplays the system prompt and command line.

Inserts a code to indicate to the system that the keystroke immediately following should be treated as a command entry, not as an editing key.

Recalls commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands.

Returns to more recent commands in the history buffer

(after recalling commands with the Up Arrow or Ctrl-P). Repeat the key sequence to recall successively more recent commands.

252

Cisco IOS Configuration Fundamentals Command Reference

D through E editing

Keys

Ctrl-Y

Esc, Y

Esc, C

Esc, U

Esc, L

Function Summary

Recall last deleted command

Recall next deleted command

C apitalize word

Make word uppercase

Make word lowercase

Function Details

Recalls the most recent entry in the delete buffer. The delete buffer contains the last ten items you have deleted or cut. Ctrl-Y can be used in conjunction with

Esc Y.

Recalls the next entry in the delete buffer. The delete buffer contains the last ten items you have deleted. Press Ctrl-Y first to recall the most recent entry. Then press Esc Y up to nine times to recall the remaining entries in the buffer. If you bypass an entry, continue to press Esc Y to cycle back to it.

Capitalizes the word from the cursor to the end of the word.

Changes all letters from the cursor to the next space on the line appear in uppercase letters.

Changes the word to lowercase from the cursor to the end of the word.

Examples In the following example, enhanced editing mode is disabled on line 3:

Router(config)# line 3

Router(config-line)# no editing

Related Commands

Command

terminal editing

Description

Controls CLI enhanced editing feature for the current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

253

D through E enable

enable

To change the privilege level for a CLI session or to use a CLI view for a CLI session, use the enable command in either user EXEC, privileged EXEC, or diagnostic mode.

enable [privilege-level] [view [view-name]]

Syntax Description privilege-level view view-name

(Optional) Privilege level at which to log in.

(Optional) Enters into root view, which enables users to configure CLI views.

Note This keyword is required if you want to configure a CLI view.

(Optional) Enters or exits a specified command-line interface (CLI) view. This keyword can be used to switch from one CLI view to another CLI view.

Command Default Privilege-level 15 (privileged EXEC)

Command Modes User EXEC (>)

Privileged EXEC (#)

Diagnostic Mode (diag)

Command History

Release

10.0

12.3(7)T

12.2(33)SRA

12.2(33)SRB

12.2SX

Modification

This command was introduced.

The view keyword and view-name argument were added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The view keyword and view-name argument were integrated into Cisco IOS Release 12.2(33)SRB.

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.

254

Cisco IOS Configuration Fundamentals Command Reference

D through E enable

Release

12.2(33)SB

Cisco IOS XE Release 2.1

Modification

This command was integrated into Cisco IOS

Release 12.2(22)SB.

This command became available on the ASR 1000

Series Routers, and became available in diagnostic mode for the first time.

Usage Guidelines

By default, using the enable command without the privilege-level argument in user EXEC mode causes the router to enter privileged EXEC mode (privilege-level 15).

Entering privileged EXEC mode enables the use of privileged commands. Because many of the privileged commands set operating parameters, privileged access should be password-protected to prevent unauthorized use. If the system administrator has set a password with the enable password global configuration command, you are prompted to enter the password before being allowed access to privileged

EXEC mode. The password is case sensitive.

If an enable password has not been set, only enable mode can be accessed through the console connection.

Security levels can be set by an administrator using the enable password and privilege level commands.

Up to 16 privilege levels can be specified, using the numbers 0 through 15. Using these privilege levels, the administrator can allow or deny access to specific commands. Privilege level 0 is associated with user

EXEC mode, and privilege level 15 is associated with privileged EXEC mode.

For more information on defined privilege levels, see the Cisco IOSSecurity Configuration Guide and the

Cisco IOS Security Command Reference publications.

If a level is not specified when entering the enable command, the user will enter the default mode of privileged EXEC (level 15).

Accessing a CLI View

CLI views restrict user access to specified CLI and configuration information. To configure and access CLI views, users must first enter into root view, which is accomplished via the enable view command (without the view-name argument). Thereafter, users are prompted for a password, which is the same password as the privilege level 15 password.

The view-name argument is used to switch from one view to another view.

To prevent dictionary attacks, a user is prompted for a password even if an incorrect view name is given.

The user is denied access only after an incorrect view name and password are given.

Examples In the following example, the user enters privileged EXEC mode (changes to privilege-level 15) by using the enable command without a privilege-level argument. The system prompts the user for a password before allowing access to the privileged EXEC mode. The password is not printed to the screen. The user then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is the greater than symbol (>), and the prompt for privileged EXEC mode is the number sign (#).

Router> enable

Password: <letmein>

Router# disable

Router>

Cisco IOS Configuration Fundamentals Command Reference

255

enable

D through E

The following example shows which commands are available inside the CLI view “first” after the user has logged into this view:

Router# enable view first

Password:

00:28:23:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'.

Router# ?

Exec commands:

configure Enter configuration mode

enable Turn on privileged commands

exit Exit from the EXEC

show Show running system information

Router# show ?

ip IP information

parser Display parser information

version System hardware and software status

Router# show ip ?

access-lists List IP access lists

accounting The active IP accounting database

aliases IP alias table

arp IP ARP table

as-path-access-list List AS path access lists

bgp BGP information

cache IP fast-switching route cache

casa display casa information

cef Cisco Express Forwarding

community-list List community-list

dfp DFP information

dhcp Show items in the DHCP database

drp Director response protocol

dvmrp DVMRP information

eigrp IP-EIGRP show commands

extcommunity-list List extended-community list

flow NetFlow switching

helper-address helper-address table

http HTTP information

igmp IGMP information

irdp ICMP Router Discovery Protocol

The following example shows how to use the enable view command to switch from the root view to the

CLI view “first”:

Router# enable view

Router#

01:08:16:%PARSER-6-VIEW_SWITCH:successfully set to view 'root'.

Router#

! Enable the show parser view command from the root view

Router# show parser view

Current view is 'root'

! Enable the show parser view command from the root view to display all views

Router# show parser view all

Views Present in System:

View Name: first

View Name: second

! Switch to the CLI view “first.”

Router# enable view first

Router#

01:08:09:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'.

! Enable the show parser view command from the CLI view “first.”

Router# show parser view

Current view is 'first'

256

Cisco IOS Configuration Fundamentals Command Reference

D through E

Related Commands

Command disable

enable password

privilege level (global)

privilege level (line) enable

Description

Exits from privileged EXEC mode to user EXEC mode, or, if privilege levels are set, to the specified privilege level.

Sets a local password to control access to various privilege levels.

Sets a privilege level for a command.

Sets a privilege level for a command for a specific line.

Cisco IOS Configuration Fundamentals Command Reference

257

D through E enable last-resort

enable last-resort

To enable password parameters as the last resort without specifying the local enable password if no

TACACS servers respond, use the enable last-resort command in global configuration mode. To disable the password parameters, use the no form of this command.

no enable last-resort {password | succeed}

no enable last-resort

Syntax Description password succeed

Enables password parameters by specifying the local enable password.

Enables password parameters without specifying the local enable password.

Command Default The password parameters for the router are not enabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Examples

The following example shows how to enable password parameters as the last resort without specifying the local enable password if no TACACS servers respond:

Router> enable

Router# configure terminal

Router(config)# enable last-resort succeed

Related Commands

Command

show tacacs

Description

Displays statistics for a TACACS+ server.

258

Cisco IOS Configuration Fundamentals Command Reference

D through E end

end

To en d the current configuration session and return to privileged EXEC mode, use the end command in global configuration mode.

end

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command will bring you back to privileged EXEC mode regardless of what configuration mode or configuration submode you are in.

Note This global configuration command can be used in any configuration mode.

Use this command when you are done configuring the system and you want to return to EXEC mode to perform verification steps.

Examples

In the following example, the end command is used to exit from ALPS ASCU configuration mode and return to privileged EXEC mode. A show command is used in privileged EXEC mode to verify the configuration.

Router# configure terminal

Router(config)# interface serial 1:1

Router(config-if)# alps ascu 4B

Router(config-alps-ascu)# end

Router# show interface serial 1:1

Cisco IOS Configuration Fundamentals Command Reference

259

end

Related Commands

Command

exit (global)

D through E

Description

Exits from the current configuration mode.

260

Cisco IOS Configuration Fundamentals Command Reference

D through E environment-monitor shutdown temperature

environment-monitor shutdown temperature

To enable monitoring of the environment sensors, use the environment-monitor shutdown temperature command in global configuration mode. To disable monitoring of the environment sensors, use the no form of this command.

environment-monitor shutdown temperature [rommon | powerdown]

no environment-monitor shutdown temperature [rommon | powerdown]

Syntax Description rommon powerdown

(Optional) Places the supervisor engine in

ROMMON when a major active alarm is identified.

(Optional) Powers down the supervisor engine when a new active major alarm is identified.

Command Default

By default, rommon is enabled.

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(18)SXF17

12.2(33)SXH6

Examples

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for powerdown keyword added.

This example shows how to place the supervisor engine in ROMMON when a major active alarm occurs:

Router(config)# environment-monitor shutdown temperature rommon

Router(config)#

This example shows how to power down the supervisor engine when a major active alarm occurs:

Router(config)# environment-monitor shutdown temperature powerdown

Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

261

D through E environment temperature-controlled

environment temperature-controlled

To enable the ambient temperature control, use the environment temperature-controlled command in global configuration mode. To disable the ambient temperature control, use the no form of this command.

environment temperature-controlled

no environment temperature-controlled

Syntax Description This command has no arguments or keywords.

Command Default This command is disabled by default.

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command does not affect temperature monitoring and alarm thresholds; it only affects whether a module may be powered on. The software does not validate the inlet temperature.

If you enter the no form of this command and the cooling capacity is reduced below the module cooling requirement, a syslog warning (and SNMP alarm) is generated. This module status does not change, and an environmental alarm is not raised when you enter the no form of this command.

Examples This example shows how to enable the ambient temperature control:

Router(config)# environment temperature-controlled

Router(config)#

This example shows how to disable the ambient temperature control:

Router(config)#

262

Cisco IOS Configuration Fundamentals Command Reference

D through E no environment temperature-controlled

Router(config)# environment temperature-controlled

Cisco IOS Configuration Fundamentals Command Reference

263

D through E erase

erase

To erase a file system or all files available on a file system, use the erasecommand in privileged EXEC or diagnostic mode.

erase {/all nvram: | /no-squeeze-reserve-space filesystem: | filesystem: | startup-config}

Cisco 7600 Series Routers and Cisco ASR 1000 Series Routers

erase {/all nvram: | filesystem: | startup-config}

Syntax Description

/all nvram:

file-system:

/no-squeeze-reserve-space startup-config

Erases all files in the specified file system.

Erases all files in the NVRAM.

File system name, followed by a colon. For example, flash: or nvram:.

Note This argument may not be used if the device memory contains logging persistent files.

Disables the squeeze operation to conserve memory and makes the erase command compatible with older file systems.

Erases the contents of the configuration memory.

Command Modes Privileged EXEC (#) Diagnostic (#)

Command History

Release

11.0

12.2(11)T

12.2(14)SX

12.2(33)SRA

Modification

This command was introduced.

This command was modified. The /no-squeeze-

reserve-spacekeyword was added.

This command was modified. Support for this command was added for the Supervisor Engine

720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

264

Cisco IOS Configuration Fundamentals Command Reference

D through E erase

Release

Cisco IOS XE Release 2.1

15.0(1)M

Modification

This command was modified. The command was introduced in diagnostic mode on the Cisco ASR

1000 Series Routers, and the /all keyword was added.

This command was modified in a release earlier than Cisco IOS Release 15.0(1)M. The file-system : argument was added.

Usage Guidelines The erase nvram: command replaces the write erase command and the erase startup-config command.

Caution When you use the erase command to erase a file system, you cannot recover the files in the file system.

The word help feature is disabled for the erase command. You must enter the complete command name to enable the command. The parser does not complete the command name if you enter partial syntax of the command and press the Tab key. For more information on the word help feature, refer to the Using the

Cisco IOS Command-Line Interface feature guide.

The erasecommand can be used on Class B and Class C flash file systems only.

Class A flash file systems cannot be erased. You can delete individual files using the delete command and then reclaim the space using the squeeze command. You can use the formatcommand to format the flash file system. The format command when used on ATA disk clears the File Allocation Table (FAT) and root directory entries only. The data is not erased.

The erase nvram: command erases NVRAM. On Class A file system platforms, if the CONFIG_FILE variable specifies a file in flash memory, the specified file will be marked “deleted.”

The erase /all nvram: command erases all files on NVRAM, including private NVRAM.

The /no-squeeze-reserve-space keyword is available on systems with small amounts of flash memory in order to conserve memory. When a squeeze operation is performed, the last two erase sectors are permanently reserved for the squeeze logs and squeeze buffer. The /no-squeeze-reserve-spacekeyword prevents the reservation of space that guarantees the ability to run the squeeze command. Disabling the squeeze operation keeps these memory sectors free. If any sectors using squeeze data are detected, they will be erased when the /no-squeeze-reserve-space keyword is used. The /no-squeeze-reserve-space keyword increases the available amount of usable flash space, but you may not be able to run the squeeze command.

This is typically fine if the file system (such as flash) is used to store a single, large file. For example, an

IOS image.

On Class C flash file systems, space is dynamically reclaimed when you use the delete command. You can also use either the format or erase command to reinitialize a Class C flash file system.

Note Use the context-sensitive help to determine which file systems can be used for the erase command. The output will vary based on the platform.

Cisco IOS Configuration Fundamentals Command Reference

265

D through E erase

Examples The following example shows how to erase the NVRAM, including the startup configuration located there:

Router# erase nvram:

The following example shows how to erase all of partition 2 in internal flash memory:

Router# erase flash:2

System flash directory, partition 2:

File Length Name/status

1 1711088 dirt/images/c3600-i-mz

[1711152 bytes used, 15066064 available, 16777216 total]

Erase flash device, partition 2? [confirm]

Are you sure? [yes/no]: yes

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

The following example shows how to erase flash memory when flash is partitioned, but no partition is specified in the command:

Router# erase flash:

System flash partition information:

Partition Size Used Free Bank-Size State Copy-Mode

1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH

2 4096K 2048K 2048K 2048K Read/Write Direct

[Type ?<no> for partition directory; ? for full directory; q to abort]

Which partition? [default = 2]

The system will prompt only if there are two or more read/write partitions. If the partition entered is not valid or is the read-only partition, the process terminates. You can enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (? number) for directory display of a particular partition. The default is the first read/write partition.

System flash directory, partition 2:

File Length Name/status

1 3459720 master/igs-bfpx.100-4.3

[3459784 bytes used, 734520 available, 4194304 total]

Erase flash device, partition 2? [confirm] <Return>

Related Commands

Command

boot config delete

more nvram:startup-config

show bootvar

Description

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Deletes a file on a flash memory device.

Displays the startup configuration file contained in

NVRAM or specified by the CONFIG_FILE environment variable.

266

Cisco IOS Configuration Fundamentals Command Reference

D through E

Command squeeze undelete

write erase erase

Description

Removes all deleted files from the flash file system and recovers the memory space used by deleted files.

Recovers a file marked “deleted” on a Class A or

Class B flash file system.

The write erase command is replaced by the erase

nvram:command. See the description of the erase command for more information

Cisco IOS Configuration Fundamentals Command Reference

267

D through E erase bootflash

erase bootflash

The erase bootflash: and erase bootflash commands have identical functions. See the description of the

erasecommand in this chapter for more information.

268

Cisco IOS Configuration Fundamentals Command Reference

D through E errdisable detect cause

errdisable detect cause

To enable error-disable detection, use the errdisable detect cause command in global configuration mode.

To disable error-disable detection, use the no form of this command.

errdisable detect cause {all | bpduguard | dtp-flap | l2ptguard | link-flap | packet-buffer-error |

pagp-flap | rootguard | udld}

no errdisable detect cause {all | bpduguard | dtp-flap | l2ptguard | link-flap | pagp-flap |

rootguard | udld}

Syntax Description all bpduguard dtp-flap l2ptguard link-flap packet-buffer-error pagp-flap rootguard udld

Specifies error-disable detection for all errordisable causes.

Specifies detection for the Bridge Protocol Data

Unit (BPDU)-guard error-disable cause.

Specifies detection for the Dynamic Trunking

Protocol (DTP)-flap error-disable cause.

Specifies detection for the Layer 2 Protocol

Tunneling guard error-disable cause.

Specifies detection for the link flap error-disable cause.

Causes the packet buffer error to error-disable the affected port.

Specifies detection for the Port Aggregation

Protocol (PAgP)-flap error-disable cause.

Specifies detection for the root-guard error-disable cause.

Specifies detection for the Unidirectional Link

Detection (UDLD) error-disable cause.

Command Default Error-disable detection is enabled for all causes.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

269

D through E errdisable detect cause

Command History

Release

15.0(1)M

12.2(14)SX

12.2(17b)SXA

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was modified. Support was added for the Supervisor Engine 720.

This command was modified. The packet-buffer-

error keyword was added.

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

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Note Entering the no errdisable detect cause packet-buffer-error command allows you to detect the fault that triggers a power cycle of the affected module.

A cause (bpduguard, dtp-flap, link-flap, pagp-flap, root-guard, udld) is defined as the reason why the errordisable state occurred. When a cause is detected on an interface, the interface is placed in an error-disable state (an operational state that is similiar to the link-down state).

You must enter the shutdown and then the no shutdown commands to recover an interface manually from the error-disable state.

Examples The following example shows how to enable error-disable detection for the Layer 2 protocol-tunnel guard error-disable cause:

Router(config)# errdisable detect cause l2ptguard

Related Commands

Command

show errdisable detect

show interfaces status shutdown

Description

Displays the error-disable detection status.

Displays the interface status or a list of interfaces in an error-disable state on LAN ports only.

Disables an interface.

270

Cisco IOS Configuration Fundamentals Command Reference

D through E errdisable recovery

errdisable recovery

To configure recovery mechanism variables, use the errdisable recovery command in global configuration mode. To return to the default state, use the no form of this command.

errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-

violation | rootguard | udld | unicast-flood} | interval seconds}

no errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-

violation | rootguard | udld | unicast-flood} | interval seconds}

Syntax Description cause all arp-inspection bpduguard channel-misconfig dhcp-rate-limit dtp-flap gbic-invalid l2ptguard link-flap pagp-flap psecure-violation

Enables error-disable recovery from a specific cause.

Enables the recovery timers for all error-disable causes.

Enables error-disable recovery from an Address

Resolution Protocol (ARP) inspection cause.

Enables the recovery timer for the Bridge Protocol

Data Unit (BPDU)-guard error-disable cause.

Enables the recovery timer for the channelmisconfig error-disable cause.

Enables the recovery timer for the Dynamic Host

Configuration Protocol (DHCP)-rate-limit errordisable cause.

Enables the recovery timer for the Dynamic

Trunking Protocol (DTP)-flap error-disable cause.

Enables the recovery timer for the Gigabit Interface

Converter (GBIC)-invalid error-disable cause.

Enables the recovery timer for the Layer 2 Protocol

Tunneling (L2PT) error-disable cause.

Enables the recovery timer for the link-flap errordisable cause.

Enables the recovery timer for the Port Aggregation

Protocol (PAgP)-flap error-disable cause.

Enables the recovery timer for the psecure-violation error-disable cause.

Cisco IOS Configuration Fundamentals Command Reference

271

D through E errdisable recovery security-violation rootguard udld unicast-flood

interval seconds

Enables the automatic recovery of ports that were disabled because of 802.1X security violations.

Enables the recovery timer for the root-guard errordisable cause.

Enables the recovery timer for the Unidirectional

Link Detection (UDLD) error-disable cause.

Enables the recovery timer for the unicast-flood error-disable cause.

Specifies the time, in seconds, to recover from a specified error-disable cause. The range is from 30 to 86400. The default interval is 300.

Command Default The recovery mechanisms are disabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(14)SX

12.2(17d)SXB

12.2(18)SXD

12.2(33)SRA

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was modified. This command was implemented on the Supervisor Engine 720.

This command was modified. This command was implemented on the Supervisor Engine 2.

This command was modified. The arp-inspection keyword was added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A cause (bpduguard, channel-misconfig, dhcp-rate-limit, dtp-flap, l2ptguard, link-flap, pagp-flap, psecureviolation, security-violation, rootguard, udld, or unicast-flood) is defined as the reason why the errordisable state occurred. When a cause is detected on an interface, the interface is placed in an error-disable state (an operational state that is similar to the link-down state). If you do not enable error-disable recovery for the cause, the interface stays in the error-disable state until a shutdown and no shutdown occur. If you enable recovery for a cause, the interface is brought out of the error-disable state and allowed to retry operation once all the causes have timed out.

272

Cisco IOS Configuration Fundamentals Command Reference

D through E errdisable recovery

You must enter the shutdown command and then the no shutdown command to manually recover an interface from the error-disable state.

Note A separate line is required each time you want to enter the errdisable recovery cause command to add a new reason for recovery; each new reason does not get appended to the original single line. This means you must enter each new reason separately.

Examples This example shows how to enable the recovery timer for the BPDU-guard error-disable cause:

Router(config)#

errdisable recovery cause bpduguard

This example shows how to set the recovery timer to 300 seconds:

Router(config)#

errdisable recovery interval 300

Related Commands

Command

show errdisable recovery

show interfaces status shutdown

Description

Displays the information about the error-disable recovery timer.

Displays the interface status or a list of interfaces in an error-disabled state on LAN ports only.

Disables an interface.

Cisco IOS Configuration Fundamentals Command Reference

273

D through E escape-character

escape-character

To define a system escape character, use the escape-character command in line configuration mode. To set the escape character to Break, use the noor defaultform of this command.

escape-character {break | char | default | none | soft}

no escape-character [soft]

default escape-character [soft]

Syntax Description break char default none soft

Sets the escape character to Break. Note that the

Break key should not be used as an escape character on a console terminal.

Character (for example, !) or its ASCII decimal representation ( integer in the range of 0 to 255) to be used as the escape character.

Sets the escape key sequence to the default of Ctrl-

^, X.

Disables escape entirely.

Sets an escape character that will wait until pending input is processed before it executes.

Command Default

The default escape key sequence is Ctrl-Shift-6 (Ctrl-^) or Ctrl-Shift-6, X (^^X). The X is generally only required for modem connections.

The default escape-character command sets the escape character to Break (the default setting for Break is

Ctrl-C).

Command Modes Line configuration

Command History

Release

10.0

11.3

12.2(33)SRA

Modification

This command was introduced.

The soft keyword was added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

274

Cisco IOS Configuration Fundamentals Command Reference

D through E escape-character

Usage Guidelines See the "ASCII Character Set and Hexidecimal Values" appendix for a list of ASCII characters.

The escape character (or key sequence) suspends any actively running processes and returns you to privileged EXEC mode or, if a menu is being used, to the system menu interface. The escape character is used for interrupting or aborting a process started by previously executed command. Examples of processes from which you can escape include Domain-Name lookup, ping, trace, and Telnet sessions initiated from the device to which you are connected.

To view the current setting of the escape sequence for a line, use the show line command followed by the specific line identifier (for example, show line 0, or show line console). The default escape sequence for a line is often displayed as ^^X . The first caret symbol represents the Control (Ctrl) key, the second caret symbol is literal (Shift-6), and the X is literal (for most systems, the X is not required).

To set the escape key for the active terminal line session, use the terminal escape-character command.

The Break key cannot be used as an escape character on a console terminal because the Cisco IOS software interprets Break as an instruction to halt the system. Depending upon the configuration register setting, break commands issued from the console line either will be ignored or cause the server to shut down.

To send an escape sequence over a Telnet connection, press Ctrl-Shift-6 twice.

The escape-character soft form of this command defines a character or character sequence that will cause the system to wait until pending input is processed before suspending the current session. This option allows you to program a key sequence to perform multiple actions, such as using the F1 key to execute a command, then execute the escape function after the first command is executed.

The following restrictions apply when using the soft keyword:

• The length of the logout sequence must be 14 characters or fewer.

• The soft escape character cannot be the same as the generic Cisco escape character, Break, or the characters b, d, n, or s.

• The soft escape character should be an ASCII value from 1 to 127. Do not use the number 30.

Examples The following example sets the escape character for the console line to the keyboard entry Ctrl-P, which is represented by the ASCII decimal value of 16:

Router(config)# line console

Router(config-line)# escape-character 16

The following example sets the escape character for line 1 to !, which is represented in the configuration file as the ASCII number 33:

Router(config)# line 1

Router(config-line)# escape-character !

Router(config-line)# end

Router# show running-config

Building configuration...

line 1

autoselect during-login

autoselect ppp

modem InOut

transport preferred none

transport output telnet

escape-character 33

Cisco IOS Configuration Fundamentals Command Reference

275

escape-character

Related Commands

Command

show line

terminal escape-character

D through E

Description

Displays information about the specified line connection, or all the lines.

Sets the escape character for the current terminal line for the current session.

276

Cisco IOS Configuration Fundamentals Command Reference

D through E exec

exec

To allow an EXEC process on a line, use the exec command in line configuration mode. To turn off the

EXEC process for the specified line, use the no form of this command.

exec

no exec

Syntax Description This command has no arguments or keywords.

Command Default The EXEC processes is enabled on all lines.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines When you want to allow only an outgoing connection on a line, use the no exec command.

The no exec command allows you to disable the EXEC process for connections which may attempt to send unsolicited data to the router. (For example, the control port of a rack of modems attached to an auxiliary port of router.) When certain types of data are sent to a line connection, an EXEC process can start, which makes the line unavailable.

When a user tries to Telnet to a line with the EXEC process disabled, the user will get no response when attempting to log on.

Examples The following example disables the EXEC process on line 7.

Router(config)# line 7

Router(config-line)# no exec

Cisco IOS Configuration Fundamentals Command Reference

277

D through E exec-banner

exec-banner

To reenable the display of EXEC and message-of-the-day (MOTD) banners on the specified line or lines, use the exec-banner command in line configuration mode. To suppress the banners on the specified line or lines, use the no form of this command.

exec-banner

no exec-banner

Syntax Description This command has no arguments or keywords.

Command Default Enabled on all lines

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command determines whether the router will display the EXEC banner and the message-of-the-day

(MOTD) banner when an EXEC session is created. These banners are defined with the banner exec and

banner motdglobal configurationcommands. By default, these banner are enabled on all lines. Disable the

EXEC and MOTD banners using the no exec-banner command.

This command has no effect on the incoming banner, which is controlled by the banner incoming command.

The MOTD banners can also be disabled by the no motd-banner line configuration command, which disables MOTD banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-bannercommand is enabled or disabled. The table below summarizes the effects of the exec-banner command and the motd-banner command.

278

Cisco IOS Configuration Fundamentals Command Reference

D through E exec-banner

Table 24 motd-banner (default) no motd-banner

Banners Displayed Based On exec-banner and motd-banner Combinations exec-banner (default)

MOTD banner

EXEC banner

EXEC banner no exec-banner

None

For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. The table below summarizes the effects of the

exec-banner command and the motd-banner command for reverse Telnet connections.

Table 25 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet

Sessions to Async Lines motd-banner (default) no motd-banner exec-banner (default)

MOTD banner

Incoming banner

Incoming banner no exec-banner

Incoming banner

Examples The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4:

Router(config)# line vty 0 4

Router(config-line)# no exec-banner

Related Commands

Command

banner exec

banner incoming

banner motd motd-banner

Description

Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.

Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.

Defines and enables a customized message-of-theday banner.

Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

279

D through E exec-character-bits

exec-character-bits

To configure the character widths of EXEC and configuration command characters, use the exec-

character-bits command in line configuration mode. To restore the default value, use the no form of this command.

exec-character-bits {7 | 8}

no exec-character-bits

Syntax Description

Selects the 7-bit character set. This is the default.

Selects the full 8-bit character set for use of international and graphical characters in banner messages, prompts, and so on.

Command Default

7-bit ASCII character set

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Setting the EXEC character width to 8 allows you to use special graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can cause failures. If a user on a terminal that is sending parity enters the help command, an “ unrecognized command” message appears because the system is reading all 8 bits, and the eighth bit is not needed for the help command.

Note If you are using the autoselect function, set the activation character to the default (Return) and the value for

exec-character-bits to 7. If you change these defaults, the application will not recognize the activation request.

280

Cisco IOS Configuration Fundamentals Command Reference

D through E exec-character-bits

Examples The following example enables full 8-bit international character sets, except for the console, which is an

ASCII terminal. It illustrates use of the default-value exec-character-bits global configuration command and the exec-character-bits line configuration command.

Router(config)# default-value exec-character-bits 8

Router(config)# line 0

Router(config-line)# exec-character-bits 7

Related Commands

Command

default-value exec-character-bits

default-value special-character-bits length

terminal exec-character-bits

terminal special-character-bits

Description

Defines the EXEC character width for either 7 bits or 8 bits.

Configures the flow control default value from a 7bit width to an 8-bit width.

Sets the terminal screen length.

Locally changes the ASCII character set used in

EXEC and configuration command characters for the current session.

Changes the ASCII character widths to accept special characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

281

D through E exec-timeout

exec-timeout

To set the interval that the EXEC command interpreter waits until user input is detected, use the exec-

timeout command in line configuration mode. To remove the timeout definition, use the no form of this command.

exec-timeout minutes [seconds]

no exec-timeout

Syntax Description minutes seconds

Integer that specifies the number of minutes. The default is 10 minutes.

(Optional) Additional time intervals in seconds.

Command Default 10 minutes

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

15.0(1)SY2

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The no form of the command updated to configure an exec-timeout of 0 0on the device.

Usage Guidelines If no input is detected during the interval, the EXEC facility resumes the current connection. If no connections exist, the EXEC facility returns the terminal to the idle state and disconnects the incoming session.

To specify no timeout, enter the no form of this command.

Examples The following example sets a time interval of 2 minutes, 30 seconds:

Router(config)# line console 0

Router(config-line)# exec-timeout 2 30

282

Cisco IOS Configuration Fundamentals Command Reference

D through E

The following example sets a time interval of 10 seconds:

Router(config)# line console 0

Router(config-line)# exec-timeout 0 10 exec-timeout

Cisco IOS Configuration Fundamentals Command Reference

283

D through E execute-on

execute-on

To execute commands on a line card, use the execute-on command in privileged EXEC mode.

execute-on {slot slot-number | all | master} command

Syntax Description

slot slot-number all master command

Executes the command on the line card in the specified slot. Slot numbers can be chosen from the following ranges:

• Cisco 12012 router: 0 to 11

• Cisco 12008 access server: 0 to 7

• Cisco AS5800 access server: 0 to 13

Executes the command on all line cards.

(AS5800 only) Executes the designated command on a Dial Shelf Controller (DSC). Do not use this option; it is used for technical support troubleshooting only.

Cisco IOS command to remotely execute on the line card.

Command Modes Privileged EXEC

Command History

Release

11.2 GS

11.3(2)AA

12.2(33)SRA

12.2(33)SRE

Modification

This command was introduced to support Cisco

12000 series Gigabit Switch Routers.

This command was implemented in images for the

Cisco AS5800 series.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SRE. Pipe '|" options can now be used with show option in the execute-on command on SUP and SAMI consoles.

284

Cisco IOS Configuration Fundamentals Command Reference

D through E execute-on

Usage Guidelines Use this command to execute a command on one or all line cards to monitor and maintain information on one or more line cards (for example, a line card in a specified slot on a dial shelf). This allows you to issue commands remotely; that is, to issue commands without needing to log in to the line card directly. The all form of the command allows you to issue commands to all the line cards without having to log in to each in turn.

Though this command does not have a no form, note that it is possible to use the no form of the remotely executed commands used in this command.

Tip This command is useful when used with show EXEC commands (such as show version), because you can verify and troubleshoot the features found only on a specific line card. Please note, however, that because not all statistics are maintained on the line cards, the output from some of the show commands might not be consistent.

Cisco 12000 GSR Guidelines and Restrictions

You can use the execute-on privileged EXEC command only from Cisco IOS software running on the GRP card.

Timesaver Though you can use the attachprivileged EXEC command to execute commands on a specific line card, using the execute-on slotcommand saves you some steps. For example, first you must use the attach command to connect to the Cisco IOS software running on the line card. Next you must issue the command. Finally you must disconnect from the line card to return to the Cisco IOS software running on the GRP card. With the execute-on slot command, you can perform three steps with one command. In addition, the execute-on allcommand allows you to perform the same command on all line cards simultaneously.

Cisco c7600 Sup Guidelines and Restrictions

Beginning with the 12.2(33)SRE Cisco IOS release, all pipe '|" options can now be used with show option in the execute-on command on SUP and SAMI consoles.

Cisco AS5800 Guidelines and Restrictions

The purpose of the command is to conveniently enable certain commands to be remotely executed on the dial shelf cards from the router without connecting to each line card. This is the recommended procedure, because it avoids the possibility of adversely affecting a good configuration of a line card in the process.

The execute-oncommand does not give access to every Cisco IOS command available on the Cisco

AS5800 access server. In general, the purpose of the execute-on command is to provide access to statistical reports from line cards without directly connecting to the dial shelf line cards.

Caution Do not use this command to change configurations on dial shelf cards, because such changes will not be reflected in the router shelf.

Using this command makes it possible to accumulate inputs for inclusion in the show tech-

supportcommand.

The master form of the command can run a designated command remotely on the router from the DSC card. However, using the console on the DSC is not recommended. It is used for technical support troubleshooting only.

Cisco IOS Configuration Fundamentals Command Reference

285

D through E execute-on

Examples

The show tech-supportcommand for each dial shelf card is bundled into the router shelf's show tech-

support command via the execute-on facility.

The execute-on command also support interactive commands such as the following: router: execute-on slave slot slot

ping

The execute-on command has the same limitations and restrictions as a vty telnet client has; that is, it cannot reload DSC using the following command: router: execute-on slave slot slot

reload

You can use the execute-on command to enable remote execution of the commands included in the following partial list:

• debug dsc clock

• show context

• show diag

• show environment

• show dsc clock

• show dsi

• show dsip

• show tech-support

In the following example, the user executes the show controllers command on the line card in slot 4 of a

Cisco 12000 series GSR:

Router# execute-on slot 4 show controllers

========= Line Card (Slot 4) =======

Interface POS0

Hardware is BFLC POS lcpos_instance struct 6033A6E0

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000400

SUNI rsop intr status 00

CRC16 enabled, HDLC enc, int clock no loop

Interface POS1

Hardware is BFLC POS lcpos_instance struct 6033CEC0

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000600

SUNI rsop intr status 00

CRC32 enabled, HDLC enc, int clock no loop

Interface POS2

Hardware is BFLC POS lcpos_instance struct 6033F6A0

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000800

SUNI rsop intr status 00

CRC32 enabled, HDLC enc, int clock no loop

286

Cisco IOS Configuration Fundamentals Command Reference

D through E execute-on

Interface POS3

Hardware is BFLC POS lcpos_instance struct 60341E80

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000A00

SUNI rsop intr status 00

CRC32 enabled, HDLC enc, ext clock no loop

Router#

In the following example, the user executes the show version command on the line card in slot 2 and 3 of a

Cisco c7600 Sup series device:

Example for c7600 SUP -

Router#execute-on 2 3 show

WORD Command to be executed

| Output modifiers

<cr>

Router#execute-on 2 3 show version

| ?

append Append redirected output to URL (URLs supporting append operation

only)

begin Begin with the line that matches

exclude Exclude lines that match

format Format the output using the specified spec file

include Include lines that match

redirect Redirect output to URL

section Filter a section of output

tee Copy output to URL

Router#execute-on 2 3 execute-on 4 show version

WORD Command to be executed

| Output modifiers

<cr>

Router#execute-on 2 3 execute-on 4 show version

| redirect

bootflash: Uniform Resource Locator

const_nvram: Uniform Resource Locator

disk0: Uniform Resource Locator

disk1: Uniform Resource Locator

nvram: Uniform Resource Locator

sami#2-fs: Uniform Resource Locator

sami#3-fs: Uniform Resource Locator

slavebootflash: Uniform Resource Locator

slaveconst_nvram: Uniform Resource Locator

slavedisk0: Uniform Resource Locator

slavedisk1: Uniform Resource Locator

slavenvram: Uniform Resource Locator

slavercsf: Uniform Resource Locator

slavesup-bootdisk: Uniform Resource Locator

slavesup-bootflash: Uniform Resource Locator

sup-bootdisk: Uniform Resource Locator

sup-bootflash: Uniform Resource Locator

In the following example, the user executes the show command on the line card in slot 4 of a Cisco c7600

SAMI series device:

Router#execute-on 4 show

WORD Command to be executed

| Output modifiers

<cr>

Router#execute-on 4 show

| ?

append Append redirected output to URL (URLs supporting append operation

only)

begin Begin with the line that matches

exclude Exclude lines that match

include Include lines that match

Cisco IOS Configuration Fundamentals Command Reference

287

D through E execute-on

redirect Redirect output to URL

section Filter a section of output

tee Copy output to URL

Related Commands

Command attach

Description

Connects you to a specific line card for the purpose of executing commands using the Cisco IOS software image on that line card.

288

Cisco IOS Configuration Fundamentals Command Reference

D through E exit (EXEC)

exit (EXEC)

To close an active terminal session by logging off the router, use the exit command in EXEC mode.

exit

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values

Command Modes EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use the exit command in EXEC mode to exit the active session (log off the device). This command can be used in any EXEC mode (such as User EXEC mode or Privileged EXEC mode) to exit from the EXEC process.

Examples

In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the exit (EXEC) command is used to log off (exit the active session):

Router(config)# exit

Router# disable

Router> exit

Related Commands

Command disconnect end

Description

Disconnects a line.

Ends your configuration session by exiting to

EXEC mode.

Cisco IOS Configuration Fundamentals Command Reference

289

exit (EXEC)

Command

exit (global) logout

D through E

Description

Exits from the current configuration mode to the next highest configuration mode.

Closes your connection to the device (equivilant to the exit command).

290

Cisco IOS Configuration Fundamentals Command Reference

D through E exit (global)

exit (global)

To exit any configuration mode to the next highest mode in the CLI mode hierarchy, use the exit command in any configuration mode.

exit

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values

Command Modes All configuration modes

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The exit command is used in the Cisco IOS CLI to exit from the current command mode to the next highest command mode in the CLI mode hierarchy.

For example, use the exit command in global configuration mode to return to privileged EXEC mode. Use the exit command in interface, line, or router configuration mode to return to global configuration mode.

Use the exit command in subinterface configuration mode to return to interface configuration mode. At the highest level, EXEC mode, the exit command will exit the EXEC mode and disconnect from the router interface (see the description of the exit (EXEC) command for details).

Examples The following example shows how to exit from the subinterface configuration mode and to return to the interface configuration mode:

Router(config-subif)# exit

Router(config-if)#

The following example displays an exit from the interface configuration mode to return to the global configuration mode:

Router(config-if)# exit

Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

291

exit (global)

Related Commands

Command disconnect end

exit (EXEC)

D through E

Description

Disconnects a line.

Ends your configuration session by exiting to privileged EXEC mode.

Closes the active terminal session by logging off the router.

292

Cisco IOS Configuration Fundamentals Command Reference

F through K

•

file prompt, page 294

•

file verify auto, page 295

•

•

•

•

•

•

•

history size, page 315

•

hold-character, page 317

•

hostname, page 319

•

hw-module reset, page 321

•

hw-module shutdown, page 322

•

insecure, page 323

•

international, page 324

•

ip bootp server, page 326

•

ip finger, page 328

•

ip ftp passive, page 330

•

ip ftp password, page 331

•

ip ftp source-interface, page 333

•

ip ftp username, page 335

•

ip rarp-server, page 337

•

ip rcmd domain-lookup, page 339

•

ip rcmd rcp-enable, page 341

•

ip rcmd remote-host, page 343

•

ip rcmd remote-username, page 346

•

ip rcmd rsh-enable, page 348

•

ip rcmd source-interface, page 350

•

ip telnet source-interface, page 352

•

ip tftp blocksize, page 354

•

ip tftp boot-interface, page 355

•

ip tftp min-timeout, page 356

•

ip tftp source-interface, page 357

•

ip wccp web-cache accelerated, page 359

Cisco IOS Configuration Fundamentals Command Reference

293

F through K file prompt

file prompt

To specify the level of prompting, use the file promptcommand in global configuration mode.

file prompt prompt [alert | noisy | quiet]

Syntax Description alert noisy quiet

(Optional) Prompts only for destructive file operations. This is the default.

(Optional) Confirms all file operation parameters.

(Optional) Seldom prompts for file operations.

Command Default alert

Command Modes Global configuration

Command History

Release

11.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to change the amount of confirmation needed for different file operations.

This command affects only prompts for confirmation of operations. The router will always prompt for missing information.

Examples The following example configures confirmation prompting for all file operations:

Router(config)# file prompt noisy

294

Cisco IOS Configuration Fundamentals Command Reference

F through K file verify auto

file verify auto

To enable automatic image verification, use the file verify auto command in global configuration mode. To disable automatic image verification, use the no form of this command.

file verify auto

no file verify auto

Syntax Description This command has no arguments or keywords.

Command Default Image verification is not automatically applied to all images that are copied or reloaded onto a router.

Command Modes Global configuration

Command History

Release

12.2(18)S

12.0(26)S

12.2(14)SX

12.2(17d)SXB

12.3(4)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.0(26)S.

This command was integrated into Cisco IOS

Release 12.2(14)SX and implemented on the

Supervisor Engine 720.

Support was added for the Supervisor Engine 2.

This command was integrated into Cisco IOS

Release 12.3(4)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Image verification is accomplished by verifying the compressed Cisco IOS image checksum.

Image verification allows users to automatically verify the integrity of all Cisco IOS images. Thus, users can be sure that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user.

The file verify auto command enables image verification globally; that is, all images that are to be copied

(via the copy command) or reloaded (via the reload command) are automatically verified. Although both the copy and reload commands have a /verify keyword that enables image verification, you must issue the

Cisco IOS Configuration Fundamentals Command Reference

295

F through K file verify auto keyword each time you want to copy or reload an image. The file verify auto command enables image verification by default so you no longer have to specify image verification multiple times.

If you have enabled image verification by default but prefer to disable verification for a specific image copy or reload, the /noverify keyword along with either the copy or the reload command will override the

file verify auto command.

Examples The following example shows how to enable automatic image verification:

Router(config)# file verify auto

Related Commands

Command copy copy/noverify reload verify

Description

Copies any file from a source to a destination.

Disables the automatic image verification for the current copy operation.

Reloads the operating system.

Verifies the checksum of a file on a Flash memory file system or computes an MD5 signature for a file.

296

Cisco IOS Configuration Fundamentals Command Reference

F through K format

format

To format a Class A, Class B, or Class C flash memory file system, use the format command in privileged

EXEC or diagnostic mode.

Class B and Class C Flash File Systems

format filesystem1:

Class A Flash File System

format [spare spare-number] filesystem1 : [[filesystem2:][monlib-filename]]

Syntax Description spare spare-number

filesystem1 :

filesystem2 : monlib-filename

(Optional) Reserves spare sectors as specified by the spare-number argument when you format flash memory.

(Optional) Number of the spare sectors to reserve in formatted flash memory. Valid values are from 0 to

16. The default value is 0.

Flash memory to format, followed by a colon.

Valid values for use with the Cisco 7600 series router are disk0: disk1:, bootflash:, slot0:, sup-

slot0:, and sup-bootflash:; see the “Usage

Guidelines” section for additional information.

Valid values for use with the ASR 1000 Series

Routers are bootflash:, harddisk:, stby-harddisk:,

obfl:, and usb[0 1];.

(Optional) File system containing the monlib file to use for formatting the argument

filesystem1followed by a colon.

(Optional) Name of the ROM monitor library file

(monlib file) to use for formatting the

filesystem1argument. The default monlib file is the one bundled with the system software.

Dual Route Switch Processors (RSP) High System

Availability (HSA) Functionality

When this command is used with Dual RSPs and you do not specify the monlib-filenameargument, the system takes the ROM monitor library file from the slave image bundle. If you specify the monlib-

filename argument, the system assumes that the files reside on the slave devices.

Cisco IOS Configuration Fundamentals Command Reference

297

F through K format

Command Default spare-number : 0monlib-filename:The monlib file bundled with the system software

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

11.0

12.2(14)SX

12.2(17d)SXB

12.3(14)T

12.2(33)SRA

Cisco IOS XE Release 2.1

12.2YST

Modification

This command was introduced.

Support for this command was added for the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

Support for Class B flash (USB flash and USB eToken) file systems was added as part of the USB

Storage feature.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco ASR

1000 Series Routers and the following enhancements were introduced:

• This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 Series

Routers.

• The harddisk:, obfl:, stby-harddisk:, stby-

usb[0-1]: and usb[0-1]: filesystem1 : options were introduced.

This command was integrated into Cisco IOS

Release 12.2YST.

Usage Guidelines Reserve a certain number of memory sectors as spares, so that if some sectors fail, most of the flash memory card can still be used. Otherwise, you must reformat the flash card after some of the sectors fail.

Use this command to format Class A, B, or C flash memory file systems. The Cisco 7600 series router supports only Class A and Class C flash file systems.

In some cases, you might need to insert a new Personal Computer Memory Card Industry Association

(PCMCIA) flash memory or flash PC card and load images or backup configuration files onto it. Before you can use a new flash memory or flash PC card, you must format it.

Sectors in flash memory or flash PC cards can fail. Reserve certain flash memory or flash PC sectors as

“spares” by using the optional spare-number argument on the format command to specify 0 to 16 sectors

298

Cisco IOS Configuration Fundamentals Command Reference

F through K format

Examples as spares. If you reserve a small number of spare sectors for emergencies, you can still use most of the flash memory or flash PC card. If you specify 0 spare sectors and some sectors fail, you must reformat the flash memory or flash PC card, thereby erasing all existing data.

The monlib file is the ROM monitor library. The ROM monitor uses this file to access files in the flash file system. The Cisco IOS system software contains a monlib file. Use the show disk0: allcommand to display monlib file details.

When this command is used with HSA and you do not specify the monlib-filename argument, the system takes the ROM monitor library file from the slave image bundle. If you specify the monlib-filename

argument, the system assumes that the files reside on the slave devices.

In the command syntax, the filesystem1 :argumentspecifies the device to format and the

filesystem2 :argumentspecifies the optional device containing the monlib file used to format the

filesystem1 :argument. The device determines which monlib file to use, as follows:

• If you omit the optional filesystem2 : and monlib-filename arguments, the system formats the

filesystem1 : argument using the monlib file already bundled with the system software.

• If you omit only theoptional filesystem2 : argument, the system formats the filesystem1 : argumentusing the monlib file from the device you specified with the cd command.

• If you omit only the optional monlib-filename argument, the system formats filesystem1 : using the

filesystem2 : monlib file.

• When you specify both arguments--filesystem2 : and monlib-filename-- the system formats the

filesystem1 : argumentusing the monlib file from the specified device.

• You can specify the filesystem1 :arguments’s own monlib file in this argument. If the system cannot find a monlib file, it terminates its formatting.

Note Most platforms do not support booting from images stored on flash memory cards . You should reboot your device only from integrated memory locations, such as NVRAM.

Cisco 7600 Series Router Notes

The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2.

Use the format command to format Class A or C flash memory file systems.

• The disk0: and disk1: keywords are for Class C file systems.

• The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are for Class A file systems.

The disk0: keyword is supported on Cisco 7600 series routers that are configured with a Supervisor Engine

2 only.

Cisco ASR 1000 Series Routers Notes

This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 Series

Routers.

The following example shows how to format a flash memory card that is inserted in slot 0:

Router# format slot0:

Running config file on this device, proceed? [confirm] y

All sectors will be erased, proceed? [confirm] y

Enter volume id (up to 31 characters): <Return>

Cisco IOS Configuration Fundamentals Command Reference

299

F through K format

Formatting sector 1 (erasing)

Format device slot0 completed

When the console returns to the privileged EXEC prompt, the new flash memory card is formatted and ready for use.

This following example shows how to format a CompactFlash PC card that is inserted in slot 0:

Router# format disk0:

Running config file on this device, proceed? [confirm] y

All sectors will be erased, proceed? [confirm] y

Enter volume id (up to 31 characters): <Return>

Formatting sector 1 (erasing)

Format device disk0 completed

When the console returns to the EXEC prompt, the new CompactFlash PC card is formatted and ready for use.

This follwing example shows how a format operation cleans up the disk and writes the monitor library on the disk filesystem:

Router# format formatdisk:

Format operation may take a while. Continue? [confirm]

Format operation will destroy all data in "bootdisk:". Continue? [confirm]

Hash Computation: 100%Done!

Computed Hash SHA2: DFBA87256310DC8A7B7BF8158451F7F4

0AC333C9B396D9D0E42DDBD542C30E08

F3946DDE692AF04F0B20F29BE51C49C4

1B631790A542D81F9A7C90ABC2426960

Embedded Hash SHA2: DFBA87256310DC8A7B7BF8158451F7F4

0AC333C9B396D9D0E42DDBD542C30E08

F3946DDE692AF04F0B20F29BE51C49C4

1B631790A542D81F9A7C90ABC2426960

Digital signature successfully verified in file Monlib

Writing Monlib sectors....

Monlib write complete

Format: All system sectors written. OK...

Format: Total sectors in formatted partition: 1000881

Format: Total bytes in formatted partition: 512451072

Format: Operation completed successfully.

Format of bootdisk: complete

Related Commands

Command cd copy delete

show disk0: all

show file systems squeeze undelete

Description

Changes the default directory or file system.

Copies any file from a source to a destination.

Deletes a file on a flash memory device.

Displays ATA MONLIB file information for disk0.

Lists available file systems.

Permanently deletes flash files by squeezing a Class

A flash file system.

Recovers a file marked “deleted” on a Class A or

Class B flash file system.

300

Cisco IOS Configuration Fundamentals Command Reference

F through K fsck

fsck

To check a File Allocation Table (FAT)-based disk, a flash file system, or a Class C file system for damage and to repair any problems, use the fsckcommand in privileged EXEC or diagnostic mode.

Supported Platforms Other than the Cisco 7600 Series and Cisco ASR1000 Series Routers

fsck [/nocrc] [/automatic] [/all] [/force] [filesystem:]

Cisco 7600 Series Routers

fsck [/automatic] [/all] [/force] [filesystem:]

Cisco ASR 1000 Series Routers

fsck [/all] [/force] [filesystem:]

Syntax Description

/nocrc

/automatic

/ all

/force

filesystem :

(Optional) This keyword is available for Class C flash file systems only. Omits cyclic redundancy checks (CRCs).

(Optional) This keyword is available for Advanced

Technology Attachment (ATA) FAT-based disks only. Specifies that the check and repair actions should proceed automatically. This option can be used to skip the prompts for each check and repair action.

Note This command also specifies the automatic mode for the Cisco 7600 series router; see the “Usage Guidelines” section for additional information.

(Optional) Specifies that all partitions on the disk be checked for problems.

(Optional) Ensures forced termination of simultaneous file operations on the same device.

The file system prefix indicating the disk to be checked. The colon (:) is required. Typically, the file system prefix will be disk0: or disk1:. In case of dual processors, the file system on the redundant supervisor engine can also be specified.

Command Default A FAT-based disk, flash file system, or Class C file system is not checked for damage and repaired. If you do not enter the /automatic keyword, command-line interface (CLI) prompts for actions are issued. For the

Cisco 7600 series router, if you do not specify the disk0: keyword, the current file system is checked.

Cisco IOS Configuration Fundamentals Command Reference

301

F through K fsck

This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 series routers.

Command Modes Privileged EXEC (#) Diagnostic (diag)

Command History

Release

11.3 AA

12.0(22)S

12.2(13)T

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Cisco IOS XE Release 2.1

15.0(1)M

Modification

This command was introduced.

This command was implemented on the Cisco 7000 family of routers and on the Cisco 10000 series router and the Gigabit Switch Router (GSR) to support ATA disks.

This command was integrated into Cisco IOS

Release 12.2(13)T.

This command was modified. Support for this command was added for the Supervisor Engine

720.

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

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco ASR

1000 Series Routers and the following enhancements were introduced:

• This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 series routers.

• The /all option was introduced.

• The harddisk:, obfl:, stby-harddisk:, stby-

usb[0-1]:,and usb[0-1]: filesystem : options were introduced.

This command was modified. The /force keyword was added.

Usage Guidelines Supported Platforms Other than Cisco 7600 Series Router

302

Cisco IOS Configuration Fundamentals Command Reference

F through K fsck

This command performs all steps necessary to remove corrupted files and reclaim unused disk space.

Changes include checking for incorrect file sizes, cluster loops, and so on. The default form of this command issues multiple prompts to confirm each of the changes. However, you can skip these prompts by using the /automatic keyword when issuing the command.

When you use the /automatickeyword you are prompted to confirm that you want the automatic option.

Prompts for actions will be skipped, but all actions performed are displayed to the terminal (see the example below).

This command works with ATA Personal Computer Memory Card Industry Association (PCMCIA) cards formatted in Disk Operating System (DOS), or for Class C flash file systems.

Note Only one partition (the active partition) is checked in the ATA disk.

Table 26

Cisco 7600 Series Router

The disk0: or slavedisk0: file systems are the only file systems in the Cisco 7600 series routers on which you can run the File-System-Check ( fsck) utility. The slavedisk0: file system appears in redundant supervisor engine systems only.

This command is valid only on Class C flash file systems and only on PCMCIA ATA flash disks and

CompactFlash disks.

The output for the fsck slavedisk0: command is similar to the fsck disk0: command output.

If you do not enter any arguments, the current file system is used. Use the pwd command to display the current file system.

If you enter the disk0: or slavedisk0: keyword, the fsck utility checks the selected file system for problems. If a problem is detected, a prompt is displayed asking if you want the problem fixed.

If you enter the /automatic keyword, you are prompted to confirm that you want the automatic mode. In automatic mode, problems are fixed automatically and you are not prompted to confirm.

If you do not specify the /forcekeyword, any simultaneous file operations on the same device are not terminated. Instead, an error message stating files are open for read or write access appears. If you specify the /force keyword, the fsck utility terminates files that are open for read or write access and continues to check for problems.

The table below lists the checks and actions that are performed by the fsck utility.

fsck Utility Checks and Actions

Checks

Checks the boot sector and the partition table and reports the errors.

Actions

No action.

Validates the media with the signature in the last 2 bytes of the first sector (0x55 and 0xaa, respectively).

No action.

Checks the os_id to find whether this is a FAT-12 or FAT-16 file system (valid values include 0, 1, 4, and 6).

No action.

Checks the number of FAT’s field (correct values are 1 and 2).

No action.

Cisco IOS Configuration Fundamentals Command Reference

303

F through K fsck

Checks

Checks these values:

• n_fat_sectors cannot be less than 1.

• n_root_entries cannot be less than 16.

• n_root_sectors cannot be less than 2.

• base_fat_sector, n_sectors_per_cluster, n_heads, n_sectors_per_track is not 0.

Actions

No action.

Checks the files and FAT for these errors:

Checks the FAT for invalid cluster numbers.

If the cluster is a part of a file chain, the cluster is changed to end of file (EOF). If the cluster is not part of a file chain, it is added to the free list and unused cluster chain. The table below lists valid cluster numbers; numbers other than those listed in the table below are invalid numbers.

Checks the file’s cluster chain for loops.

Checks the directories for nonzero size fields.

Checks for invalid start cluster file numbers.

Checks files for bad or free clusters.

Checks to see if the file’s cluster chain is longer than indicated by the size fields.

Checks to see if two or more files share the same cluster

(crosslinked).

Checks to see if the file’s cluster chain is shorter than is indicated by the size fields.

If the loop is broken, the file is truncated at the cluster where the looping occurred.

If directories are found with nonzero size fields, the size is reset to zero.

If the start cluster number of a file is invalid, the file is deleted.

If the file contains bad or free clusters, the file is truncated at the last good cluster; an example is the cluster that points to this bad/free cluster.

If the file’s cluster chain is longer than indicated by the size fields, the file size is recalculated and the directory entry is updated.

If two or more files are crosslinked, you are prompted to accept the repair, and one of the files is truncated.

If the file’s cluster chain is shorter than is indicated by the size fields, the file size is recalculated and the directory entry is updated.

Checks to see if there are any unused cluster chains.

If unused cluster chains are found, new files are created and linked to that file with the name fsck-start cluster

The table below lists the valid cluster numbers. Numbers other than those listed in the table below are invalid numbers.

Table 27 Valid Cluster Numbers

Cluster

Next entry in the chain

FAT-12

2-FEF

FAT-16

2-FFEF

304

Cisco IOS Configuration Fundamentals Command Reference

F through K

Examples fsck

Cluster

Last entry in chain

Available cluster

Bad Cluster

FAT-12

FF8-FFF

FF7

FAT-16

FFF8-FFFF

FFF7

Supported Platforms Other than the Cisco 7600 Series Router

The following example shows sample output from the fsck command in automatic mode:

Router# fsck /automatic disk1:

Proceed with the automatic mode? [yes] y

Checking the boot sector and partition table...

Checking FAT, Files and Directories...

Start cluster of file disk1:/file1 is invalid, removing file

File disk1:/file2 has a free/bad cluster, truncating...

File disk1:/file2 truncated.

File disk1:/file3 has a free/bad cluster, truncating...

File disk1:/file3 truncated.

File disk1:/file4 has a invalid cluster, truncating...

File disk1:/file4 truncated.

File disk1:/file5 has a invalid cluster, truncating...

File disk1:/file5 truncated.

File disk1:/file6 has a invalid cluster, truncating...

File disk1:/file6 truncated.

File size of disk1:/file7 is not correct, correcting it

File disk1:/file8 cluster chain has a loop, truncating it

File disk1:/file8 truncated.

File disk1:/file9 cluster chain has a loop, truncating it

File disk1:/file9 truncated.

File disk1:/file16 has a free/bad cluster, truncating...

File disk1:/file16 truncated.

File disk1:/file20 has a free/bad cluster, truncating...

File disk1:/file20 truncated.

Reclaiming unused space...

Created file disk1:/fsck-4 for an unused cluster chain

Created file disk1:/fsck-41 for an unused cluster chain

Created file disk1:/fsck-73 for an unused cluster chain

Created file disk1:/fsck-106 for an unused cluster chain

Created file disk1:/fsck-121 for an unused cluster chain

Created file disk1:/fsck-132 for an unused cluster chain

Created file disk1:/fsck-140 for an unused cluster chain

Created file disk1:/fsck-156 for an unused cluster chain

Created file disk1:/fsck-171 for an unused cluster chain

Created file disk1:/fsck-186 for an unused cluster chain

Created file disk1:/fsck-196 for an unused cluster chain

Created file disk1:/fsck-235 for an unused cluster chain

Created file disk1:/fsck-239 for an unused cluster chain

Updating FAT...

fsck of disk1: complete

Cisco 7600 Series Router

This example shows how to run a check of the current file system:

Router# fsck

Checking the boot sector and partition table...

Checking FAT, Files and Directories...

Files

1) disk0:/FILE3 and

2) disk0:/FILE2

Cisco IOS Configuration Fundamentals Command Reference

305

F through K fsck

have a common cluster.

Press 1/2 to truncate or any other character to ignore[confirm] q

Ignoring this error and continuing with the rest of the check...

Files

1) disk0:/FILE5 and

2) disk0:/FILE4

have a common cluster.

Press 1/2 to truncate or any other character to ignore[confirm] 1

File disk0:/FILE5 truncated.

Files

1) disk0:/FILE7 and

2) disk0:/FILE6

have a common cluster.

1) disk0:/FILE15 and

2) disk0:/FILE13

have a common cluster.

Press 1/2 to truncate or any other character to ignore[confirm] i

Ignoring this error and continuing with the rest of the check...

Reclaiming unused space...

Created file disk0:/fsck-11 for an unused cluster chain

Created file disk0:/fsck-20 for an unused cluster chain

Created file disk0:/fsck-30 for an unused cluster chain

Created file disk0:/fsck-35 for an unused cluster chain

Created file disk0:/fsck-40 for an unused cluster chain

Created file disk0:/fsck-46 for an unused cluster chain

Created file disk0:/fsck-55 for an unused cluster chain

Created file disk0:/fsck-62 for an unused cluster chain

Created file disk0:/fsck-90 for an unused cluster chain

Updating FAT...

fsck of disk0: complete

Related Commands

Command cd pwd

Description

Changes the default directory or file system.

Shows the current setting of the cd command.

306

Cisco IOS Configuration Fundamentals Command Reference

F through K full-help

full-help

To get help f or the full set of user-level commands, use the full-help command in line configuration mode.

full-help

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The full-help command enables (or disables) an unprivileged user to see all of the help messages available.

It is used with the show ? command.

Examples In the following example, the show ? command is used first with full-help disabled. Then full-help is enabled for the line, and the show ? command is used again to demonstrate the additional help output that is displayed.

Router> show ?

bootflash Boot Flash information

calendar Display the hardware calendar

clock Display the system clock

context Show context information

dialer Dialer parameters and statistics

history Display the session command history

hosts IP domain-name, lookup style, nameservers, and host table

isdn ISDN information

kerberos Show Kerberos Values

modemcap Show Modem Capabilities database

ppp PPP parameters and statistics

rmon rmon statistics

sessions Information about Telnet connections

snmp snmp statistics

terminal Display terminal configuration parameters

users Display information about terminal lines

version System hardware and software status

Cisco IOS Configuration Fundamentals Command Reference

307

F through K full-help

Router> enable

Password:<letmein>

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# line console 0

Router(config-line)# full-help

Router(config-line)# exit

Router#

%SYS-5-CONFIG_I: Configured from console by console

Router# disable

Router> show ?

access-expression List access expression

access-lists List access lists

aliases Display alias commands

apollo Apollo network information

appletalk AppleTalk information

arp ARP table

async Information on terminal lines used as router interfaces

bootflash Boot Flash information

bridge Bridge Forwarding/Filtering Database [verbose]

bsc BSC interface information

bstun BSTUN interface information

buffers Buffer pool statistics

calendar Display the hardware calendar

translate Protocol translation information

ttycap Terminal capability tables

users Display information about terminal lines

version System hardware and software status

vines VINES information

vlans Virtual LANs Information

whoami Info on current tty line

x25 X.25 information

xns XNS information

xremote XRemote statistics

Related Commands

Command help

Description

Displays a brief description of the help system.

308

Cisco IOS Configuration Fundamentals Command Reference

F through K help

help

To display a brief description of the help system, use the help command in any command mode.

help

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC

Privileged EXEC

All configuration modes

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The help command provides a brief description of the context-sensitive help system, which functions as follows:

• To list all commands available for a particular command mode, enter a question mark (?) at the system prompt.

• To obtain a list of commands that begin with a particular character string, enter the abbreviated command entry immediately followed by a question mark (?). This form of help is called word help , because it lists only the keywords or arguments that begin with the abbreviation you entered.

• To list the keywords and arguments associated with a command, enter a question mark (?) in place of a keyword or argument on the command line. This form of help is called command syntax help , because it lists the keywords or arguments that apply based on the command, keywords, and arguments you have already entered.

Examples In the following example, the help command is used to display a brief description of the help system:

Router#

help

Help may be requested at any point in a command by entering

Cisco IOS Configuration Fundamentals Command Reference

309

F through K help a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options.

Two styles of help are provided:

1. Full help is available when you are ready to enter a

command argument (e.g. 'show ?') and describes each possible

argument.

2. Partial help is provided when an abbreviated argument is entered

and you want to know what arguments match the input

(e.g. 'show pr?'.)

The following example shows how to use word help to display all the privileged EXEC commands that begin with the letters “co.” The letters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command.

Router# co? configure connect copy

Router# co

The following example shows how to use command syntax help to display the next argument of a partially complete access-list command. One option is to add a wildcard mask. The <cr> symbol indicates that the other option is to press Enter to execute the command without adding any more keywords or arguments.

The characters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command or to execute that command as it is.

Router(config)# access-list 99 deny 131.108.134.234 ?

A.B.C.D Mask of bits to ignore

<cr>

Router(config)# access-list 99 deny 131.108.134.234

Related Commands

Command full-help

Description

Enables help for the full set of user-level commands for a line.

310

Cisco IOS Configuration Fundamentals Command Reference

F through K hidekeys

hidekeys

To suppress the display of password information in configuration log files, use the hidekeys command in configuration change logger configuration mode. To allow the display of password information in configuration log files, use the no form of this command.

hidekeys

no hidekeys

Syntax Description This command has no arguments or keywords.

Command Default Password information is displayed.

Command Modes Configuration change logger configuration

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines

Enabling the hidekeys command increases security by preventing password information from being displayed in configuration log files.

Examples The following example shows how to prevent password information from being displayed in configuration log files:

Router# configure terminal

Cisco IOS Configuration Fundamentals Command Reference

311

F through K hidekeys

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)# hidekey s

Router(config-archive-log-config)# end

Related Commands

Command archive

log config

logging enable

logging size

notify syslog

show archive log config

Description

Enters archive configuration mode.

Enters configuration change logger configuration mode.

Enables the logging of configuration changes.

Specifies the maximum number of entries retained in the configuration log.

Enables the sending of notifications of configuration changes to a remote syslog.

Displays entries from the configuration log.

312

Cisco IOS Configuration Fundamentals Command Reference

F through K history

history

To enable the command history function, use the history command in line configuration mode. To disable the command history function, use the no form of this command.

history

no history

Syntax Description This command has no arguments or keywords.

Command Default Enabled with ten command lines in the buffer.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The command history function provides a record of EXEC commands that you have entered. This function is particularly useful for recalling long or complex commands or entries, including access lists.

To change the number of command lines that the system will record in its history buffer, use the history

size line configuration command.

The history command enables the history function with the last buffer size specified or, if there was not a prior setting, with the default of ten lines. The no history command disables the history function.

The show history EXEC command will list the commands you have entered, but you can also use your keyboard to display individual commands. The table below lists the keys you can use to recall commands from the command history buffer.

Cisco IOS Configuration Fundamentals Command Reference

313

F through K history

Table 28

Key(s)

History Keys

Ctrl-P or Up Arrow

Ctrl-N or Down Arrow1

Functions

Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.

Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the

Up Arrow. Repeat the key sequence to recall successively more recent commands.

Examples In the following example, the command history function is disabled on line 4:

Router(config)# line 4

Router(config-line)# no history

Related Commands

Command

history size

show history

terminal history

Description

Sets the command history buffer size for a particular line.

Lists the commands you have entered in the current

EXEC session.

Enables the command history function for the current terminal session or changes the size of the command history buffer for the current terminal session.

2 The arrow keys function only with ANSI-compatible terminals.

314

Cisco IOS Configuration Fundamentals Command Reference

F through K history size

history size

To change the command history buffer size for a particular line, use the history size command in line configuration mode. To reset the command history buffer size to ten lines, use the no form of this command.

history size number-of-lines

no history size

Syntax Description number-of-lines Specifies the number of command lines that the system will record in its history buffer. The range is from 0 to 256. The default is 10.

Command Default 10 command lines

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The history size command should be used in conjunction with the history and show history commands.

The history command enables or disables the command history function. The show history command lists the commands you have entered in the current EXEC session. The number of commands that the history buffer will show is set by the history size command.

Note The history size command only sets the size of the buffer; it does not reenable the history function. If the

no history command is used, the history command must be used to reenable this function.

Examples The following example displays line 4 configured with a history buffer size of 35 lines:

Router(config)# line 4

Router(config-line)# history size 35

Cisco IOS Configuration Fundamentals Command Reference

315

history size

Related Commands

Command history

show history

terminal history size

F through K

Description

Enables or disables the command history function.

Lists the commands you have entered in the current

EXEC session.

Enables the command history function for the current terminal session or changes the size of the command history buffer for the current terminal session.

316

Cisco IOS Configuration Fundamentals Command Reference

F through K hold-character

hold-character

To define the local hold character used to pause output to the terminal screen, use the hold-character command in line configuration mode. To restore the default, use the no form of this command.

hold-character ascii-number

no hold-character

Syntax Description ascii-number ASCII decimal representation of a character or control sequence (for example, Ctrl-P).

Command Default No hold character is defined.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Break character is represented by zero; NULL cannot be represented. To continue the output, enter any character after the hold character. To use the hold character in normal communications, precede it with the escape character. See the “ASCII Character Set” appendix for a list of ASCII characters.

Examples The following example sets the hold character to Ctrl-S, which is ASCII decimal character 19:

Router(config)# line 8

Router(config-line)# hold-character 19

Related Commands

Command

terminal hold-character

Description

Sets or changes the hold character for the current session.

Cisco IOS Configuration Fundamentals Command Reference

317

hold-character

F through K

318

Cisco IOS Configuration Fundamentals Command Reference

F through K hostname

hostname

To specify or modify the hostname for the network server, use the hostname command in global configuration mode.

hostname name

Syntax Description name New hostname for the network server.

Command Default The default hostname is Router.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

12.2(33)SB

12.2(33)SXI

Cisco IOS XE Release 2.5

15.0(1)M4

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.5.

This command was integrated into Cisco IOS

Release 15.0(1)M4 and support for numeric hostnames added.

Usage Guidelines The hostname is used in prompts and default configuration filenames.

Do not expect case to be preserved. Uppercase and lowercase characters look the same to many internet software applications. It may seem appropriate to capitalize a name the same way you might do in English, but conventions dictate that computer names appear all lowercase. For more information, refer to RFC

1178, Choosing a Name for Your Computer .

The name must also follow the rules for ARPANET hostnames. They must start with a letter, end with a letter or digit, and have as interior characters only letters, digits, and hyphens. Names must be 63 characters

Cisco IOS Configuration Fundamentals Command Reference

319

F through K hostname or fewer. Creating an all numeric hostname is not recommended but the name will be accepted after an error is returned.

Router(config)#hostname 123

% Hostname contains one or more illegal characters.

123(config)#

A hostname of less than 10 characters is recommended. For more information, refer to RFC 1035, Domain

Names--Implementation and Specification .

On most systems, a field of 30 characters is used for the hostname and the prompt in the CLI. Note that the length of your hostname may cause longer configuration mode prompts to be truncated. For example, the full prompt for service profile configuration mode is:

(config-service-profile)#

However, if you are using the hostname of “Router,” you will only see the following prompt (on most systems):

Router(config-service-profil)#

If the hostname is longer, you will see even less of the prompt:

Basement-rtr2(config-service)#

Keep this behavior in mind when assigning a name to your system (using the hostname global configuration command). If you expect that users will be relying on mode prompts as a CLI navigation aid, you should assign hostnames of no more than nine characters.

The use of a special character such as '\'(backslash) and a three or more digit number for the character setting like hostname, results in incorrect translation:

Router(config)#

Router(config)#hostname \99

% Hostname contains one or more illegal characters.

Examples The following example changes the hostname to “host1”:

Router(config)# hostname host1 host1(config)#

Related Commands

Command setup

Description

Enables you to make major changes to your configurations, for example, adding a protocol suit, making major addressing scheme changes, or configuring newly installed interfaces.

320

Cisco IOS Configuration Fundamentals Command Reference

F through K hw-module reset

hw-module reset

To reset a module by turning the power off and then on, use the hw-module reset command in privileged

EXEC mode.

hw-module module num reset

Syntax Description module num Applies the command to a specific module; see the

“Usage Guidelines” section for valid values.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

12.2(31)SB2

Modification

This command was introduced on the Supervisor

Engine 720.

This command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

12.2(31)SB2.

Usage Guidelines The num argument designates the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13.

Examples This example shows how to reload a specific module:

Router# hw-module module 3 reset

Cisco IOS Configuration Fundamentals Command Reference

321

F through K hw-module shutdown

hw-module shutdown

To shut down the module, use the hw-module shutdown command in privileged EXEC mode.

hw-module module num shutdown

Syntax Description module num Applies the command to a specific module; see the

“Usage Guidelines” section for valid values.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on the SSL Services Module and the NAM.

If you enter the hw-module shutdowncommand to shut down the module, you will have to enter the no power enable module command and the power enable module command to restart (power down and then power up) the module.

Examples This example shows how to shut down and restart the module:

Router# hw-module module 3 shutdown

Router# no power enable module 3

Router# power enable module 3

322

Cisco IOS Configuration Fundamentals Command Reference

F through K insecure

insecure

To configure a line as insecure, use the insecure command in line configuration mode. To disable this function, use the no form of this command.

insecure

no insecure

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to identify a modem line as insecure for DEC local area transport (LAT) classification.

Examples In the following example, line 10 is configured as an insecure dialup line:

Router(config)# line 10

Router(config-line)# insecure

Cisco IOS Configuration Fundamentals Command Reference

323

F through K international

international

If you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji) and print the Escape character as a single character instead of as the caret and bracket symbols (^[), use the international command in line configuration mode. To display characters in 7-bit format, use the no form of this command.

international

no international

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History

Release

11.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you are configuring a Cisco IOS platform using the Cisco web browser user interface (UI), this function is enabled automatically when you enable the Cisco web browser UI using the ip http server global configuration command.

Examples The following example enables a Cisco IOS platform to display 8-bit and multibyte characters and print the

Escape character as a single character instead of as the caret and bracket symbols (^[) when you are using

Telnet to access the platform: line vty 4

international

324

Cisco IOS Configuration Fundamentals Command Reference

F through K

Related Commands

Command

terminal international international

Description

Prints the Escape character as a single character instead of as the caret and bracket symbols (^[) for a current Telnet session in instances when you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji).

Cisco IOS Configuration Fundamentals Command Reference

325

F through K ip bootp server

ip bootp server

To enable the Bootstrap Protocol (BOOTP) service on your routing device, use the ip bootp server command in global configuration mode. To disable BOOTP services, use the no form of the command.

ip bootp server

no ip bootp server

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes Global configuration

Command History

Release

11.2

12.0(1)T

12.2(8)T

12.2(33)SRA

Modification

This command was introduced.

The DHCP relay agent and DHCP server features were introduced. BOOTP forwarding is now handled by the DHCP relay agent implementation.

The ip dhcp bootp ignore command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines By default, the BOOTP service is enabled. When disabled, the no ip bootp server command will appear in the configuration file.

The integrated Dynamic Host Configuration Protocol (DHCP) server was introduced in Cisco IOS Release

12.0(1)T. Because DHCP is based on BOOTP, both of these services share the “well-known” UDP server port of 67 (per RFC 951, RFC 1534, and RFC 2131; the client port is 68). To disable DHCP services

(DHCP relay and DHCP server), use the no service dhcp command. To disable BOOTP services (in releases 12.2(8)T and later), but leave DHCP services enabled, use the ip dhcp bootp ignore command.

If both the BOOTP server and DHCP server are disabled, “ICMP port unreachable” messages will be sent in response to incoming requests on port 67, and the original incoming packet will be discarded. If DHCP is enabled, using the no ip bootp server command by itself will not stop the router from listening on UDP port 67.

326

Cisco IOS Configuration Fundamentals Command Reference

F through K ip bootp server

Note As with all minor services, the async line BOOTP service should be disabled on your system if you do not have a need for it in your network. Any network device that has User Data Protocol (UDP), TCP, BOOTP,

DHCP, or Finger services should be protected by a firewall or have the services disabled to protect against

Denial of Service attacks.

Examples In the following example, BOOTP and DHCP services are disabled on the router:

Router(config)# no ip bootp server

Router(config)# no service dhcp

Related Commands

Command

ip dhcp bootp ignore

service dhcp

Description

Configures the Cisco IOS DHCP server to selectively ignore and not reply to received

Bootstrap Protocol (BOOTP) request packets, allowing you continue using DHCP while disabling

BOOTP.

Enables the Cisco IOS Dynamic Host

Configuration Protocol (DHCP) server and relay agent features.

Cisco IOS Configuration Fundamentals Command Reference

327

F through K ip finger

ip finger

To configure a system to accept Finger protocol requests (defined in RFC 742), use the ip finger command in global configuration mode. To disable this service, use the noform of this command.

ip finger [rfc-compliant]

no ip finger

Syntax Description rfc-compliant (Optional) Configures the system to wait for

“Return” or “/W” input when processing Finger requests. This keyword should not be used for those systems.

Command Default Disabled

Command Modes Global configuration

Command History

Release

11.3

12.1(5), 12.1(5)T

12.2(33)SRA

Modification

This command was introduced.

This command was changed from being enabled by default to being disabled by default.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The Finger service allows remote users to view the output equivalent to the show users [wide] command.

When ip finger is configured, the router will respond to a telnet a.b.c.d finger command from a remote host by immediately displaying the output of the show userscommand and then closing the connection.

When the ip finger rfc-compliantcommandis configured, the router will wait for input before displaying anything (as required by RFC 1288). The remote user can then enter the Return key to display the output of the show users EXEC command, or enter /W to display the output of the show users wide EXEC command. After this information is displayed, the connection is closed.

328

Cisco IOS Configuration Fundamentals Command Reference

F through K ip finger

Examples

Note As with all minor services, the Finger service should be disabled on your system if you do not have a need for it in your network. Any network device that has UDP, TCP, BOOTP, or Finger services should be protected by a firewall or have the services disabled to protect against Denial of Service attacks.

Because of the potential for hung lines, the rfc-compliantform of this command should not be configured for devices with more than 20 simultaneous users.

The following example disables the Finger protocol:

Router(config)# no ip finger

Cisco IOS Configuration Fundamentals Command Reference

329

F through K ip ftp passive

ip ftp passive

To configure the router to use only passive FTP connections, use the ip ftp passivecommand in global configuration mode . To allow all types of FTP connections, use the noform of this command.

ip ftp passive

no ip ftp passive

Syntax Description This command has no arguments or keywords.

Command Default All types of FTP connections are allowed.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the router is configured to use only passive FTP connections:

Router(config)# ip ftp passive

Related Commands

Command

ip ftp password

ip ftp source-interface

ip ftp username

Description

Specifies the password to be used for FTP connections.

Specifies the source IP address for FTP connections.

Configures the username for FTP connections.

330

Cisco IOS Configuration Fundamentals Command Reference

F through K ip ftp password

ip ftp password

To specify the password to be used for File Transfer Protocol (FTP) connections, use the ip ftp

passwordcommand in global configuration mode. To return the password to its default, use the no form of this command.

ip ftp password [type] password

no ip ftp password

Syntax Description type password

(Optional) Type of encryption to use on the password. A value of 0 disables encryption. A value of 7 indicates proprietary encryption.

Password to use for FTP connections.

Command Default The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples

The following example configures the router to use the username “red” and the password “blue” for FTP connections:

Router(config)# ip ftp username red

Router(config)# ip ftp password blue

Cisco IOS Configuration Fundamentals Command Reference

331

ip ftp password

Related Commands

Command

ip ftp password

ip ftp source-interface

ip ftp username

F through K

Description

Specifies the password to be used for FTP connections.

Specifies the source IP address for FTP connections.

Configures the username for FTP connections.

332

Cisco IOS Configuration Fundamentals Command Reference

F through K ip ftp source-interface

ip ftp source-interface

To specify the source IP address for File Transfer Protocol (FTP) connections, use the ip ftp source-

interfacecommand in global configuration mode. To use the address of the interface where the connection is made, use the no form of this command.

ip ftp source-interface interface-type interface-number

no ip ftp source-interface

Syntax Description

interface-type interface-number The interface type and number to use to obtain the source address for FTP connections.

Command Default The FTP source address is the IP address of the interface that the FTP packets use to leave the router.

Command Modes Global configuration (config)

Command History

Release

10.3

12.3(6)

12.3(8)T

12.2(33)SRA

Modification

This command was introduced.

Destination address lookup in a Virtual Private

Network (VPN) routing and forwarding (VRF) table was added for the transfer of FTP packets.

This command was integrated into Cisco IOS

Release 12.3(8)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to set the same source address for all FTP connections.

In Cisco IOS 12.3(6) and later releases, FTP is VRF-aware, which means that FTP transfer is supported across an interface within a VRF instance. To specify a VRF as a source for FTP connections, the VRF must be associated with the same interface that you configure with the ip ftp source-interface command.

In this configuration, FTP looks for the destination IP address for file transfer in the specified VRF table. If the specified source interface is not up, Cisco IOS software selects the address of the interface closest to the destination as the source address.

Cisco IOS Configuration Fundamentals Command Reference

333

F through K ip ftp source-interface

Examples The following example shows how to configure the router to use the IP address associated with Ethernet interface 0 as the source address on all FTP packets, regardless of which interface is actually used to send the packet:

Router> enable

Router# configure terminal

Router(config)# ip ftp source-interface ethernet 0

The following example shows how to configure the router to use the VRF table named vpn1 to look for the destination IP address for the transfer of FTP packets:

Router# configure terminal

Router(config)# ip ftp source-interface ethernet 0

Router(config)# ip vrf vpn1

Router(config-vrf)# rd 200:1

Router(config-vrf)# route-target both 200:1

Router(config-vrf)# interface ethernet 0

Router(config-if)# ip vrf forwarding vpn1

Router(config-if)# end

Related Commands

Command

ip ftp passive

ip ftp password

ip ftp username

Description

Configures the router to use only passive FTP connections.

Specifies the password to be used for FTP connections.

Configures the username for FTP connections.

334

Cisco IOS Configuration Fundamentals Command Reference

F through K ip ftp username

ip ftp username

To configure the username for File Transfer Protocol (FTP) connections, use the ip ftp usernamecommand in global configuration mode . To configure the router to attempt anonymous FTP, use the noform of this command.

ip ftp username username

no ip ftp username

Syntax Description username Username for FTP connections.

Command Default The Cisco IOS software attempts an anonymous FTP.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The remote username must be associated with an account on the destination server.

Examples In the following example, the router is configured to use the username “red” and the password “blue”for

FTP connections:

Router(config)# ip ftp username red

Router(config)# ip ftp password blue

Related Commands

Command

ip ftp passive

Description

Configures the router to use only passive FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

335

ip ftp username

Command

ip ftp password

ip ftp source-interface

F through K

Description

Specifies the password to be used for FTP connections.

Specifies the source IP address for FTP connections.

336

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rarp-server

ip rarp-server

To enable the router to act as a Reverse Address Resolution Protocol (RARP) server, use the ip rarp-

server command in interface configuration mode. To restore the interface to the default of no RARP server support, use the noform of this command.

ip rarp-server ip-address

no ip rarp-server ip-address

Syntax Description ip-address IP address that is to be provided in the source protocol address field of the RARP response packet. Normally, this is set to whatever address you configure as the primary address for the interface.

Command Default Disabled

Command Modes Interface configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This feature makes diskless booting of clients possible between network subnets where the client and server are on separate subnets.

RARP server support is configurable on a per-interface basis, so that the router does not interfere with

RARP traffic on subnets that need no RARP assistance.

The Cisco IOS software answers incoming RARP requests only if both of the following two conditions are met:

• The ip rarp-server command has been configured for the interface on which the request was received.

• A static entry is found in the IP ARP table that maps the MAC address contained in the RARP request to an IP address.

Use the show ip arp EXEC command to display the contents of the IP ARP cache.

Sun Microsystems, Inc. makes use of RARP and UDP-based network services to facilitate network-based booting of SunOS on it’s workstations. By bridging RARP packets and using both the ip helper-address

Cisco IOS Configuration Fundamentals Command Reference

337

F through K ip rarp-server interface configuration command and the ip forward-protocol global configuration command, the Cisco

IOS software shouldbe able to perform the necessary packet switching to enable booting of Sun workstations across subnets. Unfortunately, some Sun workstations assume that the sender of the RARP response, in this case the router, is the host that the client can contact to TFTP load the bootstrap image.

This causes the workstations to fail to boot.

By using the ip rarp-server command, the Cisco IOS software can be configured to answer these RARP requests, and the client machine should be able to reach its server by having its TFTP requests forwarded through the router that acts as the RARP server.

In the case of RARP responses to Sun workstations attempting to diskless boot, the IP address specified in the ip rarp-server interface configuration command should be the IP address of the TFTP server. In addition to configuring RARP service, the Cisco IOS software must be configured to forward UDP-based

Sun portmapper requests to completely support diskless booting of Sun workstations. This can be accomplished using configuration commands of the following form: ip forward-protocol udp 111 interface interface name ip helper-address target-address

RFC 903 documents the RARP.

Examples The following partial example configures a router to act as a RARP server. The router is configured to use the primary address of the specified interface in its RARP responses.

arp 172.30.2.5 0800.2002.ff5b arpa interface ethernet 0 ip address 172.30.3.100 255.255.255.0

ip rarp-server 172.30.3.100

In the following example, a router is configured to act as a RARP server, with TFTP and portmapper requests forwarded to the Sun server:

! Allow the router to forward broadcast portmapper requests ip forward-protocol udp 111

! Provide the router with the IP address of the diskless sun arp 172.30.2.5 0800.2002.ff5b arpa interface ethernet 0

! Configure the router to act as a RARP server, using the Sun Server's IP

! address in the RARP response packet.

ip rarp-server 172.30.3.100

! Portmapper broadcasts from this interface are sent to the Sun Server.

ip helper-address 172.30.3.100

Related Commands

Command

ip forward-protocol

ip helper-address

Description

Speeds up flooding of UDP datagrams using the spanning-tree algorithm.

Forwards UDP broadcasts, including BOOTP, received on an interface.

338

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd domain-lookup

ip rcmd domain-lookup

To reena ble the basic Domain Name Service (DNS) security check for rcp and rsh, use the ip rcmd

domain-lookupcommand in global configuration mode. T o disable the basic DNS security check for remote copy protocol (rcp) and remote shell protoco (rsh), use the no form of this command.

ip rcmd domain-lookup

no ip rcmd domain-lookup

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The abbreviation RCMD (remote command) is used to indicate both rsh and rcp.

DNS lookup for RCMD is enabled by default (provided general DNS services are enabled on the system using the ip domain-lookupcommand).

The no ip rcmd domain-lookup command is used to disable the DNS lookup for RCMD. The ip rcmd

domain-lookup command is used to reenable the DNS lookup for RCMD.

DNS lookup for RCMD is performed as a basic security check. This check is performed using a host authentication process. When enabled, the system records the address of the requesting client. That address is mapped to a host name using DNS. Then a DNS request is made for the IP address for that host name.

The IP address received is then checked against the original requesting address. If the address does not match with any of the addresses received from DNS, the RCMD request will not be serviced.

This reverse lookup is intended to help protect against spoofing. However, please note that the process only confirms that the IP address is a valid “routable” address; it is still possible for a hacker to spoof the valid

IP address of a known host.

The DNS lookup is done after the TCP handshake but before the router (which is acting as a rsh/rcp server) sends any data to the remote client.

The no ip rcmd domain-lookup will turn off DNS lookups for rsh and rcp only. The no ip domain-

lookup command takes precedence over the ip rcmd domain-lookupcommand. This means that if the no

Cisco IOS Configuration Fundamentals Command Reference

339

F through K ip rcmd domain-lookup

ip domain-lookup command is in the current configuration, DNS will be bypassed for rcp and rsh even if the ip rcmd domain-lookup command is enabled.

Examples

In the following example, the DNS security check is disabled for RCMD (rsh/rcp):

Router(config)# no ip rcmd domain-lookup

Related Commands

Command

ip domain-lookup

Description

Enables the IP DNS-based host name-to-address translation.

340

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd rcp-enable

ip rcmd rcp-enable

To configure the Cisco IOS software to allow remote users to copy files to and from the router using remote copy protocol (rcp), use the ip rcmd rcp-enable command in global configuration mode. To disable rcp on the device, use the no form of this command.

ip rcmd rcp-enable

no ip rcmd rcp-enable

Syntax Description This command has no arguments or keywords.

Command Default

To ensure security, the router is not enabled for rcp by default.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To allow a remote user to execute rcp commands on the router, you must also create an entry for the remote user in the local authentication database using the ip rcmd remote-host command.

The no ip rcmd rcp-enable command does not prohibit a local user from using rcp to copy system images and configuration files to and from the router.

To protect against unauthorized users copying the system image or configuration files, the router is not enabled for rcp by default.

Examples In the following example, the rcp service is enabled on the system, the IP address assigned to the

Loopback0 interface is used as the source address for outbound rcp and rsh packets, and access is granted to the user “netadmin3”on the remote host 172.16.101.101:

Router(config)# ip rcmd rcp-enable

Router(config)# ip rcmd source-interface Loopback0

Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3

Cisco IOS Configuration Fundamentals Command Reference

341

ip rcmd rcp-enable

Related Commands

Command

ip rcmd remote-host

F through K

Description

Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp.

342

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd remote-host

ip rcmd remote-host

To create an entry for the remote user in a local authentication database so that remote users can execute commands on the router using remote shell protocol (rsh) or remote copy protocol (rcp), use the ip rcmd

remote-host command in global configuration mode. To remove an entry for a remote user from the local authentication database, use the no form of this command.

ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]]

no ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]]

Syntax Description local-username ip-address host-name remote-username

enable [level]

Name of the user on the local router. You can specify the router name as the username. This name needs to be communicated to the network administrator or to the user on the remote system.

To be allowed to remotely execute commands on the router, the remote user must specify this value correctly.

IP address of the remote host from which the local router will accept remotely executed commands.

Either the IP address or the host name is required.

Name of the remote host from which the local router will accept remotely executed commands.

Either the host name or the IP address is required.

Name of the user on the remote host from which the router will accept remotely executed commands.

(Optional) Enables the remote user to execute privileged EXEC commands using rsh or to copy files to the router using rcp. The range is from 1 to

15. The default is 15. For information on the enable level, refer to the privilege level global configuration command in the Release 12.2 Cisco

IOS Security Command Reference.

Command Default

No entries are in the local authentication database.

Command Modes Global configuration

Cisco IOS Configuration Fundamentals Command Reference

343

F through K ip rcmd remote-host

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A TCP connection to a router is established using an IP address. Using the host name is valid only when you are initiating an rcp or rsh command from a local router. The host name is converted to an IP address using DNS or host-name aliasing.

To allow a remote user to execute rcp or rsh commands on a local router, you must create an entry for the remote user in the local authentication database. You must also enable the router to act as an rsh or rcp server.

To enable the router to act as an rsh server, issue the ip rcmd rsh-enable command. To enable the router to act as an rcp server, issue the ip rcmd rcp-enable command.The router cannot act as a server for either of these protocols unless you explicitly enable the capacity.

A local authentication database, which is similar to a UNIX .rhosts file, is used to enforce security on the router through access control. Each entry that you configure in the authentication database identifies the local user, the remote host, and the remote user. To permit a remote user of rsh to execute commands in privileged EXEC mode or to permit a remote user of rcp to copy files to the router, specify the enable keyword and level. For information on the enable level, refer to the privilege level global configuration command in the Release 12.2 Cisco IOS Security Command Reference.

An entry that you configure in the authentication database differs from an entry in a UNIX .rhostsfile in the following aspect. Because the .rhosts file on a UNIX system resides in the home directory of a local user account, an entry in a UNIX .rhosts file need not include the local username; the local username is determined from the user account. To provide equivalent support on a router, specify the local username along with the remote host and remote username in each authentication database entry that you configure.

For a remote user to be able to execute commands on the router in its capacity as a server, the local username, host address or name, and remote username sent with the remote client request must match values configured in an entry in the local authentication file.

A remote client host should be registered with DNS. The Cisco IOS software uses DNS to authenticate the remote host’s name and address. Because DNS can return several valid IP addresses for a host name, the

Cisco IOS software checks the address of the requesting client against all of the IP addresses for the named host returned by DNS. If the address sent by the requester is considered invalid, that is, it does not match any address listed with DNS for the host name, then the software will reject the remote-command execution request.

Note that if no DNS servers are configured for the router, then that device cannot authenticate the host in this manner. In this case, the Cisco IOS software sends a broadcast request to attempt to gain access to

DNS services on another server. If DNS services are not available, you must use the no ip domain-lookup command to disable the attempt to gain access to a DNS server by sending a broadcast request.

If DNS services are not available and, therefore, you bypass the DNS security check, the software will accept the request to remotely execute a command only if all three values sent with the request match exactly the values configured for an entry in the local authentication file.

344

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd remote-host

Examples The following example allows the remote user named netadmin3 on a remote host with the IP address

172.16.101.101 to execute commands on router1 using the rsh or rcp protocol. User netadmin3 is allowed to execute commands in privileged EXEC mode.

Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3 enable

Related Commands

Command

ip rcmd rcp-enable

ip domain-lookup

ip rcmd rsh-enable

Description

Configures the Cisco IOS software to allow remote users to copy files to and from the router.

Enables the IP DNS-based host name-to-address translation.

Configures the router to allow remote users to execute commands on it using the rsh protocol.

Cisco IOS Configuration Fundamentals Command Reference

345

F through K ip rcmd remote-username

ip rcmd remote-username

To configure the remote username to be used when requesting a remote copy using remote copy protocol

(rcp), use the ip rcmd remote-usernamecommand in global configuration mode . To remove from the configuration the remote username, use the noform of this command.

ip rcmd remote-username username

no ip rcmd remote-username username

Syntax Description username Name of the remote user on the server. This name is used for rcp copy requests. All files and images to be copied are searched for or written relative to the directory of the remote user’s account, if the server has a directory structure, for example, as do

UNIX systems.

Command Default If you do not issue this command, the Cisco IOS software sends the remote username associated with the current tty process, if that name is valid, for rcp copy commands. For example, if the user is connected to the router through Telnet and the user was authenticated through the usernamecommand, then the software sends that username as the remote username.

Note The remote username must be associated with an account on the destination server.

If the username for the current tty process is not valid, the Cisco IOS software sends the host name as the remote username. For rcp boot commands, the Cisco IOS software sends the access server host name by default.

Note For Cisco, tty lines are commonly used for access services. The concept of tty originated with UNIX. For

UNIX systems, each physical device is represented in the file system. Terminals are called tty devices (tty stands for teletype, the original UNIX terminal).

Command Modes Global configuration

Command History

Release

10.3

Modification

This command was introduced.

346

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd remote-username

Release

12.2(33)SRA

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The rcp protocol requires that a client send the remote username on an rcp request to the server. Use this command to specify the remote username to be sent to the server for an rcp copy request. If the server has a directory structure, as do UNIX systems, all files and images to be copied are searched for or written relative to the directory of the remote user’s account.

Note Cisco IOS Release 10.3 added the ip keyword to rcmd commands. If you are upgrading from Release 10.2

to Release 10.3 or a later release, this keyword is automatically added to any rcmd commands you have in your Release 10.2 configuration files.

Examples

The following example configures the remote username to netadmin1:

Router(config)# ip rcmd remote-username netadmin1

Related Commands

Command

boot network rcp

boot system rcp

bridge acquire copy

Description

Changes the default name of the network configuration file from which to load configuration commands.

Specifies the system image that the router loads at startup.

Forwards any frames for stations that the system has learned about dynamically.

Copies any file from a source to a destination.

Cisco IOS Configuration Fundamentals Command Reference

347

F through K ip rcmd rsh-enable

ip rcmd rsh-enable

To configure the router to allow remote users to execute commands on it using remote shell protocol (rsh), use the ip rcmd rsh-enable command in global configuration mode. To disable a router that is enabled for rsh, use the no form of this command.

ip rcmd rsh-enable

no ip rcmd rsh-enable

Syntax Description This command has no arguments or keywords.

Command Default To ensure security, the router is not enabled for rsh by default.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines rsh, used as a client process, gives users the ability to remotely get router information (such as status) without the need to connect into the router and then disconnect. This is valuable when looking at many statistics on many different routers.

Use this command to enable the router to receive rsh requests from remote users. In addition to issuing this command, you must create an entry for the remote user in the local authentication database to allow a remote user to execute rsh commands on the router.

The no ip rcmd rsh-enable command does not prohibit a local user of the router from executing a command on other routers and UNIX hosts on the network using rsh. The no form of this command only disables remote access to rsh on the router.

Examples The following example enables a router as an rsh server:

Router(config)# ip rcmd rsh-enable

348

Cisco IOS Configuration Fundamentals Command Reference

F through K

Related Commands

Command

ip rcmd remote-host ip rcmd rsh-enable

Description

Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp.

Cisco IOS Configuration Fundamentals Command Reference

349

F through K ip rcmd source-interface

ip rcmd source-interface

To force remote copy protocol (rcp) or remote shell protocol (rsh) to use the IP address of a specified interface for all outgoing rcp/rsh communication packets, use the ip rcmd source-interface command in global configuration mode. To disable a previously configured ip rcmd source-interface command, use the no form of this command.

ip rcmd source-interface interface-id

no ip rcmd source-interface interface-id

Syntax Description interface-id The name and number used to identify the interface. For example, Loopback2.

Command Default The address of the interface closest to the destination is used as the source interface for rcp/rsh communications.

Command Modes Global configuration

Command History

Release

11.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If this command is not used, or if the interface specified in this command is not available (not up), the

Cisco IOS software uses the address of the interface closest to the destination as the source address.

Use this command to force the system to tag all outgoing rcp/rsh packets with the IP address associated with the specified interface. This address is used as the source address as long as the interface is in the up state.

This command is especially useful in cases where the router has many interfaces, and you want to ensure that all rcp and/or rsh packets from this router have the same source IP address. A consistent address is preferred so that the other end of the connection (the rcp/rsh server or client) can maintain a single session.

The other benefit of a consistent address is that an access list can be configured on the remote device.

The specified interface must have an IP address associated with it. If the specified interface does not have an IP address or is in a down state, then rcp/rsh reverts to the default. To avoid this, add an IP address to the subinterface or bring the interface to the up state.

350

Cisco IOS Configuration Fundamentals Command Reference

F through K ip rcmd source-interface

Examples

In the following example, Loopback interface 0 is assigned an IP address of 220.144.159.200, and the ip

rcmd source-interface command is used to specify that the source IP address for all rcp/rsh packets will be the IP address assigned to the Loopback0 interface: interface Loopback0 description Loopback interface ip address 220.144.159.200 255.255.255.255

no ip directed-broadcast

clock timezone GMT 0 ip subnet-zero no ip source-route no ip finger ip rcmd source-interface Loopback0 ip telnet source-interface Loopback0 ip tftp source-interface Loopback0 ip ftp source-interface Loopback0 ip ftp username cisco ip ftp password shhhhsecret no ip bootp server ip domain-name net.galaxy

ip name-server 220.144.159.1

ip name-server 220.144.159.2

ip name-server 219.10.2.1

Related Commands

Command

ip rcmd remote-host

Description

Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp.

Cisco IOS Configuration Fundamentals Command Reference

351

F through K ip telnet source-interface

ip telnet source-interface

To specify the IP address of an interface as the source address for Telnet connections, use the ip telnet

source-interface command in global configuration mode. To reset the source address to the default for each connection, use the no form of this command.

ip telnet source-interface interface

no ip telnet source-interface

Syntax Description interface The interface whose address is to be used as the source for Telnet connections.

Command Default

The address of the closest interface to the destination is the source address.

Command Modes Global configuration

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to set the IP address of an interface as the source for all Telnet connections.

If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the destination as the source address.

Examples The following example forces the IP address for Ethernet interface 1 as the source address for Telnet connections :

Router(config)# ip telnet source-interface Ethernet1

352

Cisco IOS Configuration Fundamentals Command Reference

F through K

Related Commands

Command

ip radius source-interface ip telnet source-interface

Description

Forces RADIUS to use the IP address of a specified interface for all outgoing RADIUS packets.

Cisco IOS Configuration Fundamentals Command Reference

353

F through K ip tftp blocksize

ip tftp blocksize

To negotiate a transfer TFTP blocksize, use the ip tftp blocksizecommand in global configuration mode.

To disable this configuration, use the no form of this command.

ip tftp blocksize bytes

no ip tftp blocksize

Syntax Description bytes The size in bytes of the TFTP block from 512 to

8192.

Command Default The default TFTP blocksize is 512 bytes.

Command Modes Global configuration (config)

Command History

Release

12.2S

15.1(1)SG

Modification

This command was introduced for the 12.2S

releases.

This command was integrated into the 15.1(1)SG releases.

Examples

The following example shows how to set a 1024 byte TFTP blocksize:

Router> enable

Router# configure terminal

Router(config)# ip tftp bblocksize 1024

Related Commands

Command

ip tftp min-timeout

Description

Specifies the minimum timeout period for retransmission of data.

354

Cisco IOS Configuration Fundamentals Command Reference

F through K ip tftp boot-interface

ip tftp boot-interface

To use an interface for TFTP booting, use the ip tftp boot-interfacecommand in global configuration mode. To disable this configuration, use the no form of this command.

ip tftp boot-interface type number

no ip tftp boot-interface

Syntax Description type number

The type of the interface to be used. You can choose from a list of interfaces.

The related interface number. Each interface has a related range of numbers. For example, the Virtual

Multipoint Interface has a range of interface numbers from 1 to 2147483647.

Command Default No interface is used for TFTP booting.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Examples

The following example shows how to ensure that an interface is used for TFTP booting:

Router> enable

Router# configure terminal

Router(config)# ip tftp boot-interface

Related Commands

Command

ip tftp min-timeout

Description

Specifies the minimum timeout period for retransmission of data.

Cisco IOS Configuration Fundamentals Command Reference

355

F through K ip tftp min-timeout

ip tftp min-timeout

To specify the minimum timeout period for retransmission of data using TFTP, use the ip tftp min-

timeoutcommand in global configuration mode. To disable, use the no form of this command.

ip tftp min-timeout seconds

no ip tftp min-timeout

Syntax Description seconds Specifies the timeout value, in seconds. The range is from 4 to 20.

Command Default The default minimum timeout period for retransmission of data is 4 seconds.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Examples The following example shows how to specify the minimum timeout period for retransmission of data as 5 seconds:

Router> enable

Router# configure terminal

Router(config)# ip tftp min-timeout 5

Related Commands

Command

ip tftp boot-interface

Description

Ensures that an interface is used for TFTP booting.

356

Cisco IOS Configuration Fundamentals Command Reference

F through K ip tftp source-interface

ip tftp source-interface

To specify the IP address of an interface as the source address for TFTP connections, use the ip tftp

source-interface command in global configuration mode. To return to the default, use the no form of this command.

ip tftp source-interface interface-type interface-number

no ip tftp source-interface

Syntax Description

interface-type interface-number The interface type and number whose address is to be used as the source for TFTP connections.

Command Default The address of the closest interface to the destination is selected as the source address.

Command Modes

Global configuration (config)

Command History

Release

11.1

12.3(6)

12.3(8)T

12.2(33)SRA

Modification

This command was introduced.

Destination address lookup in a Virtual Private

Network (VPN) routing and forwarding (VRF) table was added for the transfer of TFTP packets.

This command was integrated into Cisco IOS

Release 12.3(8)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to set the IP address of an interface as the source for all TFTP connections.

If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the destination as the source address.

In Cisco IOS 12.3(6) and later releases, TFTP is VRF-aware, which means that TFTP transfer is supported across an interface within a Virtual Private Network (VPN) routing and forwarding (VRF) instance. To specify a VRF as a source for TFTP connections, the VRF must be associated with the same interface that you configure with the ip tftp source-interface command. In this configuration, TFTP looks for the destination IP address for file transfer in the specified VRF table.

Cisco IOS Configuration Fundamentals Command Reference

357

F through K ip tftp source-interface

Examples The following example shows how to configure the router to use the IP address associated with loopback interface 0 as the source address for TFTP connections :

Router# configure terminal

Router(config)# ip tftp source-interface loopback0

The following example shows how to configure the router to use the VRF table named vpn1 to look for the destination IP address for TFTP connections. In this example, file transfer using TFTP is accomplished across an interface within a VRF (VRF vpn1) link.

Router# configure terminal

Router(config)# ip tftp source-interface ethernet 1/0

Router(config)# ip vrf vpn1

Router(config-vrf)# rd 100:1

Router(config-vrf)# route-target both 100:1

Router(config-vrf)# interface ethernet 1/0

Router(config-if)# ip vrf forwarding vpn1

Router(config-if)# end

Related Commands

Command

ip ftp source-interface

ip radius source-interface

Description

Forces outgoing FTP packets to use the IP address of a specified interface as the source address.

Forces outgoing RADIUS packets to use the IP address of a specified interface as the source address.

358

Cisco IOS Configuration Fundamentals Command Reference

F through K ip wccp web-cache accelerated

ip wccp web-cache accelerated

To enable the hardware acceleration for WCCP version 1, use the ip wccp web-cache

acceleratedcommand in global configuration mode. To disable hardware acceleration, use the no form of this command.

ip wccp web-cache accelerated [[group-address groupaddress] | [redirect-list access-list] |

[group-list access-list] | [password password]]

no ip wccp web-cache accelerated

Syntax Description

group-address group-address

redirect-list access-list

group-list access-list

password password

(Optional) Directs the router to use a specified multicast IP address for communication with the

WCCP service group. See the “Usage Guidelines” section for additional information.

(Optional) Directs the router to use an access list to control traffic that is redirected to this service group. See the “Usage Guidelines” section for additional information.

(Optional) Directs the router to use an access list to determine which cache engines are allowed to participate in the service group. See the “Usage

Guidelines” section for additional information.

(Optional) Specifies a string that directs the router to apply MD5 authentication to messages received from the service group specified by the service name given. See the “Usage Guidelines” section for additional information.

Command Default When this command is not configured, hardware acceleration for WCCPv1 is not enabled.

Command Modes Global configuration (config)

Command History

Release

12.2(17d)SXB

Modification

Support for this command on the Supervisor Engine

2 was extended to Cisco IOS Release

12.2(17d)SXB.

Cisco IOS Configuration Fundamentals Command Reference

359

F through K ip wccp web-cache accelerated

Release

12.2(18)SXD1

12.2(33)SRA

Modification

This command was changed to support the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The group-address group-address option requires a multicast address that is used by the router to determine which cache engine should receive redirected messages. This option instructs the router to use the specified multicast IP address to coalesce the “I See You” responses for the “Here I Am” messages that it has received on this group address. In addition, the response is sent to the group address. The default is for no group-address to be configured, so that all “Here I Am” messages are responded to with a unicast reply.

The redirect-list access-list option instructs the router to use an access list to control the traffic that is redirected to the cache engines of the service group that is specified by the service-name given. The access-

list argument specifies either a number from 1 to 99 to represent a standard or extended access list number, or a name to represent a named standard or extended access list. The access list itself specifies the traffic that is permitted to be redirected. The default is for no redirect-list to be configured (all traffic is redirected).

The group-list access-list option instructs the router to use an access list to control the cache engines that are allowed to participate in the specified service group. The access-list argument specifies either a number from 1 to 99 to represent a standard access list number, or a name to represent a named standard access list.

The access list specifies which cache engines are permitted to participate in the service group. The default is for no group-list to be configured, so that all cache engines may participate in the service group.

The password can be up to seven characters. When you designate a password, the messages that are not accepted by the authentication are discarded. The password name is combined with the HMAC MD5 value to create security for the connection between the router and the cache engine.

Examples The following example shows how to enable the hardware acceleration for WCCP version 1:

Router(config)# ip wccp web-cache accelerated

Related Commands

Command

ip wccp version

Description

Specifies which version of WCCP to configure on your router.

360

Cisco IOS Configuration Fundamentals Command Reference

L through mode

•

length, page 363

•

load-interval, page 365

•

•

•

•

•

logging buginf, page 374

•

logging enable, page 376

•

logging esm config, page 378

•

logging event bundle-status, page 380

•

logging event link-status (global configuration), page 382

•

logging event link-status (interface configuration), page 384

•

logging event subif-link-status, page 386

•

logging event trunk-status, page 388

•

logging reload, page 389

•

logging ip access-list cache (global configuration), page 391

•

logging ip access-list cache (interface configuration), page 394

•

logging persistent (config-archive-log-cfg), page 396

•

logging persistent reload (config-archive-log-cfg), page 398

•

logging size, page 400

•

logging synchronous, page 402

•

logging system, page 405

•

logout, page 407

•

logout-warning, page 408

•

macro (global configuration), page 410

•

macro (interface configuration), page 412

•

maximum, page 414

•

memory cache error-recovery, page 416

•

memory cache error-recovery options, page 418

•

memory free low-watermark, page 420

•

memory lite, page 422

•

memory reserve, page 423

•

memory reserve critical, page 425

•

memory sanity, page 427

•

memory scan, page 429

Cisco IOS Configuration Fundamentals Command Reference

361

•

memory-size iomem, page 431

•

menu (EXEC), page 433

•

menu menu-name single-space, page 435

•

menu clear-screen, page 437

•

menu command, page 439

•

menu default, page 442

•

menu line-mode, page 444

•

menu options, page 446

•

menu prompt, page 448

•

menu status-line, page 450

•

menu text, page 452

•

menu title, page 454

•

microcode (12000), page 456

•

microcode (7000/7500), page 458

•

microcode (7200), page 460

•

microcode reload (12000), page 462

•

microcode reload (7000 7500), page 464

•

microcode reload (7200), page 466

•

mkdir, page 468

•

mkdir disk0:, page 470

•

mode, page 472

L through mode

362

Cisco IOS Configuration Fundamentals Command Reference

L through mode length

length

To set the terminal screen length, use the length command in line configuration mode. To restore the default value, use the no form of this command.

length screen-length

no length

Syntax Description screen-length The number of lines on the screen. A value of zero disables pausing between screens of output.

Command Default Screen length of 24 lines

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The Cisco IOS software uses the value of this command to determine when to pause during multiple-screen output. Not all commands recognize the configured screen length. For example, the show terminal command assumes a screen length of 24 lines or more.

Examples In the following example, the terminal type is specified and the screen pause function is disabled for the terminal connection on line 6:

Router(config)# line 6

Router(config-line)# terminal-type VT220

Router(config-line)# length 0

Cisco IOS Configuration Fundamentals Command Reference

363

length

Related Commands

Command

terminal length

L through mode

Description

Sets the number of lines on the current terminal screen for the current session.

364

Cisco IOS Configuration Fundamentals Command Reference

L through mode load-interval

load-interval

To change the length of time for which data is used to compute load statistics, use the load-interval command in interface configuration mode or Frame Relay DLCI configuration mode. To revert to the default setting, use the noform of this command.

load-interval seconds

no load-interval seconds

Syntax Description seconds Length of time for which data is used to compute load statistics. Value is a multiple of 30, from 30 to

600 (30, 60, 90, 120, and so on). The default is 300 seconds.

Command Default Enabled

Command Modes Interface configuration Frame Relay DLCI configuration

Command History

Release

10.3

12.2(4)T

12.2(18)SXF

12.2(28)SB

12.2(33)SRA

Modification

This command was introduced.

This command was made available in Frame Relay

DLCI configuration mode.

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To make computations more reactive to short bursts of traffic, you can shorten the length of time over which load averages are computed.

If the load interval is set to 30 seconds, new data is used for load calculations over a 30-second period. This data is used to compute load statistics, including the input rate in bits and packets per second, the output rate in bits and packets per second, the load, and reliability.

Cisco IOS Configuration Fundamentals Command Reference

365

L through mode load-interval

Load data is gathered every five seconds. This data is used for a weighted-average calculation in which recent load data has more weight in the computation than older load data. If the load interval is set to 30 seconds, the average is computed for the last 30 seconds of load data.

If you change the calculation interval from the default of five minutes to a shorter period of time, the input and output statistics that are displayed by the show interface command or the show frame-relay pvc command will be more current and will be based on more nearly instantaneous data, rather than reflecting the average load over a longer period of time.

This command is often used for dial backup purposes to increase or decrease the likelihood of implementation of a backup interface, but it can be used on any interface.

Examples

Interface Example

In the following example, the default average of five minutes is changed to a 30-second average. A burst in traffic that would not trigger a dial backup for an interface configured with the default five-minute interval might trigger a dial backup for this interface, which is set for the shorter 30-second interval.

Router(config)# interface serial 0

Router(config-if)# load-interval 30

Frame Relay PVC Example

In the following example, the load interval is set to 60 seconds for a Frame Relay PVC with the DLCI 100:

Router(config)# interface serial 1/1

Router(config-if)# frame-relay interface-dlci 100

Router(config-fr-dlci)# load-interval 60

Related Commands

Command

show interfaces

Description

Displays statistics for all interfaces configured on the router or access server.

366

Cisco IOS Configuration Fundamentals Command Reference

L through mode location

location

To provide a description of the location of a serial device, use the location command in line configuration mode. To remove the description, use the no form of this command.

location text

no location

Syntax Description text Location description.

Command Default A location description is not provided.

Command Modes Line configuration (config-line)

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The location command enters information about the device location and status. Use the show users all

EXEC command to display the location information.

Examples In the following example, the location description for the console line is given as “Building 3, Basement”:

Router(config)# line console

Router(config-line)# location Building 3, Basement

Related Commands

Command

show users

Description

Displays information about the active lines on a router.

Cisco IOS Configuration Fundamentals Command Reference

367

L through mode lock

lock

To configure a temporary password on a line, use the lockcommand in EXEC mode.

lock

Syntax Description This command has no arguments or keywords.

Command Default

Not locked

Command Modes EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced in a release prior to

Cisco IOS Release 10.0.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You can prevent access to your session while keeping your connection open by setting up a temporary password. To lock access to the terminal, perform the following steps:

1 Enter the lock command. The system prompts you for a password.

2 Enter a password, which can be any arbitrary string. The system will prompt you to confirm the password. The screen then clears and displays the message “Locked.”

3 To regain access to your sessions, reenter the password.

The Cisco IOS software honors session timeouts on a locked lines. You must clear the line to remove this feature. The system administrator must set the line up to allow use of the temporary locking feature by using the lockable line configuration command.

Examples

The following example shows configuring the router as lockable, saving the configuration, and then locking the current session for the user:

Router(config-line)# lockable

Router(config-line)# ^Z

Router# copy system:running-config nvram:startup-config

Building configuration...

Router# lock

368

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Password: <password>

Again: <password>

Locked

Password: <password>

Router#

Related Commands

Command lockable

login (EXEC)

Description

Enables the lock EXEC command.

Enables or changes a login username.

lock

Cisco IOS Configuration Fundamentals Command Reference

369

L through mode lockable

lockable

To enable use of the lock EXEC command, use the lockablecommand in line configuration mode. To reinstate the default (the terminal session cannot be locked), use the noform of this command.

lockable

no lockable

Syntax Description This command has no arguments or keywords.

Command Default Sessions on the line are not lockable (the lock EXEC command has no effect).

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command enables use of temporary terminal locking, which is executed using the lock EXEC command. Terminal locking allows a user keep the current session open while preventing access by other users.

Examples In the following example, the terminal connection is configured as lockable, then the current connection is locked:

Router# configure terminal

Router(config)# line console 0

Router(config-line)# lockable

Router(config)# ^Z

Router# lock

Password: <password>

Again: <password>

Locked

Password: <password>

Router#

370

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command lock lockable

Description

Prevents access to your session by other users by setting a temporary password on your terminal line.

Cisco IOS Configuration Fundamentals Command Reference

371

L through mode log config

log config

To enter configuration change logger configuration mode, use the log configcommand in archive configuration mode.

log config

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Archive configuration

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Examples The following example shows how to place the router in configuration change logger configuration mode:

Router# configure terminal

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)#

372

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command archive hidekeys

logging enable

logging size

notify syslog

show archive log config log config

Description

Enters archive configuration mode.

Suppresses the display of password information in configuration log files.

Enables the logging of configuration changes.

Specifies the maximum number of entries retained in the configuration log.

Enables the sending of notifications of configuration changes to a remote syslog.

Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

373

L through mode logging buginf

logging buginf

To allow debug messages to be generated for the standard system logging buffer, use the logging

buginfcommand in global configuration mode. To disable the logging for debugging functionality, use the

no form of this command.

logging buginf

no logging buginf

Syntax Description This command has no arguments or keywords.

Command Default Debug messages are not suppressed.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1.

Usage Guidelines The no logging buginfcommand is used to avoid a situation where a large amount of debug messages might overload the processor (CPU hog condition). This condition differs from the use of the undebug

allcommand wherein all debugging calls are disabled in the Cisco IOS software. No debug reporting is available, even if debugging is enabled. Note that even though debugging has been completely disabled in the system, other message reporting, including error reporting, is still available.

Examples The following example shows how to enable buginf logging for debugging:

Router# configure terminal

Router(config)# logging buginf

374

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

show logging logging buginf

Description

Displays the state of system logging (syslog) and the contents of the standard system logging buffer.

Cisco IOS Configuration Fundamentals Command Reference

375

L through mode logging enable

logging enable

To enable the logging of configuration changes, use the logging enablecommand in configuration change logger configuration mode. To disable the logging of configuration changes, use the no form of this command.

logging enable

no logging enable

Syntax Description This command has no arguments or keywords.

Command Default Configuration change logging is disabled.

Command Modes Configuration change logger configuration

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines Use this command if you want to log configuration changes. If you disable configuration logging, all configuration log records that were collected are purged.

Examples

The following example shows how to enable configuration logging:

Router# configure terminal

Router(config)# archive

376

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging enable

Router(config-archive)# log config

Router(config-archive-log-config)# logging enable

Router(config-archive-log-config)# end

The following example shows how to clear the configuration log by disabling and then reenabling the configuration log:

Router# configure terminal

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)# no logging enable

Router(config-archive-log-config)# logging enable

Router(config-archive-log-config)# end

Related Commands

Command archive hidekeys

log config

logging size

notify syslog

show archive log config

Description

Enters archive configuration mode.

Suppresses the display of password information in configuration log files.

Enters configuration change logger configuration mode.

Specifies the maximum number of entries retained in the configuration log.

Enables the sending of notifications of configuration changes to a remote syslog.

Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

377

L through mode logging esm config

logging esm config

To permit configuration changes from Embedded Syslog Manager (ESM) filters, use the logging esm

config command in global configuration mode. To disable the configuration, use the no form of this command.

logging esm config

no logging esm config

Syntax Description This command has no arguments or keywords.

Command Default ESM filters are enabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1.

Usage Guidelines

You can use the no logging esm config command to disallow configuration changes from ESM filters.

Examples The following example shows how to configure the ESM filters:

Router# configure terminal

Router(config)# logging esm config

378

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

logging filter logging esm config

Description

Specifies a syslog filter module to be used by the

ESM.

Cisco IOS Configuration Fundamentals Command Reference

379

L through mode logging event bundle-status

logging event bundle-status

To enable message bundling, use the logging event bundle-status command in interface configuration mode. To disable message bundling, use the no form of this command.

logging event bundle-status

no logging event bundle-status

Syntax Description default boot

Enables system logging of interface state-change events on all interfaces in the system.

Enables system logging of interface state-change events on all interfaces in the system during system initialization.

Command Default Message bundling does not occur.

Command Modes

Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces.

Examples This example shows how to enable the system logging of the interface state-change events on all interfaces in the system:

Router(config)# logging event bundle-status

Router(config)# end

Router # show logging event bundle-status

*Aug 4 17:36:48.240 UTC: %EC-SP-5-UNBUNDLE: Interface FastEthernet9/23 left the port-

380

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging event bundle-status channel Port-channel2

*Aug 4 17:36:48.256 UTC: %LINK-SP-5-CHANGED: Interface FastEthernet9/23, changed state to administratively down

*Aug 4 17:36:47.865 UTC: %EC-SPSTBY-5-UNBUNDLE: Interface FastEthernet9/23 left the portchannel Port-channel2

Router # show logging event bundle-status

*Aug 4 17:37:35.845 UTC: %EC-SP-5-BUNDLE: Interface FastEthernet9/23 joined port-channel

Port-channel2

*Aug 4 17:37:35.533 UTC: %EC-SPSTBY-5-BUNDLE: Interface FastEthernet9/23 joined portchannel Port-channel2

Related Commands

Command

show running-config

Description

Displays the status and configuration of the module or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

381

L through mode logging event link-status (global configuration)

logging event link-status (global configuration)

To change the default or set the link-status event messaging during system initialization, use the logging

event link-status command in global configuration mode. To disable the link-status event messaging, use the no form of this command.

logging event link-status {default | boot}

no logging event link-status {default | boot}

Syntax Description default boot

Enables system logging of interface state-change events on all interfaces in the system.

Enables system logging of interface state-change events on all interfaces in the system during system initialization.

Command Default

Interface state-change messages are not sent.

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You do not have to enter the logging event link-status boot command to enable link-status messaging during system initialization. The logging event link-status default command logs system messages even during system initialization.

If you enter both the logging event link-status default and the no logging event link-status

bootcommands, the interface state-change events are logged after all modules in the Cisco 7600 series router come online after system initialization. The logging event link-status default and the no logging

event link-status boot commands are saved and retained in the running configuration of the system.

382

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging event link-status (global configuration)

When both the logging event link-status default and the no logging event link-status bootcommands are present in the running configuration and you want to display the interface state-change messages during system initialization, enter the logging event link-status boot command.

Examples This example shows how to enable the system logging of the interface state-change events on all interfaces in the system:

Router(config)# logging event link-status default

Router(config)#

This example shows how to enable the system logging of interface state-change events on all interfaces during system initialization:

Router(config)# logging event link-status boot

Router(config)#

This example shows how to disable the system logging of interface state-change events on all interfaces:

Router(config)# no logging event link-status default

Router(config)#

This example shows how to disable the system logging of interface state-change events during system initialization:

Router(config)# no logging event link-status boot

Router(config)#

Related Commands

Command

show running-config

Description

Displays the status and configuration of the module or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

383

L through mode logging event link-status (interface configuration)

logging event link-status (interface configuration)

To enable link-status event messaging on an interface, use the logging event link-status command in interface configuration mode. To disable link-status event messaging, use the no form of this command.

logging event link-status [bchan | dchan | nfas]

no logging event link-status [bchan | dchan | nfas]

Syntax Description bchan dchan nfas

(Optional) Logs B-channel status messages. This keyword is available only for integrated services digital network (ISDN) serial interfaces.

(Optional) Logs D-channel status messages. This keyword is available only for ISDN serial interfaces.

(Optional) Logs non-facility associated signaling

(NFAS) D-channel status messages. This keyword is available only for ISDN serial interfaces.

Command Default Interface state-change messages are not sent.

Command Modes Interface configuration (config-if)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced on the Supervisor

Engine 720.

This command was modified to support the

Supervisor Engine 2.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

To enable system logging of interface state-change events on a specific interface, enter the logging event

link-status command.

384

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Examples logging event link-status (interface configuration)

The following example shows how to enable link-status event messaging on an interface:

Router(config-if)# logging event link-status

This example shows how to disable link-status event messaging on an interface:

Router(config-if)# no logging event link-status

Cisco IOS Configuration Fundamentals Command Reference

385

L through mode logging event subif-link-status

logging event subif-link-status

To enable the link-status event messaging on a subinterface, use the logging event subif-link-status command in interface configuration mode. To disable the link-status event messaging on a subinterface, use the no form of this command.

logging event subif-link-status

no logging event subif-link-status

Syntax Description This command has no arguments or keywords.

Command Default Subinterface state-change messages are not sent.

Command Modes Interface configuration

Command History

Release

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine

720.

To enable system logging of interface state-change events on a specific subinterface, enter the logging

event subif-link-status command.

To enable system logging of interface state-change events on a specific interface, enter the logging event

link-status command.

To enable system logging of interface state-change events on all interfaces in the system, enter the logging

event link-status command.

Examples This example shows how to enable the system logging of the interface state-change events on a subinterface:

Router(config-if)# logging event subif-link-status

Router(config-if)#

386

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging event subif-link-status

This example shows how to disable the system logging of the interface state-change events on a subinterface:

Router(config-if)# no logging event subif-link-status

Router(config-if)#

Related Commands

Command

show running-config

Description

Displays the status and configuration of the module or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

387

L through mode logging event trunk-status

logging event trunk-status

To enable trunk status messaging, use the logging event trunk-status command in interface configuration mode. To disable trunk status messaging, use the no form of this command.

logging event trunk-status

no logging event trunk-status

Syntax Description This command has no keywords or variables.

Command Default This command has no default settings.

Command Modes Interface configuration mode

Command History

Release

12.2(14)SX

Modification

Support for this command was introduced.

Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces.

Examples This example shows how to enable the trunk status messaging on physical ports:

Router(config)# logging event trunk-status

Router(config)# end

Router# show logging event trunk-status

*Aug 4 17:27:01.404 UTC: %DTP-SPSTBY-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk

*Aug 4 17:27:00.773 UTC: %DTP-SP-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk

Router#

388

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging reload

logging reload

To set the reload logging level, use the logging reloadcommand in global configuration mode. To disable the reload logging, use the no form of this command.

errors | informational | notifications | warnings]

no logging reload

Syntax Description message-limit number severity-level alerts critical debugging emergencies errors informational notifications warnings

(Optional) Sets the limit on the number of messages that can be logged during reload.

Number of messages. The range is from 1 to

4294967295.

(Optional) Logging severity level. The range is from 0 to 7.

(Optional) Specifies that an immediate action is needed.

(Optional) Specifies the critical conditions.

(Optional) Displays the debugging messages

(Optional) Specifies that the system is unusable.

(Optional) Specifies error conditions

(Optional) Specifies error informational messages

(Optional) Specifies normal but significant conditions.

(Optional) Specifies warning conditions.

Command Default

The logging reload message limit is 1000 notifications.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

389

L through mode logging reload

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Releas e2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1.

Usage Guidelines The default setting is recommended. Setting the message-limit too low may result in losing important messages during reload. If the logging reload command is not enabled, logging is turned off during reload.

Examples The following example shows how to set the limit on number of messages that can be logged during reload to 100:

Router# configure terminal

Router(config)# logging reload message-limit 100

Related Commands

Command

show logging

Description

Displays the state of system logging (syslog) and the contents of the standard system logging buffer.

390

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging ip access-list cache (global configuration)

logging ip access-list cache (global configuration)

To configure the Optimized ACL Logging (OAL) parameters, use the logging ip access-list cache command in global configuration mode. To return to the default settings, use the no form of this command.

logging ip access-list cache {entries entries | interval seconds | rate-limit pps | threshold packets}

no logging ip access-list cache [entries | interval | rate-limit | threshold]

Syntax Description

entries entries

interval seconds

rate-limit pps

threshold packets

Specifies the maximum number of log entries that are cached in the software; valid values are from 0 to 1048576 entries.

Specifies the maximum time interval before an entry is sent to syslog; valid values are from 5 to

86400 seconds.

Specifies the number of packets that are logged per second in the software; valid values are from 10 to

1000000 pps.

Specifies the number of packet matches before an entry is sent to syslog; valid values are from 1 to

1000000 packets.

Command Default

The defaults are as follows:

• entries --8000 entries.

• seconds --300 seconds (5 minutes).

• rate-limit pps --0 (rate limiting is off) and all packets are logged.

• threshold packets --0 (rate limiting is off) and the system log is not triggered by the number of packet matches.

Command Modes Global configuration

Command History

Release

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

391

L through mode logging ip access-list cache (global configuration)

Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720 only.

OAL is supported on IPv4 unicast traffic only.

You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are incompatible. With OAL configured, use SPAN to capture traffic.

If the entry is inactive for the duration that is specified in the update-interval seconds command, th e entry is removed from the cache.

If you enter the no logging ip access-list cache command without keywords, all the parameters are returned to the default values.

You must set ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets.

When enabling the IP "too short" check using the mls verify ip length minimum command, valid IP packets with with an IP protocol field of ICMP(1), IGMP(2), IP(4), TCP(6), UDP(17), IPv6(41), GRE(47), or

SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched.

Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can cause routing protocol neighbor flapping as they are incompatible

Examples This example shows how to specify the maximum number of log entries that are cached in the software:

Router(config)# logging ip access-list cache entries 200

This example shows how to specify the maximum time interval before an entry is sent to the system log:

Router(config)# logging ip access-list cache interval 350

This example shows how to specify the number of packets that are logged per second in the software:

Router(config)# logging ip access-list cache rate-limit 100

This example shows how to specify the number of packet matches before an entry is sent to the system log:

Router(config)# logging ip access-list cache threshold 125

Related Commands

Command

clear logging ip access-list cache

logging ip access-list cache (interface configuration)

Description

Clears all the entries from the OAL cache and sends them to the syslog.

Enables an OAL-logging cache on an interface that is based on direction.

392

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Command

show logging ip access-list

update-interval seconds logging ip access-list cache (global configuration)

Description

Displays information about the logging IP access list.

Removes entries from the cache that are inactive for the duration that is specified in the command.

Cisco IOS Configuration Fundamentals Command Reference

393

L through mode logging ip access-list cache (interface configuration)

logging ip access-list cache (interface configuration)

To enable an Optimized ACL Logging (OAL)-logging cache on an interface that is based on direction, use the logging ip access-list cache command in interface configuration mode. To disable OAL, use the no form of this command.

logging ip access-list cache [in | out]

no logging ip access-list cache

Syntax Description in out

(Optional) Enables OAL on ingress packets.

(Optional) Enables OAL on egress packets.

Command Default Disabled

Command Modes Interface configuration

Command History

Release

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720 only.

This command is supported on traffic that matches the log keyword in the applied ACL. You must set

ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets.

On systems that are configured with a PFC3A, support for the egress direction on tunnel interfaces is not supported.

OAL is supported on IPv4 unicast traffic only.

You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are incompatible. With OAL configured, use SPAN to capture traffic.

If the entry is inactive for the duration that is specified in the update-interval seconds command, th e entry is removed from the cache.

If you enter the no logging ip access-list cache command without keywords, all the parameters are returned to the default values.

394

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging ip access-list cache (interface configuration)

SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched.

Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can cause routing protocol neighbor flapping as they are incompatible

Examples This example shows how to enable OAL on ingress packets:

Router(config-if)# logging ip access-list cache in

This example shows how to enable OAL on egress packets:

Router(config-if)# logging ip access-list cache out

Related Commands

Command

clear logging ip access-list cache

Description

Clears all the entries from the OAL cache and sends them to the syslog.

logging ip access-list cache (global configuration) Configures the OAL parameters.

show logging ip access-list Displays information about the logging IP access list.

update-interval seconds Removes entries from the cache that are inactive for the duration that is specified in the command.

Cisco IOS Configuration Fundamentals Command Reference

395

L through mode logging persistent (config-archive-log-cfg)

logging persistent (config-archive-log-cfg)

To enable the configuration logging persistent feature and to select how the configuration commands are to be saved to the Cisco IOS secure file system, use the logging persistent command in the log config submode of archive configuration mode. To disable this capability, use the no form of this command.

logging persistent {auto | manual}

no logging persistent {auto | manual}

Syntax Description auto manual

Specifies that each configuration command will be saved automatically to the Cisco IOS secure file system.

Specifies that each configuration command must be saved manually to the Cisco IOS secure file system.

Command Default The configuration commands are not saved to the Cisco IOS secure file system.

Command Modes Archive configuration mode, log config (configuration-change logger) submode (config-archive-log-cfg)#

Command History

Release

12.0(26)S

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.4(11)T

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.4(11)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

396

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging persistent (config-archive-log-cfg)

Usage Guidelines When you use the manualkeyword, you must save each configuration command manually to the Cisco IOS secure file system. To do this, you must use the archive log config persistent save command.

Examples The following example automatically saves the configuration commands to the Cisco IOS secure file system:

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-cfg)# logging enable

Router(config-archive-log-cfg)# logging persistent auto

Related Commands

Command

logging persistent reload

archive log config persistent save

Description

Sequentially applies configuration commands in the configuration logger database to the running-config file after a reload.

Saves the persisted commands in the configuration log to the Cisco IOS secure file system.

Cisco IOS Configuration Fundamentals Command Reference

397

L through mode logging persistent reload (config-archive-log-cfg)

logging persistent reload (config-archive-log-cfg)

To sequentially apply the configuration commands saved in the configuration logger database (since the last write memorycommand) to the running-config file after a reload, use the logging persistent reload command in configuration change logger configuration mode in archive configuration mode. To disable this capability, use the no form of this command.

logging persistent reload

no logging persistent reload

Syntax Description This command has no arguments or keywords.

Command Default The configuration commands saved in the configuration logger database are not applied to the runningconfig file.

Command Modes Archive config mode; log config (configuration change logger) submode (config-archive-log-cfg)#

Command History

Release

12.2(33)SRA

12.4(11)T

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.4(11)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines

Use the logging persistent reload command when you want changed configuration commands to take effect on the next reload of the router.

Examples The following example applies the configuration commands in the configuration logger database to the running-config file after the next reload:

Router(config-archive-log-cfg)# logging persistent reload

398

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

logging persistent logging persistent reload (config-archive-log-cfg)

Description

Enables the configuration logging persistent feature.

Cisco IOS Configuration Fundamentals Command Reference

399

L through mode logging size

logging size

To specify the maximum number of entries retained in the configuration log, use the logging sizecommand in configuration change logger configuration mode. To reset the default value, use the no form of this command.

logging size entries

no logging size

Syntax Description entries The maximum number of entries retained in the configuration log. Valid values range from 1 to

1000. The default value is 100 entries.

Command Default 100 entries

Command Modes Configuration change logger configuration

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines When the configuration log is full, the oldest log entry will be removed every time a new entry is added.

400

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging size

Note If a new log size is specified that is smaller than the current log size, the oldest entries will be immediately purged until the new log size is satisfied, regardless of the age of the log entries.

Examples The following example shows how to specify that the configuration log may have a maximum of 200 entries:

Router(config-archive-log-config)# logging size 200

The following example shows how to clear the configuration log by reducing the log size to 1, then resetting the log size to the desired value. Only the most recent configuration log file will be saved.

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)# logging size 1

Router(config-archive-log-config)# logging size 200

Related Commands

Command archive hidekeys

log config

logging enable

notify syslog

show archive log config

Description

Enters archive configuration mode.

Suppresses the display of password information in configuration log files.

Enters configuration change logger configuration mode.

Enables the logging of configuration changes.

Enables the sending of notifications of configuration changes to a remote syslog.

Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

401

L through mode logging synchronous

logging synchronous

To synchronize unsolicited messages and debug output with solicited Cisco IOS software output and prompts for a specific console port line, auxiliary port line, or vty, use the logging synchronous command in line configuration mode. To disable synchronization of unsolicited messages and debug output, use the

no form of this command.

logging synchronous [level severity-level | all] [limit number-of-lines]

no logging synchronous [level severity-level | all] [limit number-of-lines]

Syntax Description

level severity-level all

limit number-of-lines

(Optional) Specifies the message severity level.

Messages with a severity level equal to or higher than this value are printed asynchronously. Low numbers indicate greater severity and high numbers indicate lesser severity. The default value is 2.

(Optional) Specifies that all messages are printed asynchronously, regardless of the severity level.

(Optional) Specifies the number of buffer lines to be queued for the terminal, after which new messages are dropped. The default value is 20.

Command Default This command is disabled.

If you do not specify a severity level, the default value of 2 is assumed.

If you do not specify the maximum number of buffers to be queued, the default value of 20 is assumed.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

12.2SX

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

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.

402

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging synchronous

Usage Guidelines When synchronous logging of unsolicited messages and debug output is turned on, unsolicited Cisco IOS software output is displayed on the console or printed after solicited Cisco IOS software output is displayed or printed. This keeps unsolicited messages and debug output from being interspersed with solicited software output and prompts.

Tip This command is useful for keeping system messages from interrupting your typing. By default, messages will appear immediately when they are processed by the system, and the CLI cursor will appear at the end of the displayed message. For example, the line “Configured by console from console” may be printed to the screen, interrupting whatever command you are currently typing. The logging synchronous command allows you to avoid these potentially annoying interruptions without have to turn off logging to the console entirely.

When this command is enabled, unsolicited messages and debug output are displayed on a separate line than user input. After the unsolicited messages are displayed, the CLI returns to the user prompt.

Note This command is also useful for allowing you to continue typing when debugging is enabled.

When specifying a severity level number, consider that for the logging system, low numbers indicate greater severity and high numbers indicate lesser severity.

When a message queue limit of a terminal line is reached, new messages are dropped from the line, although these messages might be displayed on other lines. If messages are dropped, the notice “ %SYS-3-

MSGLOST number-of-messages due to overflow” follows any messages that are displayed. This notice is displayed only on the terminal that lost the messages. It is not sent to any other lines, any logging servers, or the logging buffer.

Caution By configuring abnormally large message queue limits and setting the terminal to “terminal monitor” on a terminal that is accessible to intruders, you expose yourself to “denial of service” attacks. An intruder could carry out the attack by putting the terminal in synchronous output mode, making a Telnet connection to a remote host, and leaving the connection idle. This could cause large numbers of messages to be generated and queued, and these messages could consume all available RAM. You should guard against this type of attack through proper configuration.

Examples In the following example, a system message appears in the middle of typing the show running-config command:

Router(config-line)# end

Router# show ru

2w1d: %SYS-5-CONFIG_I: Configured from console by consolenning-config

The user then enables synchronous logging for the current line (indicated by the * symbol in the show line command), after which the system displays the system message on a separate line, and returns the user to the prompt to allow the user to finish typing the command on a single line:

Router# show line

Cisco IOS Configuration Fundamentals Command Reference

403

L through mode logging synchronous

Tty Typ Tx/Rx A Modem Roty AccO AccI Uses Noise Overruns Int

* 0 CTY - - - - - 0 3 0/0 -

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# line 0

Router(config-line)# logging syn

<tab>

Router(config-line)# logging synchronous

Router(config-line)# end

Router# show ru

2w1d: %SYS-5-CONFIG_I: Configured from console by console

Router# show running-config

In the following example, synchronous logging for line 4 is enabled with a severity level of 6. Then synchronous logging for line 2 is enabled with a severity level of 7 and is specified with a maximum number of buffer lines of 1,000.

Router(config)# line 4

Router(config-line)# logging synchronous level 6

Router(config-line)# exit

Router(config)# line 2

Router(config-line)# logging synchronous level 7 limit 1000

Router(config-line)# end

Router#

Related Commands

Command line

logging on

Description

Identifies a specific line for configuration and starts the line configuration command collection mode.

Controls logging of error messages and sends debug or error messages to a logging process, which logs messages to designated locations asynchronously to the processes that generated the messages.

404

Cisco IOS Configuration Fundamentals Command Reference

L through mode logging system

logging system

To enable System Event Archive (SEA) logging, use the logging systemcommand in global configuration mode. To disable SEA logging, use the no form of this command.

logging system [disk name]

no logging system

Syntax Description

disk name (Optional) Stores the system event archive (system event log file) in the specified disk. The specified disk must be already have been configured to allow for the storage of the system event archive.

Command Default By default, SEA logging feature is enabled, and the events are logged to a file on a persistent storage device

(bootflash: or disk:).

Command Modes Global configuration (config)

Command History

Release

12.2(33)SXH

12.2(33)SCC

Modification

This command was introduced.

The command was introduced for the Cisco uBR10012 router in the Cisco IOS Software

Release 12.2(33)SCC.

Usage Guidelines

SEA is supported on switches that have a Supervisor Engine 32 or Supervisor Engine 720 with a compact flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine 720).

To stop SEA logging to a specified disk, use the default logging system command.

For documentation of the configuration tasks associated with this feature, see the chapter “Configuring the

System Event Archive” in the Catalyst 6500 Release 12.2SX Software Configuration Guide .

Cisco Universal Broadband Router 100112

The SEA feature is used to address the deficiencies of the debug trace and system console. Support for SEA feature was introduced on Cisco uBR10012 Router in the Cisco IOS Release 12.2(33)SCC. Use the logging

system disk command to change the location of the disk used to store the sea_log.dat file.

Cisco IOS Configuration Fundamentals Command Reference

405

L through mode logging system

Note To store the system event logs, the SEA requires either PCMCIA ATA disk or Compact Flash disk in compact flash adapter for PRE2.

Examples The following example shows how to specify that the SEA log file should be written to the disk “disk1:”:

Router(config)# logging system disk disk1:

Router(config)# end

Related Commands

clear logging system

copy logging system

show logging system

Clears the event records stored in the SEA.

Copies the archived system event log to another location.

Displays the SEA logging system disk.

406

Cisco IOS Configuration Fundamentals Command Reference

L through mode logout

logout

To close an active terminal session by logging off the router, use the logout command in user EXEC mode.

logout

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the logout command is used to log off (exit from the active session):

Router(config)# exit

Router# disable

Router> logout

Cisco IOS Configuration Fundamentals Command Reference

407

L through mode logout-warning

logout-warning

To warn users of an impending forced timeout, use the logout-warningcommand in line configuration mode. To restore the default, use the no form of this command.

logout-warning [seconds] logout-warning

Syntax Description seconds (Optional) Number of seconds that are counted down before session termination. If no number is specified, the default of 20 seconds is used.

Command Default No warning is sent to the user.

Command Modes Line configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command notifies the user of an impending forced timeout (set using the absolute-timeout command).

Examples In the following example, a logout warning is configured on line 5 with a countdown value of 30 seconds:

Router(config)# line 5

Router(config-line)# logout-warning 30

Related Commands

Command absolute-timeout

Description

Sets the interval for closing user connections on a specific line or port.

408

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Command session-timeout logout-warning

Description

Sets the interval for closing the connection when there is no input or output traffic.

Cisco IOS Configuration Fundamentals Command Reference

409

L through mode macro (global configuration)

macro (global configuration)

To create a global command macro, use the macrocommand in global configuration mode. To remove the macro, use the no form of this command.

macro {global {apply macro-name | description text | trace macro-name [keyword-to-value] value-

first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword

[keyword-to-value]} | name macro-name}

no macro {global {apply macro-name | description text | trace macro-name [keyword-to-value]

value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-

keyword [keyword-to-value]} | name macro-name}

Syntax Description global

apply macro-name

description text

trace macro-name keyword-to-value value-first-keyword value-second-keyword value-third-keyword

name macro-name

Applies the macro globally.

Applies a specified macro.

Provides a description of the macros applied to the switch.

Applies a specified macro with trace enabled.

(Optional) Keyword to replace with a value.

Value of the first keyword to replace.

Value of the second keyword to replace.

Value of the third keyword to replace.

Specifies the name of a macro.

Command Default

This command has no default setting.

Command Modes Global configuration (config)

Command History

Release

12.2(33)SXH

15.0(1)M

Modification

This command was introduced.

This command was integrated into a release earlier than Cisco IOS Release 15.0(1)M.

410

Cisco IOS Configuration Fundamentals Command Reference

L through mode macro (global configuration)

Usage Guidelines You can enter up to three keyword pairs using the macro global trace command.

You can enter the macro global descriptioncommand on the switch stack or on a standalone switch.

Use the description textkeyword and argument to associate the comment text, or the macro name with a switch. When multiple macros are applied on a switch, the description text is used from the last applied macro. You can verify the global description settings by using the show parser macro description command.

To find the syntax or configuration errors, enter the macro global trace macro-name command to apply and debug the macro.

To display a list of any keyword-value pairs defined in the macro, enter the macro global apply macro-

name ? command.

You can delete a global macro-applied configuration on a switch only by entering the no version of each command that is in the macro.

Keyword matching is case sensitive.

When a macro is applied on the commands, all matching occurrences of keywords are replaced with the corresponding values.

The no form of the macro name command deletes only the macro definition. It does not affect the configuration of the interfaces on which the macro is already applied.

Examples The following example shows how to apply the macro called snmp to set the hostname address to “testserver” and to set the IP precedence value to 7:

Router(config)# macro global apply snmp ADDRESS test-server VALUE 7

The following example shows how to debug the macro called snmp by using the macro global trace command to find the syntax or configuration errors in the macro when it is applied to a switch:

Router(config)# macro global trace snmp VALUE 7 VALUE 8 VALUE 9

Applying command...`snmp-server enable traps port-security'

Applying command...`snmp-server enable traps linkup'

Applying command...`snmp-server enable traps linkdown'

Applying command...`snmp-server host'

%Error Unknown error.

Applying command...`snmp-server ip precedence 7'

Router(config)#

Related Commands

Command

macro (interface configuration)

show parser macro

Description

Creates an interface-specific command macro.

Displays the smart port macros.

Cisco IOS Configuration Fundamentals Command Reference

411

L through mode macro (interface configuration)

macro (interface configuration)

To create an interface-specific command macro, use the macro command in interface configuration mode.

To remove the macro, use the no form of this command.

macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-

keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword

[keyword-to-value]}

no macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-

keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword

[keyword-to-value]}

Syntax Description

apply macro-name

description text

trace macro-name keyword-to-value value-first-keyword

Applies a specified macro.

Specifies a description about the macros that are applied to the interface.

Applies a specified macro with trace enabled.

(Optional) Keyword to replace with a value.

Value of the keyword to replace.

Command Default

This command has no default setting.

Command Modes Interface configuration (config-if)

Command History

Release

12.2(33)SXH

Modification

This command was introduced.

Usage Guidelines You can enter up to three keyword changes using the macro trace command.

You can enter the macro description command on the switch stack or on a standalone switch.

Use the description text keyword and argument to associate comment text, or the macro name, with a switch. When multiple macros are applied on a switch, the description text will be from the last applied macro. You can verify the description settings by entering the show parser macro description command.

To find any syntax or configuration errors, enter the macro trace macro-name command to apply and debug the macro.

412

Cisco IOS Configuration Fundamentals Command Reference

L through mode macro (interface configuration)

To display a list of any keyword-value pairs defined in the macro, enter the macro apply macro-name ? command.

To successfully apply the macro, you must enter any required keyword-value pairs.

Keyword matching is case sensitive.

In the commands that the macro applies, all matching occurrences of keywords are replaced with the corresponding values.

You can delete all configuration on an interface by entering the default interface interfaceinterface configuration command.

Examples The following example shows how to apply the user-created macro called desktop-config and to verify the configuration:

Router(config)# interface fastethernet1/2

Router(config-if)# macro apply desktop-config

The following example shows how to apply the user-created macro called desktop-config and to replace all occurrences of vlan with VLAN ID 25:

Router(config-if)# macro apply desktop-config vlan 25

Related Commands

Command

macro (global configuration)

show parser macro

Description

Creates a command macro.

Displays the smart port macros.

Cisco IOS Configuration Fundamentals Command Reference

413

L through mode maximum

maximum

To set the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive, use the maximum command in archive configuration mode. To reset this command to its default, use the no form of this command.

maximum number

no maximum number

Syntax Description number Maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. You can archive from 1 to 14 configuration files. The default is 10.

Command Default By default, a maximum of 10 archive files of the running configuration are saved in the Cisco IOS configuration archive.

Command Modes Archive configuration (config-archive)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

414

Cisco IOS Configuration Fundamentals Command Reference

L through mode maximum

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.

After the maximum number of files are saved in the Cisco IOS configuration archive, the oldest file is automatically deleted when the next, most recent file is saved.

Note This command should only be used when a local writable file system is specified in the url argument of the

path command. Network file systems may not support deletion of previously saved files.

Examples In the following example, a value of 5 is set as the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive: configure terminal

archive

path disk0:myconfig

maximum 5

end

Related Commands

Command

archive config

configure confirm

configure replace path

show archive time-period

Description

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

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

415

L through mode memory cache error-recovery

memory cache error-recovery

To trace error recovery in memory using caches, use the memory cache error-recoverycommand in global configuration mode. To disable the memory cache error recovery mechanisms, use the no form of this command.

memory cache error-recovery {L1 | L2 | L3} {data | inst}

no memory cache error-recovery {L1 | L2 | L3} {data | inst}

Syntax Description

L3 data inst

Specifies the L1 cache.

Specifies the L2 cache.

Specifies the L3 cache.

Specifies if data recovery is required.

Specifies if instruction recovery is required.

Command Default Memory cache error recovery mechanisms are not enabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SXI

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to enable the memory cache error-recovery command:

Router> enable

Router# configure terminal

Router(config)# memory cache error-recovery

416

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

memory cache error-recovery options memory cache error-recovery

Description

Traces error recovery in memory using caches through set options.

Cisco IOS Configuration Fundamentals Command Reference

417

L through mode memory cache error-recovery options

memory cache error-recovery options

To trace error recovery in memory using caches through set options, use the memory cache error-

recovery optionscommand in global configuration mode. To disable the set memory cache error recovery mechanisms, use the no form of this command.

memory cache error-recovery options {abort-if-same-content | blocking-mode | max-recoveries

value | nvram-report | parity-check | window seconds}

no memory cache error-recovery options {abort-if-same-content | blocking-mode | max-

recoveries value | nvram-report | parity-check | window seconds}

Syntax Description abort-if-same-content blocking-mode

max-recoveries value nvram-report parity-check

window seconds

Abort recovery if the cache contains the same content as the memory.

Sets the memory blocking mode to special or ON.

The maximum number of recoveries allowed within a time window. Specify a value in the range 0 to

255.

Saves the report in the NVRAM.

Sets the parity checking mode to normal or ON.

The time window, in seconds. Specify a value in the range 1 to 31536000.

Command Default Memory cache error recovery mechanisms are not enabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SXI

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

Examples

The following example shows how to enable the memory cache error-recovery optionscommand:

Router> enable

418

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory cache error-recovery options

Router# configure terminal

Router(config)# memory cache error-recovery options abort-if-same-content

Related Commands

Command

memory cache error-recovery

Description

Traces error recovery in memory using caches.

Cisco IOS Configuration Fundamentals Command Reference

419

L through mode memory free low-watermark

memory free low-watermark

To configure a router to issue system logging message notifications when available memory falls below a specified threshold, use the memory free low-watermarkcommand in global configuration mode. To disable memory threshold notifications, use the no form of this command.

memory free low-watermark {processor threshold | io threshold}

no memory free low-watermark

Syntax Description

processor threshold

io threshold

Sets the processor memory threshold in kilobytes.

When available processor memory falls below this threshold, a notification message is triggered. Valid values are 1 to 4294967295.

Sets the input/output (I/O) memory threshold in kilobytes. When available I/O memory falls below this threshold, a notification message is triggered.

Valid values are 1 to 4294967295.

Command Default Memory threshold notifications are disabled.

Command Modes Global configuration

Command History

Release

12.2(18)S

12.0(26)S

12.3(4)T

12.2(27)SBC

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.0(26)S.

This command was integrated into Cisco IOS

Release 12.3(4)T.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

420

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory free low-watermark

Usage Guidelines Using this command, you can configure a router to issue a system logging message each time available free memory falls below a specified threshold (“low-watermark”). Once available free memory rises to 5 percent above the threshold, another notification message is generated.

Examples The following example specifies a free processor memory notification threshold of 20000 KB:

Router(config)# memory free low-watermark processor 200000

If available free processor memory falls below this threshold, the router sends a notification message like this one:

000029: *Aug 12 22:31:19.559: %SYS-4-FREEMEMLOW: Free Memory has dropped below 20000k

Pool: Processor Free: 66814056 freemem_lwm: 204800000

Once available free processor memory rises to a point 5 percent above the threshold, another notification message like this is sent:

000032: *Aug 12 22:33:29.411: %SYS-5-FREEMEMRECOVER: Free Memory has recovered 20000k

Pool: Processor Free: 66813960 freemem_lwm: 0

Related Commands

Command

memory reserve critical

Description

Reserves memory for use by critical processes.

Cisco IOS Configuration Fundamentals Command Reference

421

L through mode memory lite

memory lite

To enable the memory allocation lite (malloc_lite) feature, use the memory lite command in global configuration mode. To disable this feature, use the no form of this command.

memory lite

no memory lite

Syntax Description This command has no arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration

Command History

Release

12.3(11)T

Modification

This command was introduced.

Usage Guidelines The malloc_lite feature was implemented to avoid excessive memory allocation overhead for situations where less than 128 bytes were required. This feature is supported for processor memory pools only.

The malloc_lite feature is enabled by default. If the malloc_lite feature is disabled using the no memory

litecommand, you can re-enable the feature by entering the memory lite command.

Examples The following example shows how to disable the malloc_lite feature: no memory lite

Related Commands

Command

scheduler heapcheck process

Description

Performs a “sanity check” for corruption in memory blocks when a process switch occurs.

422

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory reserve

memory reserve

To reserve a specified amount of memory in kilobytes for console access and critical notifications, use the

memory reserve command in global configuration mode. To disable the configuration, use the no form of this command.

Syntax for Releases 15.0(1)M and 12.2(33)SRC and Later Releases

memory reserve {console size | critical [total-size]}

no memory reserve {console | critical}

Syntax for Releases 12.2(33)SXI, Cisco IOS XE Release 2.1 and Later Releases

memory reserve critical [total-size]

no memory reserve critical

Syntax Description console size critical total-size

Reserves the memory size for a console session.

Amount of memory to be reserved, in kilobytes.

The range is from 1 to 4096.

Reserves the memory for critical notifications.

(Optional) Total amount of memory to be reserved, in kilobytes. The range is from 1 to 4294967295.

Command Modes Global configuration (config)

Command Default 256 KB is reserved for console memory access. 100 KB is reserved for cricial memory access.

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

Cisco IOS Configuration Fundamentals Command Reference

423

L through mode memory reserve

Release

Cisco IOS XE Release 2.1

Modification

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines

The memory reserve console command reserves enough memory to ensure console access to a Cisco IOS device for administrative and troubleshooting purposes. This feature is especially beneficial when the device runs low on memory.

The memory reserve critical command reserves the specified amount of memory in kilobytes so that the router can issue critical notifications. The amount of memory reserved for critical notifications cannot exceed 25 percent of the total available memory.

Examples The following example shows how to reserve a specified amount of memory in kilobytes for console access:

Router# configure terminal

Router(config)# memory reserve console 2

Related Commands

Command

memory free low-watermark

Description

Configures a router to issue system logging message notifications when available memory falls below a specified threshold.

424

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory reserve critical

memory reserve critical

Note Effective with Cisco IOS Release 12.4(15)T1, the memory reserve critical command is replaced by the

memory reserve command. See the memory reserve command for more information.

To configure the size of the memory region to be used for critical notifications (system logging messages), use the memory reserve criticalcommand in global configuration mode. To disable the reservation of memory for critical notifications, use the no form of this command.

memory reserve critical kilobytes

no memory reserve critical

Syntax Description kilobytes Specifies the amount of memory to be reserved in kilobytes. Valid values are 1 to 4294967295, but the value you specify cannot exceed 25 percent of total memory. The default is 100 kilobytes.

Command Default 100 kilobytes of memory is reserved for the logging process.

Command Modes Global configuration (config)

Command History

Release

12.2(18)S

12.0(26)S

12.3(4)T

12.2(27)SBC

12.2(33)SRA

12.4(15)T1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.0(26)S.

This command was integrated into Cisco IOS

Release 12.3(4)T.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was replaced by the memory

reserve command.

Cisco IOS Configuration Fundamentals Command Reference

425

L through mode memory reserve critical

Usage Guidelines This command reserves a region of memory on the router so that, when system resources are overloaded, the router retains enough memory to issue critical system logging messages.

Note Once the size of the reserved memory region is specified, any change to the specified value takes effect only after the current configuration is saved and the system has been reloaded.

Examples The following example shows how to reserve 1,000 KB of system memory for logging messages at the next system restart:

Router(config)# memory reserve critical 1000

Related Commands

Command

memory free low-watermark

Description

Configures a router to issue syslog notifications when available memory falls below a specified threshold.

426

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory sanity

memory sanity

To perform a “sanity check” for corruption in buffers and queues, use the memory sanity command in global configuration mode. To disable this feature, use the no form of this command.

memory sanity [buffer | queue | all]

no memory sanity

Syntax Description buffer queue all

(Optional) Specifies checking all buffers.

(Optional) Specifies checking all queues.

(Optional) Specifies checking all buffers and queues.

Command Default This command is not enabled by default. If the buffer or queue keyword is not specified, a sanity check will be performed on all buffers and queues.

Command Modes Global configuration

Command History

Release

12.2(15)T

Modification

This command was introduced.

Usage Guidelines

When the memory sanity buffer command is enabled, a sanity check is performed on buffers when a packet buffer is allocated or when a packet buffer is returned to the buffer pool. This command also timestamps the buffer, which may be useful when tracking the age of a buffer.

The memory sanity command can be saved in the startup configuration file and, therefore, it is not necessary to reconfigure this command each time the router is reloaded. Like the scheduler heapcheck

process memory command, the memory sanity command can check for corruption in the I/O memory block.

Enabling the memory sanity command may result in slight router performance degradation.

Examples The following example shows how to perform a sanity check for corruption in all buffers and queues: memory sanity all

Cisco IOS Configuration Fundamentals Command Reference

427

L through mode memory sanity

Related Commands

Command

scheduler heapcheck process memory

Description

Performs a “sanity check” for corruption in memory blocks when a process switch occurs.

428

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory scan

memory scan

To enable the Memory Scan feature, use the memory scan command in global configuration mode. To restore the router configuration to the default, use the no form of this command.

memory scan

no memory scan

Syntax Description This command has no arguments or keywords.

Command Default This command is disabled by default.

Command Modes Global configuration

Command History

Release

12.0(4)XE

12.0(7)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated in Cisco IOS Release

12.0 T for the Cisco 7500 series only.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Memory Scan feature adds a low-priority background process that searches all installed dynamic random-access memory (DRAM) for possible parity errors. If errors are found in memory areas that are not in use, this feature attempts to scrub (remove) the errors. The time to complete one memory scan and scrub cycle can range from 10 minutes to several hours, depending on the amount of installed memory. The impact of the Memory Scan feature on the central processing unit (CPU) is minimal. To view the status of the memory scan feature on your router, use the show memory scan command in EXEC mode.

Examples The following example enables the Memory Scan feature on a Cisco 7500 series router:

Router(config)# memory scan

Cisco IOS Configuration Fundamentals Command Reference

429

memory scan

Related Commands

Command

show memory scan

L through mode

Description

Displays the number and type of parity errors on your system.

430

Cisco IOS Configuration Fundamentals Command Reference

L through mode memory-size iomem

memory-size iomem

To reallocate the percentage of DRAM to use for I/O memory and processor memory, use the memory-size

iomem command in global configuration mode. To revert to the default memory allocation, use the no form of this command.

memory-size iomem i/o-memory-percentage

no memory-size iomem

Syntax Description i/o-memory-percentage The percentage of DRAM allocated to I/O memory, in bytes. The values permitted are 5, 10, 15, 20, 25,

30, 40, and 50 . A minimum of 4 MB of memory is required for I/O memory.

Command Default The default memory allocation is 25 percent of the DRAM to I/O memory and 75 percent of the DRAM to processor memory.

Note If thesmartinitprocess has been enabled, the default memory allocation of 25 percent to the I/O memory does not apply. Instead, smartinitexamines the network modules, and then calculates the memory allocation for the I/O memory.

Command Modes Global configuration (config)

Command History

Release

11.2 P

12.2(33)SRA

12.4(15)T1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.4(15)T1.

Usage Guidelines When you specify the percentage of I/O memory in the command line, the processor memory automatically acquires the remaining percentage of the DRAM memory.

Cisco IOS Configuration Fundamentals Command Reference

431

L through mode memory-size iomem

Examples The following example allocates 40 percent of the DRAM memory to I/O memory and the remaining 60 percent to the processor memory:

Router# configure terminal

Router(config)# memory-size iomem 40

Smart-init will be disabled and new I/O memory size will take effect upon reload.

432

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu (EXEC)

menu (EXEC)

To display a preconfigured user menu, use the menu command in user EXEC or privileged EXEC mode.

menu menu-name

Syntax Description menu-name The name of the menu.

Command Modes User EXEC

Privileged EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A user menu is a type of user interface where text descriptions of actions to be performed are displayed to the user. The user can use the menu to select services and functions without having to know the details of command-line interface (CLI) commands.

Menus can be created for users in global configuration mode, using the commands listed in the “Related

Commands” section.

A menu can be invoked at either the user or privileged EXEC level, but if an item in the menu contains a privileged EXEC command, the user must be logged in at the privileged level for the command to succeed.

Examples The following example invokes a menu named OnRamp:

Router> menu OnRamp

Welcome to OnRamp Internet Services

Type a number to select an option;

Type 9 to exit the menu.

1 Read email

2 UNIX Internet access

3 Resume UNIX connection

6 Resume next connection

9 Exit menu system

Cisco IOS Configuration Fundamentals Command Reference

433

menu (EXEC)

Related Commands

Command

menu clear-screen

menu command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu status-line

menu text

menu title

no menu

L through mode

Description

Clears the terminal screen before displaying a menu.

Specifies underlying commands for user interface menus.

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an option number.

Sets options for items in user interface menus.

Specifies the prompt for a user interface menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu.

Specifies the text of a menu item in a user interface menu.

Creates a title, or banner, for a user menu.

Deletes a specified menu from a menu configuration.

434

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu menu-name single-space

menu menu-name single-space

To display menu items single-spaced rather than double-spaced, use the menu <menu-name> single-space command in global configuration mode.

menu menu-name single-space

Syntax Description menu-name Name of the menu this command should be applied to.

Command Default Enabled for menus with more than nine items; disabled for menus with nine or fewer items.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

When more than nine menu items are defined, the menu is displayed single-spaced. To configure the menus with nine or fewer items to display single-spaced, use this command.

Examples In the following example, single-spaced menu items are displayed for the menu named Access1: menu Access1 single-space

Related Commands

Command

menu (EXEC)

menu clear-screen

menu command

Description

Invokes a user menu.

Clears the terminal screen before displaying a menu.

Specifies underlying commands for user menus.

Cisco IOS Configuration Fundamentals Command Reference

435

menu menu-name single-space

Command

menu default

menu line-mode

menu options

menu prompt

menu status-line

menu text

menu title

L through mode

Description

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays a line of status information about the current user at the top of a menu.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

436

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu clear-screen

menu clear-screen

To clear the terminal screen before displaying a menu, use the menu clear-screen command in global configuration mode.

menu clear-screen menu-name clear-screen

Syntax Description menu-name Name of the menu this command should be applied to.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command uses a terminal-independent mechanism based on termcap entries defined in the router and the configured terminal type for the user. This command allows the same menu to be used on multiple types of terminals instead of having terminal-specific strings embedded within menu titles. If the termcap entry does not contain a clear string, the menu system enters 24 new lines, causing all existing text to scroll off the top of the terminal screen.

Examples In the following example, the terminal screen is cleared before displaying the menu named Access1:

Router(config)# menu Access1 clear-screen

Related Commands

Command

menu (EXEC)

menu command

Description

Invokes a user menu.

Specifies underlying commands for user menus.

Cisco IOS Configuration Fundamentals Command Reference

437

menu clear-screen

Command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu status-line

menu text

menu title

no menu

L through mode

Description

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Deletes a specified menu from a menu configuration.

438

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu command

menu command

To specify underlying commands for user menus, use the menu command command in global configuration mode.

menu command menu menu-name command menu-item {command | menu-exit}

Syntax Description menu-name menu-item command menu-exit

Name of the menu. You can specify a maximum of

20 characters.

Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu entries. When the tenth item is added to the menu, the line-mode and single-space options are activated automatically.

Command to issue when the user selects an item.

Provides a way for menu users to return to a higherlevel menu or exit the menu system.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Use this command to assign actions to items in a menu. Use the menu text global configuration command to assign text to items. These commands must use the same menu name and menu selection key.

The menu command command has a special keyword for the command argument, menu-exit, that is available only within menus. It is used to exit a submenu and return to the previous menu level, or to exit the menu altogether and return to the EXEC command prompt.

You can create submenus that are opened by selecting entries in another menu. Use the menu EXEC command as the command for the submenu item.

Cisco IOS Configuration Fundamentals Command Reference

439

L through mode menu command

Note If you nest too many levels of menus, the system prints an error message on the terminal and returns to the previous menu level.

When a menu allows connections (their normal use), the command for an entry activating the connection should contain a resume command, or the line should be configured to prevent users from escaping their sessions with the escape-char none command. Otherwise, when they escape from a connection and return to the menu, there will be no way to resume the session and it will sit idle until the user logs out.

Specifying the resume command as the action that is performed for a selected menu entry permits a user to resume a named connection or connect using the specified name, if there is no active connection by that name. As an option, you can also supply the connect string needed to connect initially. When you do not supply this connect string, the command uses the specified connection name.

You can also use the resume/next command, which resumes the next connection in the user’s list of connections. This function allows you to create a single menu entry that steps through all of the user’s connections.

Note A menu should not contain any exit paths that leave users in an unfamiliar interface environment.

When a particular line should always display a menu, that line can be configured with an autocommand line configuration command. Menus can be run on a per-user basis by defining a similar

autocommandcommand for that local username. For more information about the autocommand command, refer to the Cisco IOS Dial Technologies Configuration Guide.

Examples In the following example, the commands to be issued when the menu user selects option 1, 2, or 3 are specified for the menu named Access1: menu Access1 command 1 tn3270 vms.cisco.com

menu Access1 command 2 rlogin unix.cisco.com

menu Access1 command 3 menu-exit

The following example allows a menu user to exit a menu by entering Exit at the menu prompt: menu Access1 text Exit Exit menu Access1 command Exit menu-exit

Related Commands

Command autocommand

menu (EXEC)

menu clear-screen

Description

Configures the Cisco IOS software to automatically execute a command when a user connects to a particular line.

Invokes a user menu.

Clears the terminal screen before displaying a menu.

440

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu status-line

menu text

menu title menu command

Description

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

441

L through mode menu default

menu default

To specify the menu item to use as the default, use the menu default command in global configuration mode.

menu menu-name default menu-item

Syntax Description menu-name menu-item

Name of the menu. You can specify a maximum of

20 characters.

Number, character, or string key of the item to use as the default.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to specify which menu entry is used when the user presses Enter without specifying an item. The menu entries are defined by the menu command and menu text global configuration commands.

Examples In the following example, the menu user exits the menu when pressing Enter without selecting an item: menu Access1 9 text Exit the menu menu Access1 9 command menu-exit menu Access1 default

442

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

menu (EXEC)

menu command

menu prompt

menu text

menu title menu default

Description

Invokes a preconfigured user menu.

Specifies underlying commands for user menus.

Specifies the prompt for a user menu.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

443

L through mode menu line-mode

menu line-mode

To require the user to press Enter after specifying an item, use the menu line-mode command in global configuration mode.

menu menu-name line-mode

Syntax Description menu-name Name of the menu this command should be applied to.

Command Default Enabled for menus with more than nine items. Disabled for menus with nine or fewer items.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

In a menu of nine or fewer items, you ordinarily select a menu item by entering the item number. In line mode, you select a menu entry by entering the item number and pressing Enter. Line mode allows you to backspace over the selected number and enter another number before pressing Enter to issue the command.

This option is activated automatically when more than nine menu items are defined but also can be configured explicitly for menus of nine or fewer items.

In order to use strings as keys for items, the menu line-mode command must be configured.

Examples In the following example, the line-mode option is enabled for the menu named Access1: menu Access1 line-mode

444

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

menu (EXEC)

menu clear-screen

menu command

menu default

menu options

menu prompt

menu single-space

menu status-line

menu text menu line-mode

Description

Invokes a preconfigured user menu.

Clears the terminal screen before displaying a menu.

Specifies underlying commands for a user menu.

Specifies the menu item to use as the default.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu.

Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

445

L through mode menu options

menu options

To set options for items in user menus, use the menu options command in global configuration mode.

Cisco IOS Release 10.0, 12.2(33)SRA, 12.2(33)SXI , and Later Releases

menu menu-name options menu-item [login] [pause]

Cisco IOS XE Release 3.1S and Later Releases

menu menu-name options menu-item {login | pause}

Syntax Description menu-name menu-item login pause

The name of the menu. You can specify a maximum of 20 characters.

Number, character, or string key of the item affected by the option.

(Optional) Configures the router to request a login before issuing the command.

(Optional) Configures the router to pause after issuing the command and before redrawing the menu.

Command Default The menu options are disabled.

Command Modes Global configuration (config)

Command History

Release

10.0

12.2(33)SRA

12.2(33)SXI

Cisco IOS XE Release 3.1S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into a release earlier than Cisco IOS Release 3.1S.

446

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu options

Usage Guidelines Use the menu command and menu text commands to define a menu entry.

Examples The following example shows how to configure the router to request a login before issuing the command specified by menu entry 3 of the menu named Access1:

Router(config)# menu Access1 options 3 login

Related Commands

Command

menu (EXEC)

menu clear-screen

menu command

menu default

menu line-mode

menu prompt

menu single-space

menu status-line

menu text

menu title

Description

Invokes a user menu.

Clears the terminal screen before displaying a menu.

Specifies underlying commands for user menus.

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

447

L through mode menu prompt

menu prompt

To specify the prompt for a user menu, use the menu prompt command in global configuration mode.

menu menu-name prompt d prompt d

Syntax Description menu-name d prompt

Name of the menu. You can specify a maximum of

20 characters.

A delimiting character that marks the beginning and end of a title. Text delimiters are characters that do not ordinarily appear within the text of a title, such as slash ( / ), double quote ("), and tilde (~). ^C is reserved for special use and should not be used in the text of the title.

Prompt string for the menu.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Press Enter after entering the first delimiter. The router will prompt you for the text of the prompt. Enter the text followed by the delimiter, and press Enter.

Use the menu command and menu text commands to define the menu selections.

Examples In the following example, the prompt for the menu named Access1 is configured as “Select an item.”:

Router(config)# menu Access1 prompt /

Enter TEXT message. End with the character '/'.

Select an item. /

Router(config)#

448

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

menu (EXEC)

menu command

menu default

menu text

menu title menu prompt

Description

Invokes a user menu.

Specifies underlying commands for user menus.

Specifies the menu item to use as the default.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

449

L through mode menu status-line

menu status-line

To display a line of status information about the current user at the top of a menu, use the menu status-line command in global configuration mode.

menu menu-name status-line

Syntax Description menu-name Name of the menu this command should be applied to.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command displays the status information at the top of the screen before the menu title is displayed.

This status line includes the router’s host name, the user’s line number, and the current terminal type and keymap type (if any).

Examples In the following example, status information is enabled for the menu named Access1: menu Access1 status-line

Related Commands

Command

menu (EXEC)

menu clear-screen

Description

Invokes a user menu.

Clears the terminal screen before displaying a menu.

450

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Command

menu command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu text

menu title menu status-line

Description

Specifies underlying commands for user menus.

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item in a menu.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

451

L through mode menu text

menu text

To specify th e text of a menu item in a user menu, use the menu text command in global configuration mode.

menu menu-name text menu-item menu-text

Syntax Description menu-name menu-item menu-text

Name of the menu. You can specify a maximum of

20 characters.

Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu items. When the tenth item is added to the menu, the menu line-mode and menu single-space commands are activated automatically.

Text of the menu item.

Command Default No text appears for the menu item.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to assign text to items in a menu. Use the menu command command to assign actions to items. These commands must use the same menu name and menu selection key.

You can specify a maximum of 18 items in a menu.

Examples In the following example, the descriptive text for the three entries is specified for options 1, 2, and 3 in the menu named Access1: menu Access1 text 1 IBM Information Systems

452

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu text menu Access1 text 2 UNIX Internet Access menu Access1 text 3 Exit menu system

Related Commands

Command

menu (EXEC)

menu clear-screen

menu command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu status-line

menu title

Description

Invokes a user menu.

Clears the terminal screen before displaying a menu.

Specifies underlying commands for user menus.

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

453

L through mode menu title

menu title

To create a t itle (banner) for a user menu, use the menu title command in global configuration mode.

menu menu-name title d menu-title d

Syntax Description menu-name d menu-title

Name of the menu. You can specify a maximum of

20 characters.

Lines of text to appear at the top of the menu.

Command Default The menu does not have a title.

Command Modes

Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The menu title command must use the same menu name used with the menu text and menu command commands used to create a menu.

You can position the title of the menu horizontally by preceding the title text with blank characters. You can also add lines of space above and below the title by pressing Enter.

Follow the title keyword with one or more blank characters and a delimiting character of your choice. Then enter one or more lines of text, ending the title with the same delimiting character. You cannot use the delimiting character within the text of the message.

When you are configuring from a terminal and are attempting to include special control characters, such as a screen-clearing string, you must use Ctrl-V before the special control characters so that they are accepted as part of the title string. The string ^[[H^[[J is an escape string used by many VT100-compatible terminals to clear the screen. To use a special string, you must enter Ctrl-V before each escape character.

454

Cisco IOS Configuration Fundamentals Command Reference

L through mode menu title

You also can use the menu clear-screen global configuration command to clear the screen before displaying menus and submenus, instead of embedding a terminal-specific string in the menu title. The

menu clear-screen command allows the same menu to be used on different types of terminals.

Examples In the following example, the title that will be displayed is specified when the menu named Access1 is invoked. Press Enter after the second slash (/) to display the prompt.

Router(config)# menu Access1 title /^[[H^[[J

Enter TEXT message. End with the character '/'.

Welcome to Access1 Internet Services

Type a number to select an option;

Type 9 to exit the menu.

Router(config)#

Related Commands

Command

menu (EXEC)

menu clear-screen

menu command

menu default

menu line-mode

menu options

menu prompt

menu single-space

menu status-line

menu text

Description

Invokes a user menu.

Clears the terminal screen before displaying a menu.

Specifies underlying commands for user menus.

Specifies the menu item to use as the default.

Requires the user to press Enter after specifying an item.

Sets options for items in user menus.

Specifies the prompt for a user menu.

Displays menu items single-spaced rather than double-spaced.

Displays a line of status information about the current user at the top of a menu.

Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

455

L through mode microcode (12000)

microcode (12000)

To load a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000 series Gigabit Switch Router (GSR), use the microcode command in global configuration mode. To load the microcode bundled with the GRP system image, use the no form of this command.

microcode {oc12-atm | oc12-pos | oc3-pos4} {flash file-id [slot] | system [slot]}

no microcode {oc12-atm | oc12-pos | oc3-pos4} [flash file-id [slot] | system [slot]]

Syntax Description

oc12-atm | oc12-pos | oc3-pos4 flash file-id slot system

Interface name.

Loads the image from the Flash file system.

Specifies the device and filename of the image file to download from Flash memory. A colon (:) must separate the device and filename (for example, slot0:gsr-p-mz). Valid devices include:

• bootflash: --Internal Flash memory.

• slot0: --First PCMCIA slot.

• slot1: --Second PCMCIA slot.

(Optional) Slot number of the line card that you want to copy the software image to. Slot numbers range from 0 to 11 for the Cisco 12012 router and 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is downloaded on all line cards.

Loads the image from the software image on the

GRP card.

Command Default

The default is to load the image from the GRP card (system).

Command Modes Global configuration

Command History

Release

11.2 GS

Modification

This command was introduced for Cisco 12000 series GSRs.

456

Cisco IOS Configuration Fundamentals Command Reference

L through mode microcode (12000)

Release

12.2(33)SRA

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on a Cisco 12000 series has a Cisco IOS image. When the router is reloaded, the specified image is loaded onto the GRP card and then automatically downloaded to all the line cards.

Cisco IOS image that is different from the one on the line card. Additionally, you might need to load a new image on the line card to work around a problem that is affecting only one of the line cards.

To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to download the image to the line card, followed by the microcode reload command to start the image.

Immediately after you enter the microcode reload command and press Return, the system reloads all microcode. Global configuration mode remains enabled. After the reloading is complete, enter the exit command to return to the EXEC system prompt.

To verify that the correct image is running on the line card, use the execute-on slot slot show version command.

For additional information on GSR configuration, refer to the documentation specific to your Cisco IOS software release.

Examples In the following example, the Cisco IOS software image in slot 0 is downloaded to the line card in slot 10.

This software image is used when the system is booted, a line card is inserted or removed, or the

microcode reloadglobal configuration command is issued.

Router(config)# microcode oc3-POS-4 flash slot0:fip.v141-7 10

Router(config)# microcode reload 10

In this example, the user would issue the execute-on slot 10 show version command to verify that the correct version is loaded.

Related Commands

Command

microcode reload (12000)

Description

Reloads microcode on Cisco 12000 series GSRs.

Cisco IOS Configuration Fundamentals Command Reference

457

L through mode microcode (7000/7500)

microcode (7000/7500)

To specify the location of the microcode that you want to download from Flash memory into the writable control store (WCS) on Cisco 7000 series (including RSP based routers) or Cisco 7500 series routers, use the microcode command in global configuration mode. To load the microcode bundled with the system image, use the no form of this command.

microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]}

no microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]}

Syntax Description interface-type

flash-filesystem : filename slot rom system

One of the following interface processor names:

aip, cip, eip, feip, fip, fsip, hip, mip, sip, sp, ssp,

trip, vip, or vip2

Flash file system, followed by a colon . Valid file systems are bootflash, slot0, and slot1

Slave devices such as slaveslot0 are invalid. The slave’s file system is not available during microcode reloads.

Name of the microcode file.

(Optional) Number of the slot. Range is from 0 to

15.

If ROM is specified, the router loads from the onboard ROM microcode.

If the system keyword is specified, the router loads the microcode from the microcode bundled into the system image you are running for that interface type.

Command Default

The default is to load from the microcode bundled in the system image.

Command Modes Global configuration

Command History

Release

10.3

Modification

This command was introduced.

458

Cisco IOS Configuration Fundamentals Command Reference

L through mode microcode (7000/7500)

Release

12.2(33)SRA

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

If you do not use the microcode reload command after using the microcode command, the microcode

reload command will be written to the configuration file automatically.

When using Dual RSPs for simple hardware backup, ensure that the master and slave RSP card contain the same microcode image in the same location when the router is to load the interface processor microcode from a Flash file system. Thus, if the slave RSP becomes the master, it will be able to find the microcode image and download it to the interface processor.

Examples In the following example, all FIP cards will be loaded with the microcode found in Flash memoryfile fip.v141-7 when the system is booted, when a card is inserted or removed, or when the microcode

reloadglobal configuration command is issued. The configuration is then written to the startup configuration file.

Router(config)# microcode fip slot0:fip.v141-7

Router(config)# end

Router# copy system:running-config nvram:startup-config

Related Commands

Command

more flh:logfile

Description

Displays the system console output generated during the Flash load helper operation.

Cisco IOS Configuration Fundamentals Command Reference

459

L through mode microcode (7200)

microcode (7200)

To configure a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router, use the microcode command in global configuration mode. To revert to the default microcode for the current running version of the Cisco IOS software, use the no form of this command.

microcode {ecpa | pcpa} location

no microcode {ecpa | pcpa}

Syntax Description ecpa pcpa location

ESCON Channel Port Adapter (CPA) interface.

Parallel CPA interface.

Location of microcode, including the device and filename.

Command Default If the default or noform of the command is specified, the driver uses the default microcode for the current running version of the Cisco IOS software.

Command Modes Global configuration

Command History

Release

11.3(3)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If there are any default overrides when the configuration is written, then the microcode reload command will be written to the configuration automatically. This action enables the configured microcode to be downloaded at system startup.

The CPA microcode image is preloaded on Flash memory cards for Cisco 7200-series routers for Cisco

IOS Release 11.3(3)T and later releases. You may be required to copy a new image to Flash memory when a new microcode image becomes available.

For more information on the CPA configuration and maintenance, refer to the “Configuring Cisco

Mainframe Channel Connection Adapters” chapter in the Release 12.2 Cisco IOS Bridging and IBM

Networking Configuration Guide.

460

Cisco IOS Configuration Fundamentals Command Reference

L through mode microcode (7200)

Examples The following example instructs the Cisco IOS software to load the microcode from an individual microcode image that is stored as a file on the Flash card inserted in Flash card slot 0: microcode ecpa slot0:xcpa26-1

Related Commands

Command

microcode reload (7200)

show microcode

Description

Resets and reloads the specified hardware in a

Cisco 7200 series router.

Displays microcode information.

Cisco IOS Configuration Fundamentals Command Reference

461

L through mode microcode reload (12000)

microcode reload (12000)

To reload the Cisco IOS image from a line card on Cisco 12000 series routers, use the microcode reload command in global configuration mode.

microcode reload [slot-number]

Syntax Description slot-number (Optional) Slot number of the line card that you want to reload the Cisco IOS software image on.

Slot numbers range from 0 to 11 for the Cisco

12012 and from 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is reloaded on all line cards.

Command Modes Global configuration

Command History

Release

11.2 GS

12.2(33)SRA

Modification

This command was introduced for Cisco 12000 series GSRs.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on Cisco 12000 series routers has a Cisco IOS image. When the router is reloaded, the specified Cisco IOS image is loaded onto the GRP card and automatically downloaded to all the line cards.

Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a different Cisco IOS image. Additionally, you might need to load a new image on the line card to work around a problem affecting only one of the line cards.

For additional information on GSR configuration, refer to the “Observing System Startup and Performing a

Basic Configuration” chapter in the Cisco 12000 series installation and configuration guides.

The microcode reload (12000) command allows you to issue another command immediately.

462

Cisco IOS Configuration Fundamentals Command Reference

L through mode microcode reload (12000)

Note Issuing a microcode reload command on any of the line cards in a Cisco 12000 GSR immediately returns the console command prompt. This allows you to issue a subsequent command immediately to the reloading line card. However, any commands entered at this time will not execute, and often no indication will be given that such a command failed to run. Verify that the microcode has reloaded before issuing new commands.

Examples In the following example, the mirocode firmware is reloaded on the line card in slot 10:

Router(config)# microcode reload 10

Related Commands

Command

microcode (12000)

Description

Loads a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco

12000 series GSR.

Cisco IOS Configuration Fundamentals Command Reference

463

L through mode microcode reload (7000 7500)

microcode reload (7000 7500)

To reload the processor card on the Cisco 7000 series with RSP7000 or Cisco 7500 series routers, use the

microcode reload command in global configuration mode.

microcode reload [slot-number]

Syntax Description slot-number (Optional) Reloads the specified processor card slot on a Cisco 7500 series router.

Command Default No default behaviors or values.

Command Modes Global configuration

Command History

Release

10.3

12.3(8)T

12.2(33)SRA

Modification

This command was introduced for Cisco 7500 series routers.

The slot-number argument was added for Cisco

7500 series routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command reloads the microcode without rebooting the router. Immediately after you enter the

microcode reload command, the system reloads all microcode. Global configuration mode remains enabled.

Note If you modify the system configuration to load a microcode image, the microcode reload command will be written to the configuration file automatically following the use of a microcode command. This action enables the configured microcode to be downloaded at system startup.

464

Cisco IOS Configuration Fundamentals Command Reference

L through mode microcode reload (7000 7500)

Examples In the following example, all controllers are reset, and the microcode specified in the current configuration is loaded:

Router(config)# microcode reload

Related Commands

Command

microcode (7000/7500)

Description

Specifies the location from where microcode should be loaded when the microcode reload command is processed on RSP-based routers.

Cisco IOS Configuration Fundamentals Command Reference

465

L through mode microcode reload (7200)

microcode reload (7200)

To reload the Cisco IOS microcode image on an ESCON CPA card in the Cisco 7200 series router, use the

microcode reload command in privileged EXEC mode.

microcode reload {all | ecpa [slot slot-number] | pcpa [slot slot-number]}

Syntax Description all ecpa pcpa

slot slot-number

Resets and reloads all hardware types that support downloadable microcode.

Resets and reloads only those slots that contain hardware type ecpa.

Resets and reloads only those slots that contain hardware type pcpa.

(Optional) Resets and reloads only the slot specified, and only if it contains the hardware specified.

Command Modes Privileged EXEC

Command History

Release

11.3(3)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Hardware types that do not support downloadable microcode are unaffected by the microcode reload all command.

You will be prompted for confirmation before the microcode reloadcommand is executed.

Examples The following example reloads the ESCON CPA microcode in slot 5 with the currently configured microcode:

Router# microcode reload ecpa slot 5

466

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command

microcode (7200)

show microcode microcode reload (7200)

Description

Configures a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router.

Displays the microcode bundled into a Cisco 7000 series with RSP7000, Cisco 7200 series, or Cisco

7500 series router.

Cisco IOS Configuration Fundamentals Command Reference

467

L through mode mkdir

mkdir

To create a new directory in a Class C flash file system, use the mkdir command in user EXEC, privileged

EXEC, or diagnostic mode.

mkdir directory

Syntax Description directory The name of the directory to create.

Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History

Release

11.3AA

12.2(33)SRA

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified and implemented on the Cisco ASR 1000 Aggregation Services Routers.

The following enhancements were made:

• This command was introduced in diagnostic mode. The command can be entered in both privileged EXEC and diagnostic mode on the

Cisco ASR 1000 Series Routers.

• The harddisk:, obfl:, stby-harddisk:, stby-

nvram:, stby-obfl:, stby-usb[0-1]:,and

usb[0-1]: directory options were added.

Usage Guidelines This command is valid only on Class C flash file systems.

When executing the mkdir directory command on a USB token device, you can create only two levels of subdirectories under a directory. A new directory (third level directory) cannot be created on the USB token, but you can copy files to the existing subdirectories.

Examples

The following example creates a directory named newdir:

Router# mkdir newdir

Mkdir file name [newdir]?

Created dir flash:newdir

Router# dir

468

Cisco IOS Configuration Fundamentals Command Reference

L through mode mkdir

Directory of flash:

2 drwx 0 Mar 13 1993 13:16:21 newdir

8128000 bytes total (8126976 bytes free)

Related Commands

Command dir rmdir

Description

Displays a list of files on a file system.

Removes an existing directory in a Class C flash file system.

Cisco IOS Configuration Fundamentals Command Reference

469

L through mode mkdir disk0:

mkdir disk0:

To create a new directory in a Flash file system, use the mkdir disk0:command.

mkdir disk0:

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to the 12.2 SX release.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command is valid only on Flash file systems.

After you enter the mkdir disk0: command, you are prompted to enter the new directory filename.

To check your entry, enter the dir command.

To remove a directory, enter the rmdir command.

Examples This example shows how to create a directory named newdir:

Router# mkdir disk0:

Create directory filename [ ]? newdir

Created dir disk0: newdir

Router#

470

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Related Commands

Command cd dir rmdir mkdir disk0:

Description

Changes the default directory or file system.

Displays a list of files on a file system.

Removes an existing directory in a Class C Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

471

L through mode mode

mode

To set the redundancy mode, use the mode command in redundancy configuration mode.

Syntax for 12.2S Release

mode {rpr | rpr-plus | sso}

Syntax for Cisco IOS XE Release 2.5 and Later Releases

mode {rpr | sso}

Syntax for 12.2XNE Release

mode sso

Syntax Description rpr rpr-plus sso

Specifies Route Processor Redundancy (RPR) mode.

Specifies Route Processor Redundancy Plus (RPR

+) mode.

Specifies stateful switchover (SSO) mode.

Command Default

• The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image.

• The default is RPR mode if different versions are installed.

• If redundancy is enabled, the default is the mode that you have configured.

Command Default

• The default is RPR+ mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image.

• The default is RPR mode if different versions are installed.

• If redundancy is enabled, the default is the mode that you have configured.

Command Default

• The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image.

• The default is RPR mode if different versions are installed.

472

Cisco IOS Configuration Fundamentals Command Reference

L through mode mode

Command Default • The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image.

• The default is RPR mode if different versions are installed.

Command Modes Redundancy configuration (config-red)

Command History

Release

12.2(14)SX

12.2(17b)SXA

12.2(17d)SXB

12.2(33)SRA

12.2(33)XNE

Cisco IOS XE Release 2.5

Modification

This command was introduced on the Supervisor

Engine 720.

This command was modified. Support was added for SSO mode and the default mode change.

This command was modified. Support was added for multicast and unicast traffic.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified. This command was implemented on the Cisco 10000 router.

This command was modified. This command was implemented on the Cisco ASR 1000 Series

Routers.

Usage Guidelines Cisco IOS Release 12.2S and 7600 Series Routers

SSO is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2.

On releases prior to Release 12.2(17d)SXB, single router mode (SRM) with SSO redundancy does not support stateful switchover for multicast traffic. When a switchover occurs, all multicast hardware switching entries are removed and are then re-created and reinstalled in the hardware by the newly active multilayer switch feature card (MSFC).

SRM/SSO is supported in the following releases only:

• Release 12.2(17b)SXA and subsequent rebuilds.

• Release 12.2(17d)SXB and subsequent rebuilds.

Nonstop forwarding (NSF) with SSO redundancy mode supports IPv4. NSF with SSO redundancy mode does not support IPv6, Internetwork Packet Exchange (IPX), and Multiprotocol Label Switching (MPLS).

If you have configured MPLS on the Cisco 7600 series routers with redundant supervisor engines, you must configure the Cisco 7600 series router in RPR mode. The switch should not be running in the default mode of SSO.

Enter the redundancy command in global configuration mode to enter redundancy configuration mode.

You can enter the mode command within redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

473

L through mode mode

Follow these guidelines when configuring your system for RPR+ mode:

• You must install compatible images on the active and standby supervisor engines to support RPR+ mode and SSO mode.

• Both supervisor engines must run the same Cisco IOS software version.

• Any modules that are not online at the time of a switchover are reset and reloaded on a switchover.

• The Forwarding Information Base (FIB) tables are cleared on a switchover. As a result, routed traffic is interrupted until route tables reconverge.

The standby supervisor engine reloads on any change of mode and begins to work in the current mode.

When you use this command to force the standby supervisor engine to run as a Distributed Forwarding

Card (DFC) card, the uplink ports in the standby engine continue to be in use and are not disabled.

Cisco IOS Release XE Release 2.5 and ASR 1000 Series Routers

For Cisco ASR 1002 and 1004 routers, RRP and stateful switchover can be used to switch between Cisco

IOS processes. RPR and SSO need to be configured by the user, however, because a second Cisco IOS process is not available by default on Cisco ASR 1002 and 1004 routers. Enter the redundancy command in global configuration mode to enter redundancy configuration mode. You can enter the mode command within redundancy configuration mode.

The Cisco ASR 1006 Router supports a second Route Processor. The second Cisco IOS process can run only on the standby Route Processor. This means that hardware redundancy is available and RPR and SSO do not need to be configured by the user because a second Cisco IOS process is available by default on the

Cisco ASR 1006 router.

RPR+ mode is not supported on the Cisco ASR 1000 Series Routers.

Cisco IOS Release 12.2XNE and 1000 Series Routers

Enter the redundancy command in global configuration mode to enter redundancy configuration mode.

You can enter the mode command within redundancy configuration mode.

RPR mode is not supported on the Cisco 10000 router.

Examples This example shows how to set the redundancy mode to RPR+:

Router(config)# redundancy

Router(config-red)# mode rpr-plus

This example shows how to set the redundancy mode to SSO:

Router(config)# redundancy

Router(config-red)# mode sso

Related Commands

Command redundancy

redundancy force-switchover route-converge-interval

Description

Enters redundancy configuration mode.

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

Configures the time interval after which the old FIB entries are purged.

474

Cisco IOS Configuration Fundamentals Command Reference

L through mode

Command

show redundancy

show running-config mode

Description

Displays RF information.

Displays the status and configuration of the module or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

475

mode

L through mode

476

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Cisco IOS Configuration Fundamentals Command Reference

477

monitor event-trace through Q monitor event-trace (EXEC)

monitor event-trace (EXEC)

To monitor and control the event trace function for a specified Cisco IOS software subsystem component, use the monitor event-trace command in privileged EXEC mode.

monitor event-trace component {clear | continuous | disable | dump [pretty] | enable | one-shot}

Cisco 10000 Series Routers

monitor event-trace component {disable | dump | enable | size | stacktrace}

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

monitor event-trace all-traces {continuous [cancel] | dump [merged] [pretty]}

monitor event-trace l3 {clear | continuous [cancel] | disable | dump [pretty] | enable | interface

type mod/port | one-shot}

monitor event-trace spa {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot}

monitor event-trace subsys {clear | continuous [cancel] | disable | dump [pretty] | enable | one-

shot}

Syntax Description component clear continuous disable dump pretty enable one-shot

Name of the Cisco IOS software subsystem component that is the subject of the event trace. To get a list of components that support event tracing, use the monitor event-trace ? command.

Clears existing trace messages for the specified component from memory on the networking device.

Continuously displays the latest event trace entries.

Turns off event tracing for the specified component.

Writes the event trace results to the file configured using the monitor event-trace command in global configuration mode. The trace messages are saved in binary format.

(Optional) Saves the event trace message in ASCII format.

Turns on event tracing for the specified component.

Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the

monitor event-tracecommand in global configuration mode.

478

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor event-trace (EXEC) size stacktrace all-traces merged l3 spa

interface type mod / port cancel subsys

Sets the number of messages that can be written to memory for a single instance of a trace.

Note Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the show

monitor event-trace componentparameters command.

When the number of event trace messages in memory exceeds the size, new messages will begin to overwrite the older messages in the file.

Enables the stack trace at tracepoints.

Displays the configured merged-event traces.

(Optional) Dumps the entries in all event traces sorted by time.

Displays information about the Layer 3 trace.

Displays information about the Shared Port Adapter

(SPA) trace.

Specifies the interface to be logged.

(Optional) Cancels the continuous display of latest trace entries.

Displays information about the subsystem’s initial trace.

Command Default The event trace function is disabled by default.

Command Modes Privileged EXEC (#)

Command History

Release

12.0(18)S

12.2(8)T

12.2(14)SX

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(8)T.

Support for this command was introduced on the

Supervisor Engine 720.

Cisco IOS Configuration Fundamentals Command Reference

479

monitor event-trace through Q monitor event-trace (EXEC)

Release

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(33)SXH

12.4(20)T

Modification

This command was integrated into Cisco IOS

Release 12.2(25)S. The monitor event-trace cef

ipv4 clearcommand replaces the clear ip cef

event-logcommand.

This command was integrated into Cisco IOS

Release 12.2(28)SB and implemented on the Cisco

10000 series routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.4(20)T.

Usage Guidelines Use the monitor event-trace command to control what, when, and how event trace data is collected. Use this command after you have configured the event trace functionality on the networking device using the

monitor event-trace command in global configuration mode.

Note The amount of data collected from the trace depends on the trace message size configured using the

monitor event-tracecommand in global configuration mode for each instance of a trace.

The Cisco IOS software allows for the subsystem components to define whether support for event tracing is enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the monitor

event-tracecommand in privileged EXEC mode or using the monitor event-tracecommand in global configuration mode. To disable event tracing, you would enter either of these commands with the disable keyword. To enable event tracing again, you would enter either of these commands with the enable keyword.

To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? commandto get a list of software components that support event tracing. To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to display trace messages.

Use the show monitor event-trace command to display trace messages. Use the monitor event-trace

component dump command to save trace message information for a single event. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace component dump pretty command.

To write the trace messages for all events currently enabled on a networking device to a file, enter the

monitor event-trace dumpcommand.

To configure the file where you want to save trace information, use the monitor event-trace command in global configuration mode. The trace messages are saved in a binary format.

480

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor event-trace (EXEC)

Examples The following example shows the privileged EXEC commands to stop event tracing, clear the current contents of memory, and reenable the trace function for the interprocess communication (IPC) component.

This example assumes that the tracing function is configured and enabled on the networking device.

Router# monitor event-trace ipc disable

Router# monitor event-trace ipc clear

Router# monitor event-trace ipc enable

The following example shows how the monitor event-trace one-shotcommand accomplishes the same function as the previous example except in one command. In this example, once the size of the trace message file has been exceeded, the trace is terminated.

Router# monitor event-trace ipc one-shot

The following example shows the command for writing trace messages for an event in binary format. In this example, the trace messages for the IPC component are written to a file.

Router# monitor event-trace ipc dump

The following example shows the command for writing trace messages for an event in ASCII format. In this example, the trace messages for the MBUS component are written to a file.

Router# monitor event-trace mbus dump pretty

Catalyst 6500 Series Switches and Cisco 7600 Series Routers Examples Only

This example shows how to stop event tracing, clear the current contents of memory, and reenable the trace function for the SPA component. This example assumes that the tracing function is configured and enabled on the networking device.

Router# monitor event-trace spa disable

Router# monitor event-trace spa clear

Router# monitor event-trace spa enable

Related Commands

Command

monitor event-trace (global)

monitor event-trace dump-traces

show monitor event-trace

Description

Configures event tracing for a specified Cisco IOS software subsystem component.

Saves trace messages for all event traces currently enabled on the networking device.

Displays event trace messages for Cisco IOS software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

481

monitor event-trace through Q monitor event-trace (global)

monitor event-trace (global)

To configure event tracing for a specified Cisco IOS software subsystem component, use the monitor

event-trace command in global configuration mode.

monitor event-trace component {disable | dump-file filename | enable | size number | stacktrace

number} timestamps [datetime [localtime] [msec] [show-timezone] | uptime]

Cisco 10000 Series Routers

monitor event-trace component {disable | dump-file filename | enable | clear | continuous | one-

shot}

Syntax Description component disable

dump-file filename enable

size number

stacktrace number

Name of the Cisco IOS software subsystem component that is the object of the event trace. To get a list of components that support event tracing, use the monitor event-trace ? command.

Turns off event tracing for the specified component.

Specifies the file where event trace messages are written from memory on the networking device.

The maximum length of the filename (path and filename) is 100 characters, and the path can point to flash memory on the networking device or to a

TFTP or FTP server.

Turns on event tracing for the specified component provided that the component has been configured using the monitor event-tracecommand.

Sets the number of messages that can be written to memory for a single instance of a trace. Valid values are from1 to 65536.

Note Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the show

monitor event-trace componentparameters command.

When the number of event trace messages in memory exceeds the configured size, new messages will begin to overwrite the older messages in the file.

Enables the stack trace at tracepoints and specifies the depth of the stack trace stored. Valid values are from 1 to 16.

482

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor event-trace (global) timestamps datetime localtime msec show-timezone uptime clear continuous one-shot

(Optional) Includes time stamp information with the event trace messages for the specified component.

(Optional) Specifies that the time stamp information included with event trace messages will consist of the date and time of the event trace.

(Optional) Specifies that the time given in the time stamp will be local time.

(Optional) Includes milliseconds in the time stamp.

(Optional) Includes time zone information in the time stamp.

(Optional) Displays time stamped information about the system uptime.

Clears existing trace messages for the specified component from memory on the networking device.

Continuously displays the latest event trace entries.

Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the

monitor event-tracecommand.

Command Default Event tracing is enabled or disabled depending on the software component.

Command Modes Global configuration (config)

Command History

Release

12.0(18)S

12.2(8)T

12.2(14)SX

12.2(25)S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(8)T.

This command was integrated into Cisco IOS

Release 12.2(14)SX and implemented on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(25)S.

Cisco IOS Configuration Fundamentals Command Reference

483

monitor event-trace through Q monitor event-trace (global)

Release

12.2(28)SB

12.2(33)SRA

12.4(20)T

Modification

This command was integrated into Cisco IOS

Release 12.2(28)SB and implemented on the Cisco

10000 series routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.4(20)T.

Usage Guidelines Use the monitor event-trace command to enable or disable event tracing and to configure event trace parameters for Cisco IOS software subsystem components.

Note Event tracing is intended for use as a software diagnostic tool and should be configured only under the direction of a Technical Assistance Center (TAC) representative. In Cisco IOS software images that do not provide subsystem support for the event trace function, the monitor event-trace command is not available.

The Cisco IOS software allows the subsystem components to define whether support for event tracing is enabled or disabled by default. The command interface for event tracing allows you to change the default two ways: using the monitor event-tracecommand in privileged EXEC mode or using the monitor event-

tracecommand in global configuration mode.

Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the monitor event-tracecomponentenable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a command entry in the configuration file.

Note The amount of data collected from the trace depends on the trace message size configured using the

monitor event-tracecommand for each instance of a trace.

To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? commandto get a list of software components that support event tracing.

To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-

trace command to display trace messages.

To specify the trace call stack at tracepoints, you must first clear the trace buffer.

Examples The following example shows how to enable event tracing for the interprocess communication (IPC) subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to ipc-dump in slot0 (flash memory).

configure terminal

monitor event-trace ipc enable monitor event-trace ipc dump-file slot0:ipc-dump monitor event-trace ipc size 4096

484

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor event-trace (global)

When you select Cisco Express Forwarding as the component for which to enable event tracing, you can use the following additional arguments and keywords: monitor event-trace cef [events | interface | ipv6 |

ipv4][all]. The following example shows how to enable event tracing for IPv4 or IPv6 events of the Cisco

Express Forwarding component in Cisco IOS software: configure terminal

monitor event-trace cef ipv4 enable configure terminal

monitor event-trace cef ipv6 enable exit

The following example shows what happens when you try to enable event tracing for a component (in this case, adjacency events) when it is already enabled: configure terminal

monitor event-trace adjacency enable

%EVENT_TRACE-6-ENABLE: Trace already enabled.

Related Commands

Command

monitor event-trace (EXEC)

monitor event-trace dump-traces

show monitor event-trace

Description

Controls the event trace function for a specified

Cisco IOS software subsystem component.

Saves trace messages for all event traces currently enabled on the networking device.

Displays event trace messages for Cisco IOS software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

485

monitor event-trace through Q monitor event-trace dump-traces

monitor event-trace dump-traces

To save trace messages for all event traces currently enabled on the networking device, use the monitor

event-trace dump-tracescommand in privileged EXEC mode.

monitor event-trace dump-traces [pretty]

Syntax Description pretty (Optional) Saves the event trace message in ASCII format.

Command Modes

Privileged EXEC

Command History

Release

12.0(18)S

12.2(8)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(8)T.

Usage Guidelines

Use the monitor event-trace dump-traces command to save trace message information for all event traces currently enabled on a networking device. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the

monitor event-trace dump-traces pretty command.

To write the trace messages for an individual trace event to a file, enter the monitor event-trace (EXEC) command.

To configure the file where you want to save messages, use the monitor event-trace (global) command.

Examples The following example shows how to save the trace messages in binary format for all event traces enabled on the networking device.

monitor event-trace dump-traces

The following example shows how to save the trace messages in ASCII format for all event traces enabled on the networking device.

monitor event-trace dump-traces pretty

486

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Related Commands

Command

monitor event-trace (EXEC)

monitor event-trace (global)

show monitor event-trace monitor event-trace dump-traces

Description

Controls event trace function for a specified Cisco

IOS software subsystem component.

Configures event tracing for a specified Cisco IOS software subsystem component.

Displays event trace messages for Cisco IOS software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

487

monitor event-trace through Q monitor pcm-tracer capture-destination

monitor pcm-tracer capture-destination

To configure a location to save the Pulse Code Modulation (PCM) trace information, use the monitor pcm-

tracer capture-destination command in global configuration mode. To disable the configuration, use the

no form of this command.

monitor pcm-tracer capture-destination destination

no monitor pcm-tracer capture-destination

Syntax Description destination Destination to save the PCM trace information.

You can specify any of the following values:

• archive: --Saves trace to archive.

• flash: --Saves trace to flash memory.

• ftp: --Saves trace to an FTP network server.

• http: --Saves trace to an HTTP server.

• https: --Saves trace to a secure HTTP

(HTTPS) server.

• null: --Saves trace to file system.

• nvram: --Saves trace to the NVRAM of the router.

• pram: --Saves trace to the permanent RAM

(PRAM) of the router.

• rcp: --Saves trace to a remote copy protocol

(RCP) network server.

• scp: --Saves trace to a network server that supports Secure Shell (SSH).

• syslog: --Saves trace to the system log.

• system: --Saves trace to the system memory.

• tftp: --Saves trace to a TFTP network server.

• tmpsys: --Saves trace to a temporary system location.

Command Default The PCM trace information is saved to the NVRAM.

Command Modes Global configuration (config)

488

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command History

Release

15.0(1)M monitor pcm-tracer capture-destination

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Usage Guidelines

You can use the monitor pcm-tracer capture-destination command to specify a location to save the PCM trace information. When Cisco IOS software saves the data to network file systems, such as TFTP and FTP, it assumes the location is valid and has write access.

After the PCM capture is complete, the router automatically copies the captured contents to the specified location. The filename format at the destination location is as follows:

<Configured name>_tx_<DS0 slot>_<DS0 unit>_<DS0 channel>--For TX

<Configured name>_rx_<DS0 slot>_<DS0 unit>_<DS0 channel>--For RX

You can identify the dial feature card (DFC) channel from where the PCM is traced using the filename format.

Consider the following example:

Router(config)# monitor pcm-tracer capture-destination tftp: ://223.255.254.254/ benzeer/cap/cap_data

In this example, two files are created for the data corresponding to each DS0s, one for each direction

(transmitter and receiver). When the debug pcmtracer command is enabled, the trace data is copied into the following files:

• cap_data_tx_6_1_22 and cap_data_rx_6_1_22--This corresponds to the traffic flowing through DS0

6/1:22.

• cap_data_tx_6_1_22 and cap_data_rx_6_1_22--cap_data_tx_6_1_22 is the data in the transmit direction (from the DFC to the system backplane) and cap_data_rx_6_1_22 is the data in the receiver direction (to the DFC from the system backplane).

Examples The following example shows how to configure a router to save the PCM trace information to a flash drive:

Router# configure terminal

Router(config)# monitor pcm-tracer capture-destination flash:

Related Commands

Command

debug pcmtracer

monitor pcm-tracer

Description

Enables debugging for PCM tracing.

Monitors and controls the PCM trace function.

Cisco IOS Configuration Fundamentals Command Reference

489

monitor event-trace through Q monitor pcm-tracer delayed-start

monitor pcm-tracer delayed-start

To configure the delay time to start the Pulse Code Modulation (PCM) trace capture, use the monitor pcm-

tracer delayed-start command in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer delayed-start seconds

no monitor pcm-tracer delayed-start

Syntax Description seconds Delay, in seconds. The range is from 1 to 2147483.

Command Default The default delay time is zero.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Examples The following example shows how to configure the PCM tracer delay time to 1000 seconds:

Router# configure terminal

Router(config)# monitor pcm-tracer delayed-start 1000

Related Commands

Command

monitor pcm-tracer

Description

Configures the PCM tracer information.

490

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor pcm-tracer profile

monitor pcm-tracer profile

To create Pulse Code Modulation (PCM) capture profiles, use the monitor pcm-tracer profile command in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer profile profile-number

no monitor pcm-tracer profile profile-number

Syntax Description profile-number Profile number. The range is from 1 to 10.

Command Default PCM capture profiles are disabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Usage Guidelines You must create at least one user profile under the channels that need to be traced. You can create the following profile operations:

• Create a user profile identified by a profile number.

• Add one or more profiles. A user profile consists of capture groups in which the channels that are to be traced are specified.

• Configure one or more capture groups under a profile.

Examples The following example shows how to create a PCM capture profile with profile number 1:

Router# configure terminal

Router(config)# monitor pcm-tracer profile 1

Related Commands

Command

monitor pcm-tracer

Description

Configures the PCM tracer information.

Cisco IOS Configuration Fundamentals Command Reference

491

monitor event-trace through Q monitor permit-list

monitor permit-list

To configure a destination port permit list or add to an existing destination port permit list, use the monitor

permit-list command in global configuration mode. To delete from or clear an existing destination port permit list, use the no form of this command.

Activate monitoring

monitor permit-list

no monitor permit-list

Activate monitoring on one port

monitor permit-list destination interface interface-type slot /port

no monitor permit-list destination interface interface-type slot /port

Activate monitoring on one range of ports

monitor permit-list destination interface interface-type slot /port-last-port

no monitor permit-list destination interface interface-type slot / port-last-port

Activate monitoring on two or more ranges of ports

monitor permit-list destination interface interface-type slot /port-last-port , [port-last-port]

no monitor permit-list destination interface interface-type slot /port-last-port , [port-last-port]

Syntax Description destination

interface interface-type slot port

, last-port

Specifies a destination port.

Specifies the interface type; valid values are

ethernet, fastethernet, gigabitethernet, or tengigabitethernet

The slot that the interface module is installed in.

Specifies a single port on an interface module, or the first port on an interface module used in a range of ports.

(Optional) Specifies the port on an interface module used as the last port in a range of ports.

(Optional) Separates each instance of a port, or range of ports, that are monitored. See the Usage

Guidelines and the Examples for more information.

Command Default Disabled

492

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command Modes Global configuration

Command History

Release

12.2(18)SXE

12.2(33)SRA monitor permit-list

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To prevent accidental configuration of ports as destinations, you can create a permit list of the ports that are valid for use as destinations. With a destination port permit list configured, you can only configure the ports in the permit list as destinations.

When you enter multiple instances of interface interface-type slot/port-fastport, you must enter a space before and after the comma. For example, interface interface-type slot/port-fastport , interface-type slot/

port-fastport , interface-type slot/port-fastport.

Examples This example shows how to configure a destination port permit list that includes Gigabit Ethernet ports 5/1 through 5/4, and activate monitoring:

Router# configure terminal

Router(config)# monitor permit-list destination interface gigabitethernet 5/1-4

Router(config)# monitor permit-list

This example shows how to configure a destination port permit list that includes Fast Ethernet ports 1/1-48,

2/1-48, and Gigabit Ethernet ports 3/1 through 3/4, and activate monitoring:

Router# configure terminal

Router(config)# monitor permit-list destination interface fastEthernet 1/1-48 , fastEthernet 2/1-48 , gigabitEthernet 3/1-4

Router(config)# monitor permit-list

Related Commands

Command

show monitor permit-list

Description

Displays the permit-list state and interfaces configured.

Cisco IOS Configuration Fundamentals Command Reference

493

monitor event-trace through Q monitor session egress replication-mode

monitor session egress replication-mode

To switch the egress-span mode from the default mode (either centralized or distributed depending on your

Cisco IOS software release), use the monitor session egress replication-modecommand in global configuration mode. To return to the default mode, use the no form of the command.

Cisco IOS Release 12.2(33)SXH2a and Later Releases

monitor session egress replication-mode centralized

no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2

monitor session egress replication-mode distributed

no monitor session egress replication-mode distributed

Syntax Description centralized distributed

In Cisco IOS Release 12.2(33)SXH2a and later

releases: Specifies centralized egress span monitoring as the default mode.

In Cisco IOS Release 12.2(33)SXH, SXH1, and

SXH2: Specifies distributed egress span monitoring as the default mode.

Command Default Cisco IOS Releases 12.2(33)SXH2a and later releases: Centralized mode

Cisco IOS Releases 12.2(33)SXH, SXH1, and SXH2: Distributed mode

Command Modes Global configuration (config)

Command History

Release

12.2(33)SXH

12.2(33)SXH2a

Modification

This command was introduced.

The command was changed as follows:

• The default mode was changed from distributed mode to centralized mode.

• The centralized keyword was removed and the distributed keyword was added.

494

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor session egress replication-mode

Usage Guidelines

Note Prior to Cisco IOS Release 12.2(33)SXH and the introduction of this feature, the operating mode was centralized and could not be changed.

Centralized egress span monitoring redirects traffic to the supervisor engine for egress monitoring.

Distributed egress span monitoring is performed in the ingress module. Distributed replication for Switched

Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN) increases the total throughput at the span destination.

Note Distributed egress span (DES) mode is applied to ASIC-based sessions only.

Examples

Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2

The following example shows how to switch the egress-span mode from the distributed default to centralized mode:

Router(config)# monitor session egress replication-mode centralized

The following example shows how to switch the egress-span mode from centralized back to distributed mode:

Router(config)# no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH2a and Later Releases

The following example shows how to switch the egress-span mode from the centralized default to distributed mode:

Router(config)# monitor session egress replication-mode distributed

The following example shows how to switch the egress-span mode from distributed back to centralized mode:

Router(config)# no monitor session egress replication-mode distributed

Related Commands

Command

show monitor session

Description

Displays the operational mode and configured mode of the session and module session capabilities.

Cisco IOS Configuration Fundamentals Command Reference

495

monitor event-trace through Q monitor session type

monitor session type

To configure a local Switched Port Analyzer (SPAN), RSPAN, or ERSPAN, use the monitor session

typecommand in global configuration mode. To remove one or more source or destination interfaces from the SPAN session, use the no form of this command.

monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx |

rspan-destination | rspan-source}

no monitor session span-session-number type {erspan-destination | erspan-source | local | local-

tx | rspan-destination | rspan-source}

Syntax Description span-session-number erspan-destination erspan-source local local-tx rspan-destination rspan-source

Number of the local SPAN or ERSPAN session; valid values are from 1 to 66.

Specifies the ERSPAN destination-session configuration mode.

Specifies the ERSPAN source-session configuration mode.

Specifies the local SPAN session configuration mode.

Specifies the local egress-only SPAN session configuration mode.

Specifies the RSPAN destination-session configuration mode.

Specifies the RSPAN source-session configuration mode.

Command Default This command has no default settings.

Command Modes Global configuration (config)

Command History

Release

12.2(18)SXE

Modification

Support for this command was introduced on the

Supervisor Engine 720.

496

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Release

12.2(18)SXF

12.2(33)SXH monitor session type

Modification

This command was changed as follows:

• Support for this command was introduced on the Supervisor Engine 32.

• ERSPAN is supported in any switch fabric module functionality switching mode.

This command was changed to include the following keywords:

• local

• local-tx

• rspan-destination

• rspan-source

Usage Guidelines Release 12.2(18)SXE and later releases support ERSPAN with the Supervisor Engine 720, hardware revision 3.2 or higher. Enter the show module version | include WS-SUP720-BASE command to display the hardware revision.

ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination session.

This command is not supported on Catalyst 6500 series switches that are configured with a Supervisor

Engine 2.

All ERSPAN source sessions on a switch must use the same source IP address. You enter the origin ip

address command to configure the IP address for the ERSPAN source sessions.

All ERSPAN destination sessions on a switch must use the same IP address. You enter the ip address command to configure the IP address for the ERSPAN destination sessions. If the ERSPAN destination IP address is not a Supervisor Engine 720 (for example, it is a network sniffer), the traffic arrives with the

GRE and RSPAN headers/encapsulation intact.

The ERSPAN source session destination IP address, which must be configured on an interface on the destination switch, is the source of traffic that an ERSPAN destination session sends to the destination ports. You configure the same address in both the source and destination sessions with the ip address command.

The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from different ERSPAN source sessions.

The local ERSPAN session limits are as follows:

• Total sessions--66

• Source sessions--2 (ingress or egress or both)

• Destination sessions--23

The monitor session type command creates a new ERSPAN session or allows you to enter the ERSPAN session configuration mode. ERSPAN uses separate source and destination sessions. You configure the source and destination sessions on different switches. The ERSPAN session configuration mode prompts are as follows:

• Router(config-mon-erspan-src)--Indicates the ERSPAN source session configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

497

monitor event-trace through Q monitor session type

Table 29

• Router(config-mon-erspan-src-dst)--Indicates the ERSPAN source session destination configuration mode.

• Router(config-mon-erspan-dst)--Indicates the ERSPAN destination session configuration mode.

• Router(config-mon-erspan-dst-src)--Indicates the ERSPAN destination session source configuration mode

The table below lists the ERSPAN destination session configuration mode syntaxes.

ERSPAN Destination Session Configuration Mode Syntaxes

Syntax

Global Configuration Mode

Description

monitor session erspan-destination-session-number | rspan-

destination-session-number type erspan-destination | erspan- destination

Enters ERSPAN or RSPAN destination session configuration mode and changes the prompt to the following:

Router(config-mon-erspan-dst)#

Router(config-mon-rspan-dst)#

Destination Session Configuration Mode

description session-description shutdown

no shutdown

destination {single-interface | interface-list | interface-range |

mixed-interface-list } source

(Optional) Describes the ERSPAN or RSPAN destination session.

(Optional) (Default) Inactivates the ERSPAN destination session.

Activates the ERSPAN destination session.

Associates the ERSPAN destination session number with the destination ports.

Enters ERSPAN destination session source configuration mode and changes the prompt to the following:

Router(config-mon-erspan-dst-src)#

Destination Session Source Configuration Mode

ip address ip-address [force]

erspan-id erspan-flow-id

vrf vrf-name

Configures the ERSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN destination session configuration.

Configures the ID number used by the destination and destination sessions to identify the ERSPAN traffic.

(Optional) Configures the VRF name of the packets in the

ERSPAN traffic.

The table below lists the ERSPAN source session configuration mode syntaxes.

498

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor session type

Table 30

Syntax

ERSPAN or RSPAN Source Session Configuration Mode Syntaxes

Description

Global Configuration Mode

monitor session erspan-source-session-number type erspan-

source | rspan-source

Enters ERSPAN or RSPAN source session configuration mode and changes the prompt as appropriate to the following:

Router(config-mon-erspan-src)#

Router(config-mon-rspan-src)#

Source Session Configuration Mode

description session-description shutdown

(Optional) Describes the ERSPAN or RSPAN source session.

(Optional) (Default) Inactivates the ERSPAN or RSPAN source session.

no shutdown Activates the ERSPAN or RSPAN source session.

source {{single-interface | interface-list | interface-range |

mixed-interface-list | single-vlan | vlan-list | vlan-range | mixed-

vlan-list } [rx | tx | both]}

Associates the ERSPAN or RSPAN source session number with the source ports or VLANs, and selects the traffic direction to be monitored.

filter { single-vlan | vlan-list | vlan-range | mixed-vlan-list }

description session-description

Source Session Destination Configuration Mode

(Optional) Configures source VLAN filtering when the

ERSPAN or RSPAN source is a trunk port.

(Optional) Describes the ERSPAN or RSPAN source session.

ip address ip-address

erspan-id erspan-flow-id

origin ip address ip-address

ip {{ttlttl-value } | {precipp-value } | {dscpdscp-value }}

Configures the ERSPAN or RSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN or RSPAN destination session configuration.

Configures the ID number used by the source and destination sessions to identify the ERSPAN or RSPAN traffic.

Configures the IP address used as the source of the ERSPAN or

RSPAN traffic.

(Optional) Configures the following packet values in the

ERSPAN or RSPAN traffic:

• ttl ttl -value --IP time-to-live (TTL) value

• prec ipp-value-- IP-precedence value

• dscp dscp-value-- IP-precedence value

vrf vrf-name (Optional) Configures the VRF name of the packets in the

ERSPAN or RSPAN traffic.

When you configure the monitor sessions, follow these syntax guidelines:

• erspan-destination-span-session-number can range from 1 to 66.

Cisco IOS Configuration Fundamentals Command Reference

499

monitor event-trace through Q monitor session type

• single-interface is interfacetype slot /port ; type is fastethernet, gigabitethernet, or

tengigabitethernet.

• interface-list is single-interface , single-interface , single-interface ...

Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash.

• interface-range is interfacetype slot /first-port - last-port .

• mixed-interface-list is, in any order, single-interface , interface-range , ...

• erspan-flow-id can range from 1 to 1023.

When you clear the monitor sessions, follow these syntax guidelines:

• The no monitor sessionsession-number command entered with no other parameters clears the session

session-number .

• session-range is first-session-number -last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.

Use the monitor session type local command to configure ingress, egress, or both ingress and egress

SPAN sessions.

Use the monitor session type local-tx command to configure egress-only SPAN sessions.

When you enter the local or the local egress-only SPAN session configuration mode, the prompt changes accordingly to Router(config-mon-local)# or Router(config-mon-local-tx)#, and the following commands are available:

• description -- Describes the properties for this session using this syntax:

description description

The descriptioncan be up to 240 characters and cannot contain special characters or spaces.

• destination -- Specifies the destination and the destination properties using this syntax:

destination analysis-module num anomaly-detector-module num interface type number intrusion-

detection-module num

analysis-module num Specifies the SPAN destination analysis-module.

anomaly-detector-module num

interface type number

Specifies the SPAN destination anomaly-detectormodule.

Specifies the interface type and number as follows:

• GigabitEthernet mod /port

• port-channel num --Ethernet Channel of interfaces; valid values are from 1 to 496.

ingress (Optional) Configures destinations to receive traffic from attached devices.

500

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q monitor session type learning

intrusion-detection-module num

(Optional) Enables MAC address learning from the destinations, which allows the switch to transmit traffic that is addressed to devices attached to the destinations.

Specifies the SPAN destination intrusion-detectionmodule.

• exit -- Exits from configuration session mode.

• filter vlan vlan-id -- Limits the SPAN source traffic to specific VLANs; valid values are from 1 to

4096.

• no -- Negates a command or sets its defaults.

• shutdown -- Shuts down this session

• source -- Specifies the SPAN source interface or VLAN using the following syntax: cpu rp cpu sp

interface type number

Associates the local SPAN session number with the

CPU on the route processor.

Associates the local SPAN session number with the

CPU on the switch processor.

Specifies the interface type and number as follows:

• FastEthernet mod /port

• GigabitEthernet mod /port

• Port-channel num --Ethernet Channel of interfaces; valid values are from 1 to 496.

, vlan vlan-id Specifies the VLAN; valid values are from 1 to

4094.

(Optional) Specifies another range of interfaces.

(Optional) Specifies a range of interfaces.

both (Optional) Monitors the received and the transmitted traffic.

(Optional) Monitors the received traffic only.

tx When you enter the local-tx keyword, the rx and both keywords are not available and the tx keyword is required.

(Optional) Monitors the transmitted traffic only.

The local SPAN session limits are as follows:

• Total sessions--80

• Source sessions--2 (ingress or egress or both)

• Egress only--14

If you enter the filter keyword on a monitored trunk interface, only traffic on the set of specified VLANs is monitored.

Cisco IOS Configuration Fundamentals Command Reference

501

monitor event-trace through Q monitor session type

Only one destination per SPAN session is supported. If you attempt to add another destination interface to a session that already has a destination interface configured, you get an error. You must first remove a SPAN destination interface before changing the SPAN destination to a different interface.

You can configure up to 64 SPAN destination interfaces, but you can have one egress SPAN source interface and up to 128 ingress source interfaces only.

A SPAN session can either monitor VLANs or monitor individual interfaces, but it cannot monitor both specific interfaces and specific VLANs. Configuring a SPAN session with a source interface and then trying to add a source VLAN to the same SPAN session causes an error. Configuring a SPAN session with a source VLAN and then trying to add a source interface to that session also causes an error. You must first clear any sources for a SPAN session before switching to another type of source.

Port channel interfaces display in the list of interface options if you have them configured. VLAN interfaces are not supported. However, you can span a particular VLAN by entering the monitor session

session source vlan vlan-id command.

When you configure the destination, use these guidelines:

• A single-interface is as follows:

◦ interface type slot/port; type is fastethernet, gigabitethernet, or tengigabitethernet.

◦ interface port-channel number

Note Destination port channel interfaces must be configured with the channel-group group-num mode on command and the no channel-protocol command.

• An interface-list is single-interface, single-interface , single-interface ...

Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash.

• An interface-range is interface type slot / first-port - last-port.

• A mixed-interface-list is, in any order, single-interface , interface-range , ...

• A single-vlan is the ID number of a single VLAN.

• A single-list is single-vlan , single-vlan , single-vlan ...

• A vlan-range is first-vlan-ID - last-vlan-ID.

• A mixed-vlan-list is, in any order, single-vlan , vlan-range , ...

When you clear the monitor sessions, follow these syntax guidelines:

• The no monitor sessionsession-number command entered with no other parameters clears the session

session-number .

• session-range is first-session-number -last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.

502

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Examples monitor session type

This example shows how to configure an ERSPAN source session number and enter the ERSPAN source session configuration mode for the session:

Router(config)# monitor session 55 type erspan-source

Router(config-mon-erspan-src)#

This example shows how to configure an ERSPAN destination session number and enter the ERSPAN destination session configuration mode for the session:

Router(config)# monitor session 55 type erspan-destination

Router(config-mon-erspan-dst)#

This example shows how to associate the ERSPAN destination session number with the destination ports:

Router(config-mon-erspan-dst) destination interface fastethernet 1/2 , 2/3

This example shows how to enter the ERSPAN destination session source configuration:

Router(config-mon-erspan-dst)# source

Router(config-mon-erspan-dst-src)#

This example shows how to enter the ERSPAN destination session source configuration mode:

Router(config-mon-erspan-dst)# source

Router(config-mon-erspan-dst-src)#

This example shows how to configure multiple sources for a session:

Router(config-mon-erspan-src)# source interface fastethernet 5/15 , 7/3 rx

Router(config-mon-erspan-src)# source interface gigabitethernet 1/2 tx

Router(config-mon-erspan-src)# source interface port-channel 102

Router(config-mon-erspan-src)# source filter vlan 2 - 3

Router(config-mon-erspan-src)#

This example shows how to enter the ERSPAN source session destination configuration mode:

Router(config-mon-erspan-src)# destination

Router(config-mon-erspan-src-dst)#

This example shows how to configure the ID number that is used by the source and destination sessions to identify the ERSPAN traffic:

Router(config-mon-erspan-src-dst)# erspan-id 1005

Router(config-mon-erspan-src-dst)#

This example shows how to configure session 1 to monitor ingress traffic from Gigabit Ethernet port 1/1 and configure Gigabit Ethernet port 1/2 as the destination:

Router(config)# monitor session 1 type local

Router(config-mon-local)# source interface gigabitethernet 1/1 rx

Router(config-mon-local)# destination interface gigabitethernet 1/2

This example shows how to configure session 1 to monitor egress-only traffic from Gigabit Ethernet port

5/1 and configure Gigabit Ethernet port 5/2 as the destination:

Router(config)# monitor session 1 type local-tx

Router(config-mon-local)# source interface gigabitethernet 5/1 rx

Router(config-mon-local)# destination interface gigabitethernet 5/2

This example shows how to remove an interface from a session:

Router(config)# no monitor session 1 type local-tx

Cisco IOS Configuration Fundamentals Command Reference

503

monitor session type

Related Commands

Command

monitor session type

show monitor session monitor event-trace through Q

Description

Creates an ERSPAN source session number or enters the ERSPAN session configuration mode for the session.

Displays information about the ERSPAN, SPAN, and RSPAN sessions.

504

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q mop device-code

mop device-code

To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification

(sysid) messages and request program messages, use the mop device-code command in global configuration mode. To set the identity to the default value, use the no form of this command.

mop device-code commandmop device-code {cisco | ds200}

no mop device-code {cisco | ds200}

Syntax Description cisco ds200

Denotes a Cisco device code. This is the default.

Denotes a DECserver 200 device code.

Command Default Cisco device code

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The sysid messages and request program messages use the identity information indicated by this command.

Examples The following example identifies a DECserver 200 device as sending MOP sysid and request program messages: mop device-code ds200

Related Commands

Command

mop sysid

Description

Enables an interface to send out periodic MOP system identification messages.

Cisco IOS Configuration Fundamentals Command Reference

505

mop device-code monitor event-trace through Q

506

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q mop retransmit-timer

mop retransmit-timer

To configure the length of time that the Cisco IOS software waits before resending boot requests to a

Maintenance Operation Protocol (MOP) server, use the mop retransmit-timer command in global configuration mode. To reinstate the default value, use the no form of this command.

mop retransmit-timer seconds

no mop retransmit-timer

Syntax Description seconds Sets the length of time (in seconds) that the software waits before resending a message. The value is a number from 1 to 20.

Command Default 4 seconds

Command Modes

Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines By default, when the software sends a request that requires a response from a MOP boot server and the server does not respond, the message is re-sent after 4 seconds. If the MOP boot server and router are separated by a slow serial link, it might take longer than 4 seconds for the software to receive a response to its message. Therefore, you might want to configure the software to wait longer than 4 seconds before resending the message if you are using such a link.

Examples In the following example, if the MOP boot server does not respond within 10 seconds after the router sends a message, the server will resend the message: mop retransmit-timer 10

Cisco IOS Configuration Fundamentals Command Reference

507

mop retransmit-timer

Related Commands

Command

mop device-code

mop enabled monitor event-trace through Q

Description

Identifies the type of device sending MOP sysid messages and requests program messages.

Enables an interface to support the MOP.

508

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q mop retries

mop retries

To configure the number of times the Cisco IOS software will resend boot requests to a Maintenance

Operation Protocol (MOP) server, use the mop retries command in global configuration mode. To reinstate the default value, use the no form of this command.

mop retries count

no mop retries

Syntax Description count Indicates the number of times the software will resend a MOP boot request. The value is a number from 3 to 24. The default is 8.

Command Default 8 times

Command Modes

Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the software will attempt to resend a message to an unresponsive host 11 times before declaring a failure:

Router(config)# mop retries 11

Related Commands

Command

mop device-code

mop enabled

Description

Identifies the type of device sending MOP sysid messages and requests program messages.

Enables an interface to support the MOP server.

Cisco IOS Configuration Fundamentals Command Reference

509

mop retries

Command

mop retransmit-timer monitor event-trace through Q

Description

Configures the length of time that the Cisco IOS software waits before resending boot requests to a

MOP server.

510

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q more

To display the contents of a file, use the morecommand in privileged EXEC mode.

more [/ascii | /binary | /ebcdic] url

Syntax Description

/ascii

/binary

/ebcdic url

(Optional) Displays a binary file in ASCII format.

(Optional) Displays a file in hex/text format.

(Optional) Displays a binary file in EBCDIC format.

The URL of the file to display. A URL in the CLI consists of a file-system prefix (such as system: or

nvram:), an optional path (such as a folder name), and the name of a file.

Command Default The command displays the conent of a file in its native format. Optional formats include ascii, binary, and ebcdic.

Command Modes Privileged EXEC (>)

Command History

Release

11.3 AA

12.2(33)SRA

Cisco IOS XE Release 2.5

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on Cisco ASR

1000 series routers.

Usage Guidelines

The more system:running-config command displays the same output as the show running-config command. The more nvram:startup-config command is recommended as a replacement for the show

startup-config command and the show configuration command.

You can use this command to display configuration files, as follows:

• The more nvram:startup-config command displays the startup configuration file contained in

NVRAM or specified by the CONFIG_FILE environment variable. The Cisco IOS software informs

Cisco IOS Configuration Fundamentals Command Reference

511

monitor event-trace through Q more

Examples you whether the displayed configuration is a complete configuration or a distilled version. A distilled configuration is one that does not contain access lists.

• The more system:running-config command displays the running configuration.

These commands show the version number of the software used when you last changed the configuration file.

You can also display the contents of files on remote systems using the more command. For example, you could display a saved running configuration file on an FTP server using more ftp://

username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the

copy command for more information on file-system prefixes available in the Cisco IOS CLI.

Options for filtering and redirecting the output of this command are available by appending a pipe character

(|). See the Related Commands table for a list of more <url> command extensions.

The following partial sample output displays the configuration file named startup-config in NVRAM:

Router# more nvram:startup-config

! No configuration change since last restart

! NVRAM config last updated at 02:03:26 PDT Thu Oct 2 1997

version 12.1

service timestamps debug uptime service timestamps log uptime service password-encryption service udp-small-servers service tcp-small-servers

end

The following is partial sample output from the more nvram:startup-config command when the configuration file has been compressed:

Router# more nvram:startup-config

Using 21542 out of 65536 bytes, uncompressed size = 142085 bytes

version 12.1 service compress-config

hostname rose

The following partial sample output displays the running configuration:

Router2# more system:running-config

Building configuration...

Current configuration:

version 12.1

no service udp-small-servers no service tcp-small-servers

hostname Router2

512

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

end

Related Commands

Command

boot config

more <url> begin

more <url> exclude

more <url> include

service compress-config

show bootvar more

Description

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Begins the output of any morecommand from a matched string.

Filters the output of any more command to exclude a matched string.

Filters the output of any more command to display only the lines that match the specified string.

Compresses startup configuration files.

Cisco IOS Configuration Fundamentals Command Reference

513

monitor event-trace through Q more url begin

more url begin

To search the output of any morecommand, use the more url | begin command in EXEC mode. This command begins unfiltered output of the more command with the first line that contains the regular expression you specify.

{more url | begin regular-expression}

Syntax Description url

| regular-expression

The Universal Resource Locator (RLl) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in more command output.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression.

Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression.

Command Modes User EXEC

Privileged EXEC

Command History

Release

11.3 AA

12.0(1)T

12.2(33)SRA

Modification

The more command was introduced.

This extension of the more command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

514

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q more url begin

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at every --More-- prompt.

To search the remaining output of the more command, use the following command at the --More-- prompt:

/ regular-expression

To filter the remaining output of the more command, use one of the following commands at the --More-prompt:

- regular-expression

+ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Note Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples The following is partial sample output of the more nvram:startup-config | begincommand that begins unfiltered output with the first line that contain the regular expression “ip.” At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression “ip.” router# more nvram:startup-config | begin ip ip subnet-zero ip domain-name cisco.com

ip name-server 198.92.30.32

ip name-server 171.69.2.132

isdn switch-type primary-5ess

interface Ethernet1

ip address 5.5.5.99 255.255.255.0

--More--

-ip filtering...

media-type 10BaseT

interface Serial0:23

encapsulation frame-relay

no keepalive

dialer string 4001

dialer-group 1

isdn switch-type primary-5ess

no fair-queue

Related Commands

Command

more <url> exclude

Description

Filters more command output so that it excludes lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

515

more url begin

Command

more <url> include

show <command> begin

show <command> exclude

show <command> include monitor event-trace through Q

Description

Filters more command output so that it displays only lines that contain a particular regular expression.

Searches the output of any show command and displays the output from the first instance of a specified string.

Filters show command output so that it excludes lines that contain a particular regular expression.

Filters show command output so that it displays only lines that contain a particular regular expression.

516

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q more url exclude

more url exclude

To filter morecommand output so that it excludes lines that contain a particular regular expression, use the

more exclude command in EXEC mode.

{more url | exclude regular-expression}

Syntax Description url

| regular-expression

The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.

The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename

Prefixes can be local file systems or file locations, such as nvram: or system:. Alternatively, you can specify network locations using the following syntax:

ftp: [[//[username [:password ]@]location ]/

directory ]/filename

tftp: [[//location ]/directory ]/filename

rcp: [[//[username @]location ]/directory ]/ filename

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in more command output.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Command Modes EXEC

Command History

Release

11.3 AA

Modification

The more command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

517

monitor event-trace through Q more url exclude

Release

12.0(1)T

12.2(33)SRA

Modification

This extension of the more command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt:

/ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples The following is partial sample output of the more nvram:startup-config | excludecommand. The use of |

exclude service in the command specifies a filter that excludes lines that contain the regular expression

“service.” At the --More-- prompt, the user searches for the regular expression “Dialer1,” which continues filtered output with the first line that contains “Dialer1.” router# more nvram:startup-config | exclude service

version 12.0

hostname router

boot system flash no logging buffered

ip subnet-zero ip domain-name cisco.com

--More--

/Dialer1 filtering...

interface Dialer1

no ip address

no ip directed-broadcast

dialer in-band

no cdp enable

Related Commands

Command

more <url> begin

Description

Begins unfiltered output of the more command with the first line that contains the regular expression you specify.

518

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command

more <url> include

show <command> begin

show <command> exclude

show <command> include more url exclude

Description

Filters more command output so that it displays only lines that contain a particular regular expression.

Searches the output of any show command and displays the output from the first instance of a specified string.

Filters show command output so that it excludes lines that contain a particular regular expression.

Filters show command output so that it displays only lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

519

monitor event-trace through Q more url include

more url include

To filter morecommand output so that it displays only lines that contain a particular regular expression, use the more include command in EXEC mode.

{more url | include regular-expression}

Syntax Description url

| regular-expression

The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in more command output.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Command Modes EXEC

Command History

Release

11.3 AA

12.0(1)T

12.2(33)SRA

Modification

The more command was introduced.

This extension of the more command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt:

/ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

520

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q more url include

Examples The following is partial sample output of the more nvram:startup-config | includecommand. It only displays lines that contain the regular expression “ip.” router# more nvram:startup-config | include ip ip subnet-zero ip domain-name cisco.com

ip name-server 198.92.30.32

ip name-server 171.69.2.132

description ip address 172.21.53.199 255.255.255.0

ip address 172.21.53.199 255.255.255.0

Related Commands

Command

more <url> begin

more <url> exclude

show <command> begin

show <command> exclude

show <command> include

Description

Begins unfiltered output of the more command with the first line that contains the regular expression you specify.

Filters more command output so that it excludes lines that contain a particular regular expression.

Searches the output of any show command and displays the output from the first instance of a specified string.

Filters show command output so that it excludes lines that contain a particular regular expression.

Filters show command output so that it displays only lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

521

monitor event-trace through Q more flh:logfile

more flh:logfile

To view the system console output generated during the Flash load helper operation, use the more

flh:logfile privileged EXEC command.

more flh:logfile

Syntax Description This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

11.3 AA

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you are a remote Telnet user performing the Flash upgrade without a console connection, this command allows you to retrieve console output when your Telnet connection has terminated due to the switch to the

ROM image. The output indicates what happened during the download, and is particularly useful if the download fails.

This command is a form of the more command. See the more command for more information.

Examples

The following is sample output from the more flh:logfilecommand:

Router# more flh:logfile

%FLH: abc/igs-kf.914 from 172.16.1.111 to flash...

System flash directory:

File

Length Name/status

1 2251320 abc/igs-kf.914

[2251384 bytes used, 1942920 available, 4194304 total]

Accessing file 'abc/igs-kf.914' on 172.16.1.111...

Loading from 172.16.13.111:

Erasing device...... erased

Loading from 172.16.13.111:

- [OK -

2251320/4194304 bytes]

Verifying checksum... OK (0x97FA)

Flash copy took 79292 msecs

%FLH: Re-booting system after download

522

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK]

F3: 2183364+67924+259584 at 0x3000060

Restricted Rights Legend

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph

Rights clause at FAR sec. 52.227-19 and subparagraph

Software clause at DFARS sec. 252.227-7013.

cisco Systems, Inc.

170 West Tasman Drive

San Jose, California 95134

Cisco Internetwork Operating System Software

Cisco IOS (tm) GS Software (GS7), Version 11.0

Compiled Tue 06-Dec-94 14:01 by smith

Image text-base: 0x00001000, data-base: 0x005A9C94 cisco 2500 (68030) processor (revision 0x00) with 4092K/2048K bytes of memory.

Processor board serial number 00000000

DDN X.25 software, Version 2.0, NET2 and BFE compliant.

ISDN software, Version 1.0.

Bridging software.

Enterprise software set supported. (0x0)

1 Ethernet/IEEE 802.3 interface.

2 Serial network interfaces.

--More--

1 ISDN Basic Rate interface.

32K bytes of non-volatile configuration memory.

4096K bytes of processor board System flash (Read ONLY)

Related Commands

Command more

Description

Displays a file.

more flh:logfile

Cisco IOS Configuration Fundamentals Command Reference

523

monitor event-trace through Q motd-banner

motd-banner

To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the motd-

banner command in line configuration mode. To suppress the MOTD banners on the specified line or lines, use the no form of this command.

motd-banner

no motd-banner

Syntax Description This command has no arguments or keywords.

Command Default Enabled on all lines.

Command Modes Line configuration

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command determines whether the router will display the MOTD banner when an EXEC session is created on the specified line or lines. The MOTD banner is defined with the banner motd global configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner on specific lines using the no motd-banner line configuration command.

The MOTD banners can also be disabled by the no exec-banner line configuration command, which disables both MOTD banners and EXEC banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-bannercommand is enabled or disabled. The table below summarizes the effects of the exec-banner command and the motd-banner command.

Table 31 Banners Displayed Based On exec-banner and motd-banner Combinations motd-banner (default) exec-banner (default)

MOTD banner

EXEC banner no exec-banner

None

524

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q motd-banner no motd-banner exec-banner (default)

EXEC banner no exec-banner

None

exec-banner command and the motd-banner command for reverse Telnet connections.

Table 32 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet

Sessions to Async Lines motd-banner (default) no motd-banner exec-banner (default)

MOTD banner

Incoming banner

Incoming banner no exec-banner

Incoming banner

Examples The following example suppresses the MOTD banner on vty lines 0 through 4: line vty 0 4

no motd-banner

Related Commands

Command

banner exec

banner incoming

banner motd motd-banner

Description

Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.

Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.

Defines and enables a customized message-of-theday banner.

Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

525

monitor event-trace through Q name-connection

name-connection

To assign a logical name to a connection, use the name-connectioncommand in user EXEC mode.

name-connection

Syntax Description This command has no arguments or keywords.

Command Default No logical name is defined.

Command Modes User EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command can be useful for keeping track of multiple connections.

You are prompted for the connection number and name to assign. The where command displays a list of the assigned logical connection names.

Examples The following example assigns the logical name blueto the connection:

Router> where

Conn Host Address Byte Idle Conn Name

* 1 doc-2509 172.30.162.131 0 0 doc-2509

Router> name-connection

Connection number: 1

Enter logical name: blue

Connection 1 to doc-2509 will be named "BLUE" [confirm]

Related Commands

Command where

Description

Lists open sessions associated with the current terminal line.

526

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q name-connection

Cisco IOS Configuration Fundamentals Command Reference

527

monitor event-trace through Q no menu

no menu

To delete a user menu from the configuration file, use the no menu command in global configuration mode.

no menu menu-name

Syntax Description menu-name Name of the menu to delete from the configuration file.

Command Default No default behavior or values.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Use this command to remove any menu commands for a particular menu from the configuration file.

As with all global configuration commands, this command will only effect the startup configuration file when you save the running configuration using the copy running-config startup-config EXEC command.

Examples The following example deletes the menu named Access1: no menu Access1

Related Commands

Command

menu (EXEC)

menu command

Description

Invokes a user menu.

Specifies underlying commands for user menus.

528

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command

menu prompt

menu text

menu title no menu

Description

Specifies the prompt for a user menu.

Specifies the text of a menu item in a user menu.

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

529

monitor event-trace through Q notify

notify

To enable terminal notification about pending output from other Telnet connections, use the notify command in line configuration mode. To disable notifications, use the noform of this command.

notify

no notify

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command sets a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one.

Examples In the following example, notification of pending output from connections is enabled on virtual terminal lines 0 to 4:

Router(config)# line vty 0 4

Router(config-line)# notify

Related Commands

Command

terminal notify

Description

Configures a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one.

530

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q notify syslog

notify syslog

To enable the sending of notifications of configuration changes to a remote system message logging

(syslog), use the notify syslogcommand in configuration change logger configuration mode. To disable the sending of notifications of configuration changes to the syslog, use the no form of this command.

notify syslog [contenttype {plaintext | xml}]

no notify syslog [contenttype {plaintext | xml}]

Syntax Description contenttype plaintext xml

(Optional) Allows you to choose a format for the configuration change messages that are sent via syslog.

(Optional) Specifies that the configuration change messages are sent as plain text.

(Optional) Specifies that the configuration change messages are sent in XML format.

Command Default Notifications are not sent to the syslog.

Command Modes Configuration change logger configuration (config-archive-log-config)

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

The contenttype plaintext, and xml keywords were added.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Cisco IOS Configuration Fundamentals Command Reference

531

monitor event-trace through Q notify syslog

Usage Guidelines Enable the notify syslog command if you use the syslog to monitor your router. Syslog monitoring prevents the need to gather configuration log information manually.

Examples The following example shows how to enable the router to send notifications (in XML format) to the syslog:

Router# configure terminal

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)# notify syslog contenttype xml

Router(config-archive-log-config)# end

Related Commands

Command archive hidekeys

log config

logging enable

logging size

show archive log config

Description

Enters archive configuration mode.

Suppresses the display of password information in configuration log files.

Enters configuration change logger configuration mode.

Enables the logging of configuration changes.

Specifies the maximum number of entries retained in the configuration log.

Displays entries from the configuration log.

532

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q padding

padding

To set the padding on a specific output character, use the padding command in line configuration mode. To remove padding for the specified output character, use the no form of this command.

padding ascii-number count

no padding ascii-number

Syntax Description ascii-number count

ACII decimal representation of the character.

Number of NULL bytes sent after the specified character, up to 255 padding characters in length.

Command Default No padding

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Use this command when the attached device is an old terminal that requires padding after certain characters

(such as ones that scrolled or moved the carriage). See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters.

Examples In the following example, the Return (decimal character 13) is padded with 25 NULL bytes on the console line:

Router(config)# line console

Router(config-line)# padding 13 25

Cisco IOS Configuration Fundamentals Command Reference

533

padding

Related Commands

Command

terminal padding monitor event-trace through Q

Description

Changes the character padding on a specific output character for the current session.

534

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parity

parity

To define generation of a parity bit, use the parity command in line configuration mode. To specify no parity, use the no form of this command.

parity {none | even | odd | space | mark}

no parity

Syntax Description none even odd space mark

No parity. This is the default.

Even parity.

Odd parity.

Space parity.

Mark parity.

Command Default No parity.

Command Modes Line configuration

Command History

Release

10.0

12.4

12.2(33)SRA

Modification

This command was introduced.

This command was modified to enable parity setting on Cisco AS5350 and Cisco AS5400

NextPort lines.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems sometimes require a specific parity bit setting. Refer to the documentation for your device to determine required parity settings.

If you use this command to set parity on Cisco AS5350 and Cisco AS5400 NextPort lines, do not also set parity by means of S-register settings in a modemcap. (A modemcap is a series of parameter settings that are sent to your modem to configure it to interact with a Cisco device in a specified way. Cisco IOS software defines modemcaps that have been found to properly initialize most modems so that they function properly with Cisco routers and access servers.)

Cisco IOS Configuration Fundamentals Command Reference

535

monitor event-trace through Q parity

Examples In the following example, even parity is configured for line 34:

Router(config)# line 34

Router(config-line)# parity even

Related Commands

Command

terminal parity

Description

Defines the generation of the parity bit for the current for the current session and line.

536

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parser cache

parser cache

To reenable the Cisco IOS software parser cache after disabling it, use the parser cache command in global configuration mode. To disable the parser cache, use the no form of this command.

parser cache

no parser cache

Syntax Description This command has no arguments or keywords.

Command Default Parser cache is enabled by default.

Command Modes Global configuration

Command History

Release

12.1(5)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The parser cache is enabled by default. However, if you wish to disable the parser cache, you may do so using the no parser cache command in global configuration mode. To reenable the parser cache after it has been disabled, use the parser cache command.

When the no parser cache is issued, the command line appears in the running configuration file. However, if the parser cache is reenabled, no command line appears in the running configuration file.

Examples In the following example, the Cisco IOS software Parser Cache feature is disabled:

Router(config)# no parser cache

Cisco IOS Configuration Fundamentals Command Reference

537

parser cache

Related Commands

Command

clear parser cache

show parser statistics monitor event-trace through Q

Description

Clears the parse cache entries and hit/miss statistics stored for the Parser Cache feature.

Displays statistics about the last configuration file parsed and the status of the Parser Cache feature.

538

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parser command serializer

parser command serializer

To enable configuration access only to the users holding a configuration lock and to prevent other clients from accessing the running configuration, use the parser command serializer command in global configuration mode. To disable this configuration, use the no form of this command.

parser command serializer

no parser command serializer

Syntax Description This command has no arguments or keywords.

Command Default Access is granted only to the user holding the lock.

Command Modes Global configuration (config)

Command History

Release

12.2(33)SRE

15.1(1)T

Modification

This command was introduced.

This command was included in Cisco IOS Release

15.1(1)T.

Usage Guidelines The Parser Concurrency and Locking Improvements feature ensures that exclusive access is granted only to a requested process and prevents other users from concurrently accessing the Cisco IOS configuration. That is, it prevents simultaneous execution of two or more commands. Use the parser command serializer command to configure the Parser Concurrency and Locking Improvements feature.

Examples The following example shows how to configure the Parser Concurrency and Locking Improvements feature:

Router# configure terminal

Router(config)# parser command serializer

Cisco IOS Configuration Fundamentals Command Reference

539

parser command serializer

Related Commands

Command

configuration mode exclusive

configure terminal lock

test parser session-lock monitor event-trace through Q

Description

Enables single-user (exclusive) access functionality for the Cisco IOS CLI.

Locks the running configuration into exclusive configuration mode for the duration of your configuration session.

Tests the behavior of the Parser Concurrency and

Locking Improvements feature.

540

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parser config cache interface

parser config cache interface

To reduce the time required for the command-line interpreter to execute commands that manage the running system configuration files, use the parser config cache interfacecommand in global configuration mode. To disable the reduced command execution time functionality, use the no form of this command.

parser config cache interface

no parser config cache interface

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration (config)

Command History

Release

12.3(7)T

12.2(25)S

12.2(27)SBC

12.2(33)SRC

12.2(33)SB

12.2(33)SXI

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRC.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines

Enable the parser config cache interfacecommand to reduce the execution time required for running configuration management commands such as the show running-configuration, write terminal, and copy

system:running-configuration commands. Information for these configuration management commands is supplied by nonvolatile generation (NVGEN) processes that query the system for configuration details. The

parser config cache interfacecommand is especially useful for managing large system configurations that contain numerous interface configurations.

Cisco IOS Configuration Fundamentals Command Reference

541

monitor event-trace through Q parser config cache interface

Once enabled, the command provides faster execution of the NVGEN commands that process the running system configuration by caching interface configurations in system memory, and by retrieving only configuration information that has changed. For this reason, the device on which this command is enabled must have enough memory available to store the interface configuration. For example, if the interface configurations take up 15 KB of memory, using this command would require having an additional 15 KB of memory space available.

The first time you display the configuration file, you will not see much evidence of improvement in performance because the interface cache will be filled up. However, you will notice performance improvements when you enter subsequent NVGEN-type commands such as the show running-

configuration EXEC command.

Each time the interface configuration is changed, the interface cache is flushed. Entering an NVGEN-type command after modifying the interface configuration will once again not show any performance improvement until the next NVGEN-type command is entered.

Examples The following example shows how to enable the functionality for reducing the time required for the command-line interpreter to execute commands that manage the running system configuration files:

Router(config)# parser config cache interface

Related Commands

Command

copy system:running-configuration

show running-configuration

write terminal

Description

Copies the running configuration to another destination.

Displays the configuration currently running on the terminal.

542

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parser config partition

parser config partition

To enable configuration partitioning, use the parser config partition command. To disable the partitioning of the running configuration, use the noform of thiscommand.

parser config partition

no parser config partition

Syntax Description No arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration (config)

Command History

Release

12.2(33)SRB

12.2(33)SB

12.2(33)SXI

Modification

This command was introduced as part of the

Configuration Partitioning feature.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines

This command controls (enables or disables) the Configuration Partitioning feature.

Note This command is not related to disk partitions or disk partitioning.

To display the list of commands that make up the current running configuration for a specific part

(“partition”) of the system’s global running configuration, use the show running-config partition command in privileged Exec mode.

The Configuration Partitioning feature uses a small amount of system resources. The no parser config

partition command allows you to disable this feature if the feature is not needed on your system.

Cisco IOS Configuration Fundamentals Command Reference

543

monitor event-trace through Q parser config partition

Note Only the no form of this command will appear in configuration files. To determine if config partitioning is supported on your system and whether it is enabled, use the show running-config parser ? command.

Examples The following example shows how to disable partitioning of the system running configuration:

Router> enable

Router# config t

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# no parser config partition

System configured

Related Commands

Command

show running-config partition

Description

Displays the list of commands that make up the current running configuration for a specific part of the system’s global running configuration. When used with the ? CLI help keyword, can also be used to determine the availability and status of the

Configuration Partitioning feature.

544

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q parser maximum

parser maximum

To specify performance maximums for CLI operations use the parser maximum command in global configuration mode. To clear any previously established maximums, us the No form of the command.

parser maximum {latencylimit | utilizationlimit}

no parser maximum {latency | utilization}

Syntax Description latency limit utilization limit

Specifies the maximum process latency to allow.

Numerical latency between 20 and 200.

Specifies the maximum CPU utilization to allow.

Numerical CPU utilization between 1 and 100.

Command Default

No performance maximums enabled by default.

Command Modes Global Configuration

Command History

Release

15.1(3)T

Modification

This command was introduced.

Usage Guidelines The Parser Maximum feature provides a workaround in the event of a problem with the coding of a protocol, allowing the error to be bypassed untill it can be corrected.

Examples The following example shows how to impose a latency limit of 100.

Router(config)#paser maximum latency 100

The following example shows how to clear latency limits.

Router(config)#no paser maximum latency

Cisco IOS Configuration Fundamentals Command Reference

545

parser maximum

Related Commands

Command parser cache monitor event-trace through Q

Description

The Parser Cache feature optimizes the parsing

(translation and execution) of Cisco IOS software configuration command lines by remembering how to parse recently encountered command lines, decreasing the time required to process large configuration files.

546

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q partition

partition

To separate Flash memory into partitions on Class B file system platforms, use the partition command in global configuration mode. To undo partitioning and to restore Flash memory to one partition, use the no form of this command.

Cisco 1600 Series and Cisco 3600 Series Routers

partition flash-filesystem : [number-of-partitions] [partition-size]

no partition flash-filesystem:

All Other Class B Platforms

partition flash partitions [size1 size2]

no partition flash

Syntax Description

flash-filesystem : number-of-partitions partition-size partitions size1 size2

One of the following Flash file systems, which must be followed by a colon (:). The Cisco 1600 series can only use the flash: keyword.

• flash: -- Internal Flash memory

• slot0: -- Flash memory card in PCMCIA slot 0

• slot1: -- Flash memory card in PCMCIA slot 1

(Optional) Number of partitions in Flash memory.

(Optional) Size of each partition. The number of partition size entries must be equal to the number of specified partitions.

Number of partitions in Flash memory. Can be 1 or

(Optional) Size of the first partition (in megabytes).

(Optional) Size of the second partition (in megabytes).

Command Default Flash memory consists of one partition.

If the partition size is not specified, partitions of equal size are created.

Command Modes Global configuration

Cisco IOS Configuration Fundamentals Command Reference

547

monitor event-trace through Q partition

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

For the Cisco 1600 series and Cisco 3600 series routers, to undo partitioning, use the partition flash-

filesystem :1 or no partition flash-filesystem : command. For other Class B platforms, use either the

partition flash 1 or no partition flash command. If there are files in a partition other than the first, you must use the erase flash-filesystem:partition-numbercommand to erase the partition before reverting to a single partition.

When creating two partitions, you must not truncate a file or cause a file to spill over into the second partition.

Note The partition command will only create 3MB or larger partitions and may not be used if the device memory contains logging persistent files.

Examples

The following example creates two partitions of 4 MB each in Flash memory:

Router(config)# partition flash 2 4 4

The following example divides the Flash memory card in slot 0 into two partitions, each 8 MB in size on a

Cisco 3600 series router:

Router(config)# partition slot0: 2 8 8

The following example creates four partitions of equal size in the card on a Cisco 1600 series router:

Router(config)# partition flash: 4

548

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q path (archive configuration)

path (archive configuration)

To specify the location and filename prefix for the files in the Cisco IOS configuration archive, use the

path command in archive configuration mode. To disable this function, use the no form of this command.

path url

no path url

Syntax Description url URL (accessible by the Cisco IOS file system) used for saving archive files of the running configuration file in the Cisco IOS configuration archive.

Command Default If this command is not configured, no location or filename prefix is specified for files in the Cisco IOS configuration archive.

Command Modes

Archive configuration (config-archive)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Cisco IOS Configuration Fundamentals Command Reference

549

monitor event-trace through Q path (archive configuration)

Usage Guidelines When this command is entered, an archive file of the running configuration is saved when the archive

config, write-memory, or copy running-config startup-config command is entered.

URLs are commonly used to specify files or location on the World Wide Web. On Cisco routers, URLs can be used to specify the location of a file or directory on a router or a remote file server. The path command uses a URL to specify the location and filename prefix for the Cisco IOS configuration archive.

The locations or file systems that you can specify in the url argument are as follows:

• If your platform has disk0--disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp:

• If your platform does not have disk0--ftp:, http:, pram:, rcp:, or tftp:

The colon is required in the location format.

The filename of the first archive file is the filename specified in the url argument followed by -1. The filename of the second archive file is the filename specified in the url argument followed by -2 and so on.

Because some file systems are incapable of storing the date and time that a file was written, the filename of the archive file can contain the date, time, and router hostname. To include the router hostname in the archive file filename, enter the characters $h (for example, disk0:$h). To include the date and time in the archive file filename, enter the characters $t.

When a configuration archive operation is attempted on a local file system, the file system is tested to determine if it is writable and if it has sufficient space to save an archive file. If the file system is read-only or if there is not enough space to save an archive file, an error message is displayed.

If you specify the tftp: file server as the location with the path command, you need to create the configuration file on the TFTP file server and change the file’s privileges before the archive config command works properly.

Examples The following example of the path command shows how to specify the hostname, date, and time as the filename prefix for which to save archive files of the running configuration. In this example, the time-

period command is also configured to automatically save an archive file of the running configuration every

20 minutes.

configure terminal

archive

path disk0:$h$t

time-period 20

end

The following is sample output from the show archive command illustrating the format of the resulting configuration archive filenames.

Router# show archive

There are currently 3 archive configurations saved.

The next archive file will be named routerJan-16-01:12:23.019-4

Archive # Name

1 disk0:routerJan-16-00:12:23.019-1

2 disk0:routerJan-16-00:32:23.019-2

3 disk0:routerJan-16-00:52:23.019-3 <- Most Recent

550

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q path (archive configuration)

Cisco IOS Configuration Archive on the TFTP File Server

The following example shows how to use the path command to specify the TFTP file server, address

10.48.71.226, as the archive configuration location and router-cfg as the configuration filename. First you create the configuration file on the TFTP server and change the file’s privileges, then you can save the configuration file to the configuration archive.

The following example shows the commands to use to create the file and change the file’s privileges on the

TFTP server (UNIX commands):

> touch

router-cfg-1

> chmod

777 router-cfg-1

The following example show how to create the configuration archive, save the running configuration to the archive, and display the files in the archive: configure terminal

archive

path tftp://10.48.71.226/router-cfg

exit exit

archive config

Router# show archive

The next archive file will be named tftp://10.48.71.226/router-cfg-2

Archive # Name

1 tftp://10.48.71.226/router-cfg-1 <- Most Recent

The following is sample output from the show archive command if you did not create the configuration file on the TFTP server before attempting to archive the current running configuration file: configure terminal

archive

path tftp://10.48.71.226/router-cfg

exit exit archive config

Router# show archive

The next archive file will be named tftp://10.48.71.226/router-cfg-1

Archive # Name

Cisco IOS Configuration Fundamentals Command Reference

551

monitor event-trace through Q path (archive configuration)

Related Commands

Command archive

archive config

configure confirm

configure replace maximum

show archive time-period

Description

Enters archive configuration mode.

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

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

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

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

Displays information about the files saved in the

Cisco IOS configuration archive.

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

552

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q periodic

periodic

To specify a recurring (weekly) time range for functions that support the time-range feature, use the periodic command in time-range configuration mode. To remove the time limitation, use the no form of this command.

periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm

no periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm

Syntax Description days-of-the-week hh:mm to

The first occurrence of this argument is the starting day or day of the week that the associated time range is in effect. The second occurrence is the ending day or day of the week the associated statement is in effect.

This argument can be any single day or combinations of days: Monday, Tuesday,

Wednesday, Thursday, Friday, Saturday, and

Sunday. Other possible values are:

• daily --Monday through Sunday

• weekdays --Monday through Friday

• weekend --Saturday and Sunday

If the ending days of the week are the same as the starting days of the week, they can be omitted.

The first occurrence of this argument is the starting hours:minutes that the associated time range is in effect. The second occurrence is the ending hours:minutes the associated statement is in effect.

The hours:minutes are expressed in a 24-hour clock. For example, 8:00 is 8:00 a.m. and 20:00 is

8:00 p.m.

Entry of the to keyword is required to complete the range “from start-time to end-time.”

Command Default No recurring time range is defined.

Command Modes Time-range configuration (config-time-range)

Cisco IOS Configuration Fundamentals Command Reference

553

monitor event-trace through Q periodic

Command History

Examples

Release

12.0(1)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines For Cisco IOS Release 12.2(11)T, IP and Internetwork Packet Exchange (IPX) extended access lists are the only functions that can use time ranges. For further information on using these functions, refer to the Cisco

IOS IP Configuration Guide and the Cisco IOS AppleTalk and Novell IPX Configuration Guide.

The periodiccommand is one way to specify when a time range is in effect. Another way is to specify an absolute time period with the absolute command. Use either of these commands after the time-range global configuration command, which specifies the name of the time range. Multiple periodicentries are allowed per time-range command.

If the end days-of-the-week value is the same as the start value, they can be omitted.

If a time-range command has both absolute and periodic values specified, then the periodic items are evaluated only after the absolute start time is reached, and are not further evaluated after the absolute end time is reached.

Note All time specifications are taken as local time. To ensure that the time range entries take effect at the desired times, you should synchronize the system software clock using Network Time Protocol (NTP).

The table below lists some typical settings for your convenience:

Table 33 Typical Examples of periodic Command Syntax

If you want:

Monday through Friday, 8:00 a.m. to 6:00 p.m.

only

Configure this:

periodic weekday 8:00 to 18:00

Every day of the week, from 8:00 a.m. to 6:00 p.m.

only

periodic daily 8:00 to 18:00

periodic monday 8:00 to friday 20:00 Every minute from Monday 8:00 a.m. to Friday

8:00 p.m.

All weekend, from Saturday morning through

Sunday night

Saturdays and Sundays, from noon to midnight

periodic weekend 00:00 to 23:59

periodic weekend 12:00 to 23:59

The following example configuration denies HTTP traffic on Monday through Friday from 8:00 a.m. to

6:00 p.m.:

Router# show startup-config

554

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q periodic

time-range no-http

periodic weekdays 8:00 to 18:00

ip access-list extended strict

deny tcp any any eq http time-range no-http

interface ethernet 0

ip access-group strict in

The following example configuration permits Telnet traffic on Mondays, Tuesdays, and Fridays from 9:00 a.m. to 5:00 p.m.:

Router# show startup-config

time-range testing

periodic Monday Tuesday Friday 9:00 to 17:00

ip access-list extended legal

permit tcp any any eq telnet time-range testing

interface ethernet 0

ip access-group legal in

Related Commands

Command absolute

access-list (extended)

deny (IP)

permit (IP) time-range

Description

Specifies an absolute start and end time for a time range.

Defines an extended IP access list.

Sets conditions under which a packet does not pass a named IP access list.

Sets conditions under which a packet passes a named IP access list.

Enables time-range configuration mode and names a time range definition.

Cisco IOS Configuration Fundamentals Command Reference

555

monitor event-trace through Q ping

ping

To diagnose basic network connectivity on AppleTalk, ATM, Connectionless Network Service (CLNS),

DECnet, IP, Novell IPX, or source-route bridging (SRB) networks, use the ping command in user EXEC or privileged EXEC mode.

ping [[protocol [tag]]{host-name | system-address}]

Syntax Description protocol tag host-name system-address

(Optional) Protocol keyword, either appletalk,

atm, clns, decnet, ipx, or srb. If a protocol is not specified, a basic ping will be sent using IP (IPv4).

For extended options for ping over IP, see the documentation for the ping ip command.

The ping atm interface atm, ping ip, ping ipv6,

ping sna, and ping vrfcommands are documented separately.

(Optional) Specifies a tag encapsulated IP (tagIP) ping.

Hostname of the system to ping. If a host-name or

system-address is not specified at the command line, it will be required in the ping system dialog.

Address of the system to ping. If a host-name or

system-address is not specified at the command line, it will be required in the ping system dialog.

Command Default This command has no default values.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

10.0

12.0(7)T

12.1(12c)E

12.2(2)T

Modification

This command was introduced.

The ping sna command was introduced.

The ping vrf command was introduced.

Support for the IPv6 protocol was added.

556

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Release

12.2(13)T

12.2(28)SB

12.2(25)SG

12.2(33)SRA

12.2(33)SXH

Cisco IOS XE Release 2.1

ping

Modification

The atmprotocol keyword was added.

The following keywords were removed because the

Apollo Domain, Banyan VINES, and XNS protocols are no longer supported in Cisco IOS software:

• apollo

• vines

• xns

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(25)SG.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was introduced on Cisco ASR 1000

Series Routers.

Usage Guidelines

The ping command sends an echo request packet to an address then waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. For example, the ping clns command sends International Organization for Standardization

(ISO) CLNS echo packets to test the reachability of a remote router over a connectionless Open System

Interconnection (OSI) network.

If you enter the ping command without any keywords or argument values, an interactive system dialog prompts you for the additional syntax appropriate to the protocol you specify. (See the “Examples” section.)

To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The default escape sequence is Ctrl-^, X (Simultaneously press and release the Ctrl, Shift, and 6 keys and then press the X key). The escape sequence will vary depending on your line configuration. For example, another commonly used escape sequence is Ctrl-c.

The table below describes the test characters sent by the pingfacility.

Table 34 ping Test Characters

Character Description

Each exclamation point indicates receipt of a reply.

Cisco IOS Configuration Fundamentals Command Reference

557

monitor event-trace through Q ping

Character

Description

Each period indicates that the network server timed out while waiting for a reply.

A destination unreachable error protocol data unit

(PDU) was received.

A reply packet does not validate the reply data, and hence is marked "Corrupted".

Note This character will only appear if the

"validate" option is selected in the ping request.

User interrupted test.

A destination unreachable error protocol data unit

(PDU) was received (Type 3) MTU required but

DF bit set (code 4) with the “Next-Hop MTU” set to a non-zero value. If the “Next-hop MTU“ is zero then ‘U’ is printed.

Unknown packet type.

Packet lifetime exceeded.

Examples

Note Not all protocols require hosts to support pings. For some protocols, the pings are Cisco defined and can be answered only by another Cisco router.

The availability of protocol keywords depends on what protocols are enabled on your system.

Issuing the ping command in user EXEC mode will generally offer fewer syntax options than issuing the

ping command in privileged EXEC mode.

After you enter the ping command in privileged EXEC mode, the system prompts you for a protocol keyword. The default protocol is IP.

If you enter a hostname or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.

The following example is sample dialog from the ping command using default values. The specific dialog varies somewhat from protocol to protocol.

Router# ping

Protocol [ip]:

Target IP address: 192.168.7.27

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]:

Sweep range of sizes [n]:

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:

558

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q ping

!!!!!

Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms

The table below describes the significant fields shown in the display.

Table 35 ping Field Descriptions for IP

Field

Protocol [ip]:

Target IP address:

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]:

Sweep range of sizes [n]:

!!!!!

Success rate is 100 percent round-trip min/avg/max = 1/2/4 ms

Description

Prompt for a supported protocol. Default: ip.

Prompt for the IP address or hostname of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here.

Default: none.

Number of ping packets that will be sent to the destination address. Default: 5.

Size of the ping packet (in bytes). Default: 100 bytes.

Timeout interval. Default: 2 (seconds).

Specifies whether a series of additional commands appears.

Allows you to vary the sizes of the echo packets being sent. This capability is useful for determining the minimum sizes of the maximum transmission units (MTUs) configured on the nodes along the path to the destination address. Packet fragmentation contributing to performance problems can then be reduced.

Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.

Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic.

Round-trip travel time intervals for the protocol echo packets, including minimum/average/ maximum (in milliseconds).

The following example verifies connectivity to the neighboring ATM device for the ATM permanent virtual circuit (PVC) with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16:

Router# ping

Protocol [ip]:atm

Cisco IOS Configuration Fundamentals Command Reference

559

monitor event-trace through Q ping

ATM Interface:atm1/0

VPI value [0]:

VCI value [1]:16

Loopback - End(0), Segment(1) [0]:1

Repeat Count [5]:

Timeout [2]:

Type escape sequence to abort.

Sending 5, 53-byte segment OAM echoes, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/1 ms

The table below describes the default ping fields shown in the display.

Table 36 ping Field Descriptions for ATM

Field

Protocol [ip]:

ATM Interface:

VPI value [0]:

VCI value [1]:

Loopback - End(0), Segment(1) [0]:

Repeat Count [5]:

Timeout [2]:

!!!!!

Success rate is 100 percent round-trip min/avg/max = 1/1/1 ms

Description

Prompt for a supported protocol. Default: ip.

Prompt for the ATM interface.

Prompt for the virtual path identifier. Default: 0.

Prompt for the virtual channel identifier. Default:1.

Prompt to specify end loopback, which verifies end-to-end PVC integrity, or segment loopback, which verifies PVC integrity to the neighboring

ATM device. Default: segment loopback.

Number of ping packets that will be sent to the destination address. Default: 5.

Timeout interval. Default: 2 (seconds).

Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic.

Round-trip travel time intervals for the protocol echo packets, including minimum/average/ maximum (in milliseconds).

Related Commands

Command

ping atm interface atm

Description

Tests the connectivity of a specific PVC.

560

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command

ping ip

ping ipv6

ping sna

ping vrf ping

Description

Tests network connectivity on IP networks.

Tests the connection to a remote host on the network using IPv6.

Tests network integrity and timing characteristics over an SNA Switching network.

Tests the connection in the context of a specific

VPN (VRF).

Cisco IOS Configuration Fundamentals Command Reference

561

monitor event-trace through Q ping (privileged)

ping (privileged)

To diagnose basic network connectivity on Apollo, AppleTalk, Connectionless Network Service (CLNS),

DECnet, IP, Novell IPX, VINES, or XNS networks, use the pingcommand in privileged EXEC command mode.

ping [hostname | system-address | [protocol | tag] {hostname | system-address}] [data [hex-data-

Syntax Description hostname system-address protocol tag data hex-data-pattern df-bit repeat repeat-count size datagram-size source source-address async bvi ctunnel dialer

(Optional) Hostname of the system to ping.

(Optional) Address of the system to ping.

(Optional) Protocol to use for the ping. Valid values are: apollo, appletalk, clns, decnet, ethernet, ip,

ipv6, ipx, srb, vines, xns.

(Optional) Specifies a tag encapsulated IP ping.

(Optional) Specifies the data pattern.

(Optional) Hexidecimal value of the data in the range of 0 to FFFF.

(Optional) Enables the “do not fragment” bit in the

IP header.

(Optional) Specifies the number of times the ping should be sent.

(Optional) Integer in the range of 1 to 2147483647.

The default is 5.

(Optional) Size, in bytes, of the ping datagram.

(Optional) Integer in the range of 40 to 18024.

(Optional) Device sending the ping

(Optional) Address or name of the device sending the ping.

(Optional) Asynchronous interface.

(Optional) Bridge-Group Virtual interface.

(Optional) CTunnel interface.

(Optional) Dialer interface.

562

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q ethernet fastethernet lex loopback multilink null port-channel tunnel vif virtual-template virtual-tokenring xtagatm timeout seconds validate

Command Default A ping operation is not performed.

Command Modes Privileged EXEC

Command History

Release

10.0

12.0

12.2(33)SRA ping (privileged)

(Optional) Ethernet IEEE 802.3 interface.

(Optional) FastEthernet IEEE 802.3 interface.

(Optional) Lex interface.

(Optional) Loopback interface.

(Optional) Multilink-group interface.

(Optional) Null interface.

(Optional) Ethernet channel of interfaces.

(Optional) Tunnel interface

(Optional) Pragmatic General Multicast (PGM) host interface

(Optional) Virtual Template interface.

(Optional) Virtual TokenRing.

(Optional) Extended Tag ATM interface.

(Optional) Specifies the timeout interval in seconds.

(Optional) Integer in the range of 0 to 3600. The default is 2.

(Optional) Validates the reply data.

Modification

This command was introduced.

The following keywords were added in Cisco IOS

Release 12.0: data, df-bit, repeat, size, source,

timeout, validate.

The ethernet option for protocol was added in Cisco

IOS Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

563

monitor event-trace through Q ping (privileged)

Usage Guidelines The ping (packet internet groper) command tests the reachability of a remote router over a connectionless

Open System Interconnection (OSI) network. The command sends ISO CLNS echo packets to an address and waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.

When you type the ping command, you are prompted to enter options before the ping command executes.

The characters in brackets ([]) indicate default values. When you want to use a default value, press Enter on your keyboard.

If you enter a hostname or system address when you enter the ping command, the default action is taken for the protocol type of that hostname or system address.

The optional data, df-bit, repeat, size, source, timeout, and validate keywords can be used to prevent extended ping command output. You can use as many of these keywords as you need, and you can use them in any order after the hostname or system-address arguments.

When you enter the ethernet protocol option, you will be prompted to enter MAC address and maintenance domain in addition to the information common across protocols.

To terminate a ping session before it completes, type the escape sequence (Ctrl-^ X) by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys and then pressing the X key.

Note Not all protocols require hosts to support pings. For some protocols, the pings are defined by Cisco and answered only by a Cisco router.

The table below describes the test characters that the ping operation uses.

Table 37 ping Command Response Characters and Their Meanings

Character

Description

Receipt of a reply.

Network server timed out while waiting for a reply.

Destination unreachable error protocol data unit

(PDU) was received.

A reply packet does not validate the reply data, and hence is marked "Corrupted".

Note This character will only appear if the

"validate" option is selected in the ping request.

User interrupted test.

Unknown packet type.

Packet lifetime exceeded.

564

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q ping (privileged)

Examples The following example shows a ping command and output. The precise dialog varies from protocol to protocol, but all are similar to the ping session shown here using default values.

Router# ping

Protocol [ip]:

Target IP address: 192.168.7.27

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]:

Sweep range of sizes [n]:

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:

!!!!

Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms

The following example shows how to send a ping specifying the ethernet protocol option, MAC address, and maintenance domain and using the default values for the remaining parameters:

Router# ping

Protocol [ip]: ethernet

Mac Address : aabb.cc00.0410

Maintenance Domain : DOMAIN_PROVIDER_L5_1 VLAN [0]: 2 Source MPID [1522]:

Repeat Count [5]:

Datagram Size [107]:

Timeout in seconds [2]:

Sweep range of sizes [n]:

Type escape sequence to abort.

Sending 5 Ethernet CFM loopback messages, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 1/4/8 ms.

Related Commands

Command

ping ethernet

ping (user)

ping vrf

Description

Sends Ethernet CFM loopback messages to a destination MAC address.

Tests the connection to a remote host on the network.

Tests the connection to a remote device in a VPN.

Cisco IOS Configuration Fundamentals Command Reference

565

monitor event-trace through Q ping ip

ping ip

To test network connectivity on IP networks, use the ping ip command inprivileged EXEC mode.

ping ip {host-name | ip-address} [data [hex-data-pattern] | df-bit | repeat [repeat-count] | tos

[service value] | size [datagram-size] source {source-address | source-interface}] [timeout seconds]

[validate] [verbose]

Syntax Description host-name system-address

data hex-data-pattern df-bit

repeat repeat-count

tos service value size datagram-size source source-address

Host name of the system to ping.

Address of the system to ping.

(Optional) Specifies the data pattern. Range is from

0 to FFFF.

(Optional) Enables the “do-not-fragment” bit in the

IP header.

(Optional) Specifies the number of pings sent. The range is from 1 to 2147483647. The default is 5.

(Optional) Specifies the type of service value. The range is from 1 to 255.

(Optional) Specifies the datagram size. Datagram size is the number of bytes in each ping.

(Optional) Range is from 40 to 18024.

(Optional) Specifies the source address or source interface.

(Optional) IP address to use as the source in the ping packets.

566

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q source-interface

timeout seconds validate verbose

Command Modes Privileged Exec

Command History

Release

10.0

12.0

12.2(33)SRA ping ip

(Optional) Name of the interface from which the ping should be sent, and the Interface ID (slot/port/ number). Interface name keywords include the following:

• async ( Asynchronous Interface)

• bvi ( Bridge-Group Virtual Interface)

• ctunnel

• dialer

• ethernet

• fastEthernet

• lex

• loopback

• multilink ( Multilink-group interface)

• null

• port-channel ( Ethernet channel of interfaces)

• tunnel

• vif ( PGM Multicast Host interface)

• virtual-template

• virtual-tokenring

• xtagatm (Extended Tag ATM interface)

The availability of these keywords depends on your system hardware.

(Optional) Specifies the timeout interval in seconds.

The default is 2 seconds. Range is from 0 to 3600.

(Optional) Validates the reply data.

(Optional) Enables verbose output, which lists individual ICMP packets, as well as Echo

Responses.

Modification

This command was introduced.

The data, df-bit, repeat, size, source, timeout, and

validate keywords were added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

567

monitor event-trace through Q ping ip

Release

15.2(02)S

Modification

The tos keyword was added.

Usage Guidelines

The ping command sends an echo request packet to an address, then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.

To abnormally terminate a ping session, type the escape sequence--by default, Ctrl-^ X. You type the default by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing the X key.

The table below describes the test characters that the ping facility sends.

Table 38 ping Test Characters

Character

Description

Each exclamation point indicates receipt of a reply.

Each period indicates that the network server timed out while waiting for a reply.

A destination unreachable error protocol data unit

(PDU) was received.

A reply packet does not validate the reply data, and hence is marked "Corrupted".

Note This character will only appear if the

"validate" option is selected in the ping request.

User interrupted test.

Unknown packet type.

Packet lifetime exceeded.

Note Not all protocols require hosts to support pings. For some protocols, the pings are Cisco-defined and are only answered by another Cisco router.

Examples After you enter the ping command in privileged mode, the system prompts you for a protocol keyword.The default protocol is IP.

If you enter a host name or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.

568

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q ping ip

The optional data, df-bit, repeat, size, source, timeout, and validate keywords can be used to avoid extended ping command output. You can use as many of these keywords as you need, and you can use them in any order after the host-name or system-address arguments.

Although the precise dialog varies somewhat from protocol to protocol, all are similar to the ping session using default values shown in the following output:

Router# ping

Protocol [ip]:

Target IP address: 192.168.7.27

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]:

Sweep range of sizes [n]:

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:

!!!!!

Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms

The table below describes the default ping fields shown in the display.

Table 39 ping Field Descriptions

Field

Protocol [ip]:

Target IP address:

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]:

Sweep range of sizes [n]:

Description

Prompts for a supported protocol. The default is IP.

Prompts for the IP address or host name of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here. The default is none.

Prompts for the number of ping packets that will be sent to the destination address. The default is 5 packets.

Prompts for the size of the ping packet (in bytes).

The default is 100 bytes.

Prompts for the timeout interval. The default is 2 seconds.

Specifies whether a series of additional commands appears.

Allows you to vary the sizes of the echo packets being sent. This capability is useful for determining the minimum sizes of the MTUs configured on the nodes along the path to the destination address.

Packet fragmentation contributing to performance problems can then be reduced.

Cisco IOS Configuration Fundamentals Command Reference

569

ping ip

Field

!!!!!

Success rate is 100 percent round-trip min/avg/max = 1/2/4 ms

Related Commands

Command

ping ipv6

ping vrf monitor event-trace through Q

Description

Each exclamation point ( !) indicates receipt of a reply. A p eriod ( .) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.

Indicates the percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic.

Indicates the round-trip travel time intervals for the protocol echo packets, including minimum/average/ maximum (in milliseconds).

Description

Tests the connection to a remote host on the network using IPv6.

Tests the connection in the context of a specific

VPN (VRF).

570

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q ping srb

ping srb

To test network connectivity for Source Route Bridging (SRB) networks, use the ping srb command in privileged EXEC mode.

ping srb name

Syntax Description name Destination IP address or hostname.

Command Modes Privileged EXEC (#)

Command History

Release

15.0(1)M

12.2(33)SRE

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRE.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1 and implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Examples The following example shows how to ping the target host of IP address 192.0.2.1:

Router# ping srb 192.0.2.1

Related Commands

Command

ping ip

Description

Tests network connectivity on IP networks.

Cisco IOS Configuration Fundamentals Command Reference

571

monitor event-trace through Q ping vrf

ping vrf

To test a connection in the context of a specific VPN connection, use the ping vrf command in user EXEC or privileged EXEC mode.

ping vrf vrf-name [tag] [connection] target-address [connection-options]

Syntax Description vrf-name tag connection target-address connection-options

The name of the VPN (VRF context).

(Optional) Specifies a tag encapsulated IP (tagIP) ping.

(Optional) Connection options include atm, clns,

decnet, ip, ipv6, ipx, sna, or srb. The default is ip.

The destination ID for the ping operation. Usually, this is the IPv4 address of the host. For example, the target for an IPv4 ping in a VRF context would be the IPv4 address or domain name of the target host. The target for an IPv6 ping in a VRF context would be the IPv6 prefix or domain name of the target host.

• If the target address is not specified, the CLI will enter the interactive dialog for ping.

(Optional) Each connection type may have its own set of connection options. For example, connection options for IPv4 are source, df-bit, and timeout.

See the appropriate ping command documentation for details.

Command Default

The default connection type for ping is IPv4.

Command Modes User EXEC

Privileged EXEC

Command History

Release

12.1(12c)E, 12.2

Modification

This command was introduced.

572

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Release

12.2(33)SRA

12.2(33)SB

12.2(33)SXI

12.2(33)SCF ping vrf

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

This command was integrated into Cisco IOS

Release 12.2(33)SCF.

Usage Guidelines A VPN routing and forwarding (VRF) instance is used to identify a VPN. To check if a configured VRF is working, you can use the ping vrf command.

When attempting to ping from a provider edge (PE) router to a customer edge (CE) router, or from a PE router to PE router, the standard ping command will not usually work. The ping vrf command allows you to ping the IP addresses of LAN interfaces on CE routers.

If you are on a PE router, be sure to indicate the specific VRF (VPN) name, as shown in the “Examples” section.

If all required information is not provided at the command line, the system will enter the interactive dialog

(extended mode) for ping.

Examples In the following example, the target host in the domain 209.165.201.1 is pinged (using IP/ICMP) in the context of the “CustomerA” VPN connection.

Router# ping vrf CustomerA 209.165.201.1

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 209.165.201.1, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 176/264/576 ms

Pressing the Enter key before providing all of the required options will begin the interactive dialog for ping.

In the following example, the interactive dialog is started after the “ip” protocol is specified, but no address is given:

Router# ping vrf CustomerB ip

Target IP address: 209.165.200.225

Repeat count [5]:

Datagram size [100]:

Timeout in seconds [2]:

Extended commands [n]: y

Source address or interface:

Type of service [0]:

Set DF bit in IP header? [no]:

Validate reply data? [no]:

Data pattern [0xABCD]:

Loose, Strict, Record, Timestamp, Verbose[none]: Record

Number of hops [ 9 ]:

Loose, Strict, Record, Timestamp, Verbose[RV]:

Sweep range of sizes [n]:

Cisco IOS Configuration Fundamentals Command Reference

573

monitor event-trace through Q ping vrf

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 209.165.200.225, timeout is 2 seconds:

Packet has IP options: Total option bytes= 39, padded length=40

Record route: <*>

(0.0.0.0)

Success rate is 100 percent (5/5), round-trip min/avg/max = 4/4/4 ms

The following example shows the various options for IP in the ping vrf command:

Router# show parser dump exec | include ping vrf

1 ping vrf <string>

1 ping vrf <string> ip <string>

1 ping vrf <string> ip (interactive)

1 ping vrf <string> ip <string>

1 ping vrf <string> ip <string> source <address>

1 ping vrf <string> ip <string> source <interface>

1 ping vrf <string> ip <string> repeat <1-2147483647>

1 ping vrf <string> ip <string> size Number

1 ping vrf <string> ip <string> df-bit

1 ping vrf <string> ip <string> validate

1 ping vrf <string> ip <string> data <0-65535>

1 ping vrf <string> ip <string> timeout <0-3600>

1 ping vrf <string> ip <string> verbose

1 ping vrf <string> ip <string> data <0-65535>

1 ping vrf <string> ip <string> timeout <0-3600>

1 ping vrf <string> tag

1 ping vrf <string> atm

1 ping vrf <string> ipv6

1 ping vrf <string> appletalk

1 ping vrf <string> decnet

1 ping vrf <string> clns

1 ping vrf <string> ipx

1 ping vrf <string> sna

1 ping vrf <string> srb

Cisco CMTS Routers: Example

The following example shows how to verify the matching and marking configuration in an MPLS network:

Router# ping vrf vrfa 1.3.99.98

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 1.3.99.98, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 8/10/20 ms

Related Commands

Command ping

ping atm interface atm

Description

Diagnoses basic network connectivity to a specific host.

Tests the connectivity of a specific PVC.

574

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q

Command

ping ip

ping ipv6

ping sna ping vrf

Description

Tests the connection to a remote host on the network using IPv4.

Tests the connection to a remote host on the network using IPv6.

Tests network integrity and timing characteristics over an SNA Switching network.

Cisco IOS Configuration Fundamentals Command Reference

575

monitor event-trace through Q platform shell

platform shell

To grant shell access and enter shell access grant configuration mode, use the platform shellcommand in global configuration mode. To disable this function, use the no form of this command.

platform shell

no platform shell

Syntax Description This command has no arguments or keywords.

Command Default This command is disabled.

Command Modes Global configuration (config)

Command History

Release

12.2(33)XNC

Modification

Usage Guidelines This command should be entered before using the request platform software system shell command.

Examples The following example shows how to grant shell access:

Router(config)# platform shell

Router(config)#

Related Commands

Command

request platform software system shell

Description

Requests platform shelll access.

576

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q power enable

power enable

To turn on power for the modules, use the power enablecommand in global configuration mode. To power down a module, use the no form of this command.

power enable module slot

no power enable module slot

Syntax Description

module slot Specifies a module slot number; see the “Usage

Guidelines” section for valid values.

Command Default Enabled

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(18)SXD

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was changed to allow you to disable power to empty slots.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

When you enter the no power enable module slot command to power down a module, the module’s configuration is not saved.

When you enter the no power enable module slot command to power down an empty slot, the configuration is saved.

The slot argument designates the module number. Valid values for slotdepend on the chassis that is used.

For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13.

Cisco IOS Configuration Fundamentals Command Reference

577

monitor event-trace through Q power enable

Examples This example shows how to turn on the power for a module that was previously powered down:

Router(config)# power enable module 5

Router(config)#

This example shows how to power down a module:

Router(config)# no power enable module 5

Router(config)#

Related Commands

Command

show power

Description

Displays information about the power status.

578

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q power redundancy-mode

power redundancy-mode

To set the power-supply redundancy mode, use the power redundancy-mode command in global configuration mode.

power redundancy-mode {combined | redundant}

Syntax Description combined redundant

Specifies no redundancy (combine power-supply outputs).

Specifies redundancy (either power supply can operate the system).

Command Default redundant

Command Modes Global configuration

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to set the power supplies to the no-redundancy mode:

Router(config)# power redundancy-mode combined

Router(config)#

This example shows how to set the power supplies to the redundancy mode:

Router(config)# power redundancy-mode redundant

Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

579

power redundancy-mode

Related Commands

Command

show power monitor event-trace through Q

Description

Displays information about the power status.

580

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q printer

printer

To configure a printer and assign a server tty line (or lines) to it, use the printer command in global configuration mode. To disable printing on a tty line, use the no form of this command.

printer printer-name {line number | rotary number} [formfeed] [jobtimeout seconds] [newline-

convert] [jobtypes type]

no printer printer-name

Syntax Description printer-name

line number

rotary number formfeed

jobtimeout seconds newline-convert

jobtypes type

Printer name.

Assigns a tty line to the printer.

The numberargument can be any one of the following parameters:

• aux --Specifies the auxiliary line.

• console --Specifies the primary terminal line.

• slot / port --First slot and port numbers for the internal modems.

• tty number --Specifies the terminal controller value.

• tty-number --tty number, in the range 0 to 491.

• vty value --Specifies the virtual terminal value.

Assigns a rotary group of tty lines to the printer.

(Optional) Causes the Cisco IOS software to send a form-feed character (ASCII 0x0C) to the printer tty line immediately following each print job received from the network.

(Optional) Changes the default time for line acquisition. The range is from 1 to 3600 seconds.

(Optional) Converts newline (linefeed) characters to a two-character sequence “carriage-return, linefeed” (CR+LF).

(Optional) Specifies allowed job types.

Command Default No printers are defined.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

581

monitor event-trace through Q printer

Command History

Release

10.3

12.2(33)SRA

15.0(1)M

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified in a release earlier than Cisco IOS Release 15.0(1)M. The jobtimeout

seconds and jobtypes type keywords and arguments were added.

Usage Guidelines This command enables you to configure a printer for operations and assign either a single tty line or a group of tty lines to it. To make multiple printers available through the same printer name, specify the number of a rotary group.

In addition to configuring the printer with the printer command, you must modify the file /etc/printcap on your UNIX system to include the definition of the remote printer in the Cisco IOS software. Refer to the

Cisco IOS Configuration Fundamentals Configuration Guide for additional information.

Use the optional newline-convert keyword in UNIX environments that cannot handle single-character line terminators. This converts newline characters to a carriage-return, linefeed sequence. Use the formfeed keyword when using the line printer daemon (lpd) protocol to print and your system is unable to separate individual output jobs with a form feed (page eject). You can enter the newline-convert and formfeed keywords together and in any order.

Examples The following example shows how to configure a printer named printer1 and to assign the output to tty line

Router# configure terminal

Router(config)# printer printer1 line 4

Related Commands

Command

clear line

Description

Returns a terminal line to idle state.

582

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q private

private

To save user EXEC command changes between terminal sessions, use the private command in line configuration mode. To restore the default condition, use the no form of this command.

private

no private

Syntax Description This command has no arguments or keywords.

Command Default

User-set configuration options are cleared with the exit EXEC command or when the interval set with the

exec-timeout line configuration command has passed.

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command ensures that the terminal parameters set by the user remain in effect between terminal sessions. This behavior is desirable for terminals in private offices.

Examples In the following example, line 15 (in this example, vty 1) is configured to keep all user-supplied settings at system restarts:

Router(config)# line 15

Router(config-line)# private

Related Commands

Command exec-timeout

Description

Sets the interval that the EXEC command interpreter waits until user input is detected.

Cisco IOS Configuration Fundamentals Command Reference

583

private

Command exit monitor event-trace through Q

Description

Exits any configuration mode, or closes an active terminal session and terminates the EXEC.

584

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q process cpu statistics limit entry-percentage

process cpu statistics limit entry-percentage

To set the process entry limit and the size of the history table for CPU utilization statistics, use the process

cpu statistics limit entry-percentage command in global configuration mode. To disable CPU utilization statistics, use the no form of this command.

process cpu statistics limit entry-percentage number [size seconds]

no process cpu statistics limit entry-percentage

Syntax Description number

size seconds

Integer from 1 to 100 that indicates the percentage of CPU utilization that a process must use to become part of the history table.

(Optional) Changes the duration of time in seconds for which CPU statistics are stored in the history table. Valid values are 5 to 86400. The default is

600.

Command Default size seconds: 600 seconds

Command Modes Global configuration

Command History

Release

12.0(26)S

12.3(4)T

12.2(25)S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.3(4)T.

This command was integrated into Cisco IOS

Release 12.2(25)S.

Usage Guidelines

Use the process cpu statistics limit entry-percentage command to set the entry limit and size of CPU utilization statistics.

Examples The following example shows how to set an entry limit at 40 percent and a size of 300 seconds: configure terminal

Cisco IOS Configuration Fundamentals Command Reference

585

monitor event-trace through Q process cpu statistics limit entry-percentage process cpu statistics limit entry-percentage 40 size 300 end

Related Commands

Command

process cpu threshold type

snmp-server enable traps cpu

snmp-server host

Description

Defines CPU usage thresholds that, when crossed, cause a CPU threshold notification.

Enables CPU threshold violations traps.

Specifies the recipient of SNMP notifications.

586

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q process cpu threshold type

process cpu threshold type

To set CPU thresholding notification types and values, use the process cpu threshold type command in global configuration mode. To disable CPU thresholding notifications, use the no form of this command.

process cpu threshold type {total | process | interrupt} rising percentage interval seconds

[falling fall-percentage interval seconds]

no process cpu threshold type {total | process | interrupt}

Syntax Description total process interrupt

rising percentage

interval seconds

falling fall-percentage

Sets the CPU threshold type to total CPU utilization.

Sets the CPU threshold type to CPU process utilization.

Sets the CPU threshold type to CPU interrupt utilization.

The percentage (1 to 100) of CPU resources that, when exceeded for the configured interval, triggers a CPU thresholding notification.

The duration of the CPU threshold violation, in seconds (5 to 86400), that must be met to trigger a

CPU thresholding notification.

(Optional) The percentage (1 to 100) of CPU resources that, when usage falls below this level for the configured interval, triggers a CPU thresholding notification.

• This value must be equal to or less than the

rising percentage value.

• If not specified, the falling fall-percentage value is set to the same value as the rising

percentage value.

Command Default CPU thresholding notifications are disabled.

Command Modes Global configuration

Cisco IOS Configuration Fundamentals Command Reference

587

monitor event-trace through Q process cpu threshold type

Command History

Release

12.0(26)S

12.3(4)T

12.2(25)S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.3(4)T.

This command was integrated into Cisco IOS

Release 12.2(25)S.

Usage Guidelines This command defines CPU usage thresholds that, when crossed, cause a CPU thresholding notification.

When this command is enabled, Cisco IOS software polls the system at the configured interval.

Notification occurs in two situations:

• When a configured CPU usage threshold is exceeded (rising percentage)

• When CPU usage falls below the configured threshold (falling fall-percentage)

Examples The following example shows how to set the total CPU utilization notification threshold at 80 percent for a rising threshold notification and 20 percent for a falling threshold notification, with a 5-second polling interval: configure terminal

process cpu threshold type total rising 80 interval 5 falling 20 interval 5 end

Related Commands

Command

process cpu statistics limit entry

snmp-server enable traps cpu

snmp-server host

Description

Sets the entry limit and size of CPU utilization statistics.

Enables CPU threshold violations traps.

Specifies the recipient of SNMP notifications.

588

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q process-max-time

process-max-time

To configure the amount of time after which a process should voluntarily yield to another process, use the

process-max-timecommand in global configuration mode. To reset this value to the system default, use the

no form of this command.

process-max-time milliseconds

no process-max-time milliseconds

Syntax Description milliseconds Maximum duration (in milliseconds) that a process can run before suspension. The range is from 20to

200 milliseconds.

Command Default The default maximum process time is 200 milliseconds.

Command Modes Global configuration

Command History

Release

12.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Lowering the maximum time a process can run is useful in some circumstances to ensure equitable division of CPU time among different tasks.

Only use this command if recommended to do so by the Cisco Technical Assistance Center (TAC).

Examples

The following example limits the duration that a process will run to 100 milliseconds:

Router(config)# process-max-time 100

Cisco IOS Configuration Fundamentals Command Reference

589

monitor event-trace through Q prompt

prompt

To customiz e the CLI prompt, use the promptcommand in global configuration mode. To revert to the default prompt, use the noform of this command.

prompt string

no prompt [string]

Syntax Description string Text that will be displayed on screen as the CLI prompt, including any desired prompt variables.

Command Default

The default prompt is either Router or the name defined with the hostname global configuration command, followed by an angle bracket (>) for user EXEC mode or a pound sign (#) for privileged EXEC mode.

Command Modes Global configuration

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You can include customized variables when specifying the prompt. All prompt variables are preceded by a percent sign (%). The table below lists the available prompt variables.

Table 40 Custom Prompt Variables

Prompt Variable

Interpretation

Host name. This is either Router or the name defined with the hostname global configuration command.

Physical terminal line (tty) number of the EXEC user.

590

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q prompt

Prompt Variable

Interpretation

Prompt character itself. It is either an angle bracket

(>) for user EXEC mode or a pound sign (#) for privileged EXEC mode.

Space.

Tab.

Percent sign (%)

Issuing the prompt %h command has the same effect as issuing the no prompt command.

Examples The following example changes the EXEC prompt to include the tty number, followed by the name and a space:

Router(config)# prompt TTY%n@%h%s%p

The following are examples of user and privileged EXEC prompts that result from the previous command:

TTY17@Router1 > enable

TTY17@Router1 #

Related Commands

Command hostname

Description

Specifies or modifies the host name for the network server.

Cisco IOS Configuration Fundamentals Command Reference

591

monitor event-trace through Q prompt config

prompt config

To configure the system’s prompt for configuration mode, use the prompt config command in global configuration mode. To disable the configuration, use the no form of this command.

prompt config hostname-length number

no prompt [config]

Syntax Description hostname-length number

Sets the length of the hostname in the configuration prompt.

Maximum length of the hostname. The range is from 0 to 80.

Command Default The system's prompt is not configured for configuration mode.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Examples

This example shows how to configure the system’s prompt for configuration mode:

Router(config)#

prompt config hostname-length 4

Related Commands

Command prompt

Description

Customizes the CLI prompt.

592

Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace through Q pwd

pwd

To show the current setting of the cd command, use the pwd command in EXEC mode.

pwd

Syntax Description This command has no arguments or keywords.

Command Modes User EXEC

Priviledged EXEC

Command History

Release

11.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use the pwd command to show which directory or file system is specified as the default by the cd command. For all EXEC commands that have an optional filesystemargument, the system uses the file system specified by the cd command when you omit the optional filesystemargument.

For example, the dir command contains an optional filesystemargument and displays a list of files on a particular file system. When you omit this filesystemargument, the system shows a list of the files on the file system specified by the cd command.

Examples The following example shows that the present working file system specified by the cd command is slot 0:

Router> pwd slot0:/

The following example uses the cd command to change the present file system to slot 1 and then uses the

pwd command to display that present working file system:

Router> cd slot1:

Router> pwd slot1:/

Cisco IOS Configuration Fundamentals Command Reference

593

pwd

Related Commands

Command cd dir monitor event-trace through Q

Description

Changes the default directory or file system.

Displays a list of files on a file system.

594

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Cisco IOS Configuration Fundamentals Command Reference

595

R through setup refuse-message

refuse-message

To define and enable a line-in-use message, use the refuse-message command in line configuration mode.

To disable the message, use the noform of this command.

refuse-message d message d

no refuse-message

Syntax Description d message

Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting character in the message.

Message text.

Command Default Disabled (no line-in-use message is displayed).

Command Modes Line configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

You cannot use the delimiting character within the text of the message.

When you define a message using this command, the Cisco IOS software performs the following steps:

1 Accepts the connection.

2 Prints the custom message.

3 Clears the connection.

Examples In the following example, line 5 is configured with a line-in-use message, and the user is instructed to try again later: line 5

596

Cisco IOS Configuration Fundamentals Command Reference

R through setup refuse-message /The dial-out modem is currently in use.

Please try again later./ refuse-message

Cisco IOS Configuration Fundamentals Command Reference

597

R through setup regexp optimize

regexp optimize

To optimize the compilation of a regular expression access list, use the regexp optimize command in global configuration mode. To disable the configuration, use the no form of this command.

regexp optimize

no regexp optimize

Syntax Description This command has no arguments or keywords.

Command Default The command is enabled by default.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Examples

The following example shows how to optimize the compilation of regular expression access list:

Router# configure terminal

Router(config)# regexp optimize

Related Commands

Command

regexp (profile map configuration)

Description

Creates an entry in a cache profile group that allows authentication and authorization matches based on a regular expression.

598

Cisco IOS Configuration Fundamentals Command Reference

R through setup reload

reload

To reload the operating system, use the reload command in privileged EXEC or diagnostic mode.

reload [/verify | /noverify] [[warm file] [line | in [hhh:mm | mmm [text]] | at hh:mm [day month]

[text]] | reason [reason-string] | cancel]

Syntax Description

/verify

/noverify warm file line

in hhh : mm | mmm text

at hh : mm day

(Optional) Verifies the digital signature of the file that will be loaded onto the operating system.

(Optional) Does not verify the digital signature of the file that will be loaded onto the operating system.

Note This keyword is often issued if the file

verify auto command is enabled, which automatically verifies the digital signature of all images that are copied.

(Optional) Specifies warm rebooting.

(Optional) Specifies the image file for warm rebooting.

(Optional) Reason for reloading; the string can be from 1 to 255 characters long.

(Optional) Schedules a reload of the software to take effect in the specified minutes or hours and minutes. The reload must take place within approximately 24 days.

(Optional) Reason for reloading; the string can be from 1 to 255 characters long.

(Optional) Schedules a reload of the software to take place at the specified time (using a 24-hour clock). If you specify the month and day, the reload is scheduled to take place at the specified time and date. If you do not specify the month and day, the reload takes place at the specified time on the current day (if the specified time is later than the current time) or on the next day (if the specified time is earlier than the current time). Specifying

00:00 schedules the reload for midnight. The reload must take place within 24 days.

(Optional) Number of the day in the range from 1 to

31.

Cisco IOS Configuration Fundamentals Command Reference

599

R through setup reload month

reason reason-string cancel

Command Modes

Privileged EXEC (#) Diagnostic (diag)

Command History

Release

10.0

12.2(14)SX

12.3(2)T

12.2(18)S

12.2(20)S

12.0(26)S

12.3(4)T

12.2(17d)SXB

12.3(11)T

12.2(28)SB

12.2(33)SRA

Month of the year.

(Optional) Specifies a reason for reloading.

(Optional) Cancels a scheduled reload.

Modification

This command was introduced.

This command was modified. Support for this command was added for the Supervisor Engine

720.

This command was modified. The warm keyword was added.

This command was integrated into Cisco IOS

Release 12.2(18)S. The /verifyand /noverify keywords were added.

This command was modified. Support was added for the Cisco 7304 router. The Cisco 7500 series router in not supported in Cisco IOS Release

12.2(20)S.

This command was modified. The /verifyand /

noverify keywords were integrated into Cisco IOS

Release 12.0(26)S.

This command was modified. The /verifyand /

noverify keywords were integrated into Cisco IOS

Release 12.3(4)T.

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

This command was modified. The file keyword and

url argument were added.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

600

Cisco IOS Configuration Fundamentals Command Reference

R through setup reload

Release

15.0(1)M

Cisco IOS XE Release 2.1

Modification

This command was modified. The reason keyword and reason-stringargument were added.

This command was introduced on the Cisco ASR

1000 Series Aggregation Services Router and was made available in diagnostic mode.

Usage Guidelines

The reload command halts the system. If the system is set to restart on error, it reboots itself. Use the

reload command after configuration information is entered into a file and saved to the startup configuration.

You cannot reload from a virtual terminal if the system is not set up for automatic booting. This restriction prevents the system from using an image stored in the ROM monitor and taking the system out of the remote user’s control.

If you modify your configuration file, the system prompts you to save the configuration. During a save operation, the system prompts whether you want to proceed with the save if the CONFIG_FILE variable points to a startup configuration file that no longer exists. If you respond “yes” in this situation, the system enters setup mode upon reload.

When you schedule a reload to occur at a later time (using the in keyword), it must take place within 24 days.

The at keyword can be used only if the system clock has been set on the router (either through Network

Time Protocol [NTP], the hardware calendar, or manually). The time is relative to the configured time zone on the router. To schedule reloads across several routers to occur simultaneously, synchronize the time on each router with NTP.

When you specify the reload time using the at keyword, if you specify the month and day, the reload takes place at the specified time and date. If you do not specify the month and day, the reload takes place at the specified time on the current day (if the specified time is later than the current time), or on the next day (if the specified time is earlier than the current time). Specifying 00:00 schedules the reload for midnight. The reload must take place within 24 days.

To display information about a scheduled reload, use the show reload command.

The /verify and /noverify Keywords

If the /verify keyword is specified, the integrity of the image will be verified before it is reloaded onto a router. If verification fails, the image reload will not occur. Image verification is important because it assures the user that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user.

The /noverify keyword overrides any global automatic image verification that may be enabled via the file

verify auto command.

The warm Keyword

If you issue the reload command after you have configured the warm-reboot global configuration command, a cold reboot will occur. Thus, if you want to reload your system, but do not want to override the warm reboot functionality, you should specify the warm keyword with the reload command. The warm reboot functionality allows a Cisco IOS image to reload without ROM monitor intervention. That is, readwrite data is saved in RAM during a cold startup and restored during a warm reboot. Warm rebooting

Cisco IOS Configuration Fundamentals Command Reference

601

R through setup reload allows the router to reboot quicker than conventional rebooting (where control is transferred to ROM monitor and back to the image) because nothing is copied from flash to RAM.

Examples The following example shows how to immediately reload the software on the router:

Router# reload

The following example shows how to reload the software on the router in 10 minutes:

Router# reload in 10

Router# Reload scheduled for 11:57:08 PDT Fri Apr 21 1996 (in 10 minutes)

Proceed with reload? [confirm]

The following example shows how to reload the software on the router at 1:00 p.m. on that day:

Router# reload at 13:00

Router# Reload scheduled for 13:00:00 PDT Fri Apr 21 1996 (in 1 hour and 2 minutes)

Proceed with reload? [confirm]

The following example shows how to reload the software on the router on April 21 at 2:00 a.m.:

Router# reload at 02:00 apr 21

Router# Reload scheduled for 02:00:00 PDT Sat Apr 21 1996 (in 38 hours and 9 minutes)

Proceed with reload? [confirm]

The following example shows how to cancel a pending reload:

Router# reload cancel

%Reload cancelled.

The following example shows how to perform a warm reboot at 4:00 a.m. on that day:

Router# reload warm at 04:00

The following example shows how to specify a reason for the reload:

Router# reload reason reloaded with updated version

The following example shows how to specify image verification via the /verify keyword before reloading an image onto the router:

Router# reload /verify

Verifying file integrity of bootflash:c7200-kboot-mz.121-8a.E

%ERROR:Signature not found in file bootflash:c7200-kboot-mz.121-8a.E.

Signature not present. Proceed with verify? [confirm]

Verifying file disk0:c7200-jsmz ..........................................................................

............................................................Done!

Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCD

Computed Hash MD5 :CFA258948C4ECE52085DCF428A426DCD

CCO Hash MD5 :44A7B9BDDD9638128C35528466318183

Signature Verified

Proceed with reload? [confirm]n

Related Commands

Command

copy system:running-config nvram:startup- config

Description

Copies any file from a source to a destination.

602

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Command

file verify auto

show reload warm-reboot reload

Description

Enables automatic image verification.

Displays the reload status on the router.

Enables router reloading with reading images from storage.

Cisco IOS Configuration Fundamentals Command Reference

603

R through setup remote command

remote command

To execute a Cisco 7600 series router command directly on the switch console or a specified module without having to log into the Cisco 7600 series router first, use the remote command command in privileged EXEC mode.

remote command {module num | standby-rp | switch} command

Syntax Description

module num standby-rp switch command

Specifies the module to access; see the “Usage

Guidelines” section for valid values.

Specifies the standby route processor.

Specifies the active switch processor.

Command to be executed.

Command Default

This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(18)SXD

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

The standby-rp keyword was added.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The module num keyword and argument designate the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values are from 1 to 13. The module num keyword and argument are supported on DFC-equipped modules and the standby supervisor engine only.

When you execute the remote command switchcommand, the prompt changes to Switch-sp#.

This command is supported on DFC-equipped modules and the supervisor engine only.

604

Cisco IOS Configuration Fundamentals Command Reference

R through setup remote command

This command does not support command completion, but you can use shortened forms of the command

(for example, entering sh for show).

Examples This example shows how to execute the show calendar command from the standby route processor:

Router# remote command standby-rp show calendar

Switch-sp#

09:52:50 UTC Mon Nov 12 2001

Router#

Related Commands

Command

remote login

Description

Accesses the Cisco 7600 series router console or a specific module.

Cisco IOS Configuration Fundamentals Command Reference

605

R through setup remote login

remote login

To access the Cisco 7600 series router console or a specific module, use the remote login command in privileged EXEC mode.

remote login {module num | standby-rp | switch}

Syntax Description

module num standby-rp switch

Specifies the module to access; see the “Usage

Guidelines” section for valid values.

Specifies the standby route processor.

Specifies the active switch processor.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(18)SXD

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was changed to include the

standby-rp keyword.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Caution When you enter the attach or remote login command to access another console from your switch, if you enter global or interface configuration mode commands, the switch might reset.

The module num keyword and argument designate the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values are from 1 to 13. The module num keyword and argument are supported on DFC-equipped modules and the standby supervisor engine only.

606

Cisco IOS Configuration Fundamentals Command Reference

R through setup remote login

When you execute the remote login module num command, the prompt changes to Router-dfcx# or

Switch-sp#, depending on the type of module to which you are connecting.

When you execute the remote login standby-rp command, the prompt changes to Router-sdby#.

When you execute the remote login switch command, the prompt changes to Switch-sp#.

The remote login module num command is identical to the attach command.

There are two ways to end the session:

• You can enter the exit command as follows:

Switch-sp# exit

[Connection to Switch closed by foreign host]

Router#

• You can press Ctrl-C three times as follows:

Switch-sp# ^C

Terminate remote login session? [confirm] y

[Connection to Switch closed by local host]

Router#

Examples This example shows how to perform a remote login to a specific module:

Router# remote login module 1

Trying Switch ...

Entering CONSOLE for Switch

Type "^C^C^C" to end this session

Switch-sp#

This example shows how to perform a remote login to the Cisco 7600 series router processor:

Router# remote login switch

Trying Switch ...

Entering CONSOLE for Switch

Type "^C^C^C" to end this session

Switch-sp#

This example shows how to perform a remote login to the standby route processor:

Router# remote login standby-rp

Trying Switch ...

Entering CONSOLE for Switch

Type "^C^C^C" to end this session

Router-sdby#

Related Commands

Command attach

Description

Connects to a specific module from a remote location.

Cisco IOS Configuration Fundamentals Command Reference

607

R through setup remote-span

remote-span

To configure a virtual local area network (VLAN) as a remote switched port analyzer (RSPAN) VLAN, use the remote-span command in config-VLAN mode. To remove the RSPAN designation, use the no form of this command.

remote-span

no remote-span

Syntax Description This command has no arguments or keywords.

Command Default

This command has no default settings.

Command Modes Config-VLAN mode

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is not supported in the VLAN database mode.

You can enter the show vlan remote-span command to display the RSPAN VLANs in the Cisco 7600 series router.

Examples This example shows how to configure a VLAN as an RSPAN VLAN:

Router(config-vlan)# remote-span

Router(config-vlan)

This example shows how to remove the RSPAN designation:

Router(config-vlan)# no remote-span

Router(config-vlan)

608

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Related Commands

Connect

show vlan remote-span remote-span

Description

Displays a list of RSPAN VLANs.

Cisco IOS Configuration Fundamentals Command Reference

609

R through setup rename

rename

To rename a file in a Class C Flash file system, use the rename command in EXEC, privileged EXEC, or diagnostic mode.

rename url1 url2

Syntax Description url1 url2

The original path and filename.

The new path and filename.

Command Modes User EXEC (>)

Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

11.3 AA

12.2(33)SRA

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco ASR

1000 Series Router and was made available in diagnostic mode.

Usage Guidelines This command is valid only on Class C Flash file systems.

Examples In the following example, the file named Karen.1 is renamed test:

Router# dir

Directory of disk0:/Karen.dir/

0 -rw- 0 Jan 21 1998 09:51:29 Karen.1

0 -rw- 0 Jan 21 1998 09:51:29 Karen.2

0 -rw- 0 Jan 21 1998 09:51:29 Karen.3

0 -rw- 0 Jan 21 1998 09:51:31 Karen.4

243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur

340492288 bytes total (328400896 bytes free)

Router# rename disk0:Karen.dir/Karen.1 disk0:Karen.dir/test

Router# dir

Directory of disk0:/Karen.dir/

610

Cisco IOS Configuration Fundamentals Command Reference

R through setup

0 -rw- 0 Jan 21 1998 09:51:29 Karen.2

0 -rw- 0 Jan 21 1998 09:51:29 Karen.3

0 -rw- 0 Jan 21 1998 09:51:31 Karen.4

243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur

0 -rw- 0 Apr 24 1998 09:49:19 test

340492288 bytes total (328384512 bytes free) rename

Cisco IOS Configuration Fundamentals Command Reference

611

R through setup request platform software package describe file

request platform software package describe file

To gather descriptive information about an individual module or a Cisco IOS-XE image file, use the

request platform software package describe filecommand in privileged EXEC or diagnostic mode.

request platform software package describe file URL [detail] [verbose]

Syntax Description

URL detail verbose

Specifies the URL to the file. The URL contains the file system, directories, and the filename.

Specifies detailed output.

Displays verbose information, meaning all information that can be displayed on the console about the file will be displayed.

Command Default No default behavior or values.

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines This command can only be used to gather information on individual module and Cisco IOS-XE image files.

Using this command to collect information on any other file will generate output, but the generated output is useless.

The output of this command can be used for the following functions:

• To confirm the individual module files that are part of a Cisco IOS-XE image.

• To confirm whether or not a file is bootable.

• To confirm the contexts in which a file must be reloaded or booted.

• To confirm whether or not a file is corrupted.

• To confirm file and header sizes, build dates, and various other general information.

612

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Examples request platform software package describe file

In the following example, this command is entered to gather information about an individual SIP Base module file on the bootflash: file system.

Router# request platform software package describe file bootflash:asr1000rp1- sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Package: asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 36954316

Timestamp: 2007-12-05 15:36:27 UTC

Canonical path: /bootflash/asr1000rp1sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Raw disk-file SHA1sum:

3ee37cdbe276316968866b16df7d8a5733a1502e

Computed SHA1sum:

f2db80416a1245a5b1abf2988088860b38ce7898

Contained SHA1sum:

f2db80416a1245a5b1abf2988088860b38ce7898

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 10000

Package flags: 0

Header version: 0

Internal package information:

Name: cc

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: sipbase

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is bootable on SIP when specified

by packages provisioning file.

In the following example, this command is used to gather information about a Cisco IOS-XE image on the bootflash: file system.

Router# request platform software package describe file bootflash:ASR1000rp1- advipservicesk9.01.00.00.12-33.XN.bin

Package: ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin

Size: 218783948

Timestamp: 2007-12-04 17:14:09 UTC

Canonical path: /bootflash/ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin

Raw disk-file SHA1sum:

d2999fc7e27e01344903a42ffacd62c156eba4cc

Computed SHA1sum:

5f8cda8518d01d8282d80ecd34f7715783f4a813

Contained SHA1sum:

5f8cda8518d01d8282d80ecd34f7715783f4a813

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 30000

Package flags: 0

Header version: 0

Internal package information:

Name: rp_super

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: advipservicesk9

Cisco IOS Configuration Fundamentals Command Reference

613

R through setup request platform software package describe file

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is bootable from media and tftp.

Package contents:

Package: asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 52072652

Timestamp: 2007-12-04 13:33:13 UTC

Raw disk-file SHA1sum:

f1aad6d687256aa327a4efa84deab949fbed12b8

Computed SHA1sum:

15502fd1b8f9ffd4af4014ad4d8026c837929fe6

Contained SHA1sum:

15502fd1b8f9ffd4af4014ad4d8026c837929fe6

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 20000

Package flags: 0

Header version: 0

Internal package information:

Name: fp

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: espbase

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is bootable on ESP when specified

by packages provisioning file.

Package: asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 21844172

Timestamp: 2007-12-04 13:33:01 UTC

Raw disk-file SHA1sum:

025e6159dd91cef9d254ca9fff2602d8ce065939

Computed SHA1sum:

ea1b358324ba5815b9ea623b453a98800eae1c78

Contained SHA1sum:

ea1b358324ba5815b9ea623b453a98800eae1c78

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 30004

Package flags: 0

Header version: 0

Internal package information:

Name: rp_security

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: rpaccess-k9

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is not bootable.

Package: asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 21520588

Timestamp: 2007-12-04 13:33:06 UTC

614

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package describe file

Raw disk-file SHA1sum:

432dfa61736d8a51baefbb2d70199d712618dcd2

Computed SHA1sum:

83c0335a3adcea574bff237a6c8640a110a045d4

Contained SHA1sum:

83c0335a3adcea574bff237a6c8640a110a045d4

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 30001

Package flags: 0

Header version: 0

Internal package information:

Name: rp_base

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: rpbase

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is bootable on RP when specified

by packages provisioning file.

Package: asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 24965324

Timestamp: 2007-12-04 13:33:08 UTC

Raw disk-file SHA1sum:

eb964b33d4959c21b605d0989e7151cd73488a8f

Computed SHA1sum:

19b58886f97c79f885ab76c1695d1a6f4348674e

Contained SHA1sum:

19b58886f97c79f885ab76c1695d1a6f4348674e

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 30002

Package flags: 0

Header version: 0

Internal package information:

Name: rp_daemons

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: rpcontrol

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is not bootable.

Package: asr1000rp1-rpiosadvipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 48515276

Timestamp: 2007-12-04 13:33:13 UTC

Raw disk-file SHA1sum:

bc13462d6a4af7a817a7346a44a0ef7270e3a81b

Computed SHA1sum:

f1235d703cc422e53bce850c032ff3363b587d70

Contained SHA1sum:

f1235d703cc422e53bce850c032ff3363b587d70

Hashes match. Package is valid.

Cisco IOS Configuration Fundamentals Command Reference

615

R through setup request platform software package describe file

Header size: 204 bytes

Package type: 30003

Package flags: 0

Header version: 0

Internal package information:

Name: rp_iosd

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: rpios-advipservicesk9

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is not bootable.

Package: asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 36954316

Timestamp: 2007-12-04 13:33:11 UTC

Raw disk-file SHA1sum:

3ee37cdbe276316968866b16df7d8a5733a1502e

Computed SHA1sum:

f2db80416a1245a5b1abf2988088860b38ce7898

Contained SHA1sum:

f2db80416a1245a5b1abf2988088860b38ce7898

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 10000

Package flags: 0

Header version: 0

Internal package information:

Name: cc

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

Platform: ASR1000

User: mcpre

PackageName: sipbase

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is bootable on SIP when specified

by packages provisioning file.

Package: asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Size: 19933388

Timestamp: 2007-12-04 13:33:06 UTC

Raw disk-file SHA1sum:

44b6d15cba31fb0e9b27464665ee8a24b92adfd2

Computed SHA1sum:

b1d5faf093b183e196c7c8e1023fe1f7aafdd36d

Contained SHA1sum:

b1d5faf093b183e196c7c8e1023fe1f7aafdd36d

Hashes match. Package is valid.

Header size: 204 bytes

Package type: 10001

Package flags: 0

Header version: 0

Internal package information:

Name: cc_spa

BuildTime: 2007-12-04_05.24

ReleaseDate: Tue 04-Dec-07 01:00

RouteProcessor: rp1

616

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package describe file

Platform: ASR1000

User: mcpre

PackageName: sipspa

Build: v122_33_xn_asr_rls0_throttle_20071204_051318

Package is not bootable.

Related Commands

Command

request platform software package install file

Description

Upgrades an individual package or a superpackage file.

Cisco IOS Configuration Fundamentals Command Reference

617

R through setup request platform software package expand file

request platform software package expand file

To extract the individual modules from a Cisco IOS-XE image, use the request platform software

package expand filecommand in privileged EXEC or diagnostic mode.

request platform software package expand file source-URL [to destination-URL] [force]

[verbose] [wipe]

Syntax Description source-URL

to destination-URL force verbose wipe

Specifies the URL to the Cisco IOS-XE file that stores the contents that will be extracted.

Specifies the destination URL where the files that were extracted from the Cisco IOS-XE file are left after the operation is complete.

If this option is not entered, the Cisco IOS-XE image file contents are extracted onto the same directory where the Cisco IOS-XE image file is currently stored.

(Optional) Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages.

(Optional) Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed.

(Optional) Erases all content on the destination snapshot directory before extracting the files and placing them on the snapshot directory.

Command Default No default behavior or values

Command Modes Privileged EXEC (#)

Diagnostic Mode (diag)

Command History

Release

IOS XE Release 2.1

Modification

This command was introduced.

618

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package expand file

Usage Guidelines This command only extracts individual module files and a provisioning file from the Cisco IOS-XE image.

Additional configuration is needed to configure the router to boot using the provisioning files and run using the individual modules.

When this command is used, copies of each module and the provisioning file within the Cisco IOS-XE image are copied and placed on the destination directory. The Cisco IOS-XE image file is unchanged after the operation is complete.

If the todestination-URL option is not entered, the Cisco IOS-XE image contents will be extracted onto the same directory where the Cisco IOS-XE image is currently stored.

If this command is used to extract individual module files onto a directory that already contains individual module files, the files that would have been extracted onto the same directory are instead extracted to an automatically created directory on the destination device.

Examples The following example shows how to extract the individual modules and the provisioning file from a Cisco

IOS-XE image that has already been placed in the directory where the user wants to store the individual modules and the provisioning file.

Output of the directory before and after the extraction is given to confirm the files were extracted.

Router# dir bootflash:

Directory of bootflash:/

11 drwx 16384 Dec 4 2007 11:26:07 +00:00 lost+found

14401 drwx 4096 Dec 4 2007 11:27:41 +00:00 .installer

12 -rw- 218783948 Dec 4 2007 12:12:16 +00:00 ASR1000rp1advipservicesk9.01.00.00.12-33.XN.bin

Router# request platform software package expand file bootflash:ASR1000rp1- advipservicesk9.01.00.00.12-33.XN.bin

Verifying parameters

Validating package type

Copying package files

Router# dir bootflash:

Directory of bootflash:/

11 drwx 16384 Dec 4 2007 11:26:07 +00:00 lost+found

14401 drwx 4096 Dec 4 2007 11:27:41 +00:00 .installer

12 -rw- 218783948 Dec 4 2007 12:12:16 +00:00 ASR1000rp1advipservicesk9.01.00.00.12-33.XN.bin

28803 -rw- 52072652 Dec 4 2007 12:14:17 +00:00 asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28804 -rw- 21844172 Dec 4 2007 12:14:17 +00:00 asr1000rp1-rpaccessk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28805 -rw- 21520588 Dec 4 2007 12:14:18 +00:00 asr1000rp1rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28806 -rw- 24965324 Dec 4 2007 12:14:19 +00:00 asr1000rp1rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28807 -rw- 48515276 Dec 4 2007 12:14:20 +00:00 asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28808 -rw- 36954316 Dec 4 2007 12:14:21 +00:00 asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28809 -rw- 19933388 Dec 4 2007 12:14:22 +00:00 asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

28802 -rw- 7145 Dec 4 2007 12:14:22 +00:00 packages.conf

928833536 bytes total (483700736 bytes free)

The following example shows how to extract the individual modules and the provisioning file from a Cisco

IOS-XE image that has already been placed on the router in a directory that will not store the individual modules and the provisioning file. In this particular example, the contents of a Cisco IOS-XE image stored in usb0: are extracted into bootflash:.

Output of the bootflash: directory before and after the extraction is given to confirm the files were extracted.

Router# dir usb0:

Cisco IOS Configuration Fundamentals Command Reference

619

R through setup request platform software package expand file

Directory of usb0:/

1120 -rwx 213225676 Dec 4 2007 10:50:36 +00:00 asr1000rp1advipservicesk9.v122_33_xn_asr_rls0_throttle.bin

Router# dir bootflash:

Directory of bootflash:/

11 drwx 16384 Dec 4 2007 12:32:46 +00:00 lost+found

86401 drwx 4096 Dec 4 2007 14:06:24 +00:00 .ssh

14401 drwx 4096 Dec 4 2007 14:06:36 +00:00 .rollback_timer

43201 drwx 4096 Dec 4 2007 12:34:45 +00:00 .installer

Router# request platform software package expand file usb0:asr1000rp1- advipservicesk9.v122_33_xn_asr_rls0_throttle.bin to bootflash:

Verifying parameters

Validating package type

Copying package files

Router# dir bootflash:

Directory of bootflash:/

11 drwx 16384 Dec 4 2007 12:32:46 +00:00 lost+found

86401 drwx 4096 Dec 4 2007 14:06:24 +00:00 .ssh

14401 drwx 4096 Dec 4 2007 14:06:36 +00:00 .rollback_timer

43201 drwx 4096 Dec 4 2007 12:34:45 +00:00 .installer

28803 -rw- 51986636 Dec 4 2007 16:40:38 +00:00 asr1000rp1espbase.v122_33_xn_asr_rls0_throttle.pkg

28804 -rw- 21838028 Dec 4 2007 16:40:39 +00:00 asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle.pkg

28805 -rw- 21508300 Dec 4 2007 16:40:39 +00:00 asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle.pkg

28806 -rw- 24963276 Dec 4 2007 16:40:40 +00:00 asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle.pkg

28807 -rw- 48419020 Dec 4 2007 16:40:41 +00:00 asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle.pkg

28808 -rw- 36946124 Dec 4 2007 16:40:43 +00:00 asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle.pkg

28809 -rw- 14670028 Dec 4 2007 16:40:43 +00:00 asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle.pkg

28802 -rw- 6563 Dec 4 2007 16:40:43 +00:00 packages.conf

928862208 bytes total (708186112 bytes free)

Related Commands

Command

request platform software package install file

Description

Upgrades an individual module or a Cisco IOS-XE file.

620

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install commit

request platform software package install commit

To cancel the rollback timer and commit a software upgrade, use the request platform software package

install commitcommand in privileged EXEC or diagnostic mode.

request platform software package install rp rp-slot-number commit [verbose]

Syntax Description

rp rp-slot-number commit verbose

Specifies the RP slot number.

Specifies that an upgrade that was done using a rollback timer that has not expired can be committed.

(Optional) Displays verbose information, meaning all information that can be displayed on the console during the process will be displayed.

Command Default No default behavior or values.

Command Modes Privileged EXEC (#)

Diagnostic Mode (diag)

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines

This command is entered after the request platform software package install rp rp-slot-number file command is used with the auto-rollback minutes option to begin an individual sub-package or a consolidated package upgrade. When the auto-rollback minutes option is used in this context, a rollback timer that cancels the upgrade after the number of specified minutescancels the upgrade if the request

platform software package install rp rp-slot-number commit command is not entered to commit the upgrade.

If this command is not entered after the request platform software package install rp rp-slot-number file command is used with the auto-rollback minutes option to upgrade an individual sub-package or a consolidated package and the rollback timer expires, the upgrade does not complete and the router continues running the previous sub-package or consolidated package.

Cisco IOS Configuration Fundamentals Command Reference

621

R through setup request platform software package install commit

Examples In the following example, this command is entered to commit an upgrade:

request platform software package install rp 1 commit

Related Commands

Command

request platform software package install file

request platform software package install rollback

Description

Upgrades a consolidated package or sub-package.

Rolls back a previous software upgrade.

622

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install file

request platform software package install file

To upgrade a consolidated package or an individual sub-package, use the request platform software

package install filecommand in privileged EXEC or diagnostic mode.

request platform software package install rp rp-slot-number file file-URL [auto-rollback minutes]

[provisioning-file URL] [slot slot-number] [bay bay-number] [force] [on-reboot] [verbose]

Syntax Description

rp rp-slot-number

file file-URL

auto-rollback minutes

provisioning-file provisioning-file-URL

slot slot-number

bay bay-number force on-reboot verbose

Specifies the RP slot number.

Specifies the URL to the consolidated package or sub-package.

Specifies the setting of a rollback timer, and sets the number of minutes on the rollback timer before the rollback timer expires.

Specifies the URL to the provisioning file. A provisioning file is used for booting only when a

Cisco ASR 1000 Series Router is booted using individual sub-packages.

Specifies the router slot number where a SIP can be installed.

Specifies the SPA bay number within a SIP.

Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages.

Specifies that the installation will not be completed until the next RP reboot.

Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed.

Command Default No default behavior or values.

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Cisco IOS Configuration Fundamentals Command Reference

623

R through setup request platform software package install file

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines This command is used to upgrade consolidated packages and individual sub-packages.

When this command is used to upgrade a SIPBASE sub-package, the slot slot-number of the SIP must be specified.

When this command is used to upgrade a SIPSPA sub-package, the slot slot-numberof the SIP and the bay

bay-number of the SPA must be specified.

When the auto-rollback minutes option is used, the request platform software package install rp rp-

slot-number commit command must be entered before the rollback timer expires to complete the upgrade.

If this command is not entered, the router rolls back to the previous software version. The rollback timer expires after the number of specified minutes. If the auto-rollback minutes option is not used, the upgrade simply occurs.

Examples

Managing and Configuring a consolidated package using the request platform package command

In the following example, the request platform software package install command is used to upgrade a consolidated package running on RP 0. The force option, which forces the upgrade past any prompt (such as already having the same consolidated package installed), is used in this example.

Router# request platform software package install rp 0 file bootflash:ASR1000rp1- advipservicesk9.01.00.00.12-33.XN.bin force

--- Starting installation state synchronization ---

Finished installation state synchronization

--- Starting file path checking ---

Finished file path checking

--- Starting image file verification ---

Checking image file names

Verifying image file locations

Locating image files and validating name syntax

Inspecting image file types

Processing image file constraints

Extracting super package content

Verifying parameters

Validating package type

Copying package files

Checking and verifying packages contained in super package

Creating candidate provisioning file

WARNING:

WARNING: Candidate software will be installed upon reboot

WARNING:

Finished image file verification

--- Starting candidate package set construction ---

Verifying existing software set

Processing candidate provisioning file

Constructing working set for candidate package set

Constructing working set for running package set

Checking command output

Constructing merge of running and candidate packages

Finished candidate package set construction

--- Starting compatibility testing ---

Determining whether candidate package set is compatible

624

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install file

WARNING:

WARNING: Candidate software combination not found in compatibility database

WARNING:

Determining whether installation is valid

Determining whether installation is valid ... skipped

Checking IPC compatibility with running software

Checking IPC compatibility with running software ... skipped

Checking candidate package set infrastructure compatibility

Checking infrastructure compatibility with running software

Checking infrastructure compatibility with running software ... skipped

Finished compatibility testing

--- Starting commit of software changes ---

Updating provisioning rollback files

Creating pending provisioning file

Committing provisioning file

Finished commit of software changes

SUCCESS: Software provisioned. New software will load on reboot.

Router# reload

Note A reload must be performed to finish this procedure.

SIP Sub-package Installation with Verbose Option

In the following example, the SIP sub-package for the SIP in slot 1 is installed using the request platform

software package installcommand. In this example, the force option, which forces the upgrade past any prompt (such as already having the same sub-package installed), and the verbose option, which displays all possible output during the installation, are used.

Router# request platform software package install rp 0 file bootflash:asr1000rp1- sipspa.v122_33_xn_asr_rls0_throttle.pkg slot 1 force verbose

--- Starting installation state synchronization ---

Finished installation state synchronization

--- Starting file path checking ---

Finished file path checking

--- Starting image file verification ---

Checking image file names

... file names checked

Verifying image file locations

... image file locations verified

Locating image files and validating name syntax

... image file names validated

Inspecting image file types

... image file types acceptable

Processing image file constraints

... constraints satisfied

Creating candidate provisioning file

... created candidate provisioning file

Finished image file verification

--- Starting candidate package set construction ---

Verifying existing software set

... verified existing software set is valid

Processing candidate provisioning file

... candidate provisioning file processed

Constructing working set for candidate package set

... working set constructed

Constructing working set for running package set

... working set for running package set constructed

Checking command output

... command output is consistent with command set

Constructing merge of running and candidate packages

... merged running and candidate packages

Finished candidate package set construction

--- Starting compatibility testing ---

Determining whether candidate package set is compatible

WARNING:

Cisco IOS Configuration Fundamentals Command Reference

625

R through setup request platform software package install file

WARNING: Candidate software combination not found in compatibility database

WARNING:

... candidate package set is valid

Determining whether installation is valid

Software is unchanged

Software sets are identified as compatible

... installation is valid

Checking IPC compatibility with running software calling minime_merge.sh for /tmp/tdlresolve/compat/_tmp_issu_provision_sw_ minime_merge done for /tmp/tdlresolve/compat/_tmp_issu_provision_sw_

... IPC is compatible with running software

Checking candidate package set infrastructure compatibility

... candidate package set infrastructure is compatible

Checking infrastructure compatibility with running software

... infrastructure is compatible with running software

Finished compatibility testing

--- Starting impact testing ---

Checking operational impact of change

... operational impact of change is allowable

Finished impact testing

--- Starting commit of software changes ---

Updating provisioning rollback files

... rollback provisioning files updated

Creating pending provisioning file

Ensuring that cached content is written to media

... cached content flushed to media

... pending provisioning file created

Committing provisioning file

Ensuring that cached content is written to media

... cached content flushed to media

... running provisioning file committed

Finished commit of software changes

--- Starting analysis of software changes ---

------------ changes to running software ------------

0 0 cc

-----------------------------------------------------

Finished analysis of software changes

--- Starting update running software ---

Blocking peer synchronization of operating information

... peer synchronization blocked

Creating the command set placeholder directory

Finding latest command set

... latest command set identified

Assembling CLI output libraries

... CLI output libraries assembled

Assembling CLI input libraries

... CLI input libraries assembled

Applying interim IPC and database definitions

interim IPC and database definitions applied

Replacing running software

... running software replaced

Replacing CLI software

... CLI software replaced

Restarting software

Restarting CC0

... software restarted

Applying interim IPC and database definitions

*Oct 9 09:52:25.333: %MCP_OIR-6-OFFLINECARD: Card (cc) offline in slot 0

*Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/0, interfaces disabled

*Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/1, interfaces disabled

*Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/2, interfaces disabled

*Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/3, interfaces disabled ... interim IPC and database definitions applied

Notifying running software of updates

... running software notified

Unblocking peer synchronization of operating information

... peer synchronization unblocked

... unmount of old packages scheduled

Unmounting old packages

626

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install file

... inactive old packages unmounted

Cleaning temporary installation files

... temporary installation files cleaned

Finished update running software

SUCCESS: Finished installing software.

Router#

Upgrading SIP Sub-package without using the verbose option

In the following example, the SIP sub-package for the SIP in slot 1 is installed using the request platform

software package installcommand. In this example, the force option, which forces the upgrade past any prompt (such as already having the same sub-package installed), is used. The verbose option is not used in this example.

Router# request platform software package install rp 0 file bootflash:asr1000rp1- sipspa.v122_33_xn_asr_rls0_throttle.pkg slot 1 force

--- Starting installation state synchronization ---

Finished installation state synchronization

--- Starting file path checking ---

Finished file path checking

--- Starting image file verification ---

Checking image file names

Verifying image file locations

Locating image files and validating name syntax

Inspecting image file types

Processing image file constraints

Creating candidate provisioning file

Finished image file verification

--- Starting candidate package set construction ---

Verifying existing software set

Processing candidate provisioning file

Constructing working set for candidate package set

Constructing working set for running package set

Checking command output

Constructing merge of running and candidate packages

Finished candidate package set construction

--- Starting compatibility testing ---

Determining whether candidate package set is compatible

WARNING:

WARNING: Candidate software combination not found in compatibility database

WARNING:

Determining whether installation is valid

Software sets are identified as compatible

Checking IPC compatibility with running software

Checking candidate package set infrastructure compatibility

Checking infrastructure compatibility with running software

Finished compatibility testing

--- Starting impact testing ---

Checking operational impact of change

Finished impact testing

--- Starting commit of software changes ---

Updating provisioning rollback files

Creating pending provisioning file

Committing provisioning file

Finished commit of software changes

--- Starting analysis of software changes ---

Finished analysis of software changes

--- Starting update running software ---

Blocking peer synchronization of operating information

Creating the command set placeholder directory

Finding latest command set

Assembling CLI output libraries

Assembling CLI input libraries

Applying interim IPC and database definitions

interim IPC and database definitions applied

Replacing running software

Replacing CLI software

Restarting software

Restarting CC1

Cisco IOS Configuration Fundamentals Command Reference

627

R through setup request platform software package install file

Restarting CC1

Applying interim IPC and database definitions

*Oct 9 09:54:55.365: %MCP_OIR-6-OFFLINECARD: Card (cc) offline in slot 1

*Oct 9 09:54:55.365: %MCP_OIR-6-REMSPA: SPA removed from subslot 1/1, interfaces disabled

*Oct 9 09:54:55.365: %MCP_OIR-6-REMSPA: SPA removed from subslot 1/2, interfaces disabled Notifying running software of updates

Unblocking peer synchronization of operating information

Unmounting old packages

Cleaning temporary installation files

Finished update running software

SUCCESS: Finished installing software.

Router#

Upgrading IOS Sub-package

In the following example, the request platform software package installcommand is used to upgrade an

IOS sub-package. In this example, the force option, which forces the upgrade past any prompt (such as already having the same module installed), is used.

Router# request platform software package install rp 0 file bootflash:asr1000rp1-rpios- advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg force

--- Starting installation state synchronization ---

Finished installation state synchronization

--- Starting file path checking ---

Finished file path checking

--- Starting image file verification ---

Checking image file names

Verifying image file locations

Locating image files and validating name syntax

Inspecting image file types

WARNING: In-service installation of IOSD package

WARNING: requires software redundancy on target RP

WARNING: or on-reboot parameter

WARNING: Automatically setting the on-reboot flag

Processing image file constraints

Creating candidate provisioning file

Finished image file verification

--- Starting candidate package set construction ---

Verifying existing software set

Processing candidate provisioning file

Constructing working set for candidate package set

Constructing working set for running package set

Checking command output

Constructing merge of running and candidate packages

Finished candidate package set construction

--- Starting compatibility testing ---

Determining whether candidate package set is compatible

WARNING:

WARNING: Candidate software combination not found in compatibility database

WARNING:

Determining whether installation is valid

Determining whether installation is valid ... skipped

Checking IPC compatibility with running software

Checking IPC compatibility with running software ... skipped

Checking candidate package set infrastructure compatibility

Checking infrastructure compatibility with running software

Checking infrastructure compatibility with running software ... skipped

Finished compatibility testing

--- Starting commit of software changes ---

Updating provisioning rollback files

Creating pending provisioning file

Committing provisioning file

Finished commit of software changes

SUCCESS: Software provisioned. New software will load on reboot.

Router#

Note that the new RPIOS sub-package will become active only after a reboot. Reboot the router to finish this procedure.

628

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install file

Upgrading SPA Sub-package

In the following example, the request platform software package installcommand is use to upgrade a

SIPSPA sub-package for the SPA in bay 0 of router slot 1. In this example, the force option, which forces the upgrade past any prompt (such as already having the same module installed), is used.

Router# request platform software package install rp 0 file bootflash:asr1000rp1- sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg slot 1 bay 0 force

--- Starting installation state synchronization ---

Finished installation state synchronization

--- Starting file path checking ---

Finished file path checking

--- Starting image file verification ---

Checking image file names

Verifying image file locations

Locating image files and validating name syntax

Inspecting image file types

Processing image file constraints

Creating candidate provisioning file

Finished image file verification

--- Starting candidate package set construction ---

Verifying existing software set

Processing candidate provisioning file

Constructing working set for candidate package set

Constructing working set for running package set

Checking command output

Constructing merge of running and candidate packages

Finished candidate package set construction

--- Starting compatibility testing ---

Determining whether candidate package set is compatible

WARNING:

WARNING: Candidate software combination not found in compatibility database

WARNING:

Determining whether installation is valid

Software sets are identified as compatible

Checking IPC compatibility with running software

Checking candidate package set infrastructure compatibility

Checking infrastructure compatibility with running software

Finished compatibility testing

--- Starting impact testing ---

Checking operational impact of change

Finished impact testing

--- Starting commit of software changes ---

Updating provisioning rollback files

Creating pending provisioning file

Committing provisioning file

Finished commit of software changes

--- Starting analysis of software changes ---

Finished analysis of software changes

--- Starting update running software ---

Blocking peer synchronization of operating information

Creating the command set placeholder directory

Finding latest command set

Assembling CLI output libraries

Assembling CLI input libraries

Applying interim IPC and database definitions

interim IPC and database definitions applied

Replacing running software

Replacing CLI software

Restarting software

Restarting SPA CC1/0

Applying interim IPC and database definitions

Notifying running software of updates

Unblocking peer synchronization of operating information

Unmounting old packages

Cleaning temporary installation files

Finished update running software

SUCCESS: Finished installing software.

Router#

Cisco IOS Configuration Fundamentals Command Reference

629

R through setup request platform software package install file

Related Commands

Command

request platform software package install commit

request platform software package install rollback

request platform software package install snapshot

Description

Cancel the rollback timer and commits a software upgrade.

Rolls back a previous software upgrade.

Creates a snapshot directory that will contain all the files extracted from a consolidated package.

630

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install rollback

request platform software package install rollback

To roll back a previous software upgrade, use the request platform software package install

rollbackcommand in privileged EXEC or diagnostic mode.

request platform software package install rp rp-slot-number rollback [as-booted | provisioning-

file provisioning-file-URL] [force] [on-reboot] [verbose]

Syntax Description

rp rp-slot-number as-booted

provisioning-file provisioning-file-URL force on-reboot verbose

Specifies the slot number of the RP doing the request.

Specifies that the software update will not occur, and that the router will instead boot using the same procedure that it used during the last bootup.

Specifies that the software update will not occur, and that the router will instead boot using the specified provisioning file.

Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages.

Specifies that the installation will not be completed until the next RP reboot.

Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed.

Command Default No default behavior or values

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

631

R through setup request platform software package install rollback

Usage Guidelines This command rolls back a configuration that has an active rollback timer. Active rollback timers are used when the auto-rollback option is entered when software is being upgraded using the request platform

software package install filecommand.

Examples In the following example, an upgrade that was using a rollback timer is rolled back to the previous configuration instead of upgraded: request platform software package install rp 0 rollback

Related Commands

Command

request platform software package install commit

request platform software package install file

Description

Cancel the rollback timer and commits a software upgrade.

Upgrades a consolidated package or an individual sub-package.

632

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software package install snapshot

request platform software package install snapshot

To create a snapshot directory that contains all the files extracted from a consolidated package, use the

request platform software package install snapshotcommand in privileged EXEC or diagnostic mode.

request platform software package install rp rp-slot-number snapshot to URL [as snapshot-

provisioning-filename] [force] [verbose] [wipe]

Syntax Description

rp rp-slot-number

snapshot to URL

as snapshot-provisioning-filename wipe force verbose

Specifies the slot number.

Creates a directory and extracts all files from the consolidated package into that directory. The directory is named in the command-line as part of the URL_FS.

If the URL_FSis specified as a file system, the files in the consolidated package will be extracted onto the file system and not a directory on the file system.

(Optional) Renames the provisioning file in the snapshot directory.

If this option is not used, the existing provisioning filename of the provisioning file in the consolidated package is used as the provisioning filename.

(Optional) Erases all content on the destination snapshot directory before extracting the files and placing them on the snapshot directory.

(Optional) Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages.

(Optional) Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed.

Command Default No default behavior or values

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Cisco IOS Configuration Fundamentals Command Reference

633

R through setup request platform software package install snapshot

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines This command is used to create a directory at the destination device and extract the individual subpackages in a consolidated package to that directory.

The request platform software package expand command is the only other command that can be used to extract individual sub-packages from a consolidated package.

Examples

In the following example, a snapshot directory named snapdir1_snap is created in the bootflash: file system, and the individual sub-package files from the consolidated package are extracted into the snapshot directory.

The second portion of the example first sets up the router to reboot using the files in the snapshot directory

(deletes all previous boot system commands, configures the configuration register, then enters a boot system command to boot using the extracted provisioning file), saves the new configuration, then reboots so the router will boot using the extracted provisioning file, which allows the router to run using the extracted individual sub-package files.

Router(diag)# request platform software package install rp 0 snapshot to bootflash:snapdir1_snap

--- Starting active image file snapshot --- Validating snapshot parameters Creating destination directory Copying files to destination media

Copied provisioning file as packages.conf

Copying package file asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1-rpiosadvipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1-rpaccessk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Copying package file asr1000rp1espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg

Moving files into final location Finished active image file snapshot

Router(config)# no boot system

Router(config)# config-register 0x1

Router(config)# boot system harddisk:snapdir1_snap/packages.conf

Router(config)# exit

*May 11 01:31:04.815: %SYS-5-CONFIG_I: Configured from console by con

Router# write mem

Building configuration...

[OK]

Router# reload

Related Commands

Command

request platform software package install file

Description

Upgrades a consolidated package or an indivual sub-package.

634

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software process release

request platform software process release

To restart processes that have been placed in the hold down state by the Process Manager on the Cisco ASR

1000 Series Routers, use the request platform software process releasecommand in privileged EXEC or diagnostic mode.

request platform software process release slot all

Syntax Description slot all

Specifies the hardware slot. Options include:

• number --The number of the SIP slot of the hardware module where the trace level is being set. For instance, if you wanted to specify the

SIP in SIP slot 2 of the router, enter 2 as the

number.

• f0 --The ESP in ESP slot 0.

• f1 --The ESP in ESP slot 1

• fp active --The active ESP.

• fp standby --The standby ESP.

• r0 --The RP in RP slot 0.

• r1 --The RP in RP slot 1.

• rp active --The active RP.

• rp standby --The standby RP.

Specifies that all processes currently in the holddown state within the selected slot will be restarted.

Command Default No default behavior or values

Command Modes

Privileged EXEC (#) Diagnostic Mode (diag)

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines This command is used to restart processes in the holddown state. If a process is in the holddown state, a console message is generated to notify the user that the process is helddown.

Before placing any process in the holddown state, the Process Manager makes up to 5 attempts over 120 seconds to enable the process. These attempts to enable the process also happen automatically at startup. If

Cisco IOS Configuration Fundamentals Command Reference

635

R through setup request platform software process release

Examples the Process Manager is unable to enable the process after these attempts, the process will then be placed in the holddown state.

When this command is entered, it only attempts to restart processes currently in the holddown state. Active processes will not be affected by entering this command.

In the following example, this command is entered to restart any process currently on RP 0 in the holddown state: request platform software process release r0 all

636

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software system shell

request platform software system shell

To request platform shell access, use the request platform software system shellcommand in privileged

EXEC mode.

request platform software system shell [rp | esp | sip]

Syntax Description rp esp sip

Specifies the Route Processor (RP); it can be either active or standby.

Specifies the Embedded Services Processor (ESP) control processor; it can be either active or standby.

Specifies the SPA Interface Processor (SIP).

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)XNC

Modification

This command was introduced.

Usage Guidelines The platform shell command needs to be entered before before using the request platform software system shell command. Providing shell access would not be necessary. However, there might be some cases where the command may not be available, or the IOS process hangs, or IOS console may not be available. In such cases, you can login to the shell and see the status of the system.

The shell should be accessed under Cisco supervision, and no support is provided if accessed without supervision. The following message is displayed , before the shell access is granted:

"Activity within this shell can jeopardize the functioning of the system.

Use this functionality only under supervision of Cisco Support."

Examples In the following example,

Router(config)# platform shell

Router(config)# exit

Router# request platform software shell system

Activity within this shell can jeopardize the functioning of the system.

Are you sure you want to continue? [y/n] y

**********************************************************************

Activity within this shell can jeopardize the functioning of the system.

Use this functionality only under supervision of Cisco Support.

Cisco IOS Configuration Fundamentals Command Reference

637

request platform software system shell

Related Commands

Command

platform shell

R through setup

Description

Grants shell and enters shell access grant configuration mode.

638

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software shell session output format

request platform software shell session output format

To modify the format of the output of some show commands on the Cisco ASR1000 Series Routers, use the request platform software shell session output formatcommand in privileged EXEC and diagnostic mode.

request platform software shell session output format format

Syntax Description format Specifies the output format for show command output. Options include:

• html --Specifies Hypertext Markup Language

(HTML) output.

• raw --Specifies the raw message output.

• text --Specifies plaintext output, which is the default.

• xml -- Specifies Extensible Markup Language

(XML) output

Command Default

All show command output is seen in plaintext (the text format)by default.

Command Modes Privileged EXEC (#) Diagnostic Mode (diag)

Command History

Release

IOS XE Release 2.1

Modification

This command was introduced

Usage Guidelines Entering this command can only change the output of some show commands that are available in both privileged EXEC and diagnostic mode. At the current time, most of these commands are show platform

software and show platform hardware commands.

Only a small subset of commands currently produce output using the html option.

Examples In the following example, the request platform software shell session output format command is used to change the show output format from text to raw. The output of the show platform hardware slot r0

alarms visual command is shown both before and after the request platform software shell session

output format command was entered to illustrate the change in output format.

Router# show platform hardware slot r0 alarms visual

Cisco IOS Configuration Fundamentals Command Reference

639

R through setup request platform software shell session output format

Current Visual Alarm States

Critical: On

Major : On

Minor : Off

Router# request platform software shell session output format raw

Router# show platform hardware slot r0 alarms visual message@alarms_msg: {

tdl_cman_alarms_data@tdl_cman_alarms_data: {

critical@tdl_boolean:TDL_TRUE

major@tdl_boolean:TDL_TRUE

minor@tdl_boolean:TDL_FALSE

}

} message@ui_req_msg: {

ui_req@ui_req: {

request_id@U64:2

client@ui_client: {

location@svc_loc: {

fru@b_fru:BINOS_FRU_RP

slotnum@I16:0

baynum@I16:0

}

client_type@ui_client_type:UICLIENT_INVALID

term_type@ui_terminal_type:UITT_INVALID

ttynum@U32:0

tty_name@NS:

user_name@NS:

}

command@NS:

request_name@NS:

flags@ui_req_flag:

}

In the following example, the request platform software shell session output format command is used to change the show output format from text to xml. The output of the show platform hardware slot r0

alarms visual command is shown both before and after the request platform software shell session

output format command was entered to illustrate the change in output format.

Router# show platform hardware slot r0 alarms visual

Current Visual Alarm States

Critical: On

Major : On

Minor : Off

Router# request platform software shell session output format xml

Router# show platform hardware slot r0 alarms visual

<?xml version="1.0"?>

<iossr-response action="3">

<cmd-response>

<alarms_msg><tdl_cman_alarms_data><critical><TDL_TRUE/></critical>

</tdl_cman_alarms_data>

</alarms_msg>

<ui_req_msg><ui_req><request_id>4</request_id>

</location>

<client_type><UICLIENT_INVALID/></client_type>

<term_type><UITT_INVALID/></term_type>

<tty_name></tty_name>

<user_name></user_name>

</client>

<request_name></request_name>

640

Cisco IOS Configuration Fundamentals Command Reference

R through setup

</ui_req>

</ui_req_msg>

</cmd-response>

</iossr-response> request platform software shell session output format

Cisco IOS Configuration Fundamentals Command Reference

641

R through setup request platform software snapshot

request platform software snapshot

To take a snapshot of the bootflash, use the request platform software snapshot command in privilege

EXEC mode.

request platform software snapshot slot {cancel | create | delete | restore} name

Syntax Description snapshot slot cancel create delete restore name

Requests snapshot actions.

Specifies the hardware slot. Options include:

• number --The number of the SIP slot of the hardware module where the trace level is being set. For instance, if you wanted to specify the

SIP in SIP slot 2 of the router, enter 2 as the

number.

• f0 --The ESP in ESP slot 0.

• f1 --The ESP in ESP slot 1

• fp active --The active ESP.

• fp standby --The standby ESP.

• r0 --The RP in RP slot 0.

• r1 --The RP in RP slot 1.

• rp active --The active RP.

• rp standby --The standby RP.

Cancels a snapshot operation.

Creates a snapshot

Deletes a snapshot

Restores a snapshot

Specifies the name of the snapshot to be modified.

Command Default No default behavior or values

Command Modes Privileged EXEC (#) Diagnostic Mode (diag)

642

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Command History

Release

Cisco IOS XE Release 2.1

request platform software snapshot

Modification

This command was introduced.

Usage Guidelines

Use the request platform software snapshot command to create a snapshot of the bootflash, including the

NVRAM partitions and the ROMMON memory, on the harddisk. This command can also be used to restore a snapshot.

Examples This example shows how to create a snapshot named "stan" on the processor in the RO slot.

router#request platform software snapshot R0 create stan

Related Commands

Command show platform software snapshot status

Description

Use this command to display a snapshot of the bootflash.

Cisco IOS Configuration Fundamentals Command Reference

643

R through setup request platform software vty attach

request platform software vty attach

To enter EXEC mode on a router after persistent SSH or persistent Telnet is configured to connect to the router in diagnostic mode, use the request platform software vty attachcommand in diagnostic mode.

request platform software vty attach [permanent]

Syntax Description permanent (Optional) Specifies that the router should not return to diagnostic mode if EXEC mode is exited.

Command Default No default behavior or values

Command Modes Diagnostic (diag)

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines If persistent Telnet or persistent SSH is configured to make users wait for an IOS vty line before allowing them to access the IOS CLI, this command can be used to attach to an IOS vty line and place the user in

EXEC mode. Exiting EXEC mode returns the user to diagnostic mode unless the permanent keyword is entered. When the permanent keyword is entered, exiting EXEC mode exits the router.

The vty lines must be configured to allow local login for this command to work. The vty lines must also be configured to accept the type of transport traffic (SSH or Telnet) being used to connect to the router for the session in which the request platform software vty attach command is entered.

Examples In the following example, this command is used to leave diagnostic mode and enter privileged EXEC mode:

Router(diag)# request platform software vty attach

Router#

In the following example, this command is used to leave diagnostic mode and enter privileged EXEC mode. The user then re-enters diagnostic mode by exiting privileged EXEC mode:

Router(diag)# request platform software vty attach

Router# exit

Router(diag)#

644

Cisco IOS Configuration Fundamentals Command Reference

R through setup request platform software vty attach

In the following example, this command is used with the permanent option to leave diagnostic mode and enter privileged EXEC mode. The user then exits the router by exiting privileged EXEC mode:

Router(diag)# request platform software vty attach permanent

Router# exit

Connection to Router closed.

Cisco IOS Configuration Fundamentals Command Reference

645

R through setup revision

revision

To set the revision number for the Multiple Spanning Tree (802.1s) (MST) configuration, use the revision command in MST configuration submode. To return to the default settings, use the no form of this command.

revision version

no revision

Syntax Description version Revision number for the configuration; valid values are from 0 to 65535.

Command Default

version is 0

Command Modes MST configuration (config-mst)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Two Cisco 7600 series routers that have the same configuration but different revision numbers are considered to be part of two different regions.

Caution Be careful when using the revision command to set the revision number of the MST configuration because a mistake can put the switch in a different region.

646

Cisco IOS Configuration Fundamentals Command Reference

R through setup revision

Examples This example shows how to set the revision number of the MST configuration:

Router(config-mst)# revision 5

Router(config-mst)#

Related Commands

Command instance

name (MST configuration submode) show

show spanning-tree

spanning-tree mst configuration

Description

Maps a VLAN or a set of VLANs to an MST instance.

Sets the name of an MST region.

Verifies the MST configuration.

Displays information about the spanning-tree state.

Enters MST-configuration submode.

Cisco IOS Configuration Fundamentals Command Reference

647

R through setup rmdir

rmdir

To remove an existing directory in a Class C Flash file system, use the rmdir command in EXEC, privileged EXEC, or diagnostic mode.

rmdir directory

Syntax Description directory Directory to delete.

Command Modes User EXEC

Privileged EXEC

Diagnostic

Command History

Release

11.3 AA

12.2(33)SRA

Cisco IOS XE Release 2.1

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco

ASR1000 Series Router and was made available in diagnostic mode.

Usage Guidelines This command is valid only on Class C Flash file systems.

Caution You can use the rmdir command to remove a directory that another user is currently accessing in read-only mode, for example if it is that user’s default working directory. If you use the rmdir command to remove such a directory and a user whose current directory is set to the deleted directory then uses the pwd command to display the current working directory, the following error message is displayed: Cannot determine current directory.

Examples The following example deletes the directory named newdir:

Router# dir

Directory of flash:

2 drwx 0 Mar 13 1993 13:16:21 newdir

648

Cisco IOS Configuration Fundamentals Command Reference

R through setup rmdir

8128000 bytes total (8126976 bytes free)

Router# rmdir newdir

Rmdir file name [newdir]?

Delete flash:newdir? [confirm]

Removed dir flash:newdir

Router# dir

Directory of flash:

No files in directory

8128000 bytes total (8126976 bytes free)

Related Commands

Command dir mkdir

Description

Displays a list of files on a file system.

Creates a new directory in a Class C Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

649

R through setup rommon-pref

rommon-pref

To select a ReadOnly or Upgrade ROMmon image to be booted on the next reload of a Cisco 7200 VXR router or Cisco 7301 router when you are in ROMmon, use the rommon-prefcommand in ROM monitor mode.

rommon-pref [readonly | upgrade]

Syntax Description readonly upgrade

Selects the ReadOnly ROMmon image to be booted on the next reload.

Selects the Upgrade, second ROMmon image to be booted on the next reload.

Command Default No default behavior or values

Command Modes ROM monitor mode

Command History

Release

12.0(28)S

12.3(8)T

12.3(9)

Modification

This command was introduced on the Cisco 7200

VXR router. It was introduced in ROMmon version

12.3(4r)T1 for the Cisco 7200 VXR router.

This command was integrated into Cisco IOS

Release 12.3(8)T and supported on the Cisco 7200

VXR router and Cisco 7301 router. It was introduced in ROMmon version 12.3(4r)T2 for the

Cisco 7301 router.

This command was integrated into Cisco IOS

Release 12.3(9) and supported on the Cisco 7200

VXR router and Cisco 7301 router.

Usage Guidelines You might select the ReadOnly ROMmon image to be booted on the next reload because the Upgrade image has features or side effects you do not like.

When you are in ROMmon, there is no descriptive output to inform you whether the ReadOnly ROMmon image was reloaded. To confirm the reload, use the showmon command after entering the rommon-pref readonly command.

650

Cisco IOS Configuration Fundamentals Command Reference

R through setup rommon-pref

Use this command when you are in ROMmon mode. Use the upgrade rom-monitor preferencecommand when you are in Cisco IOS.

Examples The following example, applicable to both the Cisco 7200 VXR and Cisco 7301 routers, shows how to select the ReadOnly ROMmon image to be booted on the next reload of the router when you are already in

ROMmon mode: rommon 2 > rommon-pref readonly

Related Commands

Command showmon

Description

Shows both the ReadOnly and the Upgrade

ROMmon image versions when you are in

ROMmon mode, as well as which ROMmon image is running.

Cisco IOS Configuration Fundamentals Command Reference

651

R through setup route-converge-interval

route-converge-interval

To configure the time interval after which the old FIB entries are purged, use the route-converge-

intervalcommand in main CPU submode. To return to the default settings, use the no form of this command.

route-converge-interval seconds

no route-converge-interval

Syntax Description seconds Time interval, in seconds, after which the old FIB entries are purged ; valid values are from 60 to

3600 seconds.

Command Default

seconds is 120 seconds (2 minutes).

Command Modes Main CPU submode

Command History

Release

12.2(17b)SXA

12.2(18)SXD

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command is supported on releases prior to

Release 12.2(18)SXD.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines SRM/SSO is supported in the following releases only.

• Release 12.2(17b)SXA and later rebuilds of Release 12.2(17b)SXA

• Release 12.2(17d)SXB and later rebuilds of Release 12.2(17d)SXB

This command is not supported in Cisco 7600 series routers that are configured with a Supervisor Engine 2.

The time interval for route-converge delay is needed to simulate the route-converge time when routing protocols restart on switchover.

652

Cisco IOS Configuration Fundamentals Command Reference

R through setup route-converge-interval

Examples This example shows how to set the time interval for the route-converge delay:

Router(config)# redundancy

Router(config-red)# main-cpu

Router(config-red-main)# route-converge-interval 90

Router(config-red-main)#

This example shows how to return to the default time interval for the route-converge delay:

Router(config)# redundancy

Router(config-red)# main-cpu

Router(config-red-main)# no route-converge-interval

Router(config-red-main)#

Related Commands

Command redundancy

Description

Enters redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

653

R through setup rsh

rsh

To execute a command remotely on a remote shell protocol (rsh) host, use the rshcommand in privilegedEXEC mode.

rsh {ip-address | host} [/user username] remote-command

Syntax Description ip-address host

/user username remote-command

IP address of the remote host on which to execute the rsh command. Either the IP address or the host name is required.

Name of the remote host on which to execute the command. Either the host name or the IP address is required.

(Optional) Remote username.

Command to be executed remotely.

Command Default If you do not specify the /user username keyword and argument, the Cisco IOS software sends a default remote username. As the default value of the remote username, the software sends the username associated with the current tty process, if that name is valid. For example, if the user is connected to the router through

Telnet and the user was authenticated through the usernamecommand, then the software sends that username as the remote username. If the tty username is invalid, the software uses the host name as the both the remote and local usernames.

Note For Cisco, tty lines are commonly used for access services. The concept of tty originated with UNIX. For

UNIX systems, each physical device is represented in the file system. Terminals are sometimes called tty devices (tty stands for teletype, the original UNIX terminal).

Command Modes Privileged EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

654

Cisco IOS Configuration Fundamentals Command Reference

R through setup rsh

Usage Guidelines Use the rsh command to execute commands remotely. The host on which you remotely execute the command must support the rsh protocol, and the .rhosts files on the rsh host must include an entry that permits you to remotely execute commands on that host.

For security reasons, the software does not default to a remote login if no command is specified, as does

UNIX. Instead, the router provides Telnet and connect services that you can use rather than rsh.

Examples

The following command specifies that the user named sharon attempts to remotely execute the UNIX ls command with the -a argument on the remote host named mysys.cisco.com. The command output resulting from the remote execution follows the command example:

Router1# rsh mysys.cisco.com /user sharon ls -a

.alias

.cshrc

.emacs

.exrc

.history

.login

.mailrc

.newsrc

.oldnewsrc

.rhosts

.twmrc

.xsession

jazz

Cisco IOS Configuration Fundamentals Command Reference

655

R through setup scheduler allocate

scheduler allocate

To guarantee CPU time for processes, use the scheduler allocatecommand in global configuration mode.

To restore the default, use the no form of this command.

scheduler allocate interrupt-time process-time

no scheduler allocate

Syntax Description interrupt-time process-time

Integer (in microseconds) that limits the maximum number of microseconds to spend on fast switching within any one network interrupt context. The range is from 400 to 60000 microseconds. The default is

4000 microseconds.

Integer (in microseconds) that guarantees the minimum number of microseconds to spend at the process level when network interrupts are disabled.

The range is from 100 to 4000 microseconds.The

default is 200 microseconds. The default for

Catalyst 6500 series switches and Cisco 7600 series routers is 800 microseconds.

Command Default Approximately 5 percent of the CPU is available for process tasks.

Command Modes Global configuration

Command History

Release

11.2

12.2(14)SX

12.2(17a)SX

12.2(17d)SXB

Modification

This command was introduced.

Support for this command was introduced on the

Supervisor Engine 720.

This command was changed as follows:

• The process-time default setting was changed from 200 microseconds to 800 microseconds.

• The no scheduler allocate action was changed to return to the default settings.

Support for this command on the Supervisor Engine

2 was extended to the 12.2(17d)SXB release.

656

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler allocate

Release

12.2(33)SRA

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command applies to the Catalyst 6500 series switches, Cisco 7200 series, Cisco 7500 series, and Cisco

7600 series routers.

Caution We recommend that you do not change the default settings. Changing settings associated with CPU processes can negatively impact system performance.

Entering the scheduler allocate command without arguments is the same as entering the no scheduler

allocate or the default scheduler allocate command.

Examples The following example makes 20 percent of the CPU available for process tasks:

Router(config)# scheduler allocate 2000 500

Related Commands

Command

scheduler interval

Description

Controls the maximum amount of time that can elapse without running system processes.

Cisco IOS Configuration Fundamentals Command Reference

657

R through setup scheduler heapcheck poll

scheduler heapcheck poll

To validate the memory and edisms poll routine, use the scheduler heapcheck pollcommand in global configuration mode. To disable the memory check and edisms poll routine, use the no form of this command.

scheduler heapcheck poll

no scheduler heapcheck poll

Syntax Description This command has no arguments or keywords.

Command Default

The scheduler heapcheck pollcommand is disabled by default. If no keywords are specified, a sanity check is performed on all the memory blocks and memory pools.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to validate the memory check and edisms poll routine:

Router# configure terminal

Router(config)# scheduler heapcheck poll

Related Commands

Command

scheduler heapcheck process

Description

Performs a sanity check for corruption in memory blocks when a process switch occurs.

658

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler heapcheck process

scheduler heapcheck process

To perform a “sanity check” for corruption in memory blocks when a process switch occurs, use the

scheduler heapcheck processcommand in global configuration mode. To disable this feature, use the no form of this command.

scheduler heapcheck process [memory [fast] [io] [multibus] [pci] [processor] [checktype {all |

data | magic | mlite-data | pointer | refcount | lite-chunks}]]

no scheduler heapcheck process

Syntax Description memory fast io multibus pci processor checktype all data magic mlite-data pointer refcount

(Optional) Specifies checking all memory blocks and memory pools.

(Optional) Specifies checking the fast memory block.

(Optional) Specifies checking the I/O memory block.

(Optional) Specifies checking the multibus memory block.

(Optional) Specifies checking the process control information (PCI) memory block.

(Optional) Specifies checking the processor memory block.

(Optional) Specifies checking specific memory pools.

(Optional) Specifies checking the value of the block magic, red zone, size, refcount, and pointers (next and previous).

(Optional) Specifies checking the value of normal blocks.

(Optional) Specifies checking the value of the block magic, red zone, and size.

(Optional) Specifies checking the value of memory allocation lite (malloc-lite) blocks.

(Optional) Specifies checking the value of the next and previous pointers.

(Optional) Specifies checking the value of the block magic and refcount.

Cisco IOS Configuration Fundamentals Command Reference

659

R through setup scheduler heapcheck process lite-chunks (Optional) Specifies checking the memory blocks allocated by the memory allocation lite

(malloc_lite) feature.

Command Default This command is disabled by default. If no keywords are specified, a sanity check will be performed on all the memory blocks and memory pools.

Command Modes Global configuration (config)

Command History

Release

12.2(15)T

12.3(11)T

12.4(20)T

Modification

This command was introduced.

The lite-chunks keyword was added.

The dataand mlite-datakeywords were added.

Usage Guidelines When configuring this command, you can choose none or all memory block keywords (fast, io, multibus,

pci, processor, and checktype).

Enabling this command has a significant impact on router performance.

Examples

The following example shows how to sanity check for corruption in the I/O memory block when a process switch occurs. In this example, the values of only the block magic, red zone, and size will be checked.

scheduler heapcheck process memory io checktype magic

The following example shows how to sanity check for corruption in the processor memory block when a process switch occurs. In this example, the values of only the next and previous pointers will be checked.

scheduler heapcheck process memory processor checktype pointer

Related Commands

Command

memory lite

memory sanity

Description

Enables the malloc_lite feature.

Performs a “sanity check” for corruption in buffers and queues.

660

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler interrupt mask profile

scheduler interrupt mask profile

To start interrupt mask profiling for all processes running on the system, use the scheduler interrupt mask

profilecommand in global configuration mode. To stop interrupt mask profiling, use the no form of this command.

scheduler interrupt mask profile

no scheduler interrupt mask profile

Syntax Description This command has no arguments or keywords.

Command Default Interrupt mask profiling is disabled by default.

Command Modes Global configuration

Command History

Release

12.4(2)T

Modification

This command was introduced.

Usage Guidelines This command enables the collection of details regarding the total amount of time a process has masked interrupts since the interrupt mask profiler was enabled.

Examples The following example shows how to enable interrupt mask profiling:

Router(config)# scheduler interrupt mask profile

Related Commands

Command

clear processes interrupt mask detail

scheduler interrupt mask size

Description

Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer.

Configures the maximum number of entries that can exist in the interrupt mask buffer.

Cisco IOS Configuration Fundamentals Command Reference

661

R through setup scheduler interrupt mask profile

Command

scheduler interrupt mask time

show process interrupt mask buffer

show processes interrupt mask detail

Description

Configures the maximum allowed time that a process can run with interrupts masked.

Displays the information stored in the interrupt mask buffer.

Displays interrupt masked details for the specified process or all processes in the system.

662

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler interrupt mask size

scheduler interrupt mask size

To configure the maximum number of entries that can exist in the interrupt mask buffer, use the scheduler

interrupt mask sizecommand in global configuration mode. To reset the maximum number of entries that can exist in the interrupt mask buffer to the default, use the no form of this command.

scheduler interrupt mask size buffersize

no scheduler interrupt mask size

Syntax Description buffersize Specifies the number of entries that can exist in the interrupt mask buffer.

Command Default The default buffer size is 50 entries.

Command Modes Global configuration

Command History

Release

12.4(2)T

Modification

This command was introduced.

Examples The following example shows how to configure 100 entries the maximum number of entries that can exist in the interrupt mask buffer:

Router(config)# scheduler interrupt mask size 100

Related Commands

Command

clear processes interrupt mask detail

scheduler interrupt mask profile

scheduler interrupt mask time

Description

Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer.

Enables or disables interrupt mask profiling for all processes running on the system.

Configures the maximum amount of time a process can run with interrupts masked.

Cisco IOS Configuration Fundamentals Command Reference

663

R through setup scheduler interrupt mask size

Command

show processes interrupt mask buffer

show processes interrupt mask detail

Description

Displays interrupt masked details for the specified process or all processes in the system and displays information stored in the interrupt mask buffer.

Displays interrupt masked details for the specified or all processes in the system.

664

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler interrupt mask time

scheduler interrupt mask time

To configure the maximum time that a process can run with interrupts masked before another entry is created in the interrupt mask buffer, use the scheduler interrupt mask timecommand in global configuration mode. To reset the threshold time to the default, use the no form of this command.

scheduler interrupt mask time threshold-time

no scheduler interrupt mask time

Syntax Description threshold-time Specifies the maximum amount of timein microseconds a process can be in interrupt masked state without creating an entry in the interrupt mask buffer.

Command Default The default threshold time value is 50 microseconds.

Command Modes Global configuration

Command History

Release

12.4(2)T

Modification

This command was introduced.

Examples The following shows how to configure 100 microseconds as the maximum time a process can run with interrupts masked before another entry is created in the interrupt mask buffer:

Router(config)# scheduler interrupt mask time 100

Related Commands

Command

clear processes interrupt mask detail

scheduler interrupt mask profile

Description

Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer.

Enables or disables interrupt mask profiling for all processes running on the system.

Cisco IOS Configuration Fundamentals Command Reference

665

R through setup scheduler interrupt mask time

Command

scheduler interrupt mask size

show processes interrupt mask buffer

show processes interrupt mask detail

Description

Configures the maximum number of entries that can exist in the interrupt mask buffer.

Displays the information stored in the interrupt mask buffer.

Displays interrupt masked details for the specified process or all processes in the system.

666

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler interval

scheduler interval

To control the maximum amount of time that can elapse without running system processes, use the

scheduler interval command in global configuration mode. To restore the default, use the noform of this command.

scheduler interval milliseconds

no scheduler interval

Syntax Description milliseconds Integer that specifies the interval (in milliseconds).

The minimum interval that you can specify is 500 milliseconds; there is no maximum value.

Command Default High-priority operations are allowed to use as much of the CPU as needed.

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The normal operation of the network server allows the switching operations to use as much of the central processor as is required. If the network is running unusually heavy loads that do not allow the processor the time to handle the routing protocols, give priority to the system process scheduler. High-priority operations are allowed to use as much of the CPU as needed.

Note Changing settings associated with CPU processes can negatively impact system performance.

On the Cisco 7200 series and Cisco 7500 series, use the scheduler allocate global configuration command instead of the scheduler interval command.

Examples The following example changes the low-priority process schedule to an interval of 750 milliseconds:

Router(config)# scheduler interval 750

Cisco IOS Configuration Fundamentals Command Reference

667

scheduler interval

Related Commands

Command

scheduler allocate

R through setup

Description

Guarantees CPU time for processes.

668

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler isr-watchdog

scheduler isr-watchdog

To detect if an Interrupt Service Routine (ISR) is suspended or stalled and to schedule and manage a watchdog timeout on an ISR, use the scheduler isr-watchdogcommand in global configuration mode. To disable the configuration, use the no form of this command.

scheduler isr-watchdog

no scheduler isr-watchdog

Syntax Description There are no additional keywords or arguments with this command.

Command Default The default detection time is 2 minutes.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Usage Guidelines The timer ISR checks the current context to avoid holding processes accountable for CPU time spent servicing interrupts during the process time slice, and vice versa for interrupt-level code accountability.

However, at each timer tick, the timer ISR applies the full 4 milliseconds of CPU time to the current context. As a result, depending on when the timer tick occurs in relation to a context switch, you might see inaccuracies in CPU utilization accounting compared with the actual computation time because some or all of the tick is being applied to the wrong context.

Examples The following example shows how to detect if an ISR is suspended or stalled and to manage a watchdog timeout on an ISR:

Router> enable

Router# configure terminal

Router(config)# scheduler isr-watchdog

Cisco IOS Configuration Fundamentals Command Reference

669

scheduler isr-watchdog

Related Commands

Command

scheduler max-sched-time

R through setup

Description

Configures the maximum time in milliseconds that a scheduler can run without flagging an error.

670

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler max-sched-time

scheduler max-sched-time

To configure or change the maximum time, in milliseconds that a scheduler can run without flagging an error or overload of the CPU, use the scheduler max-sched-timecommand in global configuration mode.

To disable this configuration, use the no form of this command.

scheduler max-sched-time milliseconds

no scheduler max-sched-time

Syntax Description milliseconds The maximum time, in milliseconds (ms). The range is from 1 to 3600.

Command Default The default time is 2000 ms to signal an overload of the CPU.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Usage Guidelines The default behavior of the scheduler max-sched-time command is to stop the process only if it is fatal. A task is defined as fatal if the task gets another watchdog within 12 hours of being assigned the first watchdog, and a handler has been registered.

Examples The following example shows how to configure the maximum time in milliseconds (to 1000 ms in this example) that a scheduler can run without flagging an error:

Router> enable

Router# configure terminal

Router(config)# scheduler max-sched-time 1000

Cisco IOS Configuration Fundamentals Command Reference

671

scheduler max-sched-time

Related Commands

Command

scheduler isr-watchdog

R through setup

Description

Detects if an ISR is suspended or stalled and manages a watchdog timeout on an ISR.

672

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler process-watchdog

scheduler process-watchdog

To configure the default action of a watchdog timeout for a process using a scheduler, use the scheduler

process-watchdogcommand in global configuration mode. To disable the configuration, use the no form of this command.

scheduler process-watchdog {hang | normal | reload | terminate}

no scheduler process-watchdog

Syntax Description hang normal reload terminate

Retains the process but does not schedule it.

Enables factory-specified per-process behavior.

Reloads the system.

Terminates the process and continues.

Command Default The default value is normal.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Usage Guidelines The watchdog timer sets the interval after which the scheduler assumes a process has been suspended or stalled and needs to be stopped.

Examples The following example shows how to configure the default action of a watchdog timeout for a process using a scheduler:

Router> enable

Router# configure terminal

Router(config)# scheduler process-watchdog normal

Cisco IOS Configuration Fundamentals Command Reference

673

scheduler process-watchdog

Related Commands

Command

scheduler max-sched-time

R through setup

Description

Configures the maximum time in milliseconds that a scheduler can run without flagging an error.

674

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler timercheck process

scheduler timercheck process

To configure process-level timer validation on a scheduler, and check the timer tree of the process after every context switch of the process Packet Identification number (PID) is configured, use the scheduler

timercheck processcommand in global configuration mode. To disable this configuration, use the no form of this command.

scheduler timercheck process pid

no scheduler timercheck process pid

Syntax Description pid PID number in the range is from 1 to 2147483647.

Command Default The process-level timer validation is not configured on a scheduler.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Usage Guidelines Specify the show processes timercheck command after configuring the schedule timercheck process command to display the details of the configuration.

Examples The following example shows how to configure process-level timer validation on a scheduler with a PID value of 5:

Router> enable

Router# configure terminal

Router(config)# scheduler timercheck process 5

Router# show processes timer

System timer check not configured.

Process timer check configuration follows.

PID Configuration Name

1 On every context switch. Chunk Manager

Cisco IOS Configuration Fundamentals Command Reference

675

R through setup scheduler timercheck process

Related Commands

Command

show processes timercheck

scheduler timercheck system context

Description

Displays information about the active Cisco IOS processes or the Cisco IOS Software Modularity

POSIX-style processes.

Configures system-level validation on context switches on a scheduler.

676

Cisco IOS Configuration Fundamentals Command Reference

R through setup scheduler timercheck system context

scheduler timercheck system context

To configure system-level validation on context switches on a scheduler, and check system level-timers, use the scheduler timercheck system contextcommand in global configuration mode. To disable the configuration, use the no form of this command.

scheduler timercheck system context

no scheduler timercheck system context

Syntax Description This command has no additional keywords or arguments.

Command Default The system-level validation on context switches on a scheduler is not configured.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS 15.0(1)M.

Examples The following example shows how to configure system level validation on context switches on a scheduler:

Router> enable

Router# configure terminal

Router(config)# scheduler timercheck system context

Related Commands

Command

scheduler timercheck process

Description

Configures process-level timer validation on a scheduler.

Cisco IOS Configuration Fundamentals Command Reference

677

R through setup send

send

To send messages to one or all terminal lines, use the sendcommand in user or privileged EXEC mode.

send {line-number | * | aux number | console number | log number [msg-ext] | tty number | vty

number | xsm [client client-id] message text}

Syntax Description line-number

aux number

console number

log number msg-text

client client-id

message text

tty number

vty number

xsm client-id

Line number to which the message will be sent.

Sends a message to all lines.

Sends a message to the specified auxiliary (AUX) port.

Sends a message to the specified console port.

Logs a message of the specified severity.

Logging message text.

(Optional) Sends the message to the specified client. The message is sent to all clients if the client

ID is not specified.

Sends a message to XSM client when it is used with the xsm keyword.

Sends a message to the specified asynchronous line.

Sends a message to the specified virtual asynchronous line.

Sends a message to the XML Subscription Manager

(XSM) client.

Command Default No messages are sent.

Command Modes User EXEC (>)

Priviledged EXEC (#)

Command History

Release

11.2

Modification

This command was introduced.

678

Cisco IOS Configuration Fundamentals Command Reference

R through setup send

Release

12.2(33)SRA

12.2(33)SXI

15.0(1)M

Cisco IOS XE Release 2.1

Modification

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

This command was integrated into Cisco IOS

Release 15.0(1)M.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines After entering the send command, the system prompts for the message to be sent, which can be up to 500 characters long. Press Ctrl-Z to end the message. Press Ctrl-Cto abort this command.

Caution Be aware that in some circumstances text sent using the send command may be interpreted as an executable command by the receiving device. For example, if the receiving device is UNIX workstation, and the receiving device is in a state (shell) where commands can be executed, the incoming text, if it is a properly formatted UNIX command, will be accepted by the workstation as a command. For this reason, you should limit your exposure to potential messages from terminal servers or other Cisco IOS-based devices when running an interactive shell.

Examples The following example shows how to send a message to all lines:

Router# send

Enter message, end with CTRL/Z; abort with CTRL/C:

The system 2509 will be shut down in 10 minutes for repairs.^Z

Send message? [confirm]

Router#

***

*** Message from tty0 to all terminals:

***

The system 2509 will be shut down in 10 minutes for repairs.

Related Commands

Command reload

Description

Reloads the operating system.

Cisco IOS Configuration Fundamentals Command Reference

679

R through setup service compress-config

service compress-config

To compress startup configuration files, use the service compress-config command in global configuration mode. To disable compression, use the no form of this command.

service compress-config

no service compress-config

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines After you configure the service compress-config command, the router will compress configuration files every time you save a configuration to the startup configuration. For example, when you enter the copy

system:running-config nvram:startup-config command, the running configuration will be compressed before storage in NVRAM.

If the file compression succeeds, the following message is displayed:

Compressing configuration from configuration-size

to compressed-size

[OK]

If the boot ROMs do not recognize a compressed configuration, the following message is displayed:

Boot ROMs do not support NVRAM compression Config NOT written to NVRAM

If the file compression fails, the following message is displayed:

Error trying to compress nvram

One way to determine whether a configuration file will be compressed enough to fit into NVRAM is to use a text editor to enter the configuration, then use the UNIX compress command to check the compressed size. To get a closer approximation of the compression ratio, use the UNIX compress -b12command.

680

Cisco IOS Configuration Fundamentals Command Reference

R through setup service compress-config

Once the configuration file has been compressed, the router functions normally. At boot time, the system recognizes that the configuration file is compressed, uncompresses it, and proceeds normally. A partition

nvram:startup-config command uncompresses the configuration before displaying it.

To disable compression of the configuration file, enter configuration mode and specify the no service

compress-config command. Then, exit global configuration mode and enter the copy system:running-

config nvram:startup-config command. The router displays an OK message if it is able to write the uncompressed configuration to NVRAM. Otherwise, the router displays an error message indicating that the configuration is too large to store. If the configuration file is larger than the physical NVRAM, the following message is displayed:

##Configuration too large to fit uncompressed in NVRAM Truncate configuration? [confirm]

When the file is truncated, commands at the end of the file are erased. Therefore, you will lose part of your configuration. To truncate and save the configuration, type Y. To not truncate and not save the configuration, type N.

Examples In the following example, the configuration file is compressed:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# service compress-config

Router(config)# end

Router#

%SYS-5-CONFIG_I: Configured from console by console

Router# copy system:running-config nvram:startup-config

Building configuration...

Compressing configuration from 1179 bytes to 674 bytes

[OK]

Related Commands

Command

partition nvram:startup-config

Description

Separates Flash memory into partitions on Class B file system platforms.

Cisco IOS Configuration Fundamentals Command Reference

681

R through setup service config

service config

To enable autoloading of configuration files from a network server, use the service config command in global configuration mode. To restore the default, use the no form of this command.

service config

no service config

Syntax Description

This command has no arguments or keywords.

Command Default Autoloading of configuration files from a network server is disabled, except on systems without NVRAM or with invalid or incomplete information in NVRAM. In these cases, autoloading of configuration files from a network server is enabled automatically.

Command Modes

Global configuration (config)

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Usually, the service config command is used in conjunction with the boot host or boot network command.

You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command. With Cisco IOS software Releases

12.3(2)T, 12.3(1)B, and later releases, you no longer have to specify the service config command for the boot host or boot network command to be active. If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg.

Note You must issue the reload command for the service config command to take effect.

682

Cisco IOS Configuration Fundamentals Command Reference

R through setup service config

Examples In the following example, a router is configured to autoload the default network and host configuration files. Because no boot host or boot network commands are specified, the router uses the broadcast address to request the files from a TFTP server.

Router(config)# service config

Router(config)# boot network rcp://172.16.1.111/bridge_9.1

Related Commands

Command

boot host

boot network

Reload

Description

Changes the default name of the host configuration filename from which to load configuration commands.

Changes the default name of the network configuration file from which to load configuration commands.

Reloads the operating system.

Cisco IOS Configuration Fundamentals Command Reference

683

R through setup service counters max age

service counters max age

To set the time interval for retrieving statistics, use the service counters max age command in global configuration mode. To return to the default settings, use the no form of this command.

service counters max age seconds

no service counters max age

Syntax Description seconds Maximum age, in seconds, of the statistics retrieved from the CLI or SNMP; valid values are from 0 to

60 seconds.

Command Default

seconds is 5 seconds.

Command Modes Global configuration

Command History

Release

12.2(18)SXD

12.2(18)SXF

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720 and the Supervisor Engine

This command was changed as follows:

• The default was changed from 10 seconds to 5 seconds.

• The valid values for seconds was changed from 1 to 60 seconds to 0 to 60 seconds.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

A fully loaded Catalyst 6500 series switch chassis running Cisco IOS software version 12.2(18)SXF or its minor variants (SXF through SXF5) takes 1-2 minutes to update the SNMP counters maintained under ifTable and ifXTable.

Polling the ifTable/ifXTable is done with the need to understand how much traffic is being handled by a specific port/interface. The typical polling interval to meet this need is 3-5 minutes. No gain is achived by reducing the polling interval to intervals lesser than 3 minutes.

684

Cisco IOS Configuration Fundamentals Command Reference

R through setup service counters max age

Examples

Note If you decrease the time interval for retrieving statistics from the default setting (5 seconds), traffic congestion may result in situations where frequent SNMP (SMNP bulk) retrievals occur.

This example shows how to set the time interval for retrieving statistics:

Router(config)# service counters max age 10

Router(config)#

This example shows how to return to the default setting:

Router(config)# no

service counters max age

Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

685

R through setup service decimal-tty

service decimal-tty

To specify that line numbers be displayed and interpreted as octal numbers rather than decimal numbers, use the no service decimal-tty command in global configuration mode. To restore the default, use the

service decimal-tty command.

service decimal-tty

no service decimal-tty

Syntax Description This command has no arguments or keywords.

Command Default Enabled (line numbers displayed as decimal numbers)

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the router is configured to display decimal rather than octal line numbers:

Router(config)# service decimal-tty

686

Cisco IOS Configuration Fundamentals Command Reference

R through setup service exec-wait

service exec-wait

To delay the startup of the EXEC on noisy lines, use the service exec-wait command in global configuration mode. To disable the delay function, use the no form of this command.

service exec-wait

no service exec-wait

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command delays startup of the EXEC until the line has been idle (no traffic seen) for 3 seconds. The default is to enable the line immediately on modem activation.

This command is useful on noisy modem lines or when a modem attached to the line is configured to ignore MNP/V.42 negotiations, and MNP/V.42 modems may be dialing in. In these cases, noise or MNP/V.

42 packets may be interpreted as usernames and passwords, causing authentication failure before the user has a chance to type a username or password. The command is not useful on nonmodem lines or lines without some kind of login configured.

Examples The following example delays the startup of the EXEC:

Router(config)# service exec-wait

Cisco IOS Configuration Fundamentals Command Reference

687

R through setup service finger

service finger

The service finger command has been replaced by the ip finger command. However, the service finger and no service finger commands continue to function to maintain backward compatibility with older versions of Cisco IOS software. Support for this command may be removed in a future release. See the description of the ip finger command for more information.

688

Cisco IOS Configuration Fundamentals Command Reference

R through setup service hide-telnet-address

service hide-telnet-address

To hide addresses while trying to establish a Telnet session, use the service hide-telnet-address command in global configuration mode. To disable this service, use the noform of this command.

service hide-telnet-address

no service hide-telnet-address

Syntax Description This command has no arguments or keywords.

Command Default Addresses are displayed.

Command Modes Global configuration

Command History

Release

11.2

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines When you attempt to connect to a device, the router displays addresses and other messages (for example,

“Trying router1 (171.69.1.154, 2008)...).” With the hide feature, the router suppresses the display of the address (for example, “Trying router1 address #1...”). The router continues to display all other messages that would normally be displayed during a connection attempt, such as detailed error messages if the connection was not successful.

The hide feature improves the functionality of the busy-message feature. When you configure only the

busy-message command, the normal messages generated during a connection attempt are not displayed; only the busy-message is displayed. When you use the hide and busy features together you can customize the information displayed during Telnet connection attempts. When you configure the service hide-telnet-

address command and the busy-message command, the router suppresses the address and displays the message specified with the busy-message command if the connection attempt is not successful.

Examples The following example hides Telnet addresses:

Router(config)# service hide-telnet-address

Cisco IOS Configuration Fundamentals Command Reference

689

service hide-telnet-address

Related Commands

Command busy-message

R through setup

Description

Creates a “host failed” message that is displayed when a connection fails.

690

Cisco IOS Configuration Fundamentals Command Reference

R through setup service linenumber

service linenumber

To configure the Cisco IOS software to display line number information after the EXEC or incoming banner, use the service linenumber command in global configuration mode. To disable this function, use the no form of this command.

service linenumber

no service linenumber

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines With the service linenumber command, you can have the Cisco IOS software display the host name, line number, and location each time an EXEC process is started, or an incoming connection is made. The line number banner appears immediately after the EXEC banner or incoming banner. This feature is useful for tracking problems with modems, because the host and line for the modem connection are listed. Modem type information can also be included.

Examples In the following example, a user Telnets to Router2 before and after the service linenumber command is enabled. The second time, information about the line is displayed after the banner.

Router1> telnet Router2

Trying Router2 (172.30.162.131)... Open

Welcome to Router2.

User Access Verification

Password:

Router2> enable

Password:

Router2# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router2(config)# service linenumber

Router2(config)# end

Cisco IOS Configuration Fundamentals Command Reference

691

R through setup service linenumber

Router2# logout

[Connection to Router2 closed by foreign host]

Router1> telnet Router2

Trying Router2 (172.30.162.131)... Open

Welcome to Router2.

Router2 line 10

User Access Verification

Password:

Router2>

Related Commands

Command

show users

Description

Displays information about the active lines on the router.

692

Cisco IOS Configuration Fundamentals Command Reference

R through setup service nagle

service nagle

To enable the Nagle congestion control algorithm, use the service nagle command in global configuration mode. To disable the algorithm, use the no form of this command.

service nagle

no service nagle

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines When using a standard TCP implementation to send keystrokes between machines, TCP tends to send one packet for each keystroke typed. On larger networks, many small packets use up bandwidth and contribute to congestion.

The algorithm developed by John Nagle (RFC 896) helps alleviate the small-packet problem in TCP. In general, it works this way: The first character typed after connection establishment is sent in a single packet, but TCP holds any additional characters typed until the receiver acknowledges the previous packet.

Then the second, larger packet is sent, and additional typed characters are saved until the acknowledgment comes back. The effect is to accumulate characters into larger chunks, and pace them out to the network at a rate matching the round-trip time of the given connection. This method is usually effective for all TCPbased traffic. However, do not use the service nagle command if you have XRemote users on X Window system sessions.

Examples The following example enables the Nagle algorithm:

Router(config)# service nagle

Cisco IOS Configuration Fundamentals Command Reference

693

R through setup service prompt config

service prompt config

To display the configuration prompt (config), use the service prompt config command in global configuration mode. To remove the configuration prompt, use the no form of this command.

service prompt config

no service prompt config

Syntax Description This command has no arguments or keywords.

Command Default The configuration prompts appear in all configuration modes.

Command Modes Global configuration

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the no service prompt config command prevents the configuration prompt from being displayed. The prompt is still displayed in EXEC mode. When the service prompt config command is entered, the configuration mode prompt reappears.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# no service prompt config hostname newname end newname# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

service prompt config newname(config)# hostname Router

Router(config)# end

Router#

694

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Related Commands

Command hostname prompt service prompt config

Description

Specifies or modifies the host name for the network server.

Customizes the prompt.

Cisco IOS Configuration Fundamentals Command Reference

695

R through setup service sequence-numbers

service sequence-numbers

To enable visible sequence numbering of system logging messages, use the service sequence-numbers command in global configuration mode. To disable visible sequence numbering of logging messages, use the no form of this command.

service sequence-numbers

no service sequence-numbers

Syntax Description This command has no arguments or keywords.

Command Default Disabled.

Command Modes Global configuration

Command History

Release

12.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Each system status messages logged in the system logging process have a sequence reference number applied. This command makes that number visible by displaying it with the message. The sequence number is displayed as the first part of the system status message. See the description of the logging commands for information on displaying logging messages.

Examples In the following example logging message sequence numbers are enabled:

.Mar 22 15:28:02 PST: %SYS-5-CONFIG_I: Configured from console by console

Router# config terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# service sequence-numbers

Router(config)# end

Router#

000066: .Mar 22 15:35:57 PST: %SYS-5-CONFIG_I: Configured from console by console

696

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Related Commands

Command

logging on

service timestamps service sequence-numbers

Description

Enables system logging globally.

Enables time-stamping of system logging messages or debugging messages.

Cisco IOS Configuration Fundamentals Command Reference

697

R through setup service slave-log

service slave-log

To allow slave Versatile Interface Processor (VIP) cards to log important error messages to the console, use the service slave-log command in global configuration mode . To disable slave logging, use the no form of this command.

service slave-log

no service slave-log

Syntax Description This command has no arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command allows slave slots to log error messages of level 2 or higher (critical, alerts, and emergencies).

Examples In the following example, the router is configured to log important messages from the slave cards to the console:

Router(config)# service slave-log

The following is sample output generated when this command is enabled:

%IPC-5-SLAVELOG: VIP-SLOT2:

IPC-2-NOMEM: No memory available for IPC system initialization

The first line indicates which slot sent the message. The second line contains the error message.

698

Cisco IOS Configuration Fundamentals Command Reference

R through setup service tcp-keepalives-in

service tcp-keepalives-in

To generate keepalive packets on idle incoming network connections (initiated by the remote host), use the

service tcp-keepalives-in command in global configuration mode . To disable the keepalives, use the

noform of this command.

service tcp-keepalives-in

no service tcp-keepalives-in

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, keepalives on incoming TCP connections are generated:

Router(config)# service tcp-keepalives-in

Related Commands

Command

service tcp-keepalives-out

Description

Generates keepalive packets on idle outgoing network connections (initiated by a user).

Cisco IOS Configuration Fundamentals Command Reference

699

R through setup service tcp-keepalives-out

service tcp-keepalives-out

To generate keepalive packets on idle outgoing network connections (initiated by a user), use the service

tcp-keepalives-out command in global configuration mode . To disable the keepalives, use the noform of this command.

service tcp-keepalives-out

no service tcp-keepalives-out

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, keepalives on outgoing TCP connections are generated:

Router(config)# service tcp-keepalives-out

Related Commands

Command

service tcp-keepalives-in

Description

Generates keepalive packets on idle incoming network connections (initiated by the remote host).

700

Cisco IOS Configuration Fundamentals Command Reference

R through setup service tcp-small-servers

service tcp-small-servers

To enable small TCP servers such as the Echo, use the service tcp-small-servers command in global configuration mode. To disable the TCP server, use the no form of this command.

service tcp-small-servers [max-servers number | no-limit]

no service tcp-small-servers [max-servers number | no-limit]

Syntax Description max-servers number no-limit

(Optional) Sets the number of allowable TCP small servers.

(Optional) Maximum number of TCP small servers.

Range is 1 to 2147483647.

(Optional) Allows the number of TCP small servers to have no limit.

Command Default TCP small servers are disabled.

Command Modes Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines

To use the service tcp-small-servers command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your Authentication, Authorization, and Accounting (AAA) administrator for assistance.

The TCP small servers consist of three services: Discard (port 9), Echo (port 7), and Chargen (port 19).

These services are used to test the TCP transport functionality. The discard server receives data and

Cisco IOS Configuration Fundamentals Command Reference

701

R through setup service tcp-small-servers discards it. The echo server receives data and echoes the same data to the sending host. The chargen server generates a sequence of data and sends it to the remote host.

Examples The following example shows how to enable small TCP servers and set the maximum number of allowable small servers to 14:

Router(config)#

service tcp-small-servers max-servers 14

Related Commands

Command

service udp-small-servers

Description

Enables small UDP servers such as the Echo.

702

Cisco IOS Configuration Fundamentals Command Reference

R through setup service telnet-zeroidle

service telnet-zeroidle

To set the TCP window to zero (0) when the Telnet connection is idle, use the service telnet-zeroidle command in global configuration mode. To disable this service, use the no form of this command.

service telnet-zero-idle

no service telnet-zeroidle

Syntax Description This command has no arguments or keywords.

Command Default The TCP window is not set to zero when the the Telnet connection is idle.

Command Modes Global configuration (config)

Command History

Release

10.0

12.2(33)SRA

15.0(1)M

12.2(33)SRC

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

Usage Guidelines

Normally, data sent to noncurrent Telnet connections is accepted and discarded. When the service telnet-

zero-idle command is enabled, if a session is suspended (that is, some other connection is made active or the router is in the privileged EXEC mode), the TCP window is set to zero. This action prevents the remote host from sending any more data until the connection is resumed. Use this command when it is important that all messages sent by the host be seen by the users and the users are likely to use multiple sessions.

Do not use this command if your host will eventually time out and log out a TCP user whose window is zero.

Examples The following example shows how to set the TCP window to zero when the Telnet connection is idle:

Router(config)# service telnet-zeroidle

Cisco IOS Configuration Fundamentals Command Reference

703

service telnet-zeroidle

Related Commands

Command resume

R through setup

Description

Switches to another open Telnet, rlogin, LAT, or

PAD session.

704

Cisco IOS Configuration Fundamentals Command Reference

R through setup service timestamps

service timestamps

To configure the system to apply a time stamp to debugging messages or system logging messages, use the

service timestamps command in global configuration mode . To disable this service, use the no form of this command.

service timestamps [debug | log] [uptime | datetime [msec]] [localtime] [show-timezone] [year]

no service timestamps [debug | log]

Syntax Description debug log uptime datetime

(Optional) Indicates time-stamping for debugging messages.

(Optional) Indicates time-stamping for system logging messages.

(Optional) Specifies that the time stamp should consist of the time since the system was last rebooted. For example “4w6d” (time since last reboot is 4 weeks and 6 days).

• This is the default time-stamp format for both debugging messages and logging messages.

• The format for uptime varies depending on how much time has elapsed:

◦ HHHH :MM :SS (HHHH hours: MM minutes: SS seconds) for the first 24 hours

◦ D dHH h (D days HH hours) after the first day

◦ W wD d (W weeks D days) after the first week

(Optional) Specifies that the time stamp should consist of the date and time.

• The time-stamp format for datetime is MMM

DD HH:MM:SS, where MMM is the month,

DD is the date, HH is the hour (in 24-hour notation), MM is the minute, and SS is the second.

• If the datetime keyword is specified, you can optionally add the msec localtime, show-

timezone, or year keywords.

• If the service timestamps datetime command is used without addtional keywords, time stamps will be shown using UTC, without the year, without milliseconds, and without a time zone name.

Cisco IOS Configuration Fundamentals Command Reference

705

R through setup service timestamps msec localtime year show-timezone

(Optional) Includes milliseconds in the time stamp, in the format HH:DD:MM:SS.mmm , where .mmm is milliseconds

(Optional) Time stamp relative to the local time zone.

(Optional) Include the year in the date-time format.

(Optional) Include the time zone name in the time stamp.

Note If the localtime keyword option is not used

(or if the local time zone has not been configured using the clock timezone command), time will be displayed in

Coordinated Universal Time (UTC).

Command Default Time stamps are applied to debug and logging messages.

Command Modes Global configuration (config)

Command History

Release

10.0

11.3(5)

12.3(1)

12.3(2)T

12.2(33)SRA

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

Service time stamps are enabled by default.

The year keyword was added.

This command was integrated into Cisco IOS

Release 12.3(2)T.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines Time stamps can be added to either debugging messages (service timestamp debug) or logging messages

(service timestamp log) independently.

706

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Examples service timestamps

If the service timestampscommand is specified with no arguments or keywords, the default is service

timestamps debug uptime.

The no service timestampscommand by itself disables time stamps for both debug and log messages.

The uptime form of the command adds time stamps (such as “2w3d”) that indicating the time since the system was rebooted. The datetime form of the command adds time stamps (such as “Sep 5 2002

07:28:20”) that indicate the date and time according to the system clock.

Entering the service timestamps {debug | log} command a second time will overwrite any previously configured service timestamp {debug | log} commands and associated options.

To set the local time zone, use the clock timezonezonehours-offset command in global configuration mode.

The time stamp will be preceeded by an asterisk or period if the time is potentially inaccurate. The table below describes the symbols that proceed the time stamp.

Table 41 Time-Stamping Symbols for syslog Messages

Symbol

(blank)

Example

15:29:03.158 UTC Tue Feb 25

2003:

Description

Time is authoritative: the software clock is in sync or has just been set manually

Time is not authoritative: the software clock has not been set, or is not in sync with configured

Network Time Protocol (NTP) servers.

Time is authoritative, but the

NTP is not synchronized: the software clock was in sync, but has since lost contact with all configured NTP servers.

*15:29:03.158 UTC Tue Feb 25

2003:

.15:29:03.158 UTC Tue Feb 25

2003:

In the following example, the router begins with time-stamping disabled. Then, the default time-stamping is enabled (uptime time stamps applied to debug output). Then, the default time-stamping for logging is enabled (uptime time stamps applied to logging output).

Router# show running-config | include time no service timestamps debug uptime no service timestamps log uptime

Router# config terminal

Router(config)# service timestamps

! issue the show running-config command in config mode using

do Router(config)# do show running-config | inc time

! shows that debug timestamping is enabled, log timestamping is disabled service timestamps debug uptime no service timestamps log uptime

! enable timestamps for logging messages

Router(config)# service timestamps log

Router(config)# do show run | inc time

Cisco IOS Configuration Fundamentals Command Reference

707

R through setup service timestamps service timestamps debug uptime service timestamps log uptime

Router(config)# service sequence-numbers

Router(config)# end

000075: 5w0d: %SYS-5-CONFIG_I: Configured from console by console

! The following is a level 5 system logging message

The leading number comes from the

service sequence-numbers command.

! 4w6d indicates the timestamp of 4 weeks, 6 days

000075: 4w6d: %SYS-5-CONFIG_I: Configured from console by console

In the following example, the user enables time-stamping on logging messages using the current time and date in Coordinated Universal Time/Greenwich Mean Time (UTC/GMT), and enables the year to be shown.

Router(config)#

The following line shows the timestamp with uptime (1 week 0 days)

1w0d: %SYS-5-CONFIG_I: Configured from console by console

Router(config)# service timestamps log datetime show-timezone

year

Router(config)# end

The following line shows the timestamp with datetime (11:13 PM March 22nd)

.Mar 22 2004 23:13:25 UTC: %SYS-5-CONFIG_I: Configured from console by console

The following example shows the change from UTC to local time:

Router# configure terminal

Logging output can be quite long; first changing line width to show ful l

! logging message

Router(config)# line 0

Router(config-line)# width 180

Router(config-line)# logging synchronous

Router(config-line)# end

Timestamping already enabled for logging messages; time shown in UTC.

Oct 13 23:20:05 UTC: %SYS-5-CONFIG_I: Configured from console by console

Router# show clock

23:20:53.919 UTC Wed Oct 13 2004

Router# configure terminal

Enter configuration commands, one per line. End with the end command.

Timezone set as Pacific Standard Time, with an 8 hour offset from UTC

Router(config)# clock timezone PST -8

Router(config)#

Oct 13 23:21:27 UTC: %SYS-6-CLOCKUPDATE:

System clock has been updated from 23:21:27 UTC Wed Oct 13 2004 to 15:21:27 PST Wed Oct 13 2004, configured from console by console.

Router(config)#

Pacific Daylight Time (PDT) configured to start in April and end in October.

! Default offset is +1 hour.

Router(config)# clock summer-time PDT recurring first Sunday April 2:00 last Sunday

October 2:00

Router(config)#

! Time changed from 3:22 P.M. Pacific Standard Time (15:22 PST)

! to 4:22 P.M. Pacific Daylight (16:22 PDT)

Oct 13 23:22:09 UTC: %SYS-6-CLOCKUPDATE:

System clock has been updated from 15:22:09 PST Wed Oct 13 2004 to 16:22:09 PDT Wed Oct 13 2004, configured from console by console.

708

Cisco IOS Configuration Fundamentals Command Reference

R through setup service timestamps

Change the timestamp to show the local time and timezone.

Router(config)# service timestamps log datetime localtime show-timezone

Router(config)# end

Oct 13 16:23:19 PDT: %SYS-5-CONFIG_I: Configured from console by console

Router# show clock

16:23:58.747 PDT Wed Oct 13 2004

Router# config t

Enter configuration commands, one per line. End with the end command.

Router(config)# service sequence-numbers

Router(config)# end

Router#

In the following example, the service timestamps log datetime command is used to change previously configured options for the date-time time stamp.

Router(config)# service timestamps log datetime localtime show-timezone

Router(config)# end

The year is not displayed.

Oct 13 15:44:46 PDT: %SYS-5-CONFIG_I: Configured from console by console

Router# config t

Enter configuration commands, one per line. End with the end command.

Router(config)# service timestamps log datetime show-timezone year

Router(config)# end

! note: because the localtime option was not specified again, that option is

! removed from the output, and time is displayed in UTC (the default)

Oct 13 2004 22:45:31 UTC: %SYS-5-CONFIG_I: Configured from console by console

Related Commands

Command

clock set ntp

service sequence-numbers

Description

Manually sets the system clock.

Controls access to the system’s NTP services.

Stamps system logging messages with a sequence number.

Cisco IOS Configuration Fundamentals Command Reference

709

R through setup service udp-small-servers

service udp-small-servers

To enable small User Datagram Protocol (UDP) servers such as the Echo, use the service udp-small-

servers command in global configuration mode. To disable the UDP server, use the no form of this command.

service udp-small-servers [max-servers number | no-limit]

no service udp-small-servers [max-servers number | no-limit]

Syntax Description max-servers number no-limit

(Optional) Sets the number of allowable UDP small servers.

(Optional) Maximum number of UDP small servers. Range is 1 to 2147483647.

(Optional) Allows the number of TCP small servers to have no limit.

Command Default UDP small servers are disabled.

Command Modes

Global configuration (config)

Command History

Release

15.0(1)M

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was implemented on the Cisco ASR

1000 Series Aggregation Services Routers.

Usage Guidelines To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your

Authentication, Authorization, and Accounting (AAA) administrator for assistance.

The UDP small servers currently consist of three services: Discard (port 9), Echo (port 7), and Chargen

(port 19). These services are used to test the UDP transport functionality. The discard server receives data

710

Cisco IOS Configuration Fundamentals Command Reference

R through setup service udp-small-servers and discards it. The echo server receives data and echoes the same data to the sending host. The chargen server generates a sequence of data and sends it to the remote host.

Examples The following example shows how to enable small UDP servers and set the maximum number of allowable small servers to 10:

Router(config)#

service udp-small-servers max-servers 10

Related Commands

Command

service tcp-small-servers

Description

Enables small TCP servers such as the Echo.

Cisco IOS Configuration Fundamentals Command Reference

711

R through setup service-module apa traffic-management

service-module apa traffic-management

To configure traffic management on the router, use the service-module apa traffic-managementcommand in interface configuration mode.

service-module apa traffic-management [monitor | inline]

Syntax Description monitor inline

Enables promiscuous monitoring.

Enables inline monitoring.

Command Default None

Command Modes Interface configuration mode

Command History

Release

12.4(20)YA

Modification

This command was introduced for the NME-APA on Cisco 2811, 2821, 2851, and Cisco 3800 Series

Integrated Services Routers.

Usage Guidelines To perform traffic management, you enable or disable the flow of packets by configuring the service module interface and the router interface.

• Configure the router interface with the service-module apa traffic-management [monitor |

inline]command.

Two traffic management options are available:

• ◦ Monitor--will copy the packet and designate the copy as the one forwarded to the Application

Performance Assurance module (NME-APA).

◦ Inline--will send the packet to the NME-APA, rather than sending a copy of the packet. After the

NME-APA has processes the packet, it sends it back to the router.

Note Enable only one traffic management option on the router, but not both concurrently.

• Configure the service module interface with the Application Performance Assurance (APA) graphical user interface (GUI). See the Cisco Application Performance Assurance User Guide for details.

712

Cisco IOS Configuration Fundamentals Command Reference

R through setup service-module apa traffic-management

Examples The following example configures an interface on a Cisco 2851 Integrated Services Router for inline traffic management.

Router> enable

Router# configure terminal

Router(config)# interface gigabitethernet 0/1

Router(config-if)# ip address

10.10.10.43 255.255.255.0

Router(config-if)# service-module apa traffic-management inline

Router(config-if)# exit end

Related Commands

Command

interface gigabitethernet

ip address

Description

Defines the interface on the router

Defines the IP address and subnet mask on the interface

Cisco IOS Configuration Fundamentals Command Reference

713

R through setup service-module wlan-ap bootimage

service-module wlan-ap bootimage

To configure the boot image on the service module, use the service-module wlan-ap bootimage command in privileged EXEC mode.

service-module wlan-ap interface number bootimage [autonomous | unified]

Syntax Description

interface number autonomous unified

The interface number for the wireless device.

Always use 0.

Autonomous software image.

Upgrade image with Lightweight Access Point

Protocol (LWAPP).

Command Default Autonomous software image

Command Modes Privileged EXEC

Command History

Release

12.4(20) T

Modification

This command was introduced for wireless-enabled

Cisco 880 Series and Cisco 890 Series Integrated

Services Routers.

Usage Guidelines When running the advanced IP services feature set on either Cisco 880 Series routers or Cisco 890 Series routers, use the service-module wlan-ap 0 bootimage unified commandto enable the Cisco unified software upgrade image on the embedded wireless access point. After enabling the unified image, use the

service-module wlan-ap 0 reload command to perform a graceful shutdown and reboot of the access point.

Note The service-module wlan-ap 0 bootimagecommand does not support recovery images on the embedded access point. Use the service-module wlan-ap 0 reload command to shutdown and reboot the access point.

Cisco 880 Series and Cisco 890 Series routers with embedded access point running the unified software image require DHCP to obtain an IP address for the access point. An IP address is needed to communicate with the Wireless LAN Controller (WLC) and to download its image upon boot up. The host router can provide DHCP server functionality through the DHCP pool to reach the WLC, and setup option 43 for the controller IP address in the DHCP pool configuration.

714

Cisco IOS Configuration Fundamentals Command Reference

R through setup service-module wlan-ap bootimage

Use the following guideline to setup a DHCP pool on the host router.

ip dhcp pool embedded-ap-pool

network 60.0.0.0 255.255.255.0

default router 60.0.0.1

option 43 hex f104.0a0a.0a0f /* Single WLC IP address (10.10.10.15) in HEX format */ int vlan 1 /* Default Vlan */ ip address 60.0.0.1 255.255.255.0

int Wlan-GigabitEthernet0 /* internal switch-port to AP */ switchport access vlan 1

Examples The following example upgrades the embedded access point image from autonomous to unified.

Router#configure terminal

Router(config)#service-module wlan-ap 0 bootimage unified

*Jan 18 05:31:58.172: %WLAN_AP_SM-6-UNIFIED_IMAGE: Embedded AP will change boot image to mini-IOS also called LWAPP recovery Please check router config to ensure connectivity between WLC and AP. Use service-module wlan-ap 0 reload to bootup mini-IOS image on AP

Router(config)#end

Router#

*Jan 18 05:32:04.136: %SYS-5-CONFIG_I: Configured from console by console Router#service- module wlan-ap 0 reload

Reload will save AP config....

Do you want to proceed with reload?[confirm] Trying to reload Service Module wlan-ap0.

Router#

Service Module saved config, start reset.

Received reload request from router

Saving configuration...

Building configuration...

Related Commands

Command interface wlan-ap

service-module wlan-ap reload

service-module wlan-ap reset

Description

Enters wireless interface configuration mode to configure an interface.

Performs a graceful shutdown and reboot of the service module.

Resets the service module hardware.

Cisco IOS Configuration Fundamentals Command Reference

715

R through setup service-module wlan-ap reload

service-module wlan-ap reload

To perform a graceful shutdown and reboot of the service module use the service-module wlan-ap reload command in privileged EXEC mode.

service-module wlan-ap interface number reload

Syntax Description

interface number The interface number for the wireless device.

Always use 0.

Command Default None

Command Modes Privileged EXEC

Command History

Release

12.4(20)T

Modification

This command was introduced for wireless-enabled

Cisco 860, 880, and 890 Integrated Services

Routers.

Usage Guidelines Autonomous Mode

At the confirmation prompt, press Enter to confirm the action, or press n to cancel.

Note When running in autonomous mode, the reload command saves the configuration before rebooting. If the attempt is unsuccessful, the following message displays: Failed to save service module configuration.

Unified Mode

The service module reload command is usually handled by the Wireless LAN Controller (WLC).

Note When running in Unified mode, the reload command will produce the following message: The embedded wireless device is in Unified mode. Reload/reset is normally handled by WLC controller. Still want to proceed? [yes]

716

Cisco IOS Configuration Fundamentals Command Reference

R through setup service-module wlan-ap reload

Examples The following examples show a graceful shut down and reboot of the service module:

Autonomous Mode

Router# service-module wlan-ap0 reload

Do you want to proceed with reload?[confirm]

Router# reload

Do you want to reload the internal AP ? [yes/no]:

Do you want to save the configuration of the AP ? [yes/no]:

System configuration has been modified. Save [yes/no]:

Proceed with reload? [confirm]

Unified Mode

Router# service-module wlan-ap0 reload

The embedded AP is in Unified mode. Reload/reset is normally handled by WLC controller.

Still want to proceed? [yes]

Router# reload

The embedded AP is in Unified mode. Reload/reset is normally handled by WLC controller.

Do you want to reload the internal AP [yes/no]:

System configuration has been modified. Save [yes/no]:

Proceed with reload [Confirm]

Related Commands

Command

interface wlan-ap

service-module wlan-ap reset

Description

Enters wireless interface configuration mode to configure an interface.

Resets the service module hardware.

Cisco IOS Configuration Fundamentals Command Reference

717

R through setup service-module wlan-ap reset

service-module wlan-ap reset

To reset the service module hardware, software, and configuration, use the service-module wlan-ap reset command in privileged EXEC mode.

service-module wlan-ap interface number reset [bootloader | default-config]

Syntax Description

interface number bootloader default-config

The interface number for the wireless device.

Always use 0.

Resets the wireless device to the bootloader for manual image recovery.

Resets the wireless device to the factory default configuration.

Command Default None

Command Modes Privileged EXEC

Command History

Release

12.4(20)T

Modification

This command was introduced for wireless-enabled

Cisco 860, 880, and 890 Integrated Services

Routers.

Usage Guidelines

At the confirmation prompt, press Enter to confirm the action, or press n to cancel.

Caution Because you may lose data, use the service-module wlan-ap reset command only to recover from a shutdown or failed state.

Examples The following example resets a wireless device on a router that is operating in either autonomous mode or

LWAPP mode:

718

Cisco IOS Configuration Fundamentals Command Reference

R through setup service-module wlan-ap reset

Autonomous Mode

Router# service-module wlan-ap0 reset

Use reset only to recover from shutdown or failed state.

LWAPP Mode

Router# service-module wlan-ap0 reset

The embedded device is in LWAPP mode. Reload/reset is normally handled by WLC controller.

Still want to proceed? [yes]

Resetting the Factory Default Configuration on the Wireless Device

The following example resets the wireless device to the default configuration.

Router#service-module wlan-ap 0 reset default-config

Router#

Recovering the Image on the Wireless Device

The following example resets the wireless device down to the bootloader level for manual image recovery.

Router#service-module wlan-ap0 reset bootloader

Router#

Related Commands

Command

interface wlan-ap service-module wlan-ap reload

Description

Enters wireless interface configuration mode to configure an interface.

Performs a graceful shutdown and reboot of the service module.

Cisco IOS Configuration Fundamentals Command Reference

719

R through setup service-module wlan-ap session

service-module wlan-ap session

To begin a configuration session with a service module through a console connection use the service-

module wlan-ap session command in privileged EXEC mode.

service-module wlan-ap interface number session [clear | disconnect]

Syntax Description

interface number clear

The interface number for the wireless device.

Always use 0.

(Optional) Clears the wireless device configuration session.

Command Default None

Command Modes Privileged EXEC

Command History

Release

12.4(20)T

Modification

This command was introduced for wireless-enabled

Cisco 860, 880, and 890 Integrated Services

Routers.

Usage Guidelines Only one session is allowed at a time into the wireless device from a router console-port connection. After starting a session, perform configuration tasks on the wireless device. You first access the router in a userlevel shell. To access the privileged EXEC command shell, where most commands are available, use the

enable command.

When you finish configuring the device, and would like to exit the console session, type Ctrl-Shift 6x to return to the router’s console. Type service-module wlan-ap session clear or disconnect to close the session with the device. At the confirmation prompt, press Enter twiceto confirm the action or n to cancel.

Note If you do not clear or disconnect the session on the service module, it will remain open in the background after you return to the router's console prompt. When the session is open in the background, pressing Enter will toggle you back to the wireless device prompt.

720

Cisco IOS Configuration Fundamentals Command Reference

R through setup service-module wlan-ap session

Examples The following example shows a session being opened on a service-module in an ISR:

Router# service-module wlan-ap 0 session

Trying 1.2.3.4, 2002 ... Open

AP#

The following example clears the session on the service-module in the ISR:

Router#service-module wlan-ap 0 session clear

[confirm]

[OK]

Related Commands

Command enable

interface wlan-ap

Description

Enters privileged EXEC mode.

Enters wireless interface configuration mode to configure an interface.

Cisco IOS Configuration Fundamentals Command Reference

721

R through setup service-module wlan-ap statistics

service-module wlan-ap statistics

To display reset and reload information for a service module and its operating system software, use the

service-module wlan-ap statisticscommand in privileged EXEC mode.

service-module wlan-ap interface number statistics

Syntax Description

interface number The interface number for the wireless device.

Always use 0.

Command Default none

Command Modes Privileged EXEC

Command History

Release

12.4(20)T

Modification

This command was introduced for wireless-enabled

Cisco 860, 880, and 890 Integrated Services

Routers.

Examples The following example displays information for wireless-enabled Cisco ISRs:

Router#service-module wlan-ap 0 statistics

Module Reset Statistics:

CLI reset count = 0

CLI reload count = 1

Registration request timeout reset count = 0

Error recovery timeout reset count = 0

Module registration count = 10

The last IOS initiated event was a cli reload at *04:27:32.041 UTC Fri Mar 8 2007

Related Commands

Command

interface wlan-ap

service-module wlan-ap reset

Description

Enters wireless interface configuration mode and configures a wireless device.

Resets the wireless device.

722

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Command

service-module wlan-ap reload service-module wlan-ap statistics

Description

Performs a graceful shutdown and reboot on the wireless device.

Cisco IOS Configuration Fundamentals Command Reference

723

R through setup service-module wlan-ap status

service-module wlan-ap status

To display configuration information related to hardware and software on the service module, use the

service-module wlan-ap statuscommand in privileged EXEC mode.

service-module wlan-ap interface number status

Syntax Description

interface number The interface number for the wireless device.

Aways use 0.

Command Default None

Command Modes Privileged EXEC

Command History

Release

12.4(20)T

Modification

This command was introduced for wireless-enabled

Cisco 860, 880, and 890 Integrated Services

Routers.

Usage Guidelines Use the service-module wlan-ap status command to

• Display the wireless device’s software release version

• Check the wireless device’s status (steady or down)

• Display hardware information for the wireless device, including image, memory, interface, and system uptime

Examples The following example displays information for the wireless device on a Cisco Integrated Services Router:

Router#service-module wlan-ap 0 status

Service Module is Cisco wlan-ap0

Service Module supports session via TTY line 2

Service Module is in Steady state

Service Module reset on error is disabled

Getting status from the Service Module, please wait..

Image path = flash:c8xx_19xx_ap-k9w7-mx.acregr/c8xx_19xx_ap-k9w7-mx.acre

System uptime = 0 days, 4 hours, 28 minutes, 5 seconds

Router#d was introduced for embedded wireless LAN access points on Cisco 860 and 880

Series Integrated Services Routers.

724

Cisco IOS Configuration Fundamentals Command Reference

R through setup

Related Commands

Command interface wlan-ap service-module wlan-ap status

Description

Enters wireless service module's console interface.

Cisco IOS Configuration Fundamentals Command Reference

725

R through setup session slot

session slot

To open a session with a module (for example, the Multilayer Switch Module (MSM), Network Analysis

Module (NAM), or Asynchronous Transfer Mode (ATM)), use the session slot command in EXEC mode.

session slot mod processor processor-id

Syntax Description mod

processor processor-id

Slot number.

Specifies the processor ID.

Command Default This command has no default settings.

Command Modes EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To end the session, enter the quit command.

This command allows you to use the module-specific CLI.

Examples This example shows how to open a session with an MSM (module 4):

Router# session slot 4 processor 2

Router#

726

Cisco IOS Configuration Fundamentals Command Reference

R through setup set memory debug incremental starting-time

set memory debug incremental starting-time

To set the current time as the starting time for incremental analysis, use the set memory debug

incremental starting-time command in privileged EXEC mode.

set memory debug incremental starting-time [none]

Syntax Description none (Optional) Resets the defined start time for incremental analysis.

Command Default

No default behavior or values.

Command Modes Privileged EXEC

Command History

Release

12.3(8)T1

12.2(25)S

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines For incremental analysis, a starting point can be defined by using the set memory debug incremental

starting-time command. When a starting time is set, only memory allocated after that starting time will be considered for reporting as leaks.

Examples The following example shows the command used to set the starting time for incremental analysis to the time when the command was issued:

Router# set memory debug incremental starting-time

Cisco IOS Configuration Fundamentals Command Reference

727

R through setup set memory debug incremental starting-time

Related Commands

Command

show memory debug incremental allocation

Description

Displays all memory blocks that were allocated after the issue of the set memory debug

incremental starting-time command.

show memory debug incremental leaks

show memory debug incremental leaks lowmem Forces incremental memory leak detection to work in low memory mode. Displays only memory that was leaked after the issue of the set memory debug

incremental starting-time command.

show memory debug incremental status

Displays only memory that was leaked after the issue of the set memory debug incremental

starting-time command.

show memory debug leaks

Displays if the starting point of incremental analysis has been defined and the time elapsed since then.

Displays detected memory leaks.

728

Cisco IOS Configuration Fundamentals Command Reference

R through setup setup

setup

To enter Setup mode, use the setup command in privileged EXEC mode.

setup

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

11.1

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Setup mode gives you the option of configuring your system without using the Cisco IOS Command Line

Interface (CLI). For some tasks, you may find it easier to use Setup than to enter Cisco IOS commands individually. For example, you might want to use Setup to add a protocol suite, to make major addressing scheme changes, or to configure a newly installed interface. Although you can use the CLI to make these changes, Setup provides you with a high-level view of the configuration and guides you through the configuration process.

If you are not familiar with Cisco products and the CLI, Setup is a particularly valuable tool because it prompts you for the specific information required to configure your system.

Note If you use the Setup mode to modify a configuration because you have added or modified the hardware, be sure to verify the physical connections using the show version EXEC command. Also, verify the logical port assignments using the show running-config EXEC command to ensure that you configure the correct port. Refer to the hardware documentation for your platform for more information on physical and logical port assignments.

Before using the Setup mode, you should have the following information so that you can configure the system properly:

• Which interfaces you want to configure

• Which routing protocols you wish to enable

• Whether the router is to perform bridging

• Network addresses for the protocols being configured

• Password strategy for your environment

When you enter the setup EXEC command after first-time startup, an interactive dialog called the System

Configuration Dialog appears on the system console screen. The System Configuration Dialog guides you

Cisco IOS Configuration Fundamentals Command Reference

729

R through setup setup

Examples through the configuration process. It prompts you first for global parameters and then for interface parameters. The values shown in brackets next to each prompt reflect either the default settings or the last configured setting.

The prompts and the order in which they appear on the screen vary depending on the platform and the interfaces installed in the device.

You must progress through the System Configuration Dialog until you come to the item that you intend to change. To accept default settings for items that you do not want to change, press the Return or Enter key.

The default choice is indicated by square brackets (for example, [yes]) before the prompt colon (:).

To exit Setup mode and return to privileged EXEC mode without making changes and without progressing through the entire System Configuration Dialog, press Ctrl-C

The facility also provides help text for each prompt. To access help text, press the question mark (?) key at a prompt.

When you complete your changes, the system will automatically display the configuration file that was created during the Setup session. It also asks you if you want to use this configuration. If you answerYes, the configuration is saved to NVRAM as the startup configuration file. If you answer No, the configuration is not saved and the process begins again. There is no default for this prompt; you must answer either Yes or No.

The following example displays the setup command facility to configure serial interface 0 and to add

ARAP and IP/IPX PPP support on the asynchronous interfaces:

Router# setup

--- System Configuration Dialog

---

At any point you may enter a question mark '?' for help.

Use ctrl-c to abort configuration dialog at any prompt.

Default settings are in square brackets '[]'.

Continue with configuration dialog? [yes]:

First, would you like to see the current interface summary? [yes]:

Interface IP-Address OK? Method Status Protocol

Ethernet0 172.16.72.2 YES manual up up

Serial0 unassigned YES not set administratively down down

Serial1 172.16.72.2 YES not set up up

Configuring global parameters:

Enter host name [Router]:

The enable secret is a one-way cryptographic secret used instead of the enable password when it exists.

Enter enable secret [<Use current secret>]:

The enable password is used when there is no enable secret and when using older software and some boot images.

Enter enable password [ww]:

Enter virtual terminal password [ww]:

Configure SNMP Network Management? [yes]:

Community string [public]:

Configure DECnet? [no]:

Configure AppleTalk? [yes]:

Multizone networks? [no]: yes

Configure IPX? [yes]:

Configure IP? [yes]:

Configure IGRP routing? [yes]:

Your IGRP autonomous system number [15]:

Configure Async lines? [yes]:

Async line speed [9600]: 57600

730

Cisco IOS Configuration Fundamentals Command Reference

R through setup setup

Configure for HW flow control? [yes]:

Configure for modems? [yes/no]: yes

Configure for default chat script? [yes]: no

Configure for Dial-in IP SLIP/PPP access? [no]: yes

Configure for Dynamic IP addresses? [yes]: no

Configure Default IP addresses? [no]: yes

Configure for TCP Header Compression? [yes]: no

Configure for routing updates on async links? [no]:

Configure for Async IPX? [yes]:

Configure for Appletalk Remote Access? [yes]:

AppleTalk Network for ARAP clients [1]: 20

Zone name for ARAP clients [ARA Dialins]:

Configuring interface parameters:

Configuring interface Ethernet0:

Is this interface in use? [yes]:

Configure IP on this interface? [yes]:

IP address for this interface [172.16.72.2]:

Number of bits in subnet field [8]:

Class B network is 172.16.0.0, 8 subnet bits; mask is /24

Configure AppleTalk on this interface? [yes]:

Extended AppleTalk network? [yes]:

AppleTalk starting cable range [1]:

AppleTalk ending cable range [1]:

AppleTalk zone name [Sales]:

AppleTalk additional zone name:

Configure IPX on this interface? [yes]:

IPX network number [1]:

Configuring interface Serial0:

Is this interface in use? [no]: yes

Configure IP on this interface? [no]: yes

Configure IP unnumbered on this interface? [no]: yes

Assign to which interface [Ethernet0]:

Configure AppleTalk on this interface? [no]: yes

Extended AppleTalk network? [yes]:

AppleTalk starting cable range [2]: 3

AppleTalk ending cable range [3]: 3

AppleTalk zone name [myzone]: ZZ Serial

AppleTalk additional zone name:

Configure IPX on this interface? [no]: yes

IPX network number [2]: 3

Configuring interface Serial1:

Is this interface in use? [yes]:

Configure IP on this interface? [yes]:

Configure IP unnumbered on this interface? [yes]:

Assign to which interface [Ethernet0]:

Configure AppleTalk on this interface? [yes]:

Extended AppleTalk network? [yes]:

AppleTalk starting cable range [2]:

AppleTalk ending cable range [2]:

AppleTalk zone name [ZZ Serial]:

AppleTalk additional zone name:

Configure IPX on this interface? [yes]:

IPX network number [2]:

Configuring interface Async1:

IPX network number [4]:

Default client IP address for this interface [none]: 172.16.72.4

Configuring interface Async2:

IPX network number [5]:

Default client IP address for this interface [172.16.72.5]:

Configuring interface Async3:

IPX network number [6]:

Default client IP address for this interface [172.16.72.6]:

Configuring interface Async4:

IPX network number [7]:

Default client IP address for this interface [172.16.72.7]:

Configuring interface Async5:

IPX network number [8]:

Default client IP address for this interface [172.16.72.8]:

Configuring interface Async6:

IPX network number [9]:

Default client IP address for this interface [172.16.72.9]:

Configuring interface Async7:

Cisco IOS Configuration Fundamentals Command Reference

731

setup

IPX network number [A]:

Default client IP address for this interface [172.16.72.10]:

Configuring interface Async8:

IPX network number [B]:

Default client IP address for this interface [172.16.72.11]:

Configuring interface Async9:

IPX network number [C]:

Default client IP address for this interface [172.16.72.12]:

Configuring interface Async10:

IPX network number [D]:

Default client IP address for this interface [172.16.72.13]:

Configuring interface Async11:

IPX network number [E]:

Default client IP address for this interface [172.16.72.14]:

Configuring interface Async12:

IPX network number [F]:

Default client IP address for this interface [172.16.72.15]:

Configuring interface Async13:

IPX network number [10]:

Default client IP address for this interface [172.16.72.16]:

Configuring interface Async14:

IPX network number [11]:

Default client IP address for this interface [172.16.72.17]:

Configuring interface Async15:

IPX network number [12]:

Default client IP address for this interface [172.16.72.18]:

Configuring interface Async16:

IPX network number [13]:

Default client IP address for this interface [172.16.72.19]:

The following configuration command script was created: hostname Router enable secret 5 $1$krIg$emfYm/1OwHVspDuS8Gy0K1 enable password ww line vty 0 4 password ww snmp-server community public

no decnet routing appletalk routing ipx routing ip routing

line 1 16 speed 57600 flowcontrol hardware modem inout

arap network 20 ARA Dialins line 1 16 arap enable autoselect

! Turn off IPX to prevent network conflicts.

interface Ethernet0 no ipx network interface Serial0 no ipx network interface Serial1 no ipx network

interface Ethernet0 ip address 172.16.72.2 255.255.255.0

appletalk cable-range 1-1 1.204

appletalk zone Sales ipx network 1 no mop enabled

interface Serial0 no shutdown no ip address ip unnumbered Ethernet0 appletalk cable-range 3-3 appletalk zone ZZ Serial

732

Cisco IOS Configuration Fundamentals Command Reference

R through setup

R through setup setup ipx network 3 no mop enabled

interface Serial1 no ip address ip unnumbered Ethernet0 appletalk cable-range 2-2 2.2

appletalk zone ZZ Serial ipx network 2 no mop enabled

Interface Async1 ipx network 4 ip unnumbered Ethernet0 peer default ip address 172.16.72.4

async mode interactive

Interface Async2 ipx network 5 ip unnumbered Ethernet0 peer default ip address 172.16.72.5

async mode interactive

Interface Async3 ipx network 6 ip unnumbered Ethernet0 peer default ip address 172.16.72.6

async mode interactive

Interface Async4 ipx network 7 ip unnumbered Ethernet0 peer default ip address 172.16.72.7

async mode interactive async dynamic address

Interface Async5 ipx network 8 ip unnumbered Ethernet0 peer default ip address 172.16.72.8

async mode interactive

Interface Async6 ipx network 9 ip unnumbered Ethernet0 peer default ip address 172.16.72.9

async mode interactive

Interface Async7 ipx network A ip unnumbered Ethernet0 peer default ip address 172.16.72.10

async mode interactive

Interface Async8 ipx network B ip unnumbered Ethernet0 peer default ip address 172.16.72.11

async mode interactive

Interface Async9 ipx network C ip unnumbered Ethernet0 peer default ip address 172.16.72.12

async mode interactive

Interface Async10 ipx network D ip unnumbered Ethernet0 peer default ip address 172.16.72.13

async mode interactive

Interface Async11

Cisco IOS Configuration Fundamentals Command Reference

733

R through setup setup ipx network E ip unnumbered Ethernet0 peer default ip address 172.16.72.14

async mode interactive

Interface Async12 ipx network F ip unnumbered Ethernet0 peer default ip address 172.16.72.15

async mode interactive

Interface Async13 ipx network 10 ip unnumbered Ethernet0 peer default ip address 172.16.72.16

async mode interactive

Interface Async14 ipx network 11 ip unnumbered Ethernet0 peer default ip address 172.16.72.17

async mode interactive

Interface Async15 ipx network 12 ip unnumbered Ethernet0 peer default ip address 172.16.72.18

async mode interactive

Interface Async16 ipx network 13 ip unnumbered Ethernet0 peer default ip address 172.16.72.19

async mode interactive

router igrp 15 network 172.16.0.0

end

Use this configuration? [yes/no]: yes

Building configuration...

Use the enabled mode 'configure' command to modify this configuration.

Router#

Related Commands

Command

erase nvram:

show running-config

show startup-config

show version

Description

Erases a file system.

Displays the running configuration file. Command alias for the more system:running-config command.

Displays the startup configuration file. Command alias for the more system:startup-

configcommand.

Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.

734

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

•

show, page 737

•

show command append, page 739

•

show command begin, page 741

•

show command exclude, page 744

•

show command include, page 746

•

show command redirect, page 749

•

show command section, page 751

•

show command tee, page 753

•

show (Flash file system), page 755

•

show aliases, page 764

•

show alignment, page 765

•

show archive, page 768

•

show archive config differences, page 771

•

show archive config incremental-diffs, page 774

•

show archive config rollback timer, page 776

•

show archive log config, page 778

•

show as5400, page 782

•

show async bootp, page 785

•

show autoupgrade configuration unknown, page 787

•

show bcm560x, page 789

•

show bootflash:, page 790

•

show bootvar, page 793

•

show buffers, page 797

•

show c2600, page 807

•

show c7200, page 811

•

show catalyst6000, page 813

•

show cls, page 816

•

show config id, page 818

•

show configuration id, page 820

•

show configuration lock, page 822

•

show context, page 826

•

show controllers (GRP image), page 830

•

show controllers (line card image), page 833

•

show controllers logging, page 842

•

show controllers tech-support, page 844

Cisco IOS Configuration Fundamentals Command Reference

735

•

show coverage history, page 846

•

show data-corruption, page 847

•

show debugging, page 849

•

show declassify, page 852

•

show derived-config, page 854

•

show diagnostic cns, page 857

•

show diagnostic sanity, page 859

•

show disk, page 863

•

show disk0:, page 865

•

show disk1:, page 868

•

show environment, page 871

•

show environment alarm, page 899

•

show environment connector, page 902

•

show environment cooling, page 904

•

show environment status, page 906

•

show environment temperature, page 909

•

show errdisable detect, page 912

•

show errdisable recovery, page 914

•

show fastblk, page 916

•

show file descriptors, page 918

•

show file information, page 920

•

show file systems, page 922

•

show flh-log, page 925

•

show fm inspect, page 926

•

show fm interface, page 928

•

show fm reflexive, page 931

•

show fm summary, page 932

•

show funi, page 934

•

show identity policy, page 938

•

show identity profile, page 939

•

show platform software snapshot status, page 941

show through show fm summary

736

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show

show

To verify the Multiple Spanning Tree (MST) configuration, use the show command in MST configuration mode.

show [current | pending]

Syntax Description current pending

(Optional) Displays the current configuration that is used to run MST.

(Optional) Displays the edited configuration that will replace the current configuration.

Command Default This command has no default settings.

Command Modes MST configuration (config-mst)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The display output from the show pending command is the edited configuration that will replace the current configuration if you enter the exit command to exit MST configuration mode.

Entering the show command with no arguments displays the pending configurations.

Examples This example shows how to display the edited configuration:

Router(config-mst)# show pending

Pending MST configuration

Name [zorglub]

Version 31415

Instance Vlans Mapped

-------- ---------------------------------------------------------------------

Cisco IOS Configuration Fundamentals Command Reference

737

show through show fm summary show

0 4001-4096

2 1010, 1020, 1030, 1040, 1050, 1060, 1070, 1080, 1090, 1100, 1110

1120

3 1-1009, 1011-1019, 1021-1029, 1031-1039, 1041-1049, 1051-1059

1061-1069, 1071-1079, 1081-1089, 1091-1099, 1101-1109, 1111-1119

1121-4000

------------------------------------------------------------------------------

Router(config-mst)#

This example shows how to display the current configuration:

Router(config-mst)# show current

Current MST configuration

Name []

Revision 0

Instance Vlans mapped

-------- ---------------------------------------------------------------------

0 1-4094

-------------------------------------------------------------------------------

Related Commands

Command instance

name (MST configuration submode) revision

show spanning-tree mst

spanning-tree mst configuration

Description

Maps a VLAN or a set of VLANs to an MST instance.

Sets the name of an MST region.

Sets the revision number for the MST configuration.

Displays the information about the MST protocol.

Enters MST-configuration submode.

738

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command append

show command append

To redirect and add the output of any show command to an existing file, use the show command | append command in privileged EXEC mode.

{show command | append url}

Syntax Description command

| append url

Any Cisco IOS showcommand.

The addition of this syntax redirects the command output to the file location specified in the Universal

Resource Locator (URL). The pipe (|) is required.

The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename

Prefixes can be local file locations, such as flash: or

disk0:. Alternatively, you can specify network locations using the following syntax:

ftp: [[//[username [:password ]@]location ]/

directory ]/filename

tftp: [[//location ]/directory ]/filename

The rcp: prefix is not supported.

Command Modes Privileged EXEC

Command History

Release

12.0(21)S

12.2(13)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(13)T.

Usage Guidelines To display all URL prefixes that are supported for this command, use the showcommand| append ? command.

This command adds the show command output to the end of the specified file.

Cisco IOS Configuration Fundamentals Command Reference

739

show through show fm summary show command append

Examples In the following example, output from the show tech-support command is redirected to an existing file on

Disk 1 with the file-name of “showoutput.txt.” This output is added at the end of any existing data in the file.

Router# show tech-support | append disk1:showoutput.txt

Related Commands

Command

show <command> redirect

show <command> tee

Description

Redirects the output of any show command to a specified file.

Copies the show command output to a file while displaying it on the terminal.

740

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command begin

show command begin

To begin the output of any showcommand from a specified string, use the show command | begin command in EXEC mode.

{show command | begin regular-expression}

Syntax Description

| command regular-expression

Any supported show command.

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in show command output. The show output will begin from the first instance of this string (output prior to this string will not be printed to the screen). The string is casesensitive. Use parenthesis to indicate a literal use of spaces.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression.

Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression.

Command Modes EXEC

Command History

Release

8.3

12.0(1)T

12.2(33)SRA

Modification

The show command was introduced.

This extension of the show command was introduced..

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

741

show through show fm summary show command begin

Usage Guidelines The regular-expressionargument is case sensitive and allows for complex matching requirements. Use parenthesis to indicate a literal use of spaces. For example, | begin u indicates that the show output should begin with any line that contains a u; | begin ( u) indicates that the show output should begin with any line that contains a space and a u together (line has a word that begins with a lowercase u).

To search the remaining output of the show command, use the following command at the --More-- prompt:

/ regular-expression

You can specify a filtered search at any --More-- prompt. To filter the remaining output of the show command, use one of the following commands at the --More-- prompt:

- regular-expression

+ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-z.

Note Once you specify a filter for a show command, you cannot specify another filter at the next --More-prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.

Because prior output is not saved, you cannot search or filter backward through prior output.

Note A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or

Ctrl-Z combinations as there are --More-- prompts to completely abort output.

Examples

The following is partial sample output of the show interface | begincommand that begins unfiltered output with the first line that contains the regular expression “Ethernet.” At the --More-- prompt, the user specifies a filter to show only the lines in the remaining output that contain the regular expression “Serial.”

Router# show interface | begin Ethernet

Ethernet0 is up, line protocol is up

Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399)

Description: ip address is 172.1.2.14 255.255.255.0

Internet address is 172.1.2.14/24

0 lost carrier, 0 no carrier

0 output buffer failures, 0 output buffers swapped out

--More--

+Serial filtering...

Serial1 is up, line protocol is up

Serial2 is up, line protocol is up

Serial3 is up, line protocol is down

Serial4 is down, line protocol is down

Serial5 is up, line protocol is up

Serial6 is up, line protocol is up

Serial7 is up, line protocol is up

742

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

more <url> begin

more <url> exclude

more <url> include

show <command> exclude

show <command> include show command begin

Description

Begins unfiltered output of the more command with the first line that contains the regular expression you specify.

Filters more command output so that it excludes lines that contain a particular regular expression.

Filters more command output so that it displays only lines that contain a particular regular expression.

Filters show command output so that it excludes lines that contain a particular regular expression.

Filters show command output so that it displays only lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

743

show through show fm summary show command exclude

show command exclude

To filter showcommand output so that it excludes lines that contain a particular regular expression, use the

show command | exclude command in EXEC mode.

{show command | exclude regular-expression}

Syntax Description

| command

/ regular-expression

Any supported show command.

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in show command output.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Command Modes EXEC

Command History

Release

12.0(1)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt:

/ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

744

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command exclude

Ctrl-Z combinations as there are --More-- prompts to completely abort output.

Examples

The following is partial sample output of the show | excludecommand used with the show

bufferscommand. It excludes lines that contain the regular expression “0 misses.” At the --More-- prompt, the user searches for the regular expression “Serial0,” which continues the filtered output with the first line that contains “Serial0.”

Router# show buffers | exclude 0 misses

Buffer elements:

398 in free list (500 max allowed)

Public buffer pools:

Small buffers, 104 bytes (total 50, permanent 50):

50 in free list (20 min, 150 max allowed)

551 hits, 3 misses, 0 trims, 0 created

Big buffers, 1524 bytes (total 50, permanent 50):

49 in free list (5 min, 150 max allowed)

Very Big buffers, 4520 bytes (total 10, permanent 10):

Huge buffers, 18024 bytes (total 0 permanent 0):

0 in free list (0 min, 4 max allowed)

--More--

/Serial0 filtering...

Serial0 buffers, 1543 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

Related Commands

Command

more <url> begin

more <url> exclude

more <url> include

show <command> begin

show <command> include

Description

Begins unfiltered output of the more command with the first line that contains the regular expression you specify.

Filters more command output so that it excludes lines that contain a particular regular expression.

Filters more command output so that it displays only lines that contain a particular regular expression.

Searches the output of any show command and displays the output from the first instance of a specified string.

Filters showcommand output so that it displays only lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

745

show through show fm summary show command include

show command include

To filter showcommand output so that it only displays lines that contain a particular regular expression, use the show command | include command in EXEC mode.

{show command | include regular-expression}

Syntax Description

| command regular-expression

Any supported show command.

A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.

Any regular expression found in show command output. Use parenthesis to include spaces in the expression.

Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.

Command Modes EXEC

Command History

Release

12.0(1)T

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt:

/ regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press

Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

746

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command include

Ctrl-Z combinations as there are --More-- prompts to completely abort output.

Examples

The following is partial sample output of the show interface | includecommand. It displays only lines that contain the regular expression “( is ).” The parentheses force the inclusion of the spaces before and after

“is.” Use of the parenthesis ensures that only lines containing “is” with a space both before and after it will be included in the output. Lines with words like “disconnect” will be excluded because there are not spaces around the instance of the string “is”.

Router# show interface | include ( is )

ATM0 is administratively down, line protocol is down

Hardware is ATMizer BX-50

Dialer1 is up (spoofing), line protocol is up (spoofing)

Hardware is Unknown

DTR is pulsed for 1 seconds on reset

Ethernet0 is up, line protocol is up

Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399)

Internet address is 172.21.53.199/24

Ethernet1 is up, line protocol is up

Hardware is Lance, address is 0060.837c.639c (bia 0060.837c.639c)

Internet address is 5.5.5.99/24

Serial0:0 is down, line protocol is down

Hardware is DSX1

--More--

At the --More-- prompt, the user searches for the regular expression “Serial0:13”, which continues filtered output with the first line that contains “Serial0:13.”

/Serial0:13 filtering...

Serial0:13 is down, line protocol is down

Hardware is DSX1

Internet address is 11.0.0.2/8

0 output errors, 0 collisions, 2 interface resets

Timeslot(s) Used:14, Transmitter delay is 0 flags

Related Commands

Command

more <url> begin

more <url> exclude

more <url> include

Description

Begins unfiltered output of the more command with the first line that contains the regular expression you specify.

Filters more command output so that it excludes lines that contain a particular regular expression.

Filters more command output so that it displays only lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

747

show command include

Command

show <command> begin

show <command> exclude show through show fm summary

Description

Searches the output of any show command and displays the output from the first instance of a specified string.

Filters show command output so that it excludes lines that contain a particular regular expression.

748

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command redirect

show command redirect

To redirect the output of any show command to a file, use the show command | redirectcommand in privileged EXEC mode.

{show command | redirect url}

Syntax Description command

| redirect url

Any Cisco IOS showcommand.

The addition of this syntax redirects the command output to the file location specified in the Universal

Resource Locator (URL). The pipe (|) is required.

The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename

Prefixes can be local file locations, such as flash: or

disk0:. Alternatively, you can specify network locations using the following syntax:

ftp: [[//[username [:password ]@]location ]/

directory ]/filename

tftp: [[//location ]/directory ]/filename

The rcp: prefix is not supported.

Command Modes Privileged EXEC

Command History

Release

12.0(21)S

12.2(13)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(13)T.

Usage Guidelines To display all URL prefixes that are supported for this command, use the showcommand| redirect ? command.

This command creates a new file at the specified location, or overwrites an existing file.

Cisco IOS Configuration Fundamentals Command Reference

749

show through show fm summary show command redirect

Examples In the following example, output from the show tech-support command is write to the file “showtech.txt” on the host at 172.16.101.101 in the directory “//tftpboot/docs/” using FTP:

Router# show tech | redirect ftp://USER:[email protected]//tftpboot/docs/ showtech.txt

Related Commands

Command

show <command> append

show <command> tee

Description

Redirects and appends showcommand output to the end of an existing file.

Copies the showcommand output to a file while displaying it on the terminal.

750

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command section

show command section

To filter the output of a show command to match a given expression as well as any lines associated with that expression, use the showcommand sectioncommand in privileged EXEC mode.

{show command | section [include | exclude] regular-expression}

Syntax Description command include exclude regular-expression

Any Cisco IOS showcommand.

(Optional) Includes only the lines that contain a particular regular expression. This is the default keyword when none is specified.

(Optional) Excludes any lines that contain a particular regular expression.

Any regular expression or plain text string found in show command output. The syntax of the regular expression conforms to that of Bell V8 regexp(3).

Command Modes Privileged EXEC

Command History

Release

12.3(2)T

Modification

This command was introduced.

Usage Guidelines In many cases, it is useful to filter the output of a show command to match a specific expression. Filtering provides some control over the type and amount of information displayed by the system. The show section command provides enhanced filtering capabilities by matching lines in the show command output containing specific expressions as well as matching any entries associated with those expressions. Filtering is especially useful, for example, when displaying large configuration files using the show running-

configuration command or the show interfaces command.

If the include or exclude keyword is not specified, include is the default.

If there are no associated entries for an expression, then only the line matching the expression is displayed.

Examples The following examples compare the filtering characteristics of the show running-config | include command with the show running-config | section command. The first example gathers just the lines from the configuration file with “interface” in them.

Router# show running-config | include interface

Cisco IOS Configuration Fundamentals Command Reference

751

show through show fm summary show command section interface Ethernet0/0 interface Ethernet1/0 interface Serial2/0 interface Serial3/0

The next example uses the showcommand sectioncommand to gather the lines in the configuration file with

“interface” in them as well as any lines associated with those entries. In this example, interface configuration information is captured.

Router# show running-config | section include interface interface Ethernet0/0

shutdown

no cdp enable interface Ethernet1/0

shutdown

no cdp enable interface Serial2/0

shutdown

no cdp enable interface Serial3/0

shutdown

no cdp enable

Related Commands

Command

show <command> append

show <command> exclude

show <command> include

show <command> redirect

Description

Redirects the output of any show command and adds it to the end of an existing file.

Filters show command output so that it excludes lines that contain a particular regular expression.

Filters show command output so that it displays only lines that contain a particular regular expression.

Redirects the output of any show command to a specified file.

752

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show command tee

show command tee

To copy the output of any show command to a file while displaying it on the terminal, use the show

command | teecommand in privileged EXEC mode.

{show command | tee [/append] url}

Syntax Description command

| tee url

/append

Any Cisco IOS showcommand.

The addition of this syntax copies the command output to the file location specified in the Universal

Resource Locator (URL). The pipe (|) is required.

The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename

Prefixes can be local file locations, such as flash: or

disk0:. Alternatively, you can specify network locations using the following syntax:

ftp: [[//[username [:password ]@]location ]/

directory ]/filename

tftp: [[//location ]/directory ]/filename

The rcp: prefix is not supported.

(Optional) Adds the show command output to the end of an existing file.

Command Modes Privileged EXEC

Command History

Release

12.0(21)S

12.2(13)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(13)T.

Usage Guidelines To display all URL prefixes that are supported for this command, use the showcommand| tee ? command.

The tee keyword was chosen to reflect that output is redirected to two locations; the terminal and a file (as a tee plumbing junction redirects water to two different pipes).

Cisco IOS Configuration Fundamentals Command Reference

753

show through show fm summary show command tee

Examples In the following example, output from the show tech-support command is displayed on-screen while it is written to the file “showoutput.txt” at the host 172.16.101.101 using TFTP:

Router# show tech-support | tee tftp://172.16.101.101/docs/showoutput.txt

The following example performs the same function as above, but in this case the output is added at the end of any existing data in the file “showoutput.txt”:

Router# show tech-support | tee /append tftp://172.16.101.101/docs/showoutput.txt

Related Commands

Command

show <command> append

show <command> redirect

Description

Redirects the output of any show command and adds it to the end of existing file.

Redirects the output of any show command to a specified file.

754

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show (Flash file system)

show (Flash file system)

To display the layout and contents of a Flash memory file system, use the show flash-filesystem command in EXEC mode.

Class A Flash File Systems

show flash-filesystem : [all | chips | filesys]

Class B Flash File Systems

show flash-filesystem : [partition-number:] [all | chips | detailed | err | summary]

Class C Flash File Systems

show flash-filesystem :

Syntax Description

flash-filesystem : all

Flash memory file system, followed by a colon. The availablity of Flash file system keywords will vary by platform. Valid flash file system keywords inlude:

• bootflash

• flash

• slot0

• slot1

• slavebootflash

• slaveslot0

• slaveslot1

(Optional) On Class B Flash file systems, all keyword displays complete information about Flash memory, including information about the individual

ROM devices in Flash memory and the names and sizes of all system image files stored in Flash memory, including those that are invalid.

On Class A Flash file systems, the all keyword displays the following information:

• The information displayed when no keywords are used.

• The information displayed by the filesys keyword.

• The information displayed by the chips keyword.

Cisco IOS Configuration Fundamentals Command Reference

755

show through show fm summary show (Flash file system) chips filesys partition-number detailed err summary

(Optional) Displays information per partition and per chip, including which bank the chip is in, plus its code, size, and name.

(Optional) Displays the Device Info Block, the

Status Info, and the Usage Info.

(Optional) Displays output for the specified partition number. If you do not specify a partition in the command, the router displays output for all partitions. You can use this keyword only when

Flash memory has multiple partitions.

(Optional) Displays detailed file directory information per partition, including file length, address, name, Flash memory checksum, computer checksum, bytes used, bytes available, total bytes, and bytes of system Flash memory.

(Optional) Displays write or erase failures in the form of number of retries.

(Optional) Displays summary information per partition, including the partition size, bank size, state, and method by which files can be copied into a particular partition. You can use this keyword only when Flash memory has multiple partitions.

Command Modes EXEC

Command History

Release

11.3 AA

12.3

12.2(33)SRA

Modification

This command was introduced.

A timestamp that shows the offset from

Coordinated Universal Time (UTC) was added to the show command display.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If Flash memory is partitioned, the command displays the requested output for each partition, unless you use the partition keyword.

The command also specifies the location of the current image.

To display the contents of boot Flash memory on Class A or B file systems, use the show bootflash: command as follows:

756

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Examples show (Flash file system)

Class A Flash file systems

show bootflash: [all | chips | filesys]

Class B Flash file systems

show bootflash: [partition-number] [all | chips | detailed | err

To display the contents of internal Flash memory on Class A or B file systems, use the show flash: command as follows:

Class A Flash file systems

show flash: all | chips | filesys]

Class B Flash file systems

show flash: [partition-number][all | chips | detailed | err | summary]

The show(Flash file system) command replaces the show flash devices command.

The output of the showcommand depends on the type of Flash file system you select. Types include flash:,

bootflash:, slot0:, slot1:, slavebootflash:, slaveslot0:, and slaveslot1:.

Examples of output from the show flashcommand are provided in the following sections:

• Class A Flash File System

• Class B Flash File Systems

Although the examples use flash: as the Flash file system, you may also use the other Flash file systems listed.

Class A Flash File System

The following three examples show sample output for Class A Flash file systems. The table below describes the significant fields shown in the display.

The following is sample output from the show flash: command.

Router# show flash:

-#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name

1 .. unknown 317FBA1B 4A0694 24 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/ c7200-j-mz

2 .. unknown 9237F3FF 92C574 11 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz

3 .D unknown 71AB01F1 10C94E0 10 7982828 Jan 02 2004 18:48:14 -08:00 rsp-jsv-mz

4 .D unknown 96DACD45 10C97E0 8 639 Jan 03 2004 12:09:17 -08:00 the_time

5 .. unknown 96DACD45 10C9AE0 3 639 Jan 03 2004 12:09:32 -08:00 the_time

6 .D unknown 96DACD45 10C9DE0 8 639 Jan 03 2004 12:37:01 -08:00 the_time

7 .. unknown 96DACD45 10CA0E0 8 639 Jan 03 2004 12:37:13 -08:00 the_time

3104544 bytes available (17473760 bytes used)

Table 42 show (Class A Flash File System) Field Descriptions

Field

Description

Index number for the file.

Whether the file contains an error (E) or is deleted

(D).

Cisco IOS Configuration Fundamentals Command Reference

757

show through show fm summary show (Flash file system)

Field type crc seek nlen length date/time name

The following is sample output from the show flash: chips command:

RouterA# show flash: chips

******** Intel Series 2+ Status/Register Dump ********

ATTRIBUTE MEMORY REGISTERS:

Config Option Reg (4000): 2

Config Status Reg (4002): 0

Card Status Reg (4100): 1

Write Protect Reg (4104): 4

Voltage Cntrl Reg (410C): 0

Rdy/Busy Mode Reg (4140): 2

COMMON MEMORY REGISTERS: Bank 0

Intelligent ID Code : 8989A0A0

Compatible Status Reg: 8080

Global Status Reg: B0B0

Block Status Regs:

0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

COMMON MEMORY REGISTERS: Bank 1

Intelligent ID Code : 8989A0A0

Compatible Status Reg: 8080

Global Status Reg: B0B0

Block Status Regs:

0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

COMMON MEMORY REGISTERS: Bank 2

Intelligent ID Code : 8989A0A0

Compatible Status Reg: 8080

Global Status Reg: B0B0

Block Status Regs:

0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

COMMON MEMORY REGISTERS: Bank 3

Intelligent ID Code : 8989A0A0

Compatible Status Reg: 8080

Global Status Reg: B0B0

Block Status Regs:

0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

Description

File type (1 = configuration file, 2 = image file).

The software displays these values only when the file type is certain. When the file type is unknown, the system displays “unknown” in this field.

Cyclic redundant check for the file.

Offset into the file system of the next file.

Name length--Length of the filename.

Length of the file itself.

Date and time the file was created. In the example,

-08:00 indicates that the given date and time is 8 hours behind Coordinated Universal Time (UTC).

Name of the file.

758

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show (Flash file system)

16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

COMMON MEMORY REGISTERS: Bank 4

Intelligent ID Code : 8989A0A0

Compatible Status Reg: 8080

Global Status Reg: B0B0

Block Status Regs:

0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0

The following is sample output from the show flash: filesys command:

RouterA# show flash: filesys

-------- F I L E S Y S T E M S T A T U S --------

Device Number = 0

DEVICE INFO BLOCK:

Magic Number = 6887635 File System Vers = 10000 (1.0)

Length = 1400000 Sector Size = 20000

Programming Algorithm = 4 Erased State = FFFFFFFF

File System Offset = 20000 Length = 13A0000

MONLIB Offset = 100 Length = C730

Bad Sector Map Offset = 1FFEC Length = 14

Squeeze Log Offset = 13C0000 Length = 20000

Squeeze Buffer Offset = 13E0000 Length = 20000

Num Spare Sectors = 0

Spares:

STATUS INFO:

Writable

NO File Open for Write

Complete Stats

No Unrecovered Errors

No Squeeze in progress

USAGE INFO:

Bytes Used = 10AA0E0 Bytes Available = 2F5F20

Bad Sectors = 0 Spared Sectors = 0

OK Files = 4 Bytes = 90C974

Deleted Files = 3 Bytes = 79D3EC

Files w/Errors = 0 Bytes = 0

The following is sample output from the show flash:command:

RouterB> show flash:

System flash directory:

File Length Name/status

1 4137888 c3640-c2is-mz.Feb24

[4137952 bytes used, 12639264 available, 16777216 total]

16384K bytes of processor board System flash (Read/Write)\

The following example shows detailed information about the second partition in internal Flash memory:

RouterB# show flash:2

System flash directory, partition 2:

File Length Name/status

1 1711088 dirt/images/c3600-i-mz

[1711152 bytes used, 15066064 available, 16777216 total]

16384K bytes of processor board System flash (Read/Write)

Class B Flash File Systems

The table below describes the significant fields shown in the displays.

Cisco IOS Configuration Fundamentals Command Reference

759

show through show fm summary show (Flash file system)

Table 43

Field addr available

Bank

Bank-Size bytes used ccksum

Chip

Code

Copy-Mode fcksum

File

Free

Length

Name show (Class B Flash File System) all Fields

Description

Address of the file in Flash memory.

Total number of bytes available in Flash memory.

Bank number.

Size of bank in bytes.

Total number of bytes used in Flash memory.

Computed checksum.

Chip number.

Code number.

Method by which the partition can be copied to:

• RXBOOT-MANUAL indicates a user can copy manually by reloading to the boot ROM image.

• RXBOOT-FLH indicates user can copy via

Flash load helper.

• Direct indicates user can copy directly into

Flash memory.

• None indicates that it is not possible to copy into that partition.

Checksum recorded in Flash memory.

Number of the system image file. If no filename is specified in the boot system flash command, the router boots the system image file with the lowest file number.

Number of bytes free in partition.

Size of the system image file (in bytes).

Name of chip manufacturer and chip type.

760

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show (Flash file system)

Field

Name/status

Partition

Size

State

System flash directory total

Used

Description

Filename and status of a system image file. The status [invalidated] appears when a file has been rewritten (recopied) into Flash memory. The first

(now invalidated) copy of the file is still present within Flash memory, but it is rendered unusable in favor of the newest version. The [invalidated] status can also indicate an incomplete file that results from the user abnormally terminating the copy process, a network timeout, or a Flash memory overflow.

Partition number in Flash memory.

Size of partition (in bytes) or size of chip.

State of the partition. It can be one of the following values:

• Read-Only indicates the partition that is being executed from.

• Read/Write is a partition that can be copied to.

Flash directory and its contents.

Total size of Flash memory (in bytes).

Number of bytes used in partition.

The following is sample output from the show flash: all command:

RouterB> show flash: all

Partition Size Used Free Bank-Size State Copy Mode

1 16384K 4040K 12343K 4096K Read/Write Direct

System flash directory:

File Length Name/status

addr fcksum ccksum

1 4137888 c3640-c2is-mz.Feb24

0x40 0xED65 0xED65

[4137952 bytes used, 12639264 available, 16777216 total]

16384K bytes of processor board System flash (Read/Write)

Chip Bank Code Size Name

1 1 01D5 1024KB AMD 29F080

2 1 01D5 1024KB AMD 29F080

3 1 01D5 1024KB AMD 29F080

4 1 01D5 1024KB AMD 29F080

1 2 01D5 1024KB AMD 29F080

2 2 01D5 1024KB AMD 29F080

3 2 01D5 1024KB AMD 29F080

4 2 01D5 1024KB AMD 29F080

1 3 01D5 1024KB AMD 29F080

2 3 01D5 1024KB AMD 29F080

3 3 01D5 1024KB AMD 29F080

4 3 01D5 1024KB AMD 29F080

1 4 01D5 1024KB AMD 29F080

2 4 01D5 1024KB AMD 29F080

3 4 01D5 1024KB AMD 29F080

4 4 01D5 1024KB AMD 29F080

Cisco IOS Configuration Fundamentals Command Reference

761

show through show fm summary show (Flash file system)

The following is sample output from the show flash: all command on a router with Flash memory partitioned:

Router# show flash: all

System flash partition information:

Partition

Size Used Free Bank-Size State Copy-Mode

4096K 3459K 637K 4096K Read Only RXBOOT-FLH

4096K 3224K 872K 4096K Read/Write Direct

System flash directory, partition 1:

File Length Name/status

addr fcksum ccksum

1 3459720 master/igs-bfpx.100-4.3

0x40 0x3DE1 0x3DE1

[3459784 bytes used, 734520 available, 4194304 total]

4096K bytes of processor board System flash (Read ONLY)

Chip Bank Code Size Name

1 1 89A2 1024KB INTEL 28F008SA

2 1 89A2 1024KB INTEL 28F008SA

3 1 89A2 1024KB INTEL 28F008SA

4 1 89A2 1024KB INTEL 28F008SA

Executing current image from System flash [partition 1]

System flash directory, partition2:

File Length Name/status

addr fcksum ccksum

1 3224008 igs-kf.100

0x40 0xEE91 0xEE91

[3224072 bytes used, 970232 available, 4194304 total]

4096K bytes of processor board System flash (Read/Write)

Chip Bank Code Size Name

1 2 89A2 1024KB INTEL 28F008SA

2 2 89A2 1024KB INTEL 28F008SA

3 2 89A2 1024KB INTEL 28F008SA

4 2 89A2 1024KB INTEL 28F008SA

The following is sample output from the show flash: chips command:

RouterB> show flash: chips

16384K bytes of processor board System flash (Read/Write)

Chip Bank Code Size Name

1 1 01D5 1024KB AMD 29F080

2 1 01D5 1024KB AMD 29F080

3 1 01D5 1024KB AMD 29F080

4 1 01D5 1024KB AMD 29F080

1 2 01D5 1024KB AMD 29F080

2 2 01D5 1024KB AMD 29F080

3 2 01D5 1024KB AMD 29F080

4 2 01D5 1024KB AMD 29F080

1 3 01D5 1024KB AMD 29F080

2 3 01D5 1024KB AMD 29F080

3 3 01D5 1024KB AMD 29F080

4 3 01D5 1024KB AMD 29F080

1 4 01D5 1024KB AMD 29F080

2 4 01D5 1024KB AMD 29F080

3 4 01D5 1024KB AMD 29F080

4 4 01D5 1024KB AMD 29F080

The following is sample output from the show flash: detailed command:

RouterB> show flash: detailed

System flash directory:

File Length Name/status

addr fcksum ccksum

762

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show (Flash file system)

1 4137888 c3640-c2is-mz.Feb24

0x40 0xED65 0xED65

[4137952 bytes used, 12639264 available, 16777216 total]

16384K bytes of processor board System flash (Read/Write)

The following is sample output from the show flash: err command:

RouterB> show flash: err

System flash directory:

File Length Name/status

1 4137888 c3640-c2is-mz.Feb24

[4137952 bytes used, 12639264 available, 16777216 total]

16384K bytes of processor board System flash (Read/Write)

Chip Bank Code Size Name erase write

1 1 01D5 1024KB AMD 29F080 0 0

2 1 01D5 1024KB AMD 29F080 0 0

3 1 01D5 1024KB AMD 29F080 0 0

4 1 01D5 1024KB AMD 29F080 0 0

1 2 01D5 1024KB AMD 29F080 0 0

2 2 01D5 1024KB AMD 29F080 0 0

3 2 01D5 1024KB AMD 29F080 0 0

4 2 01D5 1024KB AMD 29F080 0 0

1 3 01D5 1024KB AMD 29F080 0 0

2 3 01D5 1024KB AMD 29F080 0 0

3 3 01D5 1024KB AMD 29F080 0 0

4 3 01D5 1024KB AMD 29F080 0 0

1 4 01D5 1024KB AMD 29F080 0 0

2 4 01D5 1024KB AMD 29F080 0 0

3 4 01D5 1024KB AMD 29F080 0 0

4 4 01D5 1024KB AMD 29F080 0 0

See the table above for a description of the fields. The show flash: err command also displays two extra fields: erase and write. The erase field indications the number of erase errors. The write field indicates the number of write errors.

The following is sample output from the show flash summary command on a router with Flash memory partitioned. The partition in the Read Only state is the partition from which the Cisco IOS image is being executed.

Router# show flash summary

System flash partition information:

Partition Size Used Free Bank-Size State Copy-Mode

1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH

2 4096K 2048K 2048K 2048K Read/Write Direct

Related Commands

Command more

Description

Displays the contents of any file in the Cisco IOS

File System.

Cisco IOS Configuration Fundamentals Command Reference

763

show through show fm summary show aliases

show aliases

To display all alias commands, or the alias commands in a specified mode, use the show aliases command in EXEC mode.

show aliases [mode]

Syntax Description mode (Optional) Name of a specific command or configuration mode. Specifies that only aliases configured for this mode should be displayed.

Command Modes EXEC

Command History

Release

10.3

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines When used without the mode argument, this command will display all aliases currently configured on the system. Use the mode argument to display only the aliases configured for the specified command mode.

To display a list of the command mode keywords available for your system, use the show aliases ? command.

The following is sample output from the show aliases exec commands. The aliases configured for commands in EXEC mode are displayed.

Router> show aliases exec

Exec mode aliases:

h help

lo logout

p ping

r resume

s show

w where

Related Commands

Command alias

Description

Creates a command alias.

764

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show alignment

show alignment

To display alignment errors and spurious memory access errors, use the show alignment command in privileged EXEC mode.

show alignment

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

12.3(7)T

12.2(22)S

12.2(18)SXE

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(22)S.

This command was integrated into Cisco IOS

Release 12.2(18)SXE.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Alignment Errors

Alignment errors are caused by misaligned reads and writes. For example, a two-byte read where the memory address is not an even multiple of two bytes is an alignment error. Alignment errors are caused by a software defect.

Alignment errors are reported in the system log and recorded by the router. Output from the show

alignment command provides a record of these errors along with potentially useful traceback information.

The traceback information for alignment errors can generally be decoded to reveal the function causing the alignment problems.

Spurious Memory Access Errors

Spurious memory access errors occur when a software process attempts to access memory in a restricted location. A read operation to this region of memory is usually caused when a nonexisting value is returned to a function in the software, or in other words, when a null pointer is passed to a function.

Spurious memory access errors are counted and recorded, if possible, by the software. This information is displayed with the show alignment command.

Cisco IOS Configuration Fundamentals Command Reference

765

show through show fm summary show alignment

Examples The following is sample output from the show alignment command when alignment detection is disabled.

To enable alignment detection, use the enable command to enter privileged EXEC mode

Router# show alignment

Unaligned handler is disabled

Router#

The following is sample output from the show alignment command when there are no alignment or spurious memory errors:

Router# show alignment

No alignment data has been recorded.

No spurious memory references have been recorded.

Router#

The following is sample output from the show alignment command when there are only alignment errors.

The traceback information is necessary to determine the cause and the fix of the alignment errors.

Router# show alignment

Total Corrections 134, Recorded 1, Reads 134, Writes 0

Initial Initial

Address Count Access Type Traceback

1A014C5 134 32bit read 0x6012F538 0x601338F8 0x601344D8 0x6022D528

No spurious memory references have been recorded.

Router#

The table below describes the significant fields shown in the display.

Table 44 show alignment Field Descriptions

Field

Total Corrections

Recorded

Reads

Writes

Initial Address

Count

Initial Access

Type

Traceback

Description

Total number of alignment corrections made.

Number of alignment entries.

Number of misaligned reads.

Number of misaligned writes.

Address of where the alignment error occurred.

Number of times the alignment occurred at this address.

Address of where the alignment error occurred.

Type of alignment error: read or write.

The traceback address information necessary to determine the cause of the misalignment.

The following is sample output from the show alignmentcommand when there are only spurious memory access errors:

Router# show alignment

No alignment data has been recorded.

Total Spurious Accesses 50, Recorded 3

Address Count Traceback

766

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show alignment

E 10 0x605351A0 0x603CA084 0x606C4060 0x606D6368 0x60743284 0x60743270

E 20 0x605351A0 0x6036EE7C 0x606C4060 0x606D6368 0x60743284

0x60743270

E 20 0x605351A0 0x603C998C 0x606D53EC 0x606C4060 0x606D6368 0x60743284

Router#

The table below describes the significant fields shown in the display.

Table 45 show alignment Field Descriptions for Spurious Memory Access Errors

Field

Total Spurious Accesses

Recorded

Address

Count

Traceback

Description

Total number of spurious memory accesses made.

Number of recorded spurious memory access entries.

Address at which the spurious memory access error occurred.

Number of times the spurious memory access occurred at each address. The sum equals the Total

Spurious Accesses.

The traceback address information necessary to determine the cause of the misalignment.

The following is sample output from the show alignmentcommand when there are alignment errors and spurious memory access errors:

Router# show alignment

Total Corrections 134, Recorded 1, Reads 134, Writes 0

Initial Initial

Address Count Access Type Traceback

1A014C5 134 32bit read 0x6012F538 0x601338F8 0x601344D8 0x6022D528

Total Spurious Accesses 50, Recorded 3

Address Count Traceback

E 10 0x605351A0 0x603CA084 0x606C4060 0x606D6368 0x60743284 0x60743270

E 20 0x605351A0 0x6036EE7C 0x606C4060 0x606D6368 0x60743284 0x60743270

E 20 0x605351A0 0x603C998C 0x606D53EC 0x606C4060 0x606D6368 0x60743284 x60743270

Related Commands

Command enable

Description

To enter privileged EXEC mode, or any other security level set by a system administrator, use the

enable command in user EXEC or privileged

EXEC mode.

Cisco IOS Configuration Fundamentals Command Reference

767

show through show fm summary show archive

show archive

To display information about the files saved in the Cisco IOS configuration archive, use the show archive command in privileged EXEC mode.

show archive

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.3(7)T

12.2(25)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Examples The following is sample output from the show archive command:

Router# show archive

There are currently 1 archive configurations saved.

The next archive file will be named disk0:myconfig-2

Archive # Name

1 disk0:myconfig-1 <- Most Recent

768

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive

The following is sample output from the show archive command after several archive files of the running configuration have been saved. In this example, the maximum number of archive files to be saved is set to three.

Router# show archive

There are currently 3 archive configurations saved.

The next archive file will be named disk0:myconfig-8

Archive # Name

1 :Deleted

2 :Deleted

3 :Deleted

4 :Deleted

5 disk0:myconfig-5

6 disk0:myconfig-6

7 disk0:myconfig-7 <- Most Recent

The table below describes the significant fields shown in the displays.

Table 46 show archive Field Descriptions

Field

Archive #

Name

Description

Indicates the number of the running configuration file saved to the Cisco IOS configuration archive.

You can set the maximum number of archive files of the running configuration to be saved in the configuration archive. The most recent archive file is the last one shown in the display.

Indicates the name of the running configuration file saved to the Cisco IOS configuration archive.

Related Commands

Command

archive config

configure confirm

configure replace

Description

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

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

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

Cisco IOS Configuration Fundamentals Command Reference

769

show archive

Command maximum path time-period show through show fm summary

Description

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

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

Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.

770

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive config differences

show archive config differences

To perform a line-by-line comparison of any two configuration files (accessible through the Cisco IOS File

System [IFS]) and generate a list of the differences between them, use the show archive config differences command in user EXEC or privileged EXEC mode.

show archive config differences [filename1(path)[filename2(path)] [ignorecase]]

Syntax Description filename1(path) filename2(path) ignorecase

(Optional) The filename (path) of the first configuration file. Can be files in the following locations: bootflash:, cns:, fpd:, ftp:, harddisk:, http:, https:, null:, nvram:, obfl:, pram:, rcp:, revrcsf:, scp:, stby-bootflash:, stby-harddisk:, stbynvram:, stby-obfl:, stby-rcsf:, stby-usb0:, stbyusb1:, system:, tar:, tftp:, tmpsys:, usb0:

(Optional) The filename of the second configuration file. Can be files in the following locations: bootflash:, cns:, fpd:, ftp:, harddisk:, http:, https:, null:, nvram:, obfl:, pram:, rcp:, revrcsf:, scp:, stby-bootflash:, stby-harddisk:, stbynvram:, stby-obfl:, stby-rcsf:, stby-usb0:, stbyusb1:, system:, tar:, tftp:, tmpsys:, usb0:

(Optional) Indicates that the case of the filenames should be ignored.

Command Default If the filename1(path) and filename2(path) arguments are not specified, the first configuration file is assumed to be the running configuration file and the second to be the startup configuration file.

If only the filename1(path)argument is specified, the second configuration file is assumed to be the running configuration file.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.3(4)T

12.2(25)S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

Cisco IOS Configuration Fundamentals Command Reference

771

show through show fm summary show archive config differences

Release

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines Interpreting the output of the show archive config differencescommand is dependent on the order in which the two files are configured. Each entry in the generated output list is prefixed with a unique text symbol to indicate the type of difference found. The text symbols and their meanings are as follows:

• A minus symbol (-) indicates that the configuration line exists in filename1(path) but not in

filename2(path).

• A plus symbol (+) indicates that the configuration line exists in filename2(path) but not in

filename1(path).

• An exclamation point (!) with descriptive comments is used to identify order-sensitive configuration lines whose location is different in filename1(path) than in filename2(path).

Examples In this example, a diff operation is performed on the running and startup configuration files. The table below shows the configuration files used for this example.

Table 47 Configuration Files Used for the Diff Operation Example

Running Configuration File Startup Configuration File no ip subnet-zero ip cef interface Ethernet1/0

ip address 10.7.7.7 255.0.0.0

no ip route-cache

no ip mroute-cache

duplex half no ip classless snmp-server community public RO ip subnet-zero ip cef ip name-server 10.4.4.4

voice dnis-map 1

dnis 111 interface Ethernet1/0

no ip address

no ip route-cache

no ip mroute-cache

shutdown

duplex half ip default-gateway 10.5.5.5

ip classless access-list 110 deny ip any host 10.1.1.1

access-list 110 deny ip any host 10.1.1.2

access-list 110 deny ip any host 10.1.1.3

snmp-server community private RW

The following is sample output from the show archive config differencescommand. This sample output displays the results of the diff operation performed on the configuration files in the table above.

Router# show archive config differences running-config startup-config

+ip subnet-zero

772

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive config differences

+ip name-server 10.4.4.4

+voice dnis-map 1

+dnis 111 interface Ethernet1/0

+no ip address

+shutdown

+ip default-gateway 10.5.5.5

+ip classless

+access-list 110 deny ip any host 10.1.1.1

+access-list 110 deny ip any host 10.1.1.2

+access-list 110 deny ip any host 10.1.1.3

+snmp-server community private RW

-no ip subnet-zero interface Ethernet1/0

-ip address 10.7.7.7 255.0.0.0

-no ip classless

-snmp-server community public RO

Related Commands

Command

more nvram:startup-config

more system:running-config

show archive config incremental-diffs

Description

Displays the startup configuration file contained in

NVRAM or specified by the CONFIG_FILE environment variable.

Displays the contents of the currently running configuration file.

Performs a line-by-line comparison of a specified configuration file to the running configuration file and generates a list of the configuration lines that do not appear in the running configuration file.

Cisco IOS Configuration Fundamentals Command Reference

773

show through show fm summary show archive config incremental-diffs

show archive config incremental-diffs

To perform a line-by-line comparison of a specified configuration file to the running configuration file and generate a list of the configuration lines that do not appear in the running configuration file, use the show

archive config incremental-diffs command in user EXEC or privileged EXEC mode.

show archive config incremental-diffs file

Syntax Description file The filename of the configuration file to be compared to the running configuration file.

Command Modes

User EXEC Privileged EXEC

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Usage Guidelines When an incremental diff operation is performed, a list of the configuration lines that do not appear in the running configuration file (in other words, configuration lines that only appear in the specified file that is being compared to the running configuration file) is generated as output. An exclamation point (!) with descriptive comments is used to identify order-sensitive configuration lines whose location is different in the specified configuration file than in the running configuration file.

Examples

In this example, an incremental diff operation is performed on the startup and running configuration files.

The table below shows the configuration files used for this example.

774

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive config incremental-diffs

Table 48 Configuration Files Used for the Incremental Diff Operation Example

Startup Configuration File Running Configuration File ip subnet-zero ip cef ip name-server 10.4.4.4

voice dnis-map 1

dnis 111 interface Ethernet1/0

no ip address

no ip route-cache

no ip mroute-cache

shutdown

duplex half ip default-gateway 10.5.5.5

ip classless access-list 110 deny ip any host 10.1.1.1

access-list 110 deny ip any host 10.1.1.2

access-list 110 deny ip any host 10.1.1.3

snmp-server community private RW no ip subnet-zero ip cef interface Ethernet1/0

ip address 10.7.7.7 255.0.0.0

no ip route-cache

no ip mroute-cache

duplex half no ip classless snmp-server community public RO

The following is sample output from the show archive config incremental-diffscommand. This sample

output displays the results of the incremental diff operation performed on the configuration files in show archive config incremental-diffs, page 774

Router# show archive config incremental-diffs nvram:startup-config ip subnet-zero ip name-server 10.4.4.4

voice dnis-map 1

dnis 111 interface Ethernet1/0

no ip address

shutdown ip default-gateway 10.5.5.5

ip classless

access-list 110 deny ip any host 10.1.1.1

access-list 110 deny ip any host 10.1.1.2

access-list 110 deny ip any host 10.1.1.3

snmp-server community private RW

Related Commands

Command

more nvram:startup-config

more system:running-config

show archive config differences

Description

Displays the startup configuration file contained in

NVRAM or specified by the CONFIG_FILE environment variable.

Displays the contents of the currently running configuration file.

Performs a line-by-line comparison of any two configuration files (accessible through the IFS) and generates a list of the differences between them.

Cisco IOS Configuration Fundamentals Command Reference

775

show through show fm summary show archive config rollback timer

show archive config rollback timer

To display settings of the timed rollback, use the show archive config rollback timer command in privileged EXEC mode.

show archive config rollback timer

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.4(15)T

12.2(33)SRC

12.2(33)SXI

Cisco IOS XE Release 2.1

Modification

This command was introduced in Cisco IOS

Release12.4(15)T.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC.

This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.1.

Usage Guidelines Use the show archive config rollback timercommand to view the timed rollback settings, such as the timer type (idle timer or absolute timer), timer value, and so on, after a timed rollback is configured on a router.

Examples The following is sample output from the show archive config rollback timer command:

Router# show archive config rollback timer

Time configured(or reconfigured): 22:50:48 UTC Sat Feb 21 2009

Timer type: absolute timer

Timer value: 2 min

User: console

The table below describes the significant fields in the sample output.

776

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive config rollback timer

Table 49

Timer type

Timer value

User show mpls forwarding-table Field Descriptions

Field

Time configured (or reconfigured)

Description

The time with which the timer refreshes every time the ENTER key is presses.

The type of the timer: Idle or Absolute.

Displays the time, in minutes, for which to wait for confirmation.

Displays the user name.

Related Commands

Command

configure revert

configure terminal revert timer

Description

Cancels the timed rollback and trigger the rollback immediately or resets parameters for the timed rollback.

Enter global configuration mode and sets the parameters for reverting the configuration if confirmation of the new configuration is not received.

Cisco IOS Configuration Fundamentals Command Reference

777

show through show fm summary show archive log config

show archive log config

To display entries from the configuration log, use the show archive log configcommand in privileged

EXEC mode.

show archive log config {all | record-number [end-number] | user username[ session session-

number] record-number [end-number] | statistics} [provisioning] [contenttype {plaintext | xml}]

[persistent]

Syntax Description all

record-number [end-number]

user username

session session-number statistics provisioning contenttype plaintext xml persistent

Displays all configuration log entries.

Displays the log entry by record number. If you specify a record number for the optional end-

number argument, all log entries with record numbers between the values entered for the record-

number and end-number arguments are displayed.

Valid values for the record-number and end-

number arguments range from 1 to 2147483647.

Displays log entries attributed to a particular user.

(Optional) Displays log entries attributed to a particular session. Valid values for the session-

number argument range from 1 to 1000.

Displays memory usage information for the configuration log.

(Optional) Displays configuration log file information as it would appear in a configuration file, rather than in tabular format.

(Optional) Specifies the format for the display of configuration change results.

Specifies that the configuration change results will be formatted as plain text. This keyword appears only if the contenttype keyword has been entered.

Specifies that the configuration change results will be in eXtensible Markup Language (XML) format.

This keyword appears only if the contenttype keyword has been entered.

(Optional) Displays the persistent configuration changes in a configlet format.

778

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Command Modes Privileged EXEC

Command History

Release

12.3(4)T

12.2(25)S

12.2(27)SBC

12.2(33)SRA

12.4(11)T

12.2(33)SXH

12.2(33)SB show archive log config

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(27)SBC.

The contenttype, plaintext, xml, and persistent keywords were added.

This command was integrated into Cisco IOS

Release 12.4(11)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command with syntax updated in

12.2(33)SRA was integrated into Cisco IOS

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

Usage Guidelines If you do not specify the all keyword, you must specify a record number with the record-number argument.

You can optionally specify an end record number with the end-numberargument to display a range of records. If you use the end-number argument to specify a record number that does not exist, all records after the starting record number with a record number lower than that specified with the end-number argument are displayed.

Specifying the provisioningkeyword results in the display appearing as it would in a configuration file, rather than in tabular format. This output includes commands used to change configuration modes and logged configuration commands. This output can be used to set up another router if desired.

Examples The following is sample output from the show archive log config command, which displays configuration log entry numbers 1 and 2:

Router# show archive log config 1 2 idx sess user@line Logged command

1 1 user1@console logging enable

2 1 user1@console logging size 200

The table below describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

779

show through show fm summary show archive log config

Table 50

Field idx sess user@line show archive log config Field Descriptions

Logged command

Description

The record number of the configuration log entry.

The session number associated with the configuration log entry.

The username of the user who executed the command that generated the configuration log entry.

The command that was executed.

The following example results in the display of all configuration log files as they would appear in a configuration file rather than in tabular format. In addition to displaying logged commands, the example shows the commands used to change configuration modes that are required to correctly apply the logged commands.

Router# show archive log config all provisioning archive

log config

logging enable

logging size 200

The following example results in the display of memory usage statistics for the configuration log:

Router# show archive log config statistics

Config Log Session Info:

Number of sessions being tracked: 1

Memory being held: 3910 bytes

Total memory allocated for session tracking: 3910 bytes

Total memory freed from session tracking: 0 bytes

Config Log log-queue Info:

Number of entries in the log-queue: 3

Memory being held in the log-queue: 671 bytes

Total memory allocated for log entries: 671 bytes

Total memory freed from log entries:: 0 bytes

The output is self-explanatory.

The following example shows the contents of the archive log in XML format:

Router# show archive log config all contenttype xml

<?xml version="1.0" encoding="UTF-8"?>

<async>

</async>

<when>

</when>

</changeInfo>

<logComment>begin test test1</logComment>

</configChanged>

<async>

</async>

780

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show archive log config

<when>

</when>

</changeInfo>

<cli>interface e0</cli>

</enteredCommand>

<change>PRC_CHANGE</change>

</prcSuccess>

</prcResultType>

</oldConfigState>

<cli>interface e0</cli>

</newConfigState>

</changeItem>

</configChanged>

<async>

</async>

<when>

</when>

</changeInfo>

<context><cli>interface e0</cli></context>

<cli>ip address 10.1.1.1 255.255.255.0</cli>

</enteredCommand>

<change>PRC_CHANGE</change>

</prcSuccess>

</prcResultType>

<cli>ip address 10.1.1.1 255.255.255.0</cli>

</newConfigState>

</changeItem>

</configChanged>

<async>

</async>

<when>

</when>

</changeInfo>

</configChanged>

</configLoggerMsg>

Cisco IOS Configuration Fundamentals Command Reference

781

show through show fm summary show as5400

show as5400

To display the hardware details of an application server, use the show as5400command in privileged

EXEC mode.

show as5400

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.4(22)T

Modification

This command was introduced in a release earlier than Cisco IOS Release 12.4(22)T.

Usage Guidelines The show as5400 command provides complex troubleshooting information that pertains to the platform's shared references rather than to a specific interface.

Examples

The following is sample output from the show as5400 command:

Router# show as5400

Hardware Info:

System I/O Controller PLD version: 0x8

Serial Interface Controller PLD version: 0x2

Memory Info:

Memory Installed: 1024 MB

Memory Type is : DDR

Bus Watcher Counters cor_l2cache_data_ecc_count = 0 bad_l2cache_data_ecc_count = 0 cor_l2cache_tag_ecc_count = 0 bad_l2cache_tag_ecc_count = 0 cor_memory_data_ecc_count = 0 bad_memory_data_ecc_count = 0 bus_errors = 0

System Controller Network Interrupts:

Interrupt Register is at 0xB0020040 (0x0000008000000000)

BCM interrupt mask 0xFF7C03BEFFE0FCC2

Registered Interrupts:

Level Mask Count Data Interrupt Handler

0 0x0000000100000000 0 0x00000000 0x6036C144 (GT96124 Interrupt h)

0 0x0000000000100000 26415 0xC097F6AC 0x60354064 (GigabitEthernet0/1)

0 0x0000000000080000 0 0x66712B8C 0x60354064 (GigabitEthernet0/0)

0 0x0000040000000000 22982406 0x00000000 0x608B2CBC (Low IRQ interrupt)

1 0x0000100000000000 0 0x00000000 0x60085D98 (BCM1125 GPIO12 - BI)

1 0x0000000000000020 0 0xC002880C 0x608C4ABC (SB1125 Timer 3)

1 0x0000000000000010 0 0xC0028744 0x608C4ABC (SB1125 Timer 2)

1 0x0000000000000008 0 0xC002867C 0x608C4ABC (SB1125 Timer 1)

782

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show as5400

1 0x0000000000000004 0 0xC00285B4 0x608C4ABC (SB1125 Timer 0)

1 0x0000080000000000 22963823 0x00000000 0x608B2F84 (High IRQ interrupt)

3 0x0000800000000000 0 0x00000000 0x60380F88 (OIR Interrupt)

4 0x0000400000000000 0 0x00000000 0x608BD1EC (NRBUS Parity Error)

4 0x0000200000000000 0 0x00000000 0x608BD1EC (IO Error)

4 0x0000004000000000 0 0x00000000 0x608BD1EC (IO_BUS_Parity Error)

4 0x007C00000000E0C2 0 0x00000000 0x608C2FD8 (Spurious Intr ERROR)

4 0x0000000000020000 0 0x00000000 0x608C3A14 (Corrected ECC Error)

4 0x0000000000010000 0 0x00000000 0x608C2A7C (Bad ECC Error Handl)

4 0x0003000000000000 0 0x64A985BC 0x608C2B4C (BCM1125 Host LDT Br)

4 0x0000000000040000 0 0x00000000 0x608C2E04 (BCM1125 IO-Bus Erro)

4 0x0080000000000000 0 0x00000000 0x608C2BD4 (BCM1125 Host PCI Br)

6 0x0000000000000001 0 0x00000000 0x608C2FD8 (Watchdog Timer 0 Ha)

HT 600MHz Retry Count 0

BCM1125H HT Host Bridge, handle=0

BCM bridge, config=0x0

(0x00):dev, vendor id = 0x0002166D

(0x04):status, command = 0x00100107

(0x08):class code, revid = 0x06000003

(0x0C):hdr, lat timer, cls = 0x00010000

(0x18):bus id registers = 0x001B0100

(0x1C):secondary status = 0x00000141

(0x20):mem base/limit = 0x5FF04300

(0x30):io upper limit/base = 0x00010001

(0x34):capabilities ptr = 0x00000040

(0x38):expansion rom bar = 0x00000000

(0x3C):bridge ctrl = 0x00020000

(0x40):LDT cmd, cap id, = 0x20000008

(0x44):Link config/control = 0x00000020

(0x48):Link frequency = 0x801F0423

(0x50):SRIcmd, srirxden, sritxden = 0x50211010

(0x54):SRI tx numerator = 0x0000FFFF

(0x58):SRI rx numerator = 0x0000FFFF

(0x68):Error status/control = 0x00009A49

(0x6C):Tx ctrl, databufalloc = 0x00041515

(0xC8):Tx buffer count max = 0x00FFFFFF

(0xDC):Rx CRC expected = 0xBFFFABE0

(0xF0):Rx CRC received = 0x7FF3FFFD

BCM PCI Host Bridge: bus_no=0, device_no=0

DeviceID=0x0001, VendorID=0x166D, Cmd=0x0146, Status=0x02A0

Cls=0x06/0x00/0x00, Rev=0x03, LatencyTimer=0x2C, CacheLineSize=0x10

BaseAddr0=0x60000008, BaseAddr1=0x00000000, MaxLat=0x00, MinGnt=0x00

SubsysDeviceID=0x0000, SubsysVendorID=0xFFFF, ErrorAddr=0x00030400

Additional Status = 0x00000020

PLX HT2PCI Bridge A for PCM Tracer & DFC 2,4,6, handle=0

PLX HT7520 bridge, config=0x0

(0x00):dev, vendor id = 0x74501022

(0x04):status, command = 0x02300107

(0x08):class code, revid = 0x06040012

(0x0C):hdr, lat timer, cls = 0x00810000

(0x18):bus id registers = 0xF80E0201

(0x1C):secondary status = 0x02200141

(0x20):mem base/limit = 0x4FF04300

(0x30):io upper limit/base = 0x00010001

(0x34):capabilities ptr = 0x000000A0

(0x3C):bridge ctrl = 0x00020000

(0x40):miscellaneous = 0x00010004

(0x4C):prefetch ctrl = 0x00000446

(0xC0):ht cmd, cap id = 0x00410008

(0xC4):link cfg/ctrl side a = 0x00112020

(0xC8):link cfg/ctrl side b = 0x770020D0

(0xCC):link freq ctrl side a = 0x00350422

(0xD0):link freq ctrl side b = 0x00350402

PLX HT2PCI Bridge B, for DFC 1,3,5,7

(0x00):dev, vendor id = 0x74501022

(0x04):status, command = 0x02300107

(0x08):class code, revid = 0x06040012

(0x0C):hdr, lat timer, cls = 0x00810000

(0x18):bus id registers = 0xF81B0F01

(0x1C):secondary status = 0x022001A1

(0x20):mem base/limit = 0x5FF05000

(0x30):io upper limit/base = 0x00010001

Cisco IOS Configuration Fundamentals Command Reference

783

show through show fm summary show as5400

(0x34):capabilities ptr = 0x000000A0

(0x3C):bridge ctrl = 0x00020000

(0x40):miscellaneous = 0x000B0004

(0x4C):prefetch ctrl = 0x00000446

RTC chip is DS1337

The table below describes the significant fields shown in the display.

Table 51 show as5400 Field Descriptions

Field

System I/O Controller PLD version

Level

Mask

Count

Handler

RTC chip

Description

The version of the programmable logic device

(PLD) on the system.

Interrupt priority level.

Maskable interrupt.

Interrupt count.

Type of interrupt handler.

Real time clock chip type.

Related Commands

Command as

Description

Defines an application server on a gateway.

784

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show async bootp

show async bootp

To display the extended BOOTP request parameters that have been configured for asynchronous interfaces, use the show async bootp command in privileged EXEC mode.

show async bootp

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples The following is sample output from the show async bootp command:

Router# show async bootp

The following extended data will be sent in BOOTP responses: bootfile (for address 192.168.1.1) “pcboot” bootfile (for address 172.16.1.111) “dirtboot” subnet-mask 255.255.0.0

time-offset -3600 time-server 192.168.1.1

The table below describes the significant fields shown in the display.

Table 52 show async bootp Field Descriptions

Field bootfile... “pcboot” subnet-mask 255.255.0.0

time-offset -3600 time-server 192.168.1.1

Description

Boot file for address 192.168.1.1 is named pcboot.

Subnet mask.

Local time is one hour (3600 seconds) earlier than

UTC time.

Address of the time server for the network.

Cisco IOS Configuration Fundamentals Command Reference

785

show async bootp

Related Commands

Command async-bootp show through show fm summary

Description

Configures extended BOOTP requests for asynchronous interfaces as defined in RFC 1084.

786

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show autoupgrade configuration unknown

show autoupgrade configuration unknown

To display all of the unknown start-up configuration lines that the auto-upgraded Cisco IOS software image does not understand, use the show autoupgrade configuration unknown command in privileged EXEC mode.

show autoupgrade configuration unknown

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

12.4(15)T

Modification

This command was introduced.

Usage Guidelines Use the show autoupgrade configuration unknown command to view any invalid start-up configuration.

This command prints invalid start-up configuration data only when run from an an image which was upgraded using the Auto-Upgrade Manager. This command output is useful when you are upgrading to an image with a different feature set.

Examples The following example shows how to view the invalid start-up configuration lines that the Cisco IOS software image, upgraded on the router using AUM, does not understand:

Router# show autoupgrade configuration unknown

! Config Lines not understood by the current image: voice-card 0

no dspfarm crypto pki trustpoint aum_cisco_ca

enrollment terminal

revocation-check none crypto pki certificate chain aum_cisco_ca

certificate ca 40DCB71E54EE24CBE5326F8006BBA4F6 nvram:SecureServer#A4F6CA.cer

no ip http secure-server

transport output lat pad telnet rlogin lapb-ta mop udptn v120 ssh

Total 9 Invalid Config Lines

Router#

Cisco IOS Configuration Fundamentals Command Reference

787

show autoupgrade configuration unknown

Related Commands

Command

upgrade automatic abortversion

upgrade automatic getversion

upgrade automatic runversion show through show fm summary

Description

Cancels a scheduled reloading of the device with a new Cisco IOS software image.

Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server.

Reloads the device with a new Cisco IOS software image.

788

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show bcm560x

show bcm560x

To display the BCM560x hardware table information, use the show bcm560X command in user EXEC or privileged EXEC mode.

show bcm560x name {offset | all} [raw]

Syntax Description name offset all raw

Displays the bcm50x hardware table name. The hardware table name can be VLAN table name

(VTABLE) or Port based VLAN table name

(PTABLE):

Hardware table number. Range is from 0 to 65535

Displays all the bcm560x hardware table names.

(Optional) Displays the bcm560x hardware table names.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.4(15)T

Modification

This command was introduced in a release earlier than Cisco IOS Release 12.4(15)T.

Examples The following is sample output from the show bcm560X allcommand:

Router# show bcm560x VTABLE all

Router# VTABLE.0[0x1]: <VLAN_TAG=1,PORT_BITMAP=0xA000008,UT_PORT_BITMAP=8,MOD_BMAP=0>

*Mar 11 08:07:29.863: VTABLE.0[0x2]:

<VLAN_TAG=2,PORT_BITMAP=0xA000000,UT_PORT_BITMAP=0,MOD_BMAP=0>

*Mar 11 08:07:29.863: VTABLE.0[0x3]:

<VLAN_TAG=0x401,PORT_BITMAP=0xA000000,UT_PORT_BITMAP=0,MOD_BMAP=0>

*Mar 11 08:07:29.867: VTABLE.0[0x4]:

<VLAN_TAG=0xFFF,PORT_BITMAP=0x8000000,UT_PORT_BITMAP=0x8000000,MOD_BMAP=0>

*Mar 11 08:07:29.867:

Cisco IOS Configuration Fundamentals Command Reference

789

show through show fm summary show bootflash:

show bootflash:

To display information about the bootflash: file system, use the show bootflash: command in user EXEC or privileged EXEC mode.

show bootflash: [all | chips | filesys]

Syntax Description all chips filesys

(Optional) Displays all possible Flash information.

(Optional) Displays information about the Flash chip.

(Optional) Displays information about the file system.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to display information about the file system status:

Router> show bootflash: filesys

-------- F I L E S Y S T E M S T A T U S --------

Device Number = 0

DEVICE INFO BLOCK: bootflash

Magic Number = 6887635 File System Vers = 10000 (1.0)

Length = 1000000 Sector Size = 40000

Programming Algorithm = 39 Erased State = FFFFFFFF

File System Offset = 40000 Length = F40000

MONLIB Offset = 100 Length = C628

Bad Sector Map Offset = 3FFF8 Length = 8

Squeeze Log Offset = F80000 Length = 40000

790

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show bootflash:

Squeeze Buffer Offset = FC0000 Length = 40000

Num Spare Sectors = 0

Spares:

STATUS INFO:

Writable

NO File Open for Write

Complete Stats

No Unrecovered Errors

No Squeeze in progress

USAGE INFO:

Bytes Used = 917CE8 Bytes Available = 628318

Bad Sectors = 0 Spared Sectors = 0

OK Files = 2 Bytes = 917BE8

Deleted Files = 0 Bytes = 0

Files w/Errors = 0 Bytes = 0

Router>

This example shows how to display image information:

Router> show bootflash:

-#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name

1 .. image 8C5A393A 237E3C 14 2063804 Aug 23 1999 16:18:45 c6msfc-boot-mz

2 .. image D86EE0AD 957CE8 9 7470636 Sep 20 1999 13:48:49 rp.halley

Router>

This example shows how to display all bootflash information:

Router> show bootflash: all

-#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name

1 .. image 8C5A393A 237E3C 14 2063804 Aug 23 1999 16:18:45 c6msfc-bootmz

2 .. image D86EE0AD 957CE8 9 7470636 Sep 20 1999 13:48:49 rp.halley

6456088 bytes available (9534696 bytes used)

-------- F I L E S Y S T E M S T A T U S --------

Device Number = 0

DEVICE INFO BLOCK: bootflash

Magic Number = 6887635 File System Vers = 10000 (1.0)

Length = 1000000 Sector Size = 40000

Programming Algorithm = 39 Erased State = FFFFFFFF

File System Offset = 40000 Length = F40000

MONLIB Offset = 100 Length = C628

Bad Sector Map Offset = 3FFF8 Length = 8

Squeeze Log Offset = F80000 Length = 40000

Squeeze Buffer Offset = FC0000 Length = 40000

Num Spare Sectors = 0

Spares:

STATUS INFO:

Writable

NO File Open for Write

Complete Stats

No Unrecovered Errors

No Squeeze in progress

USAGE INFO:

Bytes Used = 917CE8 Bytes Available = 628318

Bad Sectors = 0 Spared Sectors = 0

OK Files = 2 Bytes = 917BE8

Deleted Files = 0 Bytes = 0

Files w/Errors = 0 Bytes = 0

Router>

Related Commands

Command delete

Description

Marks files on bootflash for deletion.

Cisco IOS Configuration Fundamentals Command Reference

791

show bootflash:

Command squeeze show through show fm summary

Description

Removes files from bootflash that have been marked for deletion.

792

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show bootvar

show bootvar

To display the contents of the BOOT variable, the name of the configuration file pointed to by the

CONFIG_FILE variable, the contents of the BOOTLDR variable, and the configuration register setting, use the show bootvar command in user EXEC or privileged EXEC mode.

show bootvar

Syntax Description This command has no arguments or keywords.

Command Modes User EXEC Privileged EXEC

Command History

Release

11.3 AA

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

This command was introduced.

Support for this command was implemented on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was integrated into Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Supported Platforms Other than the Cisco 7600 Series Router

The show bootvar command replaces the show bootcommand.

The show bootvar command allows you to view the current settings for the following variables:

• BOOT

• CONFIG_FILE

• BOOTLDR

The BOOT variable specifies a list of bootable images on various devices. The CONFIG_FILE variable specifies the configuration file used during system initialization. The BOOTLDR variable specifies the flash device and filename containing the rxboot image that ROM uses for booting. You set these variables with the boot system, boot config, and boot bootldr global configuration commands, respectively.

When you use this command on a device with multiple Route Switch Processor (RSP) cards (Dual RSPs), this command also shows you the variable settings for both the master and slave RSP card.

Cisco 7600 Series Router

The show bootvar command displays information about the BOOT environmental variable.

Cisco IOS Configuration Fundamentals Command Reference

793

show through show fm summary show bootvar

The command output depends on how you configure the boot statement as follows:

• If you enter the boot system flash bootflash: sup720_image command in the boot configuration, then the show bootvar command output displays the bootflash information.

• If you enter the boot system flash sup-bootflash: sup720_image command in the boot configuration, then the show bootvar command output displays the sup-bootflash information. This action is the correct way of configuring the boot statement.

The show bootvar command is available from the switch processor command-line interface (CLI) and the route processor CLI. From the switch processor CLI, the display is always bootflash. With either the bootflash or the sup-bootflash boot statement, the switch boots correctly. You should use sup-bootflash in the boot configuration statement because the image is stored in the switch processor bootflash; the route processor sees the image as sup-bootflash.

The number displayed after the image name (for example, c6sup12-js-mz.121-13.E,12) indicates the number of times that the Cisco 7600 series router tries to reboot the file before giving up.

Examples

Supported Platforms Other than the Cisco 7600 Series Router

The following is sample output from the show bootvar command:

Router# show bootvar

BOOT variable =

CONFIG_FILE variable = nvram:

Current CONFIG_FILE variable = slot0:router-config

BOOTLDR variable not exist

Configuration register is 0x0

In this example, the BOOT variable contains a null string; that is no bootable images are specified.

The CONFIG_FILE variable points to the configuration file in NVRAM as the startup (initialization) configuration. The run-time value for the CONFIG_FILE variable points to the router-configuration file on the flash memory card inserted in the first slot of the RSP card. That is, during the run-time configuration, you have modified the CONFIG_FILE variable using the boot config command, but you have not saved the run-time configuration to the startup configuration. To save your run-time configuration to the startup configuration, use the copy system:running-config nvram:startup-config command. If you do not save the run-time configuration to the startup configuration, then the system reverts to the saved CONFIG_FILE variable setting for initialization information upon reload. In this sample, the system reverts to NVRAM for the startup configuration file.

The BOOTLDR variable does not yet exist. That is, you have not created the BOOTLDR variable using the

boot bootldr global configuration command.

The following example is output from the show bootvar command for a Cisco 7513 router configured for high system availability (HSA):

Router# show bootvar

BOOT variable =

CONFIG_FILE variable =

Current CONFIG_FILE variable =

BOOTLDR variable does not exist

Configuration register is 0x0 current slave is in slot 7

BOOT variable =

CONFIG_FILE variable =

BOOTLDR variable does not exist

Configuration register is 0x0

The table below describes the significant fields shown in the displays.

794

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show bootvar

Table 53

Field

BOOT variable show bootvar Field Descriptions

CONFIG_FILE variable

Current CONFIG_FILE variable

BOOTLDR variable

Configuration register current slave is in slot 7

Description

Displays a list of specified bootable images.

Indicates where to locate the startup (initialization) configuration file.

Identifies the run-time configuration file.

Identifies the location of the boot image that ROM uses for booting, if it is specified.

Specifies router behavior, such as how the router boots, options while booting, and console speed

(baud rate for a terminal emulation session).

Indicates the slot where the redundant system is located in HSA configurations.

Cisco 7600 Series Router

This example shows how to display information about the BOOT environment variable:

Router# show bootvar

BOOT variable = sup-bootflash:c6sup12-js-mz.121-13.E,12

CONFIG_FILE variable =

BOOTLDR variable = bootflash:c6msfc2-boot-mz.121-13.E.bin

Configuration register is 0x2102

Standby is up

Standby has 112640K/18432K bytes of memory.

Standby BOOT variable = bootflash:c6sup12-js-mz.121-13.E,12

Standby CONFIG_FILE variable =

Standby BOOTLDR variable = bootflash:c6msfc2-boot-mz.121-13.E.bin

Standby Configuration register is 0x2102

The number displayed after the image name (for example, c6sup12-js-mz.121-13.E,12) indicates the number of times that the Cisco 7600 series router tries to reboot the file before giving up.

Related Commands

Command

boot bootldr

boot bootstrap

boot config

boot system

Description

Specifies the location of the boot image that ROM uses for booting.

Configures the filename that is used to boot a secondary bootstrap image.

Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).

Specifies the system image that the router loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

795

show bootvar

Command copy

show version show through show fm summary

Description

Copies a file from source to a destination.

Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.

796

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show buffers

show buffers

To display detailed information about the buffer pools on the network server when Cisco IOS, Cisco IOS

Software Modularity, or Cisco IOS XE images are running, use the show buffers command in user EXEC or privileged EXEC mode.

show buffers [{address hex-address | failures | pool pool-name | detailed | processes | {all |

assigned [process-id] | free | old | input-interface interface-type interface-number} | [pool pool-

name]} [dump | header | packet | location pool-location]]

Cisco Catalyst 4500e Series Switches running IOS XE software

show buffers [detailed process id {address hex-address | all | assigned | failures | free | input-

interface interface-type interface-number | old | pool pool-name} [dump | header | packet | location

pool-location]]

Syntax Description address hex-address failures pool pool-name

detailed process processes all assigned process-id free old input-interface interface-type

(Optional) Displays buffers at a specified address.

(Optional) Address in hexadecimal notation.

(Optional) Displays buffer allocation failures.

(Optional) Displays buffers in a specified buffer pool.

(Optional) Name of buffer pool.

(Optional) Displays detailed buffer information.

(Optional) For Cisco IOS Software Modularity images only. Displays buffers connected to Packet

Manager.

(Optional) Displays all buffers.

(Optional) Displays the buffers in use.

(Optional) For Cisco IOS Software Modularity images only. POSIX process identifier.

(Optional) Displays the buffers available for use.

(Optional) Displays buffers older than one minute.

(Optional) Displays interface pool information. If an interface type is specified and this interface has its own buffer pool, information for that pool is displayed.

(Optional) Interface type.

Cisco IOS Configuration Fundamentals Command Reference

797

show through show fm summary show buffers

Examples interface-number dump header packet

location pool-location

(Optional) Interface number.

(Optional) Displays the buffer header and all data.

(Optional) Displays the buffer header only.

(Optional) Displays the buffer header and packet data.

(Optional) Displays all the buffer pools in a given location. The global buffer pools come first, followed up with process-level buffer pools.

Command Default If no options are specified, all buffer pool information is displayed.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

10.0

12.3

12.2(18)SXF4

12.2(33)SRA

Cisco IOS XE Release 3.1.0.SG

Modification

This command was introduced.

The option to filter display output based on specific buffer pools was expanded.

Two additional fields were added to the output to support Cisco IOS Software Modularity.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was introduced on the Cisco

Catalyst 4500e Serfies Switches with support for the detailed process command option.

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

•

show buffers, page 797

•

show buffers, page 797

•

show buffers, page 797

798

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show buffers

Cisco IOS Software

The following is sample output from the show buffers command with no arguments, showing all buffer pool information:

Router# show buffers

Buffer elements:

398 in free list (500 max allowed)

1266 hits, 0 misses, 0 created

Public buffer pools:

Small buffers, 104 bytes (total 50, permanent 50):

50 in free list (20 min, 150 max allowed)

551 hits, 0 misses, 0 trims, 0 created

Middle buffers, 600 bytes (total 25, permanent 25):

25 in free list (10 min, 150 max allowed)

39 hits, 0 misses, 0 trims, 0 created

Big buffers, 1524 bytes (total 50, permanent 50):

49 in free list (5 min, 150 max allowed)

27 hits, 0 misses, 0 trims, 0 created

VeryBig buffers, 4520 bytes (total 10, permanent 10):

10 in free list (0 min, 100 max allowed)

0 hits, 0 misses, 0 trims, 0 created

Large buffers, 5024 bytes (total 0, permanent 0):

0 in free list (0 min, 10 max allowed)

0 hits, 0 misses, 0 trims, 0 created

Huge buffers, 18024 bytes (total 0, permanent 0):

0 in free list (0 min, 4 max allowed)

0 hits, 0 misses, 0 trims, 0 created

Interface buffer pools:

Ethernet0 buffers, 1524 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

Ethernet1 buffers, 1524 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

Serial0 buffers, 1524 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

Serial1 buffers, 1524 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

TokenRing0 buffers, 4516 bytes (total 48, permanent 48):

0 in free list (0 min, 48 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

TokenRing1 buffers, 4516 bytes (total 32, permanent 32):

32 in free list (0 min, 48 max allowed)

16 hits, 0 fallbacks

0 failures (0 no memory)

The following is sample output from the show buffers command with no arguments, showing onlybuffer pool information for Huge buffers. This output shows a highest total of five Huge buffers created five days and 18 hours before the command was issued.

Router# show buffers

Huge buffers, 18024 bytes (total 5, permanent 0, peak 5 @ 5d18h):

4 in free list (3 min, 104 max allowed)

0 hits, 1 misses, 101 trims, 106 created

0 failures (0 no memory)

The following is sample output from the show buffers command with no arguments, showing only buffer pool information for Huge buffers. This output shows a highest total of 184 Huge buffers created one hour, one minute, and 15 seconds before the command was issued.

Router# show buffers

Huge buffers, 65280 bytes (total 4, permanent 2, peak 184 @ 01:01:15):

Cisco IOS Configuration Fundamentals Command Reference

799

show through show fm summary show buffers

4 in free list (0 min, 4 max allowed)

32521 hits, 143636 misses, 14668 trims, 14670 created

143554 failures (0 no memory)

The following is sample output from the show buffers command with an interface type and interface number:

Router# show buffers Ethernet 0

Ethernet0 buffers, 1524 bytes (total 64, permanent 64):

16 in free list (0 min, 64 max allowed)

48 hits, 0 fallbacks

16 max cache size, 16 in cache

The table below describes the significant fields shown in the display.

Table 54 show buffers (Cisco IOS Software) Field Descriptions

Field

Buffer elements free list max allowed hits misses created

Description

Small structures used as placeholders for buffers in internal operating system queues. Used when a buffer may need to be on more than one queue.

Total number of the currently unallocated buffer elements.

Maximum number of buffers that are available for allocation.

Count of successful attempts to allocate a buffer when needed.

Count of buffer allocation attempts that resulted in growing the buffer pool to allocate a buffer.

Count of new buffers created to satisfy buffer allocation attempts when the available buffers in the pool have already been allocated.

Public Buffer Pools

Small buffers

Middle buffers

Big buffers

VeryBig buffers

Large buffers

Huge buffers total permanent

Buffers that are 104 bytes long.

Buffers that are 600 bytes long.

Buffers that are 1524 bytes long.

Buffers that are 4520 bytes long.

Buffers that are 5024 bytes long.

Buffers that are 18,024 bytes long.

Total number of this type of buffer.

Number of these buffers that are permanent.

800

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field peak free list min max allowed hits misses trims created

Interface Buffer Pools total permanent free list min max allowed hits show buffers

Description

Maximum number of buffers created (highest total) and the time when that peak occurred. Formats include weeks, days, hours, minutes, and seconds.

Not all systems report a peak value, which means this field may not display in output.

Number of available or unallocated buffers in that pool.

Minimum number of free or unallocated buffers in the buffer pool.

Maximum number of free or unallocated buffers in the buffer pool.

Count of successful attempts to allocate a buffer when needed.

Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer.

Count of buffers released to the system because they were not being used. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static.

Count of new buffers created in response to misses.

This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static.

Total number of this type of buffer.

Number of these buffers that are permanent.

Number of available or unallocated buffers in that pool.

Minimum number of free or unallocated buffers in the buffer pool.

Maximum number of free or unallocated buffers in the buffer pool.

Count of successful attempts to allocate a buffer when needed.

Cisco IOS Configuration Fundamentals Command Reference

801

show through show fm summary show buffers

Field fallbacks max cache size failures no memory

Description

Count of buffer allocation attempts that resulted in falling back to the public buffer pool that is the smallest pool at least as big as the interface buffer pool.

Maximum number of buffers from the pool of that interface that can be in the buffer pool cache of that interface. Each interface buffer pool has its own cache. These are not additional to the permanent buffers; they come from the buffer pools of the interface. Some interfaces place all of their buffers from the interface pool into the cache. In this case, it is normal for the free list to display 0.

Total number of times a buffer creation failed. The failure may have occurred because of a number of different reasons, such as low processor memory, low IOMEM, or no buffers in the pool when called from interrupt context.

Number of times there has been low memory during buffer creation. Low or no memory during buffer creation may not necessarily mean that buffer creation failed; memory can be obtained from an alternate resource such as a fallback pool.

Cisco IOS Software Modularity

The following is sample output from the show buffers command using a Cisco IOS Modularity image from Cisco IOS Release 12.2(18)SXF4 and later releases. Two new output fields were introduced--Public buffer heads and Temporary buffer heads--and are shown within comments in the following sample output.

Router# show buffers

Buffer elements:

500 in free list (500 max allowed)

106586 hits, 0 misses, 0 created

Public buffer pools:

Small buffers, 104 bytes (total 50, permanent 50, peak 54 @ 1d13h):

49 in free list (20 min, 150 max allowed)

54486 hits, 0 misses, 4 trims, 4 created

0 failures (0 no memory)

Middle buffers, 600 bytes (total 25, permanent 25, peak 27 @ 1d13h):

25 in free list (10 min, 150 max allowed)

20 hits, 0 misses, 2 trims, 2 created

0 failures (0 no memory)

Big buffers, 1536 bytes (total 50, permanent 50):

50 in free list (40 min, 150 max allowed)

6 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

VeryBig buffers, 4520 bytes (total 10, permanent 10):

10 in free list (0 min, 100 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Large buffers, 5024 bytes (total 0, permanent 0):

0 in free list (0 min, 10 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Huge buffers, 18024 bytes (total 1, permanent 0, peak 1 @ 1d13h):

802

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show buffers

0 in free list (0 min, 4 max allowed)

1 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

! Start of Cisco IOS Software Modularity fields

Public buffer headers:

Header buffers, 880 bytes (total 1000, peak 142 @ 1d13h):

864 in permanent free list

142 hits, 0 misses

Temporary buffer headers:

Header buffers, 896 bytes (total 0):

0 in free list

0 hits, 0 misses, 0 trims, 0 created

0 failures

! End of Cisco IOS Software Modularity fields

Interface buffer pools:

Logger Pool buffers, 600 bytes (total 150, permanent 150):

150 in free list (150 min, 150 max allowed)

22 hits, 0 misses

The table below describes the significant fields shown in the display that are different from the fields in the first table.

Table 55 show buffers (Cisco IOS Software Modularity) Field Descriptions

Description Field

Public Buffer Headers

Header buffers total permanent free list hits misses

Buffers that are 880 bytes long.

Total number of this type of buffer.

Number of available or unallocated permanent header buffers.

Count of successful attempts to allocate a header buffer when needed.

Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer.

Temporary Buffer Headers

Header buffers total free list hits misses

Buffers that are 896 bytes long.

Total number of this type of buffer.

Number of available or unallocated header buffers in that pool.

Count of successful attempts to allocate a buffer when needed.

Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer.

Cisco IOS Configuration Fundamentals Command Reference

803

show through show fm summary show buffers

Field trims created failures

Description

Count of buffers released to the system because they were not being used. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static.

Count of new buffers created in response to misses.

This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static.

Total number of allocation requests that have failed because no buffer was available for allocation; the datagram was lost. Such failures normally occur at interrupt level.

Cisco Catalyst 4500e Series Switches running IOS XE software

The following is sample output from the show buffers command on a Cisco Catalyst 4500e switch, using a

Cisco IOS image from Cisco IOS XE Release 3.1.0.SG and later releases. PDS Public buffers and Packet information was added--and are shown within comments in the following sample output.

Switch#show buffers

PDS public buffers

Public buffer pools:

Packet buffer, 2048 bytes (total 1000, permanent 1000):

1000 in free list (1000 max allowed)

Header pools:

Packet Header Memory, 0 bytes (total 0, permanent 0):

0 in free list (0 max allowed)

Buffer Header Memory, 0 bytes (total 0, permanent 0):

0 in free list (0 max allowed)

IOSd private buffers:

Buffer elements:

354 in free list (500 max allowed)

27134 hits, 0 misses, 500 created

Public buffer pools:

Small buffers, 104 bytes (total 134, permanent 50, peak 134 @ 01:04:39):

134 in free list (20 min, 150 max allowed)

2554 hits, 28 misses, 0 trims, 84 created

0 failures (0 no memory)

Middle buffers, 600 bytes (total 52, permanent 25, peak 52 @ 01:04:39):

52 in free list (10 min, 150 max allowed)

61 hits, 9 misses, 0 trims, 27 created

0 failures (0 no memory)

Big buffers, 1536 bytes (total 50, permanent 50):

50 in free list (5 min, 150 max allowed)

157 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

VeryBig buffers, 4520 bytes (total 10, permanent 10):

10 in free list (0 min, 100 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Large buffers, 5024 bytes (total 0, permanent 0):

0 in free list (0 min, 10 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Huge buffers, 18024 bytes (total 0, permanent 0):

0 in free list (0 min, 4 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Interface buffer pools:

CF Small buffers, 104 bytes (total 100, permanent 100):

100 in free list (100 min, 200 max allowed)

0 hits, 0 misses, 0 trims, 0 created

804

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show buffers

0 failures (0 no memory)

BIPC small buffers, 128 bytes (total 250, permanent 250):

250 in free list (250 min, 250 max allowed)

92 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

BIPC middle buffers, 600 bytes (total 300, permanent 300):

300 in free list (300 min, 300 max allowed)

36 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

CF Middle buffers, 600 bytes (total 100, permanent 100):

100 in free list (100 min, 200 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Syslog ED Pool buffers, 600 bytes (total 132, permanent 132):

131 in free list (132 min, 132 max allowed)

5 hits, 0 misses

CF Big buffers, 1536 bytes (total 25, permanent 25):

25 in free list (25 min, 50 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

BIPC buffers, 4096 bytes (total 2, permanent 2):

2 in free list (1 min, 8 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

IPC Emergency buffers, 4096 bytes (total 301, permanent 300, peak 302 @ 01:05:07):

301 in free list (300 min, 300 max allowed)

39 hits, 1 fallbacks, 66 trims, 67 created

0 failures (0 no memory)

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

CF VeryBig buffers, 4520 bytes (total 2, permanent 2):

2 in free list (2 min, 4 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

CF Large buffers, 5024 bytes (total 1, permanent 1):

1 in free list (1 min, 2 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

BIPC Medium buffers, 16384 bytes (total 5, permanent 5):

5 in free list (5 min, 5 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

BIPC Large buffers, 65535 bytes (total 2, permanent 2):

2 in free list (2 min, 2 max allowed)

0 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

IPC small buffers, 128 bytes (total 250, permanent 250):

228 in free list (250 min, 250 max allowed)

124 hits, 0 fallbacks

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

IPC middle buffers, 600 bytes (total 200, permanent 200):

200 in free list (200 min, 200 max allowed)

293 hits, 0 fallbacks

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

IPC buffers, 4096 bytes (total 300, permanent 300):

298 in free list (300 min, 300 max allowed)

72 hits, 0 fallbacks

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

IPC Medium buffers, 16384 bytes (total 30, permanent 30):

30 in free list (30 min, 30 max allowed)

100 hits, 0 fallbacks

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

IPC Large buffers, 65535 bytes (total 13, permanent 13):

11 in free list (13 min, 13 max allowed)

19 hits, 0 misses

0 max cache size, 0 in cache

0 hits in cache, 0 misses in cache

Header pools:

Catalyst 4000 buffers, 0 bytes (total 14600, permanent 14600):

Cisco IOS Configuration Fundamentals Command Reference

805

show buffers show through show fm summary

14600 in free list (0 min, 14601 max allowed)

14600 hits, 0 misses, 0 trims, 0 created

0 failures (0 no memory)

Switch#

The following is sample shows how to run the show buffers detailed command on a Cisco Catalyst 4500e switch, using a Cisco IOS image from Cisco IOS XE Release 3.1.0.SG and later releases and the various keywords and arguments (Explained in the Syntax Description Table) available.

Switch#

Switch#show buffers ?

detailed Show detailed buffer statistics

| Output modifiers

<cr>

Switch#show buffers detailed ?

process Show detailed process buffer info

Switch#show buffers detailed process ?

iosd IOSd Process

Switch#show buffers detailed process iosd ?

address Buffer at a given address

all All buffers

assigned Buffers in use

failures Buffer allocation failures

free Buffers available for use

input-interface Buffers assigned to an input interface

old Buffers older than one minute

pool Buffers in a specified pool

| Output modifiers

<cr>

806

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show c2600

show c2600

To display information for troubleshooting the Cisco 2600 series router, use the show c2600 command in

EXEC mode.

show c2600

Syntax Description This command has no arguments or keywords.

Command Modes EXEC

Command History

Release

11.3 XA

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

The show c2600 command provides complex troubleshooting information that pertains to the platform’s shared references rather than to a specific interface.

Examples The following is sample output from the show c2600 command:

Router# show c2600

C2600 Platform Information:

Interrupts:

Assigned Handlers...

Vect Handler # of Ints Name

00 801F224C 00000000 Xilinx bridge error interrupt

01 801DE768 0D3EE155 MPC860 TIMER INTERRUPT

02 801E94E0 0000119E 16552 Con/Aux Interrupt

04 801F0D94 00000000 PA Network Management Int Handler

05 801E6C34 00000000 Timebase Reference Interrupt

06 801F0DE4 00002C1A PA Network IO Int Handler

07 801F0EA0 0000015D MPC860 CPM INTERRUPT

14 801F224C 00000000 Xilinx bridge error interrupt

IOS Priority Masks...

Level 00 = [ EF020000 ]

Level 01 = [ EC020000 ]

Level 02 = [ E8020000 ]

Level 03 = [ E0020000 ]

Level 04 = [ E0020000 ]

Level 05 = [ E0020000 ]

Level 06 = [ C0020000 ]

Level 07 = [ 00000000 ]

Cisco IOS Configuration Fundamentals Command Reference

807

show c2600 show through show fm summary

SIU_IRQ_MASK = FFFFFFFF SIEN = EF02xxxx Current Level = 00

Spurious IRQs = 00000000 SIPEND = 0000xxxx

Interrupt Throttling:

Throttle Count = 00000000 Timer Count = 00000000

Netint usec = 00000000 Netint Mask usec = 000003E8

Active = 0 Configured = 0

Longest IRQ = 00000000

IDMA Status:

Requests = 00000349 Drops = 00000000

Complete = 00000349 Post Coalesce Frames = 00000349

Giant = 00000000

Available Blocks = 256/256

ISP Status:

Version string burned in chip: "A986122997"

New version after next program operation: "B018020998"

ISP family type: "2096"

ISP chip ID: 0x0013

Device is programmable

The table below describes the significant fields shown in the display.

Table 56 show c2600 Field Descriptions

Field

Interrupts

Assigned Handlers

Vect

Handler

# of Ints

Name

IOS Priority Masks

SIU_IRQ_MASK

Spurious IRQs

Interrupt Throttling:

Throttle Count

Description

Denotes that the next section describes the status of the interrupt services.

Denotes a subsection of the Interrupt section that displays data about the interrupt handlers.

The processor vector number.

The execution address of the handler assigned to this vector.

The number of times this handler has been called.

The name of the handler assigned to this vector.

Denotes the subsection of the Interrupt section that displays internal Cisco IOS priorities. Each item in this subsection indicates a Cisco IOS interrupt level and the bit mask used to mask out interrupt sources when that Cisco IOS level is being processed. Used exclusively for debugging.

For engineering level debug only.

This subsection describes the behavior of the

Interrupt Throttling mechanism on the platform.

Number of times throttle has become active.

808

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field

Timer Count

Netint usec

Netint Mask usec

Active

Configured

Longest IRQ

IDMA Status

Requests

Drops

Complete

Post Coalesce Frames

Giant

Available Blocks

ISP Status

Version string burned in chip show c2600

Description

Number of times throttle has deactivated because the maximum masked out time for network interrupt level has been reached.

Maximum time network level is allowed to run (in microseconds).

Maximum time network level interrupt is masked out to allow process level code to run (in microseconds).

Indicates that the network level interrupt is masked or that the router is in interrupt throttle state.

Indicates that throttling is enabled or configured when set to 1.

Duration of longest network level interrupt (in microseconds).

Monitors the activity of the Internal Direct Memory

Access (IDMA) hardware and software. Used to coalesce packets (turn particularized packets into non particularized packets) for transfer to the process level switching mechanism.

Number of times the IDMA engine is asked to coalesce a packet.

Number of times the coalescing operation was aborted.

Number of times the operation was successful.

Number of Frames completed post coalesce processing.

Number of packets too large to coalesce.

Indicates the status of the request queue, in the format N/M where N is the number of empty slots in queue and M is the total number of slots; for example, 2/256 indicates that the queue has 256 entries and can accept two more requests before it is full.

Provides status of In-System-Programmable (ISP) hardware.

Current version of ISP hardware.

Cisco IOS Configuration Fundamentals Command Reference

809

show through show fm summary show c2600

Related Commands

Field

New version after next program operation

ISP family type

ISP chip ID

Device is programmable

Command

show context

Description

Version of ISP hardware after next ISP programming operation.

Device family number of ISP hardware.

Internal ID of ISP hardware as designated by the chip manufacturer.

“Yes” or “No.” Indicates if an ISP operation is possible on this board.

Description

Displays information stored in NVRAM when the router crashes.

810

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show c7200

show c7200

To display information about the CPU and midplane for Cisco 7200 series routers, use the show c7200 command in EXEC mode.

show c7200

Syntax Description This command has no arguments or keywords.

Command Modes EXEC

Command History

Release

11.2

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You can use the output of this command to determine whether the hardware version level and upgrade is current. The information is generally useful for diagnostic tasks performed by technical support only.

Examples The following is sample output from the show c7200 command:

Router# show c7200

C7200 Network IO Interrupt Throttling:

throttle count=0, timer count=0

active=0, configured=0

netint usec=3999, netint mask usec=200

C7200 Midplane EEPROM:

Hardware revision 1.2 Board revision A0

Serial number 2863311530 Part number 170-43690-170

Test history 0xAA RMA number 170-170-170

MAC=0060.3e28.ee00, MAC Size=1024

EEPROM format version 1, Model=0x6

EEPROM contents (hex):

0x20: 01 06 01 02 AA AA AA AA AA AA AA AA 00 60 3E 28

0x30: EE 00 04 00 AA AA AA AA AA AA AA 50 AA AA AA AA

C7200 CPU EEPROM:

Hardware revision 2.0 Board revision A0

Serial number 3509953 Part number 73-1536-02

Test history 0x0 RMA number 00-00-00

EEPROM format version 1

EEPROM contents (hex):

0x20: 01 15 02 00 00 35 8E C1 49 06 00 02 00 00 00 00

0x30: 50 00 00 00 FF FF FF FF FF FF FF FF FF FF FF FF

Cisco IOS Configuration Fundamentals Command Reference

811

show c7200 show through show fm summary

812

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show catalyst6000

show catalyst6000

To display the information about the chassis, use the show catalyst6000 command in user EXEC or privileged EXEC mode.

show catalyst6000 {all | chassis-mac-address | switching-clock | traffic-meter}

Syntax Description all chassis-mac-address switching-clock traffic-meter

Displays the MAC-address ranges and the current and peak traffic-meter reading.

Displays the MAC-address range.

Displays the failure recovery mode of the switching clock.

Displays the percentage of the backplane (shared bus) utilization.

Command Default

The default is all

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

12.2(33)SXI

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

The output of the show catalyst6000 traffic-meter command was changed to include traffic monitor status information.

Usage Guidelines If you enter the switching-clock keywords, the output displays whether switching of the redundant clock sources on the backplane is allowed if the active clock source fails.

Cisco IOS Configuration Fundamentals Command Reference

813

show through show fm summary show catalyst6000

Examples

There are either 64 or 1024 MAC addresses that are available to support the software features. You can enter the show catalyst6000 chassis-mac-address command to display the MAC-address range on your chassis.

In Cisco IOS Release 12.2(33)SXI and later releases, the traffic monitor status information is displayed in the output. In earlier releases, only the current and peak traffic-meter readings are displayed.

This example shows how to display the MAC-address ranges and the current and peak traffic-meter readings:

Router> show catalyst6000 all chassis MAC addresses: 64 addresses from 0001.6441.60c0 to 0001.6441.60ff

traffic meter = 0% Never cleared

peak = 0% reached at 08:14:38 UTC Wed Mar 19 2003

switching-clock: clock switchover and system reset is allowed

Router>

This example shows how to display the MAC-address ranges:

Router# show catalyst6000 chassis-mac-address chassis MAC addresses: 1024 addresses from 00d0.004c.1800 to 00d0.004c.1c00

Router#

The following example shows how to display the current and peak traffic-meter readings and the traffic monitor status:

Router

> show catalyst6000 traffic-meter traffic meter = 0% Never cleared

peak = 0% reached at 10:54:49 UTC Wed Mar 19 2008

---=== Traffic Utilization Monitor Status ===---

State Interval Threshold MsgCount LastMsgTime

-----------------------------------------------------------------------------

Backplane Off 60s 80% 0 --

Fpoe#0 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Fpoe#1 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Fpoe#2 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Fpoe#3 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Fpoe#4 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Fpoe#19 In Off 60s 80% 0 --

out Off 60s 80% 0 --

Router

This example shows how to display the failure recovery mode of the switching clock:

Router> show catalyst6000 switching-clock switching-clock: clock switchover and system reset is allowed

Router>

814

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

monitor traffic-utilbackplane

monitor traffic-util fpoe

show environment alarm

show fm summary

show environment status show catalyst6000

Description

Enables the backplane traffic utilization monitor or sets the traffic monitor interval.

Sets the fabric channel traffic utilization monitor to generate SYSLOG messages.

Displays the information about the environmental alarm.

Displays a summary of FM Information.

Displays the information about the operational FRU status.

Cisco IOS Configuration Fundamentals Command Reference

815

show through show fm summary show cls

show cls

To display the current status of all Cisco link services (CLS) sessions on the router, use the show

clscommand in EXEC mode.

show cls [brief]

Syntax Description brief (Optional) Displays a brief version of the output.

Command Default Without the brief keyword, displays complete output.

Command Modes EXEC

Command History

Release

11.0

12.2(33)SRA

Modification

This command was introduced in a release prior to

Cisco IOS Release 11.0.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Cisco link service (CLS) is used as the interface between data link users (DLUs), such as DLSw, LAN

Network Manager (LNM), downstream physical unit (DSPU), and SNASw, and their corresponding data link circuits (DLCs) such as Logic Link Control (LLC), VDLC, and Qualified Logic Link Control (QLLC).

Each DLU registers a particular service access point (SAP) with CLS, and establishes circuits through CLS over the DLC.

The show cls command displays the SAP values associated with the DLU and the circuits established through CLS.

For further information about CLS, use the Release 12.2 Cisco IOS Bridging and IBM Networking

Configuration Guide.

Examples The following is sample output from the show cls command:

IBD-4500B# show cls

DLU user:SNASW

SSap:0x04 VDLC VDLC650

DTE:1234.4000.0001 1234.4000.0002 04 04

T1 timer:0 T2 timer:0 Inact timer:0

max out:0 max in:0 retry count:10

816

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show cls

XID retry:10 XID timer:5000 I-Frame:0

flow:0 DataIndQ:0 DataReqQ:0

DLU user:DLSWDLUPEER

DLU user:DLSWDLU

Bridging VDLC VDLC1000

Bridging VDLC VDLC650

The following is sample output from the show cls brief command:

IBD-4500B# show cls brief

DLU user:SNASW

SSap:0x04 VDLC VDLC650

DTE:1234.4000.0001 1234.4000.0002 04 04

DLU user:DLSWDLUPEER

DLU user:DLSWDLU

Bridging VDLC VDLC1000

Bridging VDLC VDLC650

The examples show two DLUs--SNASw and DLSw--active in the router. SNASw uses a SAP value of

0x04, and the associated DLC port is VDLC650. SNASw has a circuit established between MAC addresses

1234.4000.0001 and 1234.4000.0002 using source and destination SAPs 04 and 04. DLSw is a bridging protocol and uses VDLC1000 and VDLC650 ports. There are no circuits in place at this time.

In the output from the show cls command (without the brief argument), the values of timers and counters applicable to this circuit are displayed.

Related Commands

Command

stun peer-name

Description

Enables STUN for an IP address and uses Cisco

Link Services (CLS) to access the Frame Relay network.

Cisco IOS Configuration Fundamentals Command Reference

817

show through show fm summary show config id

show config id

The configuration change tracking identifier (CTID) assigns a version number to each saved version of the running-config file. To display output about the versions, use the show config idcommand in privileged

EXEC mode.

show config id [detail]

Syntax Description detail (Optional) Expands the output of the command to include the ID of the last user to make a configuration change and the process in which the changes were made.

Command Default This command is disabled by default. If this command is not entered, the management system has to query the device for the current running-config file and then compare the results to the last known configuration to determine if a change has been made.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SRC

12.2(33)SB

12.4(20)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.4(20)T.

Usage Guidelines This configuration infrastructure command assigns a version number that is updated every time the running-config file is changed. This version number is called the configuration change tracking identifier or

CTID. The CTID can be used to compare configuration files to track configuration changes and take appropriate actions (for example, a configuration rollback). Config Logger can also use the CTID to determine if there have been any changes to the running-config file.

CTID makes the management system more efficient by presenting information that indicates a change has been made to the running-config file. Without CTID, the management system has to query the device for the current running-config file and then compare the results to the last known configuration to determine if a change has been made.

818

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show config id

Examples The following example shows that the current running-config file is version 4 and that this file was saved on June 15, 2006 at 7.572 seconds after 3:02 p.m.:

Router# show config id version:4 time:2006-06-15T15:02:07.572Z

The following example shows that the current running-config file is version 9 and that this file was last saved on June 18, 2006 at 34.431 seconds after 6:34 p.m. The file was saved by the system and changed from Init:

Router# show config id detail

Configuration version : 9

Last change time : 2006-06-18T18:34:34.431Z

Changed by user : system

Changed from process : Init

Field descriptions are self-explanatory.

Related Commands

Command

copy running-config startup-config

show running-config

Description

Copies the current running-config file (source) to the startup-config file (destination).

Displays the contents of the currently running configuration file or the configuration for a specific class map, interface, map class, policy map, or virtual-circuit class.

Cisco IOS Configuration Fundamentals Command Reference

819

show through show fm summary show configuration id

show configuration id

To display output about configuration versions, use the show configuration idcommand in privileged

EXEC mode.

show configuration id [detail]

Syntax Description detail (Optional) Expands the output of the command to include the ID of the last user to make a configuration change and the process in which the changes were made.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(33)SRC

12.2(33)SB

12.4(20)T

Cisco IOS XE Release 2.5

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.4(20)T.

This command was implemented on Cisco ASR

1000 Series Aggregation Services Routers.

(CTID). The CTID assigns a version number to each saved version of the running-config file. The CTID can be used to compare configuration files to track configuration changes and take appropriate actions (for example, a configuration rollback). Config Logger can also use the CTID to determine if there have been any changes to the running-config file.

820

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show configuration id the current running-config file and then compare the results to the last known configuration to determine if a change has been made.

Examples The following example shows that the current running-config file is version 4 and that this file was saved on June 15, 2006 at 7.572 seconds after 3:02 p.m.:

Router# show configuration id version:4 time:2006-06-15T15:02:07.572Z

Router# show configuration id detail

Configuration version : 9

Last change time : 2006-06-18T18:34:34.431Z

Changed by user : system

Changed from process : Init

Related Commands

Command

copy running-config startup-config

show running-config

Description

Copies the current running-config file (source) to the startup-config file (destination).

Displays the contents of the currently running configuration file or the configuration for a specific class map, interface, map class, policy map, or virtual-circuit class.

Cisco IOS Configuration Fundamentals Command Reference

821

show through show fm summary show configuration lock

show configuration lock

To display information about the lock status of the running configuration file during a configuration replace operation, use the show configuration lockcommand in privileged EXEC mode.

show configuration lock

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC(#)

Command History

Release

12.2(25)S

12.3(14)T

12.0(31)S

12.2(28)SB

12.2(33)SRA

12.2(31)SB2

12.2(33)SXH

12.2(33)SB

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.3(14)T.

The output of this command was updated to display the configuration locking class.

The command output was enhanced.

This command was integrated into Cisco IOS

Release 12.2(28)SB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was implemented on the Cisco

10000 series.

This command was integrated into Cisco IOS

Release 12.2(33)SXH.

This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco

10000 series.

Examples

The following is sample output from the show configuration lockcommand when the running configuration file is locked by another user.

Cisco IOS Release 12.2(25)S, Release 12.2(28)SB, Release 12.3(14)T, and Later Releases

Router# configure terminal

822

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show configuration lock

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# configuration mode exclusive ? auto Lock configuration mode automatically manual Lock configuration mode on-demand

Router(config)# configuration mode exclusive auto

Router(config)# end

Router# show running-config

| include configuration configuration mode exclusive auto

Router# configure terminal

!<----------- Acquires the lock

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# show configuration lock

Parser Configure Lock

---------------------

Owner PID : 3

User : unknown

TTY : 0

Type : EXCLUSIVE

State : LOCKED

Class : EXPOSED

Count : 1

Pending Requests : 0

User debug info : configure terminal

Router(config)#

Router(config)# end

! <------------ Releases the lock

The following is sample output from the show configuration lockcommand when the running configuration file is not locked by another user.

Router# show configuration lock

Parser Configure Lock

---------------------

Owner PID : -1

User : unknown

TTY : -1

Type : NO LOCK

State : FREE

Class : unknown

Count : 0

Pending Requests : 0

User debug info :

Cisco IOS Release 12.0(31)S, 12.2(33)SRA, and Later Releases

Router# show configuration lock

Parser Configure Lock

------------------------------------------------------

Owner PID : 3

User : unknown

TTY : 0

Type : EXCLUSIVE

State : LOCKED

Class : EXPOSED

Count : 1

Pending Requests : 0

User debug info : configure terminal

Session idle state : TRUE

No of exec cmds getting executed : 0

No of exec cmds blocked : 0

Config wait for show completion : FALSE

Remote ip address : Unknown

Lock active time (in Sec) : 6

Lock Expiration timer (in Sec) : 593

Cisco IOS Configuration Fundamentals Command Reference

823

show through show fm summary show configuration lock

User

TTY

Type

State

Class

The table below describes the significant fields shown in the displays.

Table 57 show configuration lock Field Descriptions

Field

Owner PID

Count

Pending Requests

User debug info

Session idle state

No of exec cmds getting executed

No of exec cmds blocked

Config wait for show completion

Remote ip address

Lock active time (in Sec)

Lock Expiration timer (in Sec)

Description

Process identifier (PID) of the process that owns the lock.

Owner’s username.

Owner’s terminal number.

Lock type (EXCLUSIVE/COUNTER/NO LOCK).

State of the lock (FREE/LOCKED).

Classification of users of the lock (EXPOSED/

ROLLBACK). Processes other than ROLLBACK belong to the EXPOSED class.

In the case of a counter lock, total number of processes holding the lock.

Total number of processes blocked by the lock.

Any string given by the process (used for debugging only).

Indicates whether the user in an access session locking session is idle. Displays TRUE or FALSE.

Total number of EXEC commands (show and

clear) being executed simultaneously from different sessions.

Total number of EXEC commands (show and

clear) waiting for the configurationcommand

(running from the access session locking session) to complete its execution.

Indicates whether a configuration command executed in an access session locking session is waiting for the completion of the show command being executed simultaneously from a different session. Displays TRUE or FALSE.

IP address of the terminal from which the user telneted to the router.

Amount of time, in seconds, that elapsed since the lock was acquired.

The amount of time, in seconds, that expires before the lock is automatically released.

824

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show configuration lock

The following example shows how to configure the configuration file for single user auto configuration mode (using the configuration mode exclusive auto command). Use the configure terminalcommand to enter global configuration mode and lock the configuration mode exclusively. Once the Cisco IOS configuration mode is locked exclusively, you can verify the lock using the show configuration

lockcommand.

Router# configure terminal

Router(config)# configuration mode exclusive auto

Router(config)# end

Router# configure terminal

Router(config)# show configuration lock

Parser Configure Lock

Owner PID : 10

User : User1

TTY : 3

Type : EXCLUSIVE

State : LOCKED

Class : Exposed

Count : 0

Pending Requests : 0

User debug info : 0

Related Commands

Command

configuration mode exclusive

configure replace

debug configuration lock

Description

Enables single-user (exclusive) access functionality for the Cisco IOS CLI.

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

Enables debugging of the Cisco IOS configuration lock.

Cisco IOS Configuration Fundamentals Command Reference

825

show through show fm summary show context

show context

To display information stored in NVRAM when an unexpected system reload (system exception) occurs, use the show context command in user EXEC or priviledged EXEC mode.

show context [summary | all | slot slot-number [crash-index] [all] [debug]]

Syntax Description summary all

slot slot-number crash-index debug

Displays a summary of all the crashes recorded.

Displays all crashes for all the slots. When optionally used with the slot keyword, displays crash information for the specified slot.

Displays information for a particular line card. Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008. The index number allows you to look at previous crash contexts. Contexts from the last 24 line card crashes are saved on the GRP card. If the GRP reloads, the last 24 line card crash contexts are lost. For example, show context slot 3 2 shows the second most recent crash for line card in slot 3. Index numbers are displayed by the show context

summary command.

(Optional) Displays crash information as a hex record dump in addition to one of the options listed.

Command Modes User EXEC

Privileged EXEC

Command History

Release

10.3

11.2 GS

12.2(33)SRA

Modification

This command was introduced.

The slot slot-number [crash-index] [all] [debug] syntax was added for Cisco 12000 series routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The display from the show context command includes the following information:

826

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show context

Examples

• Reason for the system reboot

• Stack trace

• Software version

• The signal number, code, and router uptime information

• All the register contents at the time of the crash

Note This command is primarily for use by Cisco technical support representatives for analyzing unexpected system reloads.

Output for this command will vary by platform. Context information is specific to processors and architectures. For example, context information for the Cisco 2600 series router differs from that for other router types because the Cisco 2600 runs with an M860 processor.

The following is sample output from the show context command following a system failure:

Router> show context

System was restarted by error - a Software forced crash, PC 0x60189354

GS Software (RSP-PV-M), Experimental Version 11.1(2033) [ganesh 111]

Compiled Mon 31-Mar-97 13:21 by ganesh

Image text-base: 0x60010900, data-base: 0x6073E000

Stack trace from system failure:

FP: 0x60AEA798, RA: 0x60189354

FP: 0x60AEA798, RA: 0x601853CC

FP: 0x60AEA7C0, RA: 0x6015E98C

FP: 0x60AEA7F8, RA: 0x6011AB3C

FP: 0x60AEA828, RA: 0x601706CC

FP: 0x60AEA878, RA: 0x60116340

FP: 0x60AEA890, RA: 0x6011632C

Fault History Buffer:

GS Software (RSP-PV-M), Experimental Version 11.1(2033) [ganesh 111]

Compiled Mon 31-Mar-97 13:21 by ganesh

Signal = 23, Code = 0x24, Uptime 00:04:19

$0 : 00000000, AT : 60930120, v0 : 00000032, v1 : 00000120 a0 : 60170110, a1 : 6097F22C, a2 : 00000000, a3 : 00000000 t0 : 60AE02A0, t1 : 8000FD80, t2 : 34008F00, t3 : FFFF00FF t4 : 00000083, t5 : 3E840024, t6 : 00000000, t7 : 11010132 s0 : 00000006, s1 : 607A25F8, s2 : 00000001, s3 : 00000000 s4 : 00000000, s5 : 00000000, s6 : 00000000, s7 : 6097F755 t8 : 600FABBC, t9 : 00000000, k0 : 30408401, k1 : 30410000 gp : 608B9860, sp : 60AEA798, s8 : 00000000, ra : 601853CC

EPC : 60189354, SREG : 3400EF03, Cause : 00000024

Router>

The following is sample output from the show context summary command on a Cisco 12012 router. The

show context summary command displays a summary of all the crashes recorded for each slot (line card).

Router# show context summary

CRASH INFO SUMMARY

Slot 0 : 0 crashes

Slot 1 : 0 crashes

Slot 2 : 0 crashes

Slot 3 : 0 crashes

Slot 4 : 0 crashes

Slot 5 : 0 crashes

Slot 6 : 0 crashes

Slot 7 : 2 crashes

1 - crash at 18:06:41 UTC Tue Nov 5 1996

2 - crash at 12:14:55 UTC Mon Nov 4 1996

Slot 8 : 0 crashes

Slot 9 : 0 crashes

Slot 10: 0 crashes

Cisco IOS Configuration Fundamentals Command Reference

827

show through show fm summary show context

Slot 11: 0 crashes

Router#

The following is sample output from the show contextcommand following an unexpected system reload on a Cisco 2600 series router.

router# show context

S/W Version: Cisco IOS Software

Cisco IOS (tm) c2600 Software (c2600-JS-M), Released Version 11.3(19980115:184921]

Compiled Thu 15-Jan-98 13:49 by mmagno

Exception occurred at: 00:02:26 UTC Mon Mar 1 1993

Exception type: Data TLB Miss (0x1200)

CPU Register Context:

PC = 0x80109964 MSR = 0x00009030 CR = 0x55FFFD35 LR = 0x80109958

CTR = 0x800154E4 XER = 0xC000BB6F DAR = 0x00000088 DSISR = 0x00000249

DEC = 0x7FFFDFCA TBU = 0x00000000 TBL = 0x15433FCF IMMR = 0x68010020

R0 = 0x80000000 R1 = 0x80E80BD0 R2 = 0x80000000 R3 = 0x00000000

R4 = 0x80E80BC0 R5 = 0x40800000 R6 = 0x00000001 R7 = 0x68010000

R8 = 0x00000000 R9 = 0x00000060 R10 = 0x00001030 R11 = 0xFFFFFFFF

R12 = 0x00007CE6 R13 = 0xFFF379E8 R14 = 0x80D50000 R15 = 0x00000000

R16 = 0x00000000 R17 = 0x00000000 R18 = 0x00000000 R19 = 0x00000000

R20 = 0x00000000 R21 = 0x00000001 R22 = 0x00000010 R23 = 0x00000000

R24 = 0x00000000 R25 = 0x80E91348 R26 = 0x01936010 R27 = 0x80E92A80

R28 = 0x00000001 R29 = 0x019BA920 R30 = 0x00000000 R31 = 0x00000018

Stack trace:

Frame 00: SP = 0x80E80BD0 PC = 0x80109958

Frame 01: SP = 0x80E80C28 PC = 0x8010A720

Frame 02: SP = 0x80E80C40 PC = 0x80271010

Frame 03: SP = 0x80E80C50 PC = 0x8025EE64

Frame 04: SP = 0x80DEE548 PC = 0x8026702C

Frame 05: SP = 0x80DEE558 PC = 0x8026702C

The table below describes the significant fields shown in the display.

Table 58 show context Field Descriptions

Field

S/W Version

Exception occurred at

Exception type

CPU Register Context

Stack trace

Description

Standard Cisco IOS version string as displayed.

Router real time when exception occurred. The router must have the clock time properly configured for this to be accurate.

Technical reason for exception. For engineering analysis.

Technical processor state information. For engineering analysis.

Related Commands

Command

show processes

Description

Displays information about the active processes.

828

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Command

show stacks show context

Description

Monitors the stack usage of processes and interrupt routines.

Cisco IOS Configuration Fundamentals Command Reference

829

show through show fm summary show controllers (GRP image)

show controllers (GRP image)

To display information that is specific to the hardware, use the show controllerscommand in privileged

EXEC mode.

[register] | pos [slot-number] [details] | queues [slot-number] | sca | xbar]

Syntax Description

atm slot-number clock

csar [register csc-fpga dp83800 fab-clk

fia register

pos [slot-number] [details

(Optional) Displays the ATM controllers. Number is slot-number/ port-number (for example, 4/0). Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008 router.

(Optional) Displays the clock card configuration.

(Optional) Displays the Cisco Cell Segmentation and Reassembly (CSAR) information. CSAR is the name of the chip on the card that handles traffic between the GRP and the switch fabric interface

ASICs.

(Optional) Displays the clock and scheduler card register information in the field programmable gate array (FPGA).

(Optional) Displays the Ethernet information on the

GRP card.

(Optional) Display the switch fabric clock register information. The switch fabric clock FPGA is a chip that monitors the incoming fabric clock generated by the switch fabric. This clock is needed by each card connecting to the switch fabric to properly communicate with it. Two switch fabric clocks arrive at each card; only one can be used.

The FPGA monitors both clocks and selects which one to use if only one of them is running.

(Optional) Displays the fabric interface ASIC information and optionally displays the register information.

(Optional) Displays the POS framer state and optionally displays all the details for the interface.

Number is slot-number/port-number (for example,

4/0). Slot numbers range from 0 to 11 for the Cisco

12012 router and from 0 to 7 for the Cisco 12008 router.

830

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show controllers (GRP image)

queues [slot-number sca xbar

(Optional) Displays the SDRAM buffer carve information and optionally displays the information for a specific line card. The SDRAM buffer carve information displayed is suggested carve information from the GRP card to the line card.

Line cards might change the shown percentages based on SDRAM available. Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008.

(Optional) Displays the SCA register information.

The SCA is an ASIC that arbitrates among the line cards requests to use the switch fabric.

(Optional) Displays the crossbar register information. The XBAR is an ASIC that switches the data as it passes through the switch fabric.

Command Modes Privileged EXEC

Command History

Release

11.2 GS

12.2(33)SRA

Modification

This command was introduced to support the Cisco

12000 series routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This information provided by this command is intended for use only by technical support representatives in analyzing system failures in the field.

Examples

The following is sample output from the show controllers pos command for a Cisco 12012:

Router# show controllers pos 7/0

POS7/0

SECTION

LOF = 2 LOS = 0 BIP(B1) = 5889

Active Alarms: None

LINE

AIS = 2 RDI = 2 FEBE = 146 BIP(B2) = 2106453

Active Alarms: None

PATH

AIS = 2 RDI = 4 FEBE = 63 BIP(B3) = 3216

LOP = 0 PSE = 8 NSE = 3 NEWPTR = 2

Active Alarms: None

APS

COAPS = 3 PSBF = 2

State: PSBF_state = False

Cisco IOS Configuration Fundamentals Command Reference

831

show through show fm summary show controllers (GRP image)

Rx(K1/K2): F0/15 Tx(K1/K2): 00/00

S1S0 = 00, C2 = 64

PATH TRACE BUFFER : STABLE

Remote hostname : GSR-C

Remote interface: POS10/0

Remote IP addr : 10.201.101.2

Remote Rx(K1/K2): F0/15 Tx(K1/K2): 00/00

Router#

Related Commands

Command

clear controllers

show controllers (line card image)

Description

Resets the T1 or E1 controller.

Displays information that is specific to the hardware on a line card.

832

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show controllers (line card image)

show controllers (line card image)

T o display information that is specific to the hardware on a line card, use the attach command in privileged EXEC mode to connect to the line card and then use the show controllers command in privileged EXEC mode or the execute-on command in privileged EXEC mode.

show controllers atm [[port-number] [all | sar | summary]]

show controllers fia [register]

show controllers {frfab | tofab} {bma{microcode | ms-inst | register} | qelem start-queue-element

[end-queue-element] | qnum start-queue-element [end-queue-element] | queues | statistics}

show controllers io

show controllers l3

show controllers pos {framers | queues | registers | rxsram port-number queue-start-address

[queue-length] | txsram port-number queue-start-address [queue-length]}

show controllers events [clear | punt-sniff [none | word1 | word2] | punt-verbose [all]]

Syntax Description

atm port-number all sar summary fia register frfab tofab bma microcode

Displays the ATM controller information.

(Optional) Displays request for the physical interface on the ATM card. The range of choices is from 0 to 3.

(Optional) Lists all details.

(Optional) Lists SAR interactive command.

(Optional) Lists SAR status summary.

Displays the fabric interface ASIC information.

(Optional) Displays the register information.

(Optional) Displays the "from" (transmit) fabric information.

(Optional) Displays the "to" (receive) fabric information.

For the frfab or tofab keywords, displays microcode, micro sequencer, or register information for the silicon queuing engine (SQE), also known as the buffer management ASIC (BMA).

Displays SQE information for the microcode bundled in the line card and currently running version.

Cisco IOS Configuration Fundamentals Command Reference

833

show controllers (line card image) mis-inst register qelem start-queue-element end-queue-element

qnum start-queue-number end-queue-number queues statistics io l3 pos framers queues registers rxsram port-number queue-start-address queue-length txsram

834

Cisco IOS Configuration Fundamentals Command Reference show through show fm summary

Displays SQE information for the micro sequencer instruction.

Displays silicon queuing engine (SQE) information for the register.

For the frfab or tofab keywords, displays the

SDRAM buffer pool queue element summary information.

Specifies the start queue element number from 0 to

65535.

(Optional) Specifies the end queue element number from 0 to 65535).

For the frfab or tofab keywords, displays the

SDRAM buffer pool queue detail information.

Specifies the start free queue number (from 0 to

127).

(Optional) Specifies the end free queue number

(from 0 to 127).

For the frfab or tofab keywords, displays the

SDRAM buffer pool information.

For the frfab or tofab keywords, displays the BMA counters.

Displays input/output registers.

Displays Layer 3 ASIC information.

Displays packet-over-sonic (POS) information for framer registers, framer queues, and ASIC registers.

Displays the POS framer registers.

Displays the POS framer queue information.

Displays the ASIC registers.

Displays the receive queue SRAM.

Specifies a port number (valid range is from 0 to 3).

Specifies the queue SRAM logical starting address.

(Optional) Specifies the queue SRAM length.

Displays the transmit queue SRAM.

show through show fm summary events clear punt-sniff none word1 word2 punt-verbose all

Command Modes Privileged EXEC

Command History

Release

11.2 GS

12.2(33)SRA

12.2(31)SB show controllers (line card image)

Displays the line card counter information of events generated from line card.

(Optional) Clears all the line card event counter output details that are displayed using the commands: show controllers events, show

controllers events punt-verbose, and show

controllers events punt-sniff.

(Optional) Sniffs the packets sent to route processor from line card by specifying the word and location.

Note Punt sniff is enabled only if one of the word is configured.

(Optional) Clears the attributes and packets to be sniffed from route processor and resets the counters to zero.

(Optional) Sniffs packets sent to the route processor for the specified hexa decimal value of word1.

Location of the word is optional.

(Optional) Sniffs packets sent to the route processor matching the specified hexa decimal value of word2. Location of the word is optional.

(Optional) Displays application-wise packets punt to route processor (RP) from line card (LC).

Displays non-zero punt counters if the command is executed without the all keyword.

(Optional) Displays zero and non-zero punt counters of packets punt to RP from LC. The all keyword is used along with the command show

controllers events punt-verbose all.

Modification

This command was added to support the Cisco

12000 series Gigabit Switch Routers.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated in Cisco IOS Release

12.2(31)SB.

Cisco IOS Configuration Fundamentals Command Reference

835

show through show fm summary show controllers (line card image)

Release

12.2(33)SB

12.0(33)S

Modification

This command’ behavior was modified on the

Cisco 10000 series router for the PRE3 and PRE4.

The keywords punt-sniff and punt-verbose were added in the command show controllers events for the Cisco 12000 Series Routers.

Usage Guidelines This information displayed by this command is of use only to technical support representatives in analyzing unexpected system failures in the field. It is documented here in case you need to provide the displayed statistics to an technical support engineer.

Cisco 10000 Series Router Usage Guidelines

In releases prior to Cisco IOS Release 12.2(33)SB, when you configure the t1 loopback remote command on the local router, the command also displays in the running-config file of the far-end router. This is due to the route processor (RP) updating an incorrect parameter when it receives the loopback event message from the line card for loopback requests from the far end.

In Cisco IOS Release 12.2(33)SB, the RP updates the correct parameter and the show controllers command correctly displays the loopback CLI commands applied on the local end and displays the loopback events and status received from the line card in response to loopback requests from the far end.

This change in behavior affects the following line cards and is documented in the CSCsm84447 caveat:

• 4-port channelized STM1

• 1-port channelized OC-12

• 6-port channelized T3

• 4-port half-height channelized T3

In Cisco IOS Release 12.2(33)SB, the output from the show controller command includes line code information for the 6-port channelized T3 line card and the 8-port E3/DS3 line card. However, because

SONET line cards do not have a direct physical link at the T3 or E3 level, the output from the show controller t3 command does not include line code information.

In Cisco IOS Release 12.2(31)SB, the output from the show controller command displays line code information. The output of the show controller t3 command for SONET-based T3 also includes line code information.

Cisco 12000 Series Router Usage Guidelines

The packets processed by a line card are either sent to a route processor or a line card in the form of Cisco cells. To track the packets sent to a route processor from a line card is essential for troubleshooting. The keywords punt-sniff and punt-verbose have been added for the command show controllers events to identify the packets sent to RP from LC.

By default, the feature is enabled and packets punt to route processor are displayed using the command

show controllers events punt-verbose. To view all the zero and non-zero punt counters use the command

show controllers events punt-verbose all.

To clear all the line card events and counters including resetting the packets to be sniffed to zero, executing the command show controllers events clear.

Packets sent to route processor from line card can be sniffed by specifying the hexa-decimal value of the word. Packets can only be sniffed if the word along with the hexa-decimal value is specified. Specifying

836

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Examples show controllers (line card image) the location of the word, sniffs packets from the particular location. To reset the counters of packets to be sniffed to zero, execute the command show controllers events punt-sniff none.

For example, use the command show controllers events punt-sniff word1 0x60000000 to sniff packets punt to RP with the hexa-decimal value 0x60000000. As the location is not specified, it searches the entire buffer for the value 0x60000000. Packets punt to RP can also be sniffed by specifying a particular location using the command show controllers events punt-sniff word1 0x60000000 34.

Because you are executing this command on the line card, you must use the execute-on command to use the show command, or you must connect to the card using the attach command. All examples in this section use the execute-on command

The following is partial sample output from the show controllers atm command:

Router# execute-on slot 4 show controllers atm 0

TX SAR (Beta 1.0.0) is Operational;

RX SAR (Beta 1.0.0) is Operational;

Interface Configuration Mode:

STS-12c

Active Maker Channels: total # 6

VCID ChnnlID Type OutputInfo InPkts InOAMs MacString

1 0888 UBR 0C010010 0 0 08882000AAAA030000000800

2 0988 VBR 04010020 0 0 09882000

3 8BC8 UBR 0C010030 0 0 8BC82000AAAA030000000800

4 0E08 UBR 0C010040 0 0 0E082000AAAA030000000800

10 1288 VBR 040100A0 0 0 12882000

11 8BE8 VBR 0C0100B0 0 0 8BE82000AAAA030000000800

SAR Total Counters: total_tx_idle_cells 215267 total_tx_paks 0 total_tx_abort_paks 0 total_rx_paks 0 total_rx_drop_paks 0 total_rx_discard_cells 15

Switching Code Counters: total_rx_crc_err_paks 0 total_rx_giant_paks 0 total_rx_abort_paks 0 total_rx_crc10_cells 0 total_rx_tmout_paks 0 total_rx_unknown_paks 0 total_rx_out_buf_paks 0 total_rx_unknown_vc_paks 0

BATMAN Asic Register Values: hi_addr_reg 0x8000, lo_addr_reg 0x000C, boot_msk_addr 0x0780, rmcell_msk_addr 0x0724, rmcnt__msk_addr 0x07C2, txbuf_msk_addr 0x070C,

CM622 SAR Boot Configuration: txind_q_addr 0x14000 txcmd_q_addr 0x20000

SUNI-622 Framer Register Values:

Master Rst and Ident/Load Meters Reg (#0x0): 0x10

Master Configuration Reg (#0x1): 0x1F

Master Interrupt Status Reg (#0x2): 0x00

PISO Interrupt Reg (#0x3): 0x04

Master Auto Alarm Reg (#0x4): 0x03

Master Auto Alarm Reg (#0x5): 0x07

Parallel Output Port Reg (#0x6): 0x02

BERM Line BIP Threshold LSB Reg (#0x74): 0x00

BERM Line BIP Threshold MSB Reg (#0x75): 0x00

Router#

Cisco IOS Configuration Fundamentals Command Reference

837

show through show fm summary show controllers (line card image)

The following is partial sample output from the show controllers command:

Router# execute-on slot 6 show controllers

Interface POS0

Hardware is BFLC POS lcpos_instance struct 60311B40

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000400

SUNI rsop intr status 00

CRC32 enabled, HDLC enc, int clock no loop

Interface POS1

Hardware is BFLC POS lcpos_instance struct 603142E0

RX POS ASIC addr space 12000000

TX POS ASIC addr space 12000100

SUNI framer addr space 12000600

SUNI rsop intr status 00

CRC32 enabled, HDLC enc, int clock no loop

Router#

The following is partial sample output from the show controllers pos framers command:

Router# execute-on slot 6 show controllers pos framers

Framer 0, addr=0x12000400: master reset C0 master config 1F rrate sts3c trate sts3c fixptr master control 00 clock rcv cntrl D0

RACP control 84

RACP gfc control 0F

TACP control status 04 hcsadd

RACP intr enable 04

RSOP cntrl intr enable 00

RSOP intr status 00

TPOP path sig lbl (c2) 13

SPTB control 04 tnull

SPTB status 00

Framer 1, addr=0x12000600: master reset C0 master config 1F rrate sts3c trate sts3c fixptr master control 00 clock rcv cntrl D0

RACP control 84

RACP gfc control 0F

TACP control status 04 hcsadd

RACP intr enable 04

RSOP cntrl intr enable 00

RSOP intr status 00

TPOP path sig lbl (c2) 13

SPTB control 04 tnull

SPTB status 00

Framer 2, addr=0x12000800: master reset C0 master config 1F rrate sts3c trate sts3c fixptr master control 00 clock rcv cntrl D0

RACP control 84

RACP gfc control 0F

TACP control status 04 hcsadd

RACP intr enable 04

RSOP cntrl intr enable 00

RSOP intr status 00

TPOP path sig lbl (c2) 13

SPTB control 04 tnull

SPTB status 00

838

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show controllers (line card image)

Router#

The following is partial sample output from the show controllers fia command:

Router# execute-on slot 7 show controllers fia

========= Line Card (Slot 7) =======

Fabric configuration: Full bandwidth redundant

Master Scheduler: Slot 17

From Fabric FIA Errors

----------------------redund fifo parity 0 redund overflow 0 cell drops 0 crc32 lkup parity 0 cell parity 0 crc32 0

0 1 2 3 4

-------- -------- -------- -------- -------los 0 0 0 0 0 crc16 0 0 0 0 0

To Fabric FIA Errors

----------------------sca not pres 0 req error 0 uni fifo overflow 0 grant parity 0 multi req 0 uni fifo undrflow 0 cntrl parity 0 uni req 0 crc32 lkup parity 0 multi fifo 0 empty dst req 0 handshake error 0

The following is a sample output from the show controllers eventscommand:

Router# execute-on slot 7 show controllers events

Switching Stats

Packets punt to RP: 935

HW engine punt: 62

HW engine reject: 38113520

RX HW Engine Reject Counters

Unrecognized Protocol ID: 19182546

IP TTL Expired: 14706652

Unrecognized L2 Frame: 4224320

IPv6 Control pkts: 2

The following is a sample output from the show controllers events punt-verbose command:

Router# execute-on slot 7 show controllers events punt-verbose

RP Punted L2 Statistics in Verbose

------------------------------------

HDLC Encap : 927

RP Punted L3 Statistics in Verbose

------------------------------------

ICMP : 40

UDP : 441

OSPF : 211

IPV6 : 40

RP Punted L3 Application Statistics in Verbose

-----------------------------------------------

LDP : 441

DF Bit not Set : 692

The following is a partial sample output from the show controllers events punt-verbose all command which displays the zero and non-zero value of packets punt to RP from LC:

Router# execute-on slot 7 show controllers events punt-verbose all

RP Punted L2 Statistics in Verbose

------------------------------------

L2 Protocol - 0 : 0

ARPA Encap : 0

L2 Protocol - 2 : 0

L2 Protocol - 3 : 0

L2 Protocol - 4 : 0

HDLC Encap : 941

L2 Protocol - 6 : 0

L2 Protocol - 7 : 0

L2 Protocol - 8 : 0

L2 Protocol - 9 : 0

Cisco IOS Configuration Fundamentals Command Reference

839

show through show fm summary show controllers (line card image)

L2 Protocol - 10 : 0

L2 Protocol - 11 : 0

L2 Protocol - 12 : 0

L2 Protocol - 13 : 0

L2 Protocol - 14 : 0

L2 Protocol - 15 : 0

PPP Encap : 0

L2 Protocol - 17 : 0

L2 Protocol - 18 : 0

L2 Protocol - 19 : 0

Frame Relay Encap : 0

L2 Protocol - 21 : 0

L2 Protocol - 22 : 0

L2 Protocol - 23 : 0

L2 Protocol - 24 : 0

L2 Protocol - 25 : 0

L2 Protocol - 26 : 0

L2 Protocol - 27 : 0

L2 Protocol - 28 : 0

L2 Protocol - 29 : 0

L2 Protocol - 30 : 0

L2 Protocol - 31 : 0

L2 Protocol - 32 : 0

ATM Encap : 0

L2 Protocol - 34 : 0

L2 Protocol - 35 : 0

RP Punted L3 Statistics in Verbose

------------------------------------

HOPOPT : 0

ICMP : 40

IGMP : 0

L3 Protocol - 3 : 0

IPINIP : 0

L3 Protocol - 5 : 0

RP Punted L3 Application Statistics in Verbose

-----------------------------------------------

MPLS OAM : 0

FTP : 0

FTPD : 0

TFTP : 0

.....

The following is a sample output from the show controllers events clear command:

Router# execute-on slot 7 show controllers events clear

Drop, switching and reject counters cleared

The following is a sample output from the show controllers events punt-sniff command:

Router# execute-on slot 7 show controllers events punt-sniff

Punt Sniff Statistics

--------------------------------

Word Location Occurance

0x60000000 34 0

0xB6010102 37 5

Note: Location offset taken from the begining of BufferHeader(32 bytes).

The following is a sample output from the show controllers events punt-sniff word1 0x60000000 command. This command is used to sniff a packet with a hexa-decimal value 0x60000000from the start of the buffer header of the packet being punt to RP:

Router# execute-on slot 7 show controllers events punt-sniff word1

0x60000000

The following is a sample output from the show controllers events punt-sniff word1 0x60000000

34command. This command is used to sniff a packet with a hexa-decimal value 0x600000000 at the location 34 from the start of the buffer header of the packet being punt to RP:

Router# execute-on slot 7 show controllers events punt-sniff word1

0x60000000 34

840

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show controllers (line card image)

The following is a sample output from the show controllers events punt-sniff none command. This command is used to clear the counter of packets to be sniffed:

Router# execute-on slot 7 show controllers events punt-sniff none

Related Commands

Command

clear controllers

Description

Resets the T1 or E1 controller.

Cisco IOS Configuration Fundamentals Command Reference

841

show through show fm summary show controllers logging

show controllers logging

To display logging information about a Versatile Interface Processor (VIP) card, use the show controllers

logging command in privileged EXEC mode.

show controllers vip slot-number logging

Syntax Description

vip slot-number VIP slot number.

Command Modes Privileged EXEC

Command History

Release

11.2

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

This command displays the state of syslog error and event logging, including host addresses, and whether console logging is enabled.

When enabled, “trap logging” allows messages to be sent to a remote host (a syslog server).

Examples

The following is sample output from the show controllers logging command:

Router# show controllers vip 1 logging show logging from Slot 1:

Syslog logging:enabled (0 messages dropped, 1 messages rate-limited, 0 flushes, 0 overruns)

Console logging: disabled

Monitor logging: level debugging, 0 messages logged

Buffer logging: level debugging, 24 messages logged

Trap logging: level informational, 266 messages logged.

Logging to 209.165.202.129

Exception Logging size: 4096 bytes

Count and timestamp logging messages:disabled

Log Buffer (8192 bytes): smallest_local_pool_entries = 256, global particles = 5149 highest_local_visible_bandwidth = 155000

00:00:05:%SYS-5-RESTART:System restarted --

842

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show controllers logging

The table below describes the significant fields shown in the display.

Table 59 show controllers logging Field Descriptions

Field

Syslog logging

Console logging

Monitor logging

Buffer logging

Trap logging

Description

Shows general state of system logging (enabled or disabled), and status of logged messages (number of messages dropped, rate-limited, or flushed).

Logging to the console port. Shows "disabled" or, if enabled, the severity level limit and number of messages logged.

Enabled using the logging console command.

Logging to the monitor (all TTY lines). Shows

"disabled" or, if enabled, the severity level limit and number of messages logged.

Enabled using the logging monitor command.

Logging to the standard syslog buffer. Shows

"disabled" or, if enabled, the severity level limit and number of messages logged.

Enabled using the logging buffered command.

Logging to a remote host (syslog host). Shows

"disabled" or, if enabled, the severity level limit and number of messages logged.

(The word "trap" means a trigger in the system software for sending error messages to a remote host.)

Enabled using the logging host command. The severity level limit is set using the logging trap command.

Related Commands

Command

show logging

Description

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

843

show through show fm summary show controllers tech-support

show controllers tech-support

To display general information about a Versatile Interface Processor (VIP) card when reporting a problem, use the show controllers tech-support command in privileged EXEC mode.

show controllers vip slot-number tech-support

Syntax Description

vip slot-number VIP slot number.

Command Modes

Privileged EXEC

Command History

Release

11.2

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to help collect general information about a VIP card when you are reporting a problem.

This command displays the equivalent of the following show commands for the VIP card:

• more system:running-config

• show buffers

• show controllers

• show interfaces

• show processes cpu

• show processes memory

• show stacks

• show version

For a sample display of the show controllers tech-support command output, refer to these show commands.

Related Commands

Command

more system:running-config

show buffers

Description

Displays the running configuration.

Displays statistics for the buffer pools on the network server.

844

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Command

show controllers

show interfaces

show processes

show processes memory

show stacks

show tech-support

show version show controllers tech-support

Description

Displays information that is specific to the hardware.

Uses the show interfaces EXEC command to display ALC information.

Displays information about the active processes.

Displays memory used.

Monitors the stack usage of processes and interrupt routines.

Displays general information about the router when reporting a problem.

Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.

Cisco IOS Configuration Fundamentals Command Reference

845

show through show fm summary show coverage history

show coverage history

To display the system history table, use the show coverage historycommand in privileged EXEC mode.

show coverage history [all | first number-of-entries | last number-of-entries | status]

Syntax Description all first number-of-entries last status

(Optional) Displays the entire history table.

(Optional) Displays the oldest entries in the history table.

(Optional) Number of entries to be displayed. The range is from 1 to 100000.

(Optional) Displays the latest entries in the history table.

(Optional) Displays the status of the history system.

Command Modes

Privileged EXEC (#)

Command History

Release

12.4(24)T

Modification

This command was introduced in a release earlier than Cisco IOS Release 12.4(24)T.

Examples

The following is sample output from the show coverage history command. The output is self-explanatory.

Router# show coverage history status

History table size is 23 entries. 0 entries have been used.

Low-level count handler has been called 0 times.

There were 0 entries not traced due to recursion detection.

There were 0 entries not traced due to internal pauses.

Related Commands

Command

coverage history

Description

Enables the system to record the history of the events.

846

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show data-corruption

show data-corruption

To display data inconsistency errors of the present software version, use the show data-

corruptioncommand in user EXEC or privileged EXEC mode.

show data-corruption

Syntax Description This command has no arguments or keywords.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.2(22)SE

12.2(33)SRB

12.4(20)T

12.2(33)SXI

Cisco IOS 2.3 XE

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRB.

This command was integrated into Cisco IOS

Release 12.4(20)T.

This command was integrated into Cisco IOS

Release 12.2(33)SXI.

This command was integrated into Cisco IOS XE

Release 2.3.

Usage Guidelines Use this command to display all data inconsistency errors or the corrupt data. If there are no data errors, the

“No data inconsistency errors have been recorded” message is displayed.

Examples The following is sample output from show data-corruption command. The fields are self-explanatory.

Router# show data-corruption

Data inconsistency records for:

3800 Software (C3845-ADVIPSERVICESK9-M), Version 12.4(24)T, RELEASE

SOFTWARE (fc2)

Technical Support: http://www.cisco.com/techsupport

Compiled Thu 17-Dec-09 09:02 by xyz

Count Traceback

1842 60523C58, 616E85FC 60523C58 62A9F648

1: Jun 12 18:24:33.960

2: Jun 12 18:24:33.960

Cisco IOS Configuration Fundamentals Command Reference

847

show data-corruption

3: Jun 12 18:24:33.960

1842: Jun 19 00:30:51.350

show through show fm summary

848

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show debugging

show debugging

To display information about the types of debugging that are enabled for your router, use the show debugging command in privileged EXEC mode.

show debugging

Syntax Description

This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History

Release

11.1

12.3(7)T

12.2(33)SRA

12.2(31)SB2

12.2SX

12.4(20)T

Modification

This command was introduced.

The output of this command was enhanced to show

TCP Explicit Congestion Notification (ECN) configuration.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(31)SB2.

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.

The output of this command was enhanced to show the user-group debugging configuration.

Examples

The following is sample output from the show debugging command. In this example, the remote host is not configured or connected.

Router# show debugging

TCP:

TCP Packet debugging is on

TCP ECN debugging is on

Router# telnet 10.1.25.234

Trying 10.1.25.234 ...

00:02:48: 10.1.25.31:11001 <---> 10.1.25.234:23 out ECN-setup SYN

Cisco IOS Configuration Fundamentals Command Reference

849

show through show fm summary show debugging

00:02:48: tcp0: O CLOSED 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 ECE CWR SYN WIN 4128

00:02:50: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:02:50: cwnd from 1460 to 1460, ssthresh from 65535 to 2920

00:02:50: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 ECE CWR SYN WIN 4128

00:02:54: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:02:54: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:02:54: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 ECE CWR SYN WIN 4128

00:03:02: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:03:02: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:03:02: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 ECE CWR SYN WIN 4128

00:03:18: 10.1.25.31:11001 <---> 10.1.25.234:23 SYN with ECN disabled

00:03:18: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:03:18: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:03:18: tcp0: O SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 SYN WIN 4128

00:03:20: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:03:20: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:03:20: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 SYN WIN 4128

00:03:24: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:03:24: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:03:24: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 SYN WIN 4128

00:03:32: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes

00:03:32: cwnd from 1460 to 1460, ssthresh from 2920 to 2920

00:03:32: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018

OPTS 4 SYN WIN 4128

!Connection timed out; remote host not responding

The following is sample output from the show debugging command when user-group debugging is configured:

Router# show debugging

usergroup:

Usergroup Deletions debugging is on

Usergroup Additions debugging is on

Usergroup Database debugging is on

Usergroup API debugging is on

The following is sample output from the show debugging command when SNAP debugging is configured:

Router# show debugging

Persistent variable debugging is currently All

SNAP Server Debugging ON

SNAP Client Debugging ON

Router#

The table below describes the significant fields in the output.

Table 60 show debugging Field Descriptions

Field

OPTS 4

Description

Bytes of TCP expressed as a number. In this case, the bytes are 4.

850

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field

ECE

CWR

SYN

WIN 4128 cwnd ssthresh usergroup show debugging

Description

Echo congestion experience.

Congestion window reduced.

Synchronize connections--Request to synchronize sequence numbers, used when a TCP connection is being opened.

Advertised window size, in bytes. In this case, the bytes are 4128.

Congestion window (cwnd)--Indicates that the window size has changed.

Slow-start threshold (ssthresh)--Variable used by

TCP to determine whether or not to use slow-start or congestion avoidance.

Statically defined usergroup to which source IP addresses are associated.

Cisco IOS Configuration Fundamentals Command Reference

851

show through show fm summary show declassify

show declassify

To display the state of the declassify function (enabled, in progress, and so forth) and the sequence of declassification steps that will be performed, use the show declassify command in global configuration mode.

show declassify

Syntax Description This command has no arguments or keywords.

Note The show declassify command is supported on the Cisco 3200 series routers only.

Command Modes Global configuration

Command History

Examples

Release

12.3(8)YD

12.4(2)T

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.4(2)T.

The following example is sample output for the show declassify command:

Router# show declassify

Declassify facility: Enabled=Yes In Progress=No

Erase flash=Yes Erase nvram=Yes

Obtain memory size

Shutdown Interfaces

Declassify Console and Aux Ports

Erase flash

Declassify NVRAM

Declassify Communications Processor Module

Declassify RAM, D-Cache, and I-Cache

The table below describes the significant fields shown in the display.

Table 61 show declassify Field Descriptions

Field

Enabled

Description

A “Yes” value indicates that zeroization is enabled.

A “No” value indicates that zeroization is disabled.

852

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show declassify

Field

In Progress

Erase flash

Erase nvram

Obtain memory size

Shutdown Interfaces

Declassify Console and AUX Ports

Erase flash

Declassify NVRAM

Declassify Communications Processor Module

Declassify RAM, D-Cache, and I-Cache

Description

A “Yes” value indicates that zeroization is currently in progress.

A “No” value indicates that zeroization is currently not in progress.

A “Yes” value indicates that erasure of Flash memory is enabled.

A “No” value indicates that the erasure of Flash memory is disabled.

A “Yes” value indicates that the erasure of

NVRAM is enabled.

A “No” value indicates that the erasure of NVRAM is disabled.

Obtain the main memory size in order to understand how much of the memory is to be scrubbed.

Shut down any and all network interfaces.

Remove potentially sensitive information from console and AUX port FIFOs.

Erase Flash memory.

Erase NVRAM.

Erase the memory in the Communications

Processor Module (CPM).

Scrub the main memory, erase the Data Cache (D-

Cache), and erase the Instruction Cache (I-Cache).

Related Commands

Command

service declassify

Description

Invokes declassification.

Cisco IOS Configuration Fundamentals Command Reference

853

show through show fm summary show derived-config

show derived-config

To display the composite results of all the configuration commands that apply to an interface, including commands that come from sources such as static templates, dynamic templates, dialer interfaces, and authentication, authorization, and accounting (AAA) per-user attributes, use the show derived-config command in privileged EXEC mode.

show derived-config [interface type number]

Syntax Description

interface type number (Optional) Displays the derived configuration for a specific interface. If you use the interface keyword, you must specify the interface type and the interface number (for example, interface ethernet

0).

Command Modes Privileged EXEC

Command History

Release

12.1

12.2(33)SRA

15.1(2)S

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was modified. The output was extended to include information about service instances and xconnects that are downloaded and provisioned.

Usage Guidelines Configuration commands can be applied to an interface from sources such as static templates, dynamic templates bound by resource pooling, dialer interfaces, AAA per-user attributes and the configuration of the physical interface. The show derived-config command displays all the commands that apply to an interface.

The output for the show derived-configcommand is nearly identical to that of the show running-config command. It differs when the configuration for an interface is derived from a template, a dialer interface, or some per-user configuration. In those cases, the commands derived from the template, dialer interface, and so on, will be displayed for the affected interface.

If the same command is configured differently in two different sources that apply to the same interface, the command coming from the source that has the highest precedence will appear in the display.

854

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Examples show derived-config

The following examples show sample output for the show running-config and show derived-config commands for serial interface 0:23 and dialer interface 0. The output of the show running-config and

show derived-config commands is the same for dialer interface 0 because none of the commands that apply to that interface are derived from any sources other than the configuration of the dialer interface. The output for the show running-config and show derived-config commands for serial interface 0:23 differs because some of the commands that apply to serial interface 0:23 come from dialer interface 0.

Router# show running-config interface Serial0:23

Building configuration...

Current configuration :296 bytes

interface Serial0:23

description PRI to ADTRAN (#4444150)

ip unnumbered Loopback0

encapsulation ppp

dialer rotary-group 0

isdn switch-type primary-dms100

isdn incoming-voice modem

isdn calling-number 4444150

peer default ip address pool old_pool end

Router# show running-config interface Dialer0

Building configuration...

Current configuration :257 bytes

interface Dialer0

description Dialin Users

ip unnumbered Loopback0

no ip proxy-arp

encapsulation ppp

dialer in-band

dialer idle-timeout 30

dialer-group 1

peer default ip address pool new_pool

ppp authentication pap chap callin end

Router# show derived-config interface Serial0:23

Building configuration...

Derived configuration :332 bytes

interface Serial0:23

description PRI to ADTRAN (#4444150)

ip unnumbered Loopback0

encapsulation ppp

dialer rotary-group 0

isdn switch-type primary-dms100

isdn incoming-voice modem

isdn calling-number 4444150

peer default ip address pool new_pool

ppp authentication pap chap callin end

Router# show derived-config interface Dialer0

Building configuration...

Derived configuration :257 bytes

interface Dialer0

description Dialin Users

ip unnumbered Loopback0

no ip proxy-arp

encapsulation ppp

dialer in-band

dialer idle-timeout 30

dialer-group 1

peer default ip address pool new_pool

ppp authentication pap chap callin end

Cisco IOS Configuration Fundamentals Command Reference

855

show through show fm summary show derived-config

The following sample output from the show running-config and show derived-config commands show service instance and xconnect configurations.

Router# show running-config interface ethernet 0/0

Building configuration...

Current configuration : 201 bytes

interface Ethernet0/0

no ip address

service-policy type control mypolicy

service instance dynamic 1 ethernet

encapsulation dot1q 2-99

ethernet subscriber

initiator unclassified vlan

end

Router# show derived-config interface ethernet 0/0

Building configuration...

Derived configuration : 306 bytes

interface Ethernet0/0

no ip address

service-policy type control mypolicy

service instance dynamic 1 ethernet

encapsulation dot1q 2-99

ethernet subscriber

initiator unclassified vlan

service instance 2 ethernet

encapsulation dot1q 22

xconnect 33.33.33.34 12346 encapsulation mpls

end

Related Commands

Command

show running-config

Description

Displays the contents of the currently running configuration file or the configuration for a specific interface.

856

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show diagnostic cns

show diagnostic cns

To display the information about the CNS subject, use the show diagnostic cns command in user EXEC or privileged EXEC mode.

show diagnostic cns {publish | subscribe}

Syntax Description publish subscribe

Displays the subject with which the diagnostic results is published.

Displays the subscribed subjects.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine

The CNS subsystem communicates with remote network applications through the CNS-event agent and follows the publish and subscribe model. An application sets itself up to receive events by subscribing to the approprate event subject name.

Examples This example shows how to display the subject with which the diagnostic results is published:

Router# show diagnostic cns publish

Subject: cisco.cns.device.diag_results

This example shows how to display the subscribed subject:

Router# show diagnostic cns subscribe

Cisco IOS Configuration Fundamentals Command Reference

857

show through show fm summary show diagnostic cns

Subject: cisco.cns.device.diag_get_results

Related Commands

Command

diagnostic cns

Description

Configures the CNS diagnostics.

858

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show diagnostic sanity

show diagnostic sanity

To display sanity check results, use the show diagnostic sanity command in privileged EXEC mode.

show diagnostic sanity

Syntax Description This command has no arguments or keywords.

Command Default Displays information for all the Gigabit Ethernet WAN interfaces in the Cisco 7600 series router.

Command Modes Privileged EXEC

Command History

Release

12.2(18)SXE

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The sanity check runs a set of predetermined checks on the configuration with a possible combination of certain system states to compile a list of warning conditions. The checks are designed to look for anything that seems out of place and are intended to serve as an aid to maintaining the system sanity.

The following is a list of the checks that are run and the action taken when the condition is found:

• Checks whether the default gateways are reachable. If so, the system stops pinging.

• If a port auto-negotiates to half duplex, the system flags it.

Trunking Checks

• If a trunk port has the mode set to “on,” the system flags it.

• If a port is trunking and mode is auto, the system flags it.

• If a trunk port is not trunking and the mode is desirable, the system flags it.

• If a trunk port negotiates to half duplex, the system flags it.

Channeling Checks

• If a port has channeling mode set to on, the system flags it.

• If a port is not channeling and the mode is set to desirable, the system flags it.

• If a VLAN has a Spanning-Tree root of 32K (root is not set), the system flags it.

Spanning-Tree VLAN Checks

Cisco IOS Configuration Fundamentals Command Reference

859

show through show fm summary show diagnostic sanity

• If a VLAN has a max age on the Spanning-Tree root that is different than the default, the system flags it.

• If a VLAN has a fwd delay on the Spanning-Tree root that is different than the default, the system flags it.

• If a VLAN has a fwd delay on the bridge that is different than the default, the system flags it.

• If a VLAN has a hello time on the bridge that is different than the default, the system flags it.

Spanning-Tree Port Checks

• If a port has a port cost that is different than the default, the system flags it.

• If a port has a port priority that is different than the default, the system flags it.

UDLD Checks

• If a port has UDLD disabled, the system flags it.

• If a port had UDLD shut down, the system flags it.

• If a port had a UDLD undetermined state, the system flags it.

Assorted Port Checks

• If a port had receive flow control disabled, the system flags it.

• If a trunk port had PortFast enabled, the system flags it.

• If a inline power port has any of the following states:

◦ denied

◦ faulty

◦ other

◦ off

The system flags it.

• If a port has a native VLAN mismatch, the system flags it.

• If a port has a duplex mismatch, the system flags it.

Bootstring and Config Register Checks

• The config register on the primary supervisor engine (and on the secondary supervisor engine if present) must be one of the following values: 0x2 , 0x102, or 0x2102.

• The system verifies the bootstring on the primary supervisor engine (and on the secondary supervisor engine if present). The system displays a message if the bootstring is empty.

• The system verifies that every file is specified in the bootstring. The system displays a message if the file is absent or shows up with a wrong checksum.

If only device : is specified as a filename, then the system verifies that the first file is on the device.

Assorted Checks

• The system displays a message if IGMP snooping is disabled.

• The system displays a message if any of the values of the snmp community access strings

{RO,RW,RW-ALL} is the same as the default.

• The system displays a message if any of the modules are in states other than “Ok.”

• The system displays a message that lists all the tests that failed (displayed as an “F”) in the show test

all command.

• The system displays a message if *fast is not configured on the switch anywhere.

• The system displays a message if there is enough room for the crashinfo file on the bootflash:.

860

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Examples show diagnostic sanity

• The system displays a message if multicast routing is enabled globally but is not applied to all interfaces.

• The system displays a message if IGMP snooping is disabled and RGMP is enabled.

This example displays samples of the messages that could be displayed with the show diagnostic sanity command:

Router# show diagnostic sanity

Pinging default gateway 10.6.141.1 ....

Type escape sequence to abort.

Sending 5, 100-byte ICMP Echos to 10.6.141.1, timeout is 2 seconds:

..!!.

Success rate is 0 percent (0/5)

IGMP snooping disabled please enable it for optimum config.

IGMP snooping disabled but RGMP enabled on the following interfaces, please enable IGMP for proper config :

Vlan1, Vlan2, GigabitEthernet1/1

Multicast routing is enabled globally but not enabled on the following interfaces:

GigabitEthernet1/1, GigabitEthernet1/2

A programming algorithm mismatch was found on the device bootflash:

Formatting the device is recommended.

The bootflash: does not have enough free space to accomodate the crashinfo file.

Please check your confreg value : 0x0.

Please check your confreg value on standby: 0x0.

The boot string is empty. Please enter a valid boot string .

Could not verify boot image "disk0:" specified in the boot string on the slave.

Invalid boot image "bootflash:asdasd" specified in the boot string on the slave.

Please check your boot string on the slave.

UDLD has been disabled globally - port-level UDLD sanity checks are being bypassed.

[

The following ports have UDLD disabled. Please enable UDLD for optimum config:

Fa9/45

The following ports have an unknown UDLD link state. Please enable UDLD on both sides of the link:

Fa9/45

]

The following ports have portfast enabled:

Fa9/35, Fa9/45

The following ports have trunk mode set to on:

Fa4/1, Fa4/13

The following trunks have mode set to auto:

Fa4/2, Fa4/3

The following ports with mode set to desirable are not trunking:

Fa4/3, Fa4/4

The following trunk ports have negotiated to half-duplex:

Fa4/3, Fa4/4

The following ports are configured for channel mode on:

Fa4/1, Fa4/2, Fa4/3, Fa4/4

The following ports, not channeling are configured for channel mode desirable:

Fa4/14

The following vlan(s) have a spanning tree root of 32768:

The following vlan(s) have max age on the spanning tree root different from the default:

1-2

The following vlan(s) have forward delay on the spanning tree root different from the default:

1-2

The following vlan(s) have hello time on the spanning tree root different from the default:

1-2

Cisco IOS Configuration Fundamentals Command Reference

861

show through show fm summary show diagnostic sanity

The following vlan(s) have max age on the bridge different from the default:

1-2

The following vlan(s) have fwd delay on the bridge different from the default:

1-2

The following vlan(s) have hello time on the bridge different from the default:

1-2

The following vlan(s) have a different port priority than the default on the port FastEthernet4/1

1-2

The following ports have recieve flow control disabled:

Fa9/35, Fa9/45

The following inline power ports have power-deny/faulty status:

Gi7/1, Gi7/2

The following ports have negotiated to half-duplex:

Fa9/45

The following vlans have a duplex mismatch:

Fas 9/45

The following interafaces have a native vlan mismatch: interface (native vlan - neighbor vlan)

Fas 9/45 (1 - 64)

The value for Community-Access on read-only operations for SNMP is the same as default. Please verify that this is the best value from a security point of view.

The value for Community-Access on write-only operations for SNMP is the same as default. Please verify that this is the best value from a security point of view.

The value for Community-Access on read-write operations for SNMP is the same as default. Please verify that this is the best value from a security point of view.

Please check the status of the following modules:

8,9

Module 2 had a MINOR_ERROR.

The Module 2 failed the following tests:

TestIngressSpan

The following ports from Module2 failed test1:

1,2,4,48

862

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show disk

show disk

To display flash or file system information for a disk, use the show diskcommand in user or privileged

EXEC mode.

show {disk0 | disk1} [all | filesys]

Syntax Description disk0 disk1 all filesys

Selects disk 0 as the disk to display information about.

Selects disk 1 as the disk to display information about.

(Optional) Specifies that all flash information will be displayed for the selected disk.

(Optional) Specifies that file system information will be displayed for the selected disk.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2

12.3(7)T

12.2(25)S

12.2(33)SRA

Modification

This command was introduced in a release prior to

Cisco IOS Release 12.2.

This command was enhanced to display information about the ATA ROM monitor library

(monlib) file.

This command was integrated into the Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The show disk command is supported only on platforms that have a disk file system.

Note The name of the ATA monlib file may contain a platform name that does not match the platform that you are using. Different platforms may have a similar or the same name for their ATA monlib file.

Cisco IOS Configuration Fundamentals Command Reference

863

show through show fm summary show disk

Examples The following example displays information about disk 0. The output is self-explanatory.

Router# show disk0 all

-#- --length-- -----date/time------ path

1 19539160 Jan 27 2004 23:08:40 c7200-is-mz.123-5.7.PI3a

1011679232 bytes available (19546112 bytes used)

******** ATA Flash Card Geometry/Format Info ********

ATA CARD GEOMETRY

Manufacturer Name SMART ATA Flash Card

Model Number SMART ATA FLASH DISK

Serial Number 00000155000000704162

Firmware Revision V1.01

Number of Heads: 16

Number of Cylinders 1999

Sectors per Track 63

Sector Size 512

Total Sectors 2014992

ATA CARD FORMAT

Number of FAT Sectors 246

Sectors Per Cluster 32

Number of Clusters 62941

Number of Data Sectors 2014789

Base Root Sector 632

Base FAT Sector 140

Base Data Sector 664

ATA MONLIB INFO

Image Monlib size = 67256

Disk monlib size = 71680

Name = c7200-atafslib-m

Monlib Start sector = 2

Monlib End sector = 133

Monlib updated by = C7200-IS-M12.3(5.7)PI3a

Monlib version = 1

864

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show disk0:

show disk0:

To display flash or file system information for a disk located in slot 0, use the show disk0:command in user EXEC or privileged EXEC mode.

show disk0: [all | filesys]

Syntax Description all filesys

(Optional) The all keyword displays complete information about flash memory, including information about the individual devices in flash memory and the names and sizes of all system image files stored in flash memory, including those that are invalid.

(Optional) Displays the device information block, the status information, and the usage information.

Command Modes User EXEC Privileged EXEC

Command History

Release

11.3AA

12.2

12.3(7)T

12.2(25)S

12.2(33)SRA

Modification

This command was introduced.

This command was incorporated into Cisco IOS

Release 12.2.

This command was enhanced to display information about the ATA ROM monitor library

(monlib) file.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The show disk0: command is supported only on platforms that have a disk file system located in slot 0.

Use the show disk0: command to display details about the files in a particular ATA PCMCIA flash disk memory card.

For more information regarding file systems and flash cards, access the PCMCIA Filesystem Compatibility

Matrix and Filesystem Information document at the following URL:

Cisco IOS Configuration Fundamentals Command Reference

865

show through show fm summary show disk0: http://www.cisco.com/en/US/partner/products/hw/routers/ps341/ products_tech_note09186a00800a7515.shtml

Note The name of the ATA monlib file may contain a platform name that does not match the platform that you are using. Different platforms may have a similar name or the same name for their ATA monlib file.

Examples The following examples show displays of information about the flash disks or file system information for a disk. The output is self-explanatory.

c7200# show disk0:

-#- --length-- -----date/time------ path

1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T

2 32768 Feb 24 2006 13:30:30 +00:00 file1.log

34738176 bytes available (29540352 bytes used) c7200# show disk0: all

-#- --length-- -----date/time------ path

1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T

2 32768 Feb 24 2006 13:30:30 +00:00 file1.log

34738176 bytes available (29540352 bytes used)

******** ATA Flash Card Geometry/Format Info ********

ATA CARD GEOMETRY

Number of Heads: 4

Number of Cylinders 984

Sectors per Cylinder 32

Sector Size 512

Total Sectors 125952

ATA CARD FORMAT

Number of FAT Sectors 62

Sectors Per Cluster 8

Number of Clusters 15693

Number of Data Sectors 125812

Base Root Sector 232

Base FAT Sector 108

Base Data Sector 264

ATA MONLIB INFO

Image Monlib size = 73048

Disk monlib size = 55296

Name = NA

Monlib end sector = NA

Monlib Start sector = NA

Monlib updated by = NA

Monlib version = NA c7200# show disk0: filesys

******** ATA Flash Card Geometry/Format Info ********

ATA CARD GEOMETRY

Number of Heads: 4

Number of Cylinders 984

Sectors per Cylinder 32

Sector Size 512

Total Sectors 125952

ATA CARD FORMAT

Number of FAT Sectors 62

Sectors Per Cluster 8

Number of Clusters 15693

Number of Data Sectors 125812

Base Root Sector 232

Base FAT Sector 108

Base Data Sector 264

ATA MONLIB INFO

Image Monlib size = 73048

Disk monlib size = 55296

Name = NA

Monlib end sector = NA

866

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show disk0:

Monlib Start sector = NA

Monlib updated by = NA

Monlib version = NA

This example shows how to update and display the time settings on a device using the show disk0 command.

7206-1#

7206-1#sh disk0:

-#- --length-- -----date/time------ path

1 47495056 Aug 8 2009 02:04:06 -08:00 c7200-adventerprisek9-mz.124-24.6.PI11

2 29211500 Sep 11 2009 23:09:24 -08:00 c7200-p-mz.CSCsz11391-eagle_cnh

3 0 Aug 24 2009 02:03:40 -08:00 dtdlog

4 16089368 Sep 8 2009 08:53:58 -08:00 c7200-p-mz.CSCsz11391-v122_18_sxf_thro ttle-test

419250176 bytes available (92807168 bytes used)

7206-1#conf t

Enter configuration commands, one per line. End with CNTL/Z.

7206-1(config)#clock timezone UTC 0 0

7206-1(config)#end

7206-1#

*Sep 12 07:13:56.447: %SYS-6-CLOCKUPDATE: System clock has been updated from 23:13:56 PST

Fri S ep 11 2009 to 07:13:56 UTC Sat Sep 12 2009, configured from console by console.

7206-1#

*Sep 12 07:13:57.239: %SYS-5-CONFIG_I: Configured from console by console

7206-1#

7206-1#sh disk0

-#- --length-- -----date/time------ path

1 47495056 Aug 8 2009 10:04:06 +00:00 c7200-adventerprisek9-mz.124-24.6.PI11j

2 29211500 Sep 12 2009 07:09:24 +00:00 c7200-p-mz.CSCsz11391-eagle_cnh

3 0 Aug 24 2009 10:03:40 +00:00 dtdlog

4 16089368 Sep 8 2009 16:53:58 +00:00 c7200-p-mz.CSCsz11391-v122_18_sxf_throttle-test

419250176 bytes available (92807168 bytes used)

Related Commands

Command

dir disk0:

dir disk1: show disk1:

Description

Displays a directory listing of files on an ATA

PCMCIA flash disk card located in slot 0.

Displays a directory listing of files on an ATA

PCMCIA flash disk card located in slot 1.

Displays flash or file system information for a disk located in slot 1.

Cisco IOS Configuration Fundamentals Command Reference

867

show through show fm summary show disk1:

show disk1:

To display flash or file system information for a disk located in slot 1, use the show disk1:command in user EXEC or privileged EXEC mode.

show disk1: [all | filesys]

Syntax Description all filesys

(Optional) Displays the device information block, the status information, and the usage information.

Command Modes User EXEC Privileged EXEC

Command History

Release

11.3AA

12.2

12.3(7)T

12.2(25)S

12.2(33)SRA

Modification

This command was introduced.

This command was incorporated into Cisco IOS

Release 12.2.

This command was enhanced to display information about the ATA ROM monitor library

(monlib) file.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The show disk1: command is supported only on platforms that have a disk file system. Use the show

disk01: command to display details about the files in a particular ATA PCMCIA flash disk memory card located in slot 1.

For more information regarding file systems and flash cards, access the PCMCIA Filesystem Compatibility

Matrix and Filesystem Information document at the following URL:

868

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show disk1: http://www.cisco.com/en/US/partner/products/hw/routers/ps341/ products_tech_note09186a00800a7515.shtml

Examples The following examples show displays of information about the flash disks or file system information for a disk. The output is self-explanatory.

c7200# show disk1:

-#- --length-- -----date/time------ path

1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T

2 32768 Feb 24 2006 13:30:30 +00:00 file1.log

34738176 bytes available (29540352 bytes used) c7200# show disk1: all

-#- --length-- -----date/time------ path

1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T

2 32768 Feb 24 2006 13:30:30 +00:00 file1.log

34738176 bytes available (29540352 bytes used)

******** ATA Flash Card Geometry/Format Info ********

ATA CARD GEOMETRY

Number of Heads: 4

Number of Cylinders 984

Sectors per Cylinder 32

Sector Size 512

Total Sectors 125952

ATA CARD FORMAT

Number of FAT Sectors 62

Sectors Per Cluster 8

Number of Clusters 15693

Number of Data Sectors 125812

Base Root Sector 232

Base FAT Sector 108

Base Data Sector 264

ATA MONLIB INFO

Image Monlib size = 73048

Disk monlib size = 55296

Name = NA

Monlib end sector = NA

Monlib Start sector = NA

Monlib updated by = NA

Monlib version = NA c7200# show disk1: filesys

******** ATA Flash Card Geometry/Format Info ********

ATA CARD GEOMETRY

Number of Heads: 4

Number of Cylinders 984

Sectors per Cylinder 32

Sector Size 512

Total Sectors 125952

ATA CARD FORMAT

Number of FAT Sectors 62

Sectors Per Cluster 8

Number of Clusters 15693

Number of Data Sectors 125812

Base Root Sector 232

Base FAT Sector 108

Base Data Sector 264

ATA MONLIB INFO

Image Monlib size = 73048

Disk monlib size = 55296

Name = NA

Monlib end sector = NA

Cisco IOS Configuration Fundamentals Command Reference

869

show through show fm summary show disk1:

Monlib Start sector = NA

Monlib updated by = NA

Monlib version = NA

Related Commands

Command

dir disk0:

dir disk1:

show disk0:

Description

Displays a directory listing of files on an ATA

PCMCIA flash disk card located in slot 0.

Displays a directory listing of files on an ATA

PCMCIA flash disk card located in slot 1.

Displays flash or file system information for a disk located in slot 0.

870

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

show environment

To display temperature, voltage, fan, and power supply information, use the show environmentcommand in user EXEC or privileged EXEC mode.

power-supply | table | temperature | voltages]

Cisco 7000 Series, Cisco 7200 Series, Cisco 7304, and Cisco 7500 Series

show environment commandshow environment [all | last | table]

Cisco ASR 1000 Series

show environment {all | counters | history sensor | location sensor | sensor sensor | table sensor}

Cisco uBR10012 Routers

show environment [all | last | subslot slot/subslot | table]

Syntax Description alarms all fans hardware last leds power-supply table

(Optional) Displays the alarm contact information.

(Optional) Displays a detailed listing of all environmental monitor parameters (for example, the power supplies, temperature readings, voltage readings, and blower speeds). This is the default.

(Optional) Displays blower and fan information.

(Optional) Displays hardware-specific information.

(Optional) Displays information on the last measurement made.

(Optional) Displays the status of the MBus LEDs on the clock and scheduler cards and switch fabric cards.

(Optional) Displays power supply voltage and current information. If applicable, displays the status of the redundant power supply.

(Optional) Displays the temperature, voltage, and blower ranges and thresholds.

On the Cisco 7200 series, including the NPE-G2 in the Cisco 7200 VXR, the Cisco 7304 routers, and the Cisco 7500 series routers, the table keyword displays only the temperature and voltage thresholds.

Cisco IOS Configuration Fundamentals Command Reference

871

show through show fm summary show environment temperature voltages counters history location sensor sensor subslot slot subslot

Command Default If no options are specified, the default is all.

Command Modes User EXEC (>)

Privileged EXEC (#)

Command History

Release

10.0

11.2 GS

11.3(6)AA

12.2(20)S

12.2(20)S2

(Optional) Displays temperature information.

(Optional) Displays voltage information.

Displays operational counters.

Displays sensor state change history.

Displays sensors by location.

Displays sensor summary.

Sensor name.

(Optional) Displays environmental monitor parameters for a subslot.

Slot number. Valid values range from 1 to 8.

Subslot number. Valid values are 0 and 1.

Modification

This command was introduced.

The alarms, fans, hardware, leds, power-supply,

table, temperature, and voltageskeywords were added for the Cisco 12000 series GSRs.

This command was expanded to monitor the RPS and board temperature for the Cisco AS5300 platform, Cisco 3600 series routers, Cisco 7200 series routers, and the Cisco 12000 series GSRs.

This command was integrated into Cisco IOS

Release 12.2(20)S.

This command was integrated into Cisco IOS

Release 12.2(20)S2 to support MSCs and SPAs on the Cisco 7304 router using the all, last, and table keywords.

872

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Release

12.4(4)XD

12.2(31)SB2

Cisco IOS XE Release 2.1

12.2(33)SCD2 show environment

Modification

This command was integrated into Cisco IOS

Release 12.4(4)XD to support the NPE-G2 on the

Cisco 7200 VXR using the all, last, and table keywords. Command output was modified for the

NPE-G2.

This command was integrated into Cisco IOS

Release 12.2(31)SB2.

This command was integrated into Cisco IOS XE

Release 2.1 on the Cisco ASR 1000 Series Routers.

This command was integrated into Cisco IOS

Release 12.2(33)SCD2. The sublsot keyword option and slot/sublot parameters were introduced.

Usage Guidelines The availability of keywords depends on your system and platform. The command does not support SPAs on the Cisco 7200 series and on the NPE-G2 in the Cisco 7200 VXR routers.

A routine runs once a minute that reads environmental measurements from sensors and stores the output into a buffer. For shared port adapters (SPAs), the temperature and voltage sensors are read every few seconds to get environmental data. The environmental buffer is displayed on the console when you use the

show environment command.

If a measurement exceeds desired margins, but has not exceeded fatal margins, a warning message is printed to the system console. The system software queries the sensors for measurements once a minute, but warnings for a given test point are printed at most once every hour for sensor readings in the warning range and once every 5 minutes for sensor readings in the critical range. If a measurement is out of line within these time segments, an automatic warning message appears on the console. As noted, you can query the environmental status with the show environment command at any time to determine whether a measurement is at the warning or critical tolerance.

A SPA is shut down when any of the SPA environment readings exceed the shutdown threshold.

If a shutdown occurs because of detection of fatal environmental margins, the last measured value from each sensor is stored in internal nonvolatile memory.

For environmental specifications, refer to the hardware installation and configuration publication for your individual chassis.

For network processor engines (NPEs), network services engines (NSEs), line cards, and modular services cards (MSCs), environmental information is recorded in the CISCO-ENVMON-MIB. SPAs are not supported by the CISCO-ENVMON-MIB. In Cisco IOS Release 12.2(20)S2 and later, the CISCO-

ENTITY-SENSOR-MIB supports environmental information for SPAs, as well as NPEs, NSEs, line cards, and MSCs.

If the Cisco 12000 series GSR exceeds environmental conditions, a message similar to the following is displayed on the console:

%GSR_ENV-2-WARNING: Slot 3 Hot Sensor Temperature exceeds 40 deg C;

Check cooling systems

Cisco IOS Configuration Fundamentals Command Reference

873

show through show fm summary show environment

Note Blower temperatures that exceed environmental conditions do not generate a warning message.

You can also enable Simple Network Management Protocol (SNMP) notifications (traps or informs) to alert a network management system (NMS) when environmental thresholds are reached using the snmp-

server enable traps envmon and snmp-server host global configuration commands.

Whenever Cisco IOS software detects a failure or recovery event from the DRPS unit, it sends an SNMP trap to the configured SNMP server. Unlike console messages, only one SNMP trap is sent when the failure event is first detected. Another trap is sent when the recovery is detected.

Cisco AS5300 DRPS software reuses the MIB attributes and traps defined in CISCO-ENVMON-MIB and

CISCO-ACCESS-ENVMON-MIB. CISCO-ENVMON-MIB is supported by all Cisco routers with RPS units, and CISCO-ACCESS-ENVMON-MIB is supported by the Cisco 3600 series routers.

A power supply trap defined in CISCO-ENVMON-MIB is sent when a failure is detected and when a failure recovery occurs for the following events: input voltage fail, DC output voltage fail, thermal fail, and multiple failure events.

A fan failure trap defined in CISCO-ENVMON-MIB is sent when a fan failure or recovery event is detected by Cisco IOS software.

A temperature trap defined in CISCO-ACCESS-ENVMON-MIB is sent when a board over-temperature condition is detected by Cisco IOS software.

CISCO-ACCESS-ENVMON-MIB also defines an over-voltage trap. A similar trap is defined in CISCO-

ENVMON-MIB, but it requires the ciscoEnvMonVoltageStatusValue in varbinds. This value indicates the current value of the voltage in the RPS. With Cisco AS5300 RPS units, the current voltage value is not sent to the motherboard.

CISCO-ENVMON-MIB is extended to add a new enumerated value, internalRedundant(5), for MIB attribute ciscoEnvMonSupplySource. This is used to identify a RPS unit.

The temperature history of the Cisco uBR-MC20X20V line card, used in Cisco uBR10012 universal broadband router, can be viewed using the show environment subslot command. The show environment subslot command displays the thermal and power status of the Cisco uBR-MC20X20V line card. The slot/ subslot option of the show environment subslot command helps to identify the location of the line card.

Examples

Cisco ASR 1000 Series Routers

In the following example, the show environment all command displays system temperature, voltage, fan, and power supply conditions. (It does not display environmental information for SPAs.) The State column in show environment all output should show “Normal” except for fans where it indicates fan speed. A fan speed of 65% is normal.

Router# show environment all

Sensor List: Environmental Monitoring

Sensor Location State Reading

V1: VMA F0 Normal 1801 mV

V1: VMB F0 Normal 1206 mV

V1: VMC F0 Normal 1206 mV

V1: VMD F0 Normal 1103 mV

V1: VME F0 Normal 1005 mV

V1: 12v F0 Normal 11967 mV

V1: VDD F0 Normal 3295 mV

V1: GP1 F0 Normal 905 mV

874

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

V2: VMA F0 Normal 3295 mV

V2: VMB F0 Normal 2495 mV

V2: VMC F0 Normal 1499 mV

V2: VMD F0 Normal 1098 mV

V2: VME F0 Normal 1000 mV

V2: VMF F0 Normal 1000 mV

V2: 12v F0 Normal 11923 mV

V2: VDD F0 Normal 3295 mV

V2: GP1 F0 Normal 751 mV

Temp: Inlet F0 Normal 27 Celsius

Temp: Asic1 F0 Normal 44 Celsius

Temp: Exhaust1 F0 Normal 36 Celsius

Temp: Exhaust2 F0 Normal 34 Celsius

Temp: Asic2 F0 Normal 40 Celsius

V1: VMA 0 Normal 1103 mV

V1: VMB 0 Normal 1201 mV

V1: VMC 0 Normal 1503 mV

V1: VMD 0 Normal 1801 mV

V1: VME 0 Normal 2495 mV

V1: VMF 0 Normal 3295 mV

V1: 12v 0 Normal 11967 mV

V1: VDD 0 Normal 3295 mV

V1: GP1 0 Normal 751 mV

V1: GP2 0 Normal 903 mV

V2: VMB 0 Normal 1201 mV

V2: 12v 0 Normal 11967 mV

V2: VDD 0 Normal 3291 mV

V2: GP2 0 Normal 903 mV

Temp: Left 0 Normal 28 Celsius

Temp: Center 0 Normal 29 Celsius

Temp: Asic1 0 Normal 42 Celsius

Temp: Right 0 Normal 27 Celsius

V1: VMA 1 Normal 1103 mV

V1: VMB 1 Normal 1201 mV

V1: VMC 1 Normal 1503 mV

V1: VMD 1 Normal 1801 mV

V1: VME 1 Normal 2495 mV

V1: VMF 1 Normal 3295 mV

V1: 12v 1 Normal 11953 mV

V1: VDD 1 Normal 3291 mV

V1: GP1 1 Normal 754 mV

V1: GP2 1 Normal 903 mV

V2: VMB 1 Normal 1206 mV

V2: 12v 1 Normal 11967 mV

V2: VDD 1 Normal 3291 mV

V2: GP2 1 Normal 905 mV

Temp: Left 1 Normal 28 Celsius

Temp: Center 1 Normal 30 Celsius

Temp: Asic1 1 Normal 44 Celsius

Temp: Right 1 Normal 28 Celsius

PEM Iout P0 Normal 37 A

PEM Vout P0 Normal 12 V AC

PEM Vin P0 Normal 116 V AC

Temp: PEM P0 Normal 28 Celsius

Temp: FC P0 Fan Speed 65% 25 Celsius

Temp: FM P1 Normal 1 Celsius

Temp: FC P1 Fan Speed 65% 25 Celsius

V1: VMA R0 Normal 1118 mV

V1: VMB R0 Normal 3315 mV

V1: VMC R0 Normal 2519 mV

V1: VMD R0 Normal 1811 mV

V1: VME R0 Normal 1513 mV

V1: VMF R0 Normal 1220 mV

V1: 12v R0 Normal 12011 mV

V1: VDD R0 Normal 3300 mV

V1: GP1 R0 Normal 913 mV

V1: GP2 R0 Normal 1247 mV

Temp: CPU R0 Normal 29 Celsius

Temp: Outlet R0 Normal 30 Celsius

Temp: Inlet R0 Normal 25 Celsius

Temp: Asic1 R0 Normal 30 Celsius

The following table describes the significant fields shown in the display.

show environment

Cisco IOS Configuration Fundamentals Command Reference

875

show through show fm summary show environment

Table 62

Field

Sensor

Location

State show environment all Field Descriptions

Description

Sensor name.

Chassis slot.

State description. One of the following values:

• Critical--Critical alarm indicating a serviceaffecting condition.

• Fan Speed--Fan speed (65% is normal).

• Major--Major alarm indicating immediate action is needed.

• Minor--Minor alarm indicating warning conditions.

• Normal--Sensor reading is in acceptable range.

• Shutdown--If automatic shutdown is enabled, indicates that the router will shut down.

Voltage or temperature detected by the sensor.

Reading

Cisco 7000 Series Routers, Cisco 7200 Series Routers

In the following example, the typical show environment display is shown when no warning conditions are in the system for the Cisco 7000 series and Cisco 7200 series routers. This information may vary slightly depending on the platform you are using. The date and time of the query are displayed, along with the data refresh information and a message indicating that there are no warning conditions.

Router> show environment

Environmental Statistics

Environmental status as of 13:17:39 UTC Thu Jun 6 1996

Data is 7 second(s) old, refresh in 53 second(s)

All Environmental Measurements are within specifications

The following table describes the significant fields shown in the display.

Table 63 show environment Field Descriptions

Field

Environmental status as of...

Data is..., refresh in...

Status message

Description

Current date and time.

Environmental measurements are output into a buffer every 60 seconds, unless other higherpriority processes are running.

If environmental measurements are not within specification, warning messages are displayed.

876

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

NPE-G2 in Cisco 7200 VXR Routers

In the following example, additional temperature and voltage readings for the NPE-G2 in the Cisco 7200

VXR router are displayed by the show environment all command. Power supplies 1 and 2 are on, and all monitored variables are within the normal operating range.

Router_npe-g2# show environment all

Power Supplies:

Power Supply 1 is Zytek AC Power Supply. Unit is on.

Power Supply 2 is Zytek AC Power Supply. Unit is on.

Temperature readings:

NPE Inlet measured at 25C/77F

NPE Outlet measured at 28C/82F

CPU Die measured at 56C/132F =======> additional temperature reading on NPE-G2

Voltage readings:

+3.30 V measured at +3.32 V =======> additional voltage reading on NPE-G2

+1.50 V measured at +1.48 V =======> additional voltage reading on NPE-G2

+2.50 V measured at +2.46 V =======> additional voltage reading on NPE-G2

+1.80 V measured at +1.75 V =======> additional voltage reading on NPE-G2

+1.20 V measured at +1.17 V =======> additional voltage reading on NPE-G2

VDD_CPU measured at +1.28 V =======> additional voltage reading on NPE-G2

VDD_MEM measured at +2.50 V =======> additional voltage reading on NPE-G2

VTT measured at +1.25 V =======> additional voltage reading on NPE-G2

+3.45 V measured at +3.39 V

-11.95 measured at -11.93 V

+5.15 V measured at +4.96 V

+12.15 V measured at +12.18 V

Envm stats saved 0 time(s) since reload

Table 64 show environment all Field Descriptions for NPE-G2 in Cisco 7200 VXR Router

Field

Power Supply x is present.

Unit is ...

Temperature readings

NPE Inlet measured at 25C/77F

NPE Outlet measured at 28C/82F

Description

Specifies whether the indicated (x) power supply slot is populated. If a power supply slot is populated, the manufacturer name and whether it is an AC or DC power supply is displayed.

Indicates whether the power supply status is on or off.

Indicates the temperature of air coming in and going out of the NPE Inlet, NPE Outlet, and CPU

Die areas.

Indicates that the temperature measurements at the inlet area of the chassis is 25C/77F, which is within normal operating range. System shutdown for NPE

Inlet is 80C/176F.

Indicates that the temperature measurements at the outlet area of the chassis is 28C/82F, which is within normal operating range. System shutdown for NPE Outlet is 84C/183F.

Cisco IOS Configuration Fundamentals Command Reference

877

show through show fm summary show environment

Field

CPU Die measured at 56C/132F

Voltage readings:

+3.30 V measured at +3.32 V

+1.50 V measured at +1.48 V

VDD_CPU measured at +1.28 V

VDD_MEM measured at +2.50 V

VTT measured at +1.25 V

Description

Indicates that the temperature measurement at the

CPU Die (internal silicon of the CPU) area of the chassis is 56C/132F, which is within normal operating range. System shutdown for CPU Die is

100C/212F.

System voltage measurements that indicate the actual measured value for the specified power rail, which is named after the expected target value.

For example, the +3.30 V rail, with an expected value of +3.30 V, actually measures at +3.32 V.

This is within the target range.

For example, the +1.50 V rail, with an expected value of +1.50 V, actually measures at +1.48 V.

This is within the target range.

Indicates +1.28 V is the measured voltage of the

VDD_CPU power rail, which is within normal operating range. The expected value is 1.3 V.

Indicates +2.50 V is the measured voltage of the

VDD_MEM power rail, which is within normal operating range. The expected value is 2.5 V.

Indicates +1.25 V is the measured voltage of the

VTT power rail, which is within normal operating range. The expected value is 1.25 V.

In the following example, the show environment last command displays the previously saved measurements (readings) from the last environmental reading before the router was shut down. The command also displays the reason why the router was shut down, which was “power supply shutdown” in this case.

Router_npe-g2# show environment last

NPE Inlet previously measured at 26C/78F

NPE Outlet previously measured at 28C/82F

CPU Die previously measured at 56C/132F

+3.30 V previously measured at +3.32

+1.50 V previously measured at +1.48

+2.50 V previously measured at +2.46

+1.80 V previously measured at +1.75

+1.20 V previously measured at +1.17

VDD_CPU previously measured at +1.28

VDD_MEM previously measured at +2.50

VTT previously measured at +1.25

+3.45 V previously measured at +3.39

-11.95 previously measured at -11.93

+5.15 V previously measured at +4.96

+12.15 V previously measured at +12.18

last shutdown reason - power supply shutdown

878

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

Table 65 show environment last Field Descriptions for NPE-G2 in Cisco 7200 VXR Router

Field

NPE Inlet previously measured at 26C/78F

NPE Outlet previously measured at 28C/82F

CPU Die previously measured at 56C/132F

+3.30 V previously measured at +3.32

VDD_CPU previously measured at +1.28

VDD_MEM previously measured at +2.50

VTT previously measured at +1.25

last shutdown reason

Description

The last measured temperature of the inlet air of the router prior to shutdown.

The last measured temperature of the outlet air of the router prior to shutdown.

The last measured temperature of the CPU Die prior to shutdown.

The last measured voltage of the 3.30 V power rail prior to shutdown.

The last measured voltage of the VDD_CPU power rail prior to shutdown.

The last measured voltage of the VDD_MEM power rail prior to shutdown.

The last measured voltage of the VTT power rail prior to shutdown.

Indicates the reason for the shutdown.

In the following example, the show environment table command displays threshold levels in a table format of the environmental monitor parameters. It displays the high warning, high critical, and high shutdown temperature thresholds of the NPE inlet, NPE outlet, and CPU Die. It also displays the low and high critical voltage thresholds, and low and high shut down voltage thresholds for the power rails on the NPE-G2 in the

Cisco 7200 VXR.

Note The low range temperatures, such as the LowShut, LowCrit, and LowWarn temperature thresholds, are not checked and are not displayed on the NPE-G2. Also the warning voltage thresholds, such as LowWarn and

HighWarn, are not checked and are not displayed on the NPE-G2.

Router_npe-g2# show environment table

Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut

NPE Inlet 44C/111F 59C/138F

NPE Outlet 49C/120F 64C/147F

CPU Die 75C/167F 85C/185F

System shutdown for NPE Inlet is 80C/176F

System shutdown for NPE Outlet is 84C/183F

System shutdown for CPU Die is 100C/212F

+3.30 V +2.30 +3.12 +3.47 +4.29

+1.50 V +1.05 +1.40 +1.56 +1.95

+2.50 V +1.71 +2.34 +2.61 +3.28

+1.80 V +1.25 +1.67 +1.91 +2.34

+1.20 V +0.82 +1.13 +1.28 +1.56

VDD_CPU +0.89 +1.21 +1.36 +1.71

VDD_MEM +1.71 +2.34 +2.61 +3.28

VTT +0.85 +1.17 +1.32 +1.64

+3.45 V +2.38 +3.28 +3.63 +4.49

-11.95 V -8.44 -11.56 -12.84 -15.78

+5.15 V +3.59 +4.88 +5.42 +6.71

+12.15 V +8.55 +11.48 +12.77 +15.82

Cisco IOS Configuration Fundamentals Command Reference

879

show through show fm summary show environment

Table 66

Field

Sample Point

LowShut show environment table Field Descriptions for NPE-G2 in Cisco 7200 VXR Router

Description

This is the area for which temperature or system voltage thresholds are displayed.

This is the LowShut voltage threshold. If the voltage value is below the LowShut threshold, the router shuts down.

Note The LowShut temperature value is not checked and its threshold is not displayed on the NPE-G2.

LowCrit

LowWarn

HighWarn

HighCrit

This is the low critical voltage threshold. If the voltage value is below the LowCrit threshold, a critical message is issued for an out-of-tolerance voltage value. The system continues to operate.

However, the system is approaching shutdown.

Note The LowCrit temperature value is not checked and its threshold is not displayed on the NPE-G2.

The LowWarn temperature threshold and LowWarn voltage threshold are not checked and the threshold information is not displayed on the NPE-G2.

This is the HighWarn temperature threshold. If the temperature reaches the HighWarn threshold, a warning message is issued for an out-of-tolerance temperature value. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Note The HighWarn voltage threshold is not checked and its threshold is not displayed on the NPE-G2.

This is the HighCrit temperature or voltage threshold. If the temperature or voltage reaches the

HighCrit level, a critical message is issued. The system continues to operate. However, the system is approaching shutdown.

Note Beware that if the temperature reaches or exceeds the HighShut value, a Shutdown message is issued and the router shuts down.

HighShut This is the HighShut temperature or voltage threshold. If the temperature or voltage level reaches or exceeds the HighShut value, a Shutdown message is issued and the router shuts down.

880

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field

NPE Inlet 44C/111F 59C/138F

NPE Outlet 49C/120F 64C/147F show environment

Description

These are the HighWarn and HighCrit temperature thresholds, respectively, for the NPE Inlet.

If the NPE Inlet temperature value reaches the

HighWarn (44C/111F) and HighCrit (59C/138F) levels, warning and critical messages, respectively, are issued.

If the value reaches 44C/111F or greater, you receive a warning message indicating HighWarn.

The system continues to operate, but operator action is recommended to bring the system back to a normal state.

If the value reaches 59C/138F or greater, you receive a critical (HighCrit) message instead, that indicates the system continues to operate, but the system is approaching shutdown.

Note Beware if the temperature reaches or exceeds 80C/176F, which is the HighShut value, a Shutdown message is issued, and the NPE Inlet area shuts down.

These are the HighWarn and HighCrit temperature thresholds, respectively, for the NPE Outlet.

If the NPE Outlet temperature value reaches the

HighWarn (49C/120F) and HighCrit (64C/147F) levels, warning and critical messages, respectively, are issued.

If the value reaches 49C/120F or greater, you receive a warning message indicating HighWarn.

The system continues to operate, but operator action is recommended to bring the system back to a normal state.

If the value reaches 64C/147F or greater, you receive a critical (HighCrit) message instead that indicates the system continues to operate, but the system is approaching shutdown.

Note Beware if the temperature reaches or exceeds 84C/183F, which is the HighShut value, a Shutdown message is issued, and the NPE Outlet area shuts down.

Cisco IOS Configuration Fundamentals Command Reference

881

show through show fm summary show environment

Field

CPU Die 75C/167F 85C/185F

System shutdown for NPE Inlet is 80C/176F

System shutdown for NPE Outlet is 84C/183F

System shutdown for CPU Die is 100C/212F

Description

These are the HighWarn and HighCrit temperature thresholds, respectively, for the CPU Die.

If the CPU Die temperature value reaches the

HighWarn (75C/167F) and HighCrit (85C/185F) levels, warning and critical messages, respectively, are issued.

If the value reaches 75C/167F or greater, you receive a warning message indicating HighWarn.

The system continues to operate, but operator action is recommended to bring the system back to a normal state.

If the value reaches 85C/185F or greater, you receive a critical (HighCrit) message instead, that indicates the system continues to operate, but the system is approaching shutdown.

Note Beware if the temperature reaches or exceeds 100C/212F, which is the HighShut value, a Shutdown message is issued and the

CPU Die area shuts down.

This is the HighShut temperature threshold for the

NPE Inlet.

If the temperature reaches or exceeds 80C/176F, a

Shutdown message is issued and the NPE Inlet area is shut down.

This is the HighShut temperature threshold for the

NPE Outlet.

If the temperature reaches or exceeds 84C/183F, a

Shutdown message is issued and the NPE Outlet area is shut down.

This is the HighShut temperature threshold for the

CPU Die.

If the temperature reaches or exceeds 100C/212F, a

Shutdown message is issued and the CPU Die area is shut down.

882

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field

+3.30 V +2.30 +3.12 +3.47 +4.29

VDD_CPU +0.89 +1.21 +1.36 +1.71

VDD_MEM +1.71 +2.34 +2.61 +3.28

VTT +0.85 +1.17 +1.32 +1.64

show environment

Description

The voltage thresholds for the +3.30 V power rail are as follows:

• +2.30 is the LowShut voltage threshold.

• +3.12 is the LowCrit voltage threshold.

• +3.47 is the HighCrit voltage threshold.

• +4.29 is the HighShut voltage threshold.

Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2.

The voltage thresholds for the VDD_CPU power rail are as follows:

• +0.89 is the LowShut voltage threshold.

• +1.21 is the LowCrit voltage threshold.

• +1.36 is the HighCrit voltage threshold.

• +1.71 is the HighShut voltage threshold.

Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2.

The voltage thresholds for the VDD_MEM power rail are as follows:

• +1.71 is the LowShut voltage threshold.

• +2.34 is the LowCrit voltage threshold.

• +2.61 is the HighCrit voltage threshold.

• +3.28 is the HighShut voltage threshold.

Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2.

The voltage thresholds for the VTT power rail are as follows:

• +0.85 is the LowShut voltage threshold.

• +1.17 is the LowCrit voltage threshold.

• +1.32 is the HighCrit voltage threshold.

• +1.64 is the HighShut voltage threshold.

Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2.

Cisco IOS Configuration Fundamentals Command Reference

883

show through show fm summary show environment

Cisco 7000 Series Routers

The following are examples of messages that display on the system console when a measurement has exceeded an acceptable margin:

ENVIRONMENTAL WARNING: Air flow appears marginal.

ENVIRONMENTAL WARNING: Internal temperature measured 41.3(C)

ENVIRONMENTAL WARNING: +5 volt testpoint measured 5.310(V)

The system displays the following message if voltage or temperature exceed maximum margins:

SHUTDOWN: air flow problem

In the following example, there have been two intermittent power failures since a router was turned on, and the lower power supply is not functioning. The last intermittent power failure occurred on Monday, June

10, 1996, at 11:07 p.m.

7000# show environment all

Environmental Statistics

Environmental status as of 23:19:47 UTC Wed Jun 12 1996

Data is 6 second(s) old, refresh in 54 second(s)

WARNING: Lower Power Supply is NON-OPERATIONAL

Lower Power Supply:700W, OFF Upper Power Supply: 700W, ON

Intermittent Powerfail(s): 2 Last on 23:07:05 UTC Mon Jun 10 1996

+12 volts measured at 12.05(V)

+5 volts measured at 4.96(V)

-12 volts measured at -12.05(V)

+24 volts measured at 23.80(V)

Airflow temperature measured at 38(C)

Inlet temperature measured at 25(C)

The following table describes the significant fields shown in the display.

Table 67 show environment all Field Descriptions for the Cisco 7000 Series Routers

Field

Environmental status as of...

Data is..., refresh in...

WARNING:

Lower Power Supply

Upper Power Supply

Intermittent Powerfail(s)

Voltage specifications

Airflow and inlet temperature

Description

Date and time of last query.

Environmental measurements are output into a buffer every 60 seconds, unless other higherpriority processes are running.

If environmental measurements are not within specification, warning messages are displayed.

Type of power supply installed and its status (on or off).

Number of power hits (not resulting in shutdown) since the system was last booted.

System voltage measurements.

Temperature of air coming in and going out.

884

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

The following example is for the Cisco 7000 series routers. The router retrieves the environmental statistics at the time of the last shutdown. In this example, the last shutdown was Friday, May 19, 1995, at 12:40 p.m., so the environmental statistics at that time are displayed.

Router# show environment last

Environmental Statistics

Environmental status as of 14:47:00 UTC Sun May 21 1995

Data is 6 second(s) old, refresh in 54 second(s)

WARNING: Upper Power Supply is NON-OPERATIONAL

LAST Environmental Statistics

Environmental status as of 12:40:00 UTC Fri May 19 1995

Lower Power Supply: 700W, ON Upper Power Supply: 700W, OFF

No Intermittent Powerfails

+12 volts measured at 12.05(V)

+5 volts measured at 4.98(V)

-12 volts measured at -12.00(V)

+24 volts measured at 23.80(V)

Airflow temperature measured at 30(C)

Inlet temperature measured at 23(C)

The following table describes the significant fields shown in the display.

Table 68 show environment last Field Descriptions for the Cisco 7000 Series Routers

Field

Environmental status as of...

Data is..., refresh in...

WARNING:

LAST Environmental Statistics

Lower Power Supply

Upper Power Supply

Description

Date and time of last query.

Environmental measurements are output into a buffer every 60 seconds, unless other higherpriority processes are running.

If environmental measurements are not within specification, warning messages are displayed.

Displays test point values at time of the last environmental shutdown.

For the Cisco 7000 router, indicates the status of the two 700W power supplies.

For the Cisco 7010 router, indicates the status of the single 600W power supply.

The following example shows sample output for the current environmental status in tables that list voltage and temperature parameters. There are three warning messages: one each about the lower power supply, the airflow temperature, and the inlet temperature. In this example, voltage parameters are shown to be in the normal range, airflow temperature is at a critical level, and inlet temperature is at the warning level.

Router> show environment table

Environmental Statistics

Environmental status as of Mon 11-2-1992 17:43:36

Data is 52 second(s) old, refresh in 8 second(s)

WARNING: Lower Power Supply is NON-OPERATIONAL

WARNING: Airflow temperature has reached CRITICAL level at 73(C)

WARNING: Inlet temperature has reached WARNING level at 41(C)

Voltage Parameters:

SENSE CRITICAL NORMAL CRITICAL

-------|--------------------|------------------------|--------------------

+12(V) 10.20 12.05(V) 13.80

+5(V) 4.74 4.98(V) 5.26

-12(V) -10.20 -12.05(V) -13.80

Cisco IOS Configuration Fundamentals Command Reference

885

show through show fm summary show environment

+24(V) 20.00 24.00(V) 28.00

Temperature Parameters:

SENSE WARNING NORMAL WARNING CRITICAL SHUTDOWN

-------|-------------|------------|-------------|--------------|-----------

Airflow 10 60 70 73(C) 88

Inlet 10 39 41(C) 46 64

The following table describes the significant fields shown in the display.

Table 69 show environment table Field Descriptions for the Cisco 7000 Series Routers

Field

SENSE (Voltage Parameters)

SENSE (Temperature Parameters)

WARNING

NORMAL

CRITICAL

SHUTDOWN

Description

Voltage specification for a DC line.

Air being measured. Inlet measures the air coming in, and Airflow measures the temperature of the air inside the chassis.

System is approaching an out-of-tolerance condition.

All monitored conditions meet normal requirements.

Out-of-tolerance condition exists.

Processor has detected condition that could cause physical damage to the system.

Cisco 7200 Series Routers

The system displays the following message if the voltage or temperature enters the “Warning” range:

%ENVM-4-ENVWARN: Chassis outlet 3 measured at 55C/131F

The system displays the following message if the voltage or temperature enters the “Critical” range:

%ENVM-2-ENVCRIT: +3.45 V measured at +3.65 V

The system displays the following message if the voltage or temperature exceeds the maximum margins:

%ENVM-0-SHUTDOWN: Environmental Monitor initiated shutdown

The following message is sent to the console if a power supply has been inserted or removed from the system. This message relates only to systems that have two power supplies.

%ENVM-6-PSCHANGE: Power Supply 1 changed from Zytek AC Power Supply to removed

The following message is sent to the console if a power supply has been powered on or off. In the case of the power supply being shut off, this message can be due to the user shutting off the power supply or to a failed power supply. This message relates only to systems that have two power supplies.

%ENVM-6-PSLEV: Power Supply 1 state changed from normal to shutdown

The following is sample output from the show environment all command on the Cisco 7200 series routers when there is a voltage warning condition in the system:

7200# show environment all

Power Supplies:

886

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

Power supply 1 is unknown. Unit is off.

Power supply 2 is Zytek AC Power Supply. Unit is on.

Temperature readings:

chassis inlet measured at 25C/77F

chassis outlet 1 measured at 29C/84F

chassis outlet 2 measured at 36C/96F

chassis outlet 3 measured at 44C/111F

Voltage readings:

+3.45 V measured at +3.83 V:Voltage in Warning range!

+5.15 V measured at +5.09 V

+12.15 measured at +12.42 V

-11.95 measured at -12.10 V

The following table describes the significant fields shown in the display.

Table 70 show environment all Field Descriptions for the Cisco 7200 Series Router

Field

Power Supplies

Temperature readings

Voltage readings

Description

Current condition of the power supplies including the type and whether the power supply is on or off.

Current measurements of the chassis temperature at the inlet and outlet locations.

Current measurement of the power supply test points.

The following example is for the Cisco 7200 series routers. This example shows the measurements immediately before the last shutdown and the reason for the last shutdown (if appropriate).

7200# show environment last

chassis inlet previously measured at 27C/80F

chassis outlet 1 previously measured at 31C/87F

chassis outlet 2 previously measured at 37C/98F

chassis outlet 3 previously measured at 45C/113F

+3.3 V previously measured at 4.02

+5.0 V previously measured at 4.92

+12.0 V previously measured at 12.65

-12.0 V previously measured at 11.71

last shutdown reason - power supply shutdown

The following table describes the significant fields shown in the display.

Table 71 show environment last Field Descriptions for the Cisco 7200 Series Router

Field chassis inlet chassis outlet voltages last shutdown reason

Description

Temperature measurements at the inlet area of the chassis.

Temperature measurements at the outlet areas of the chassis.

Power supply test point measurements.

Possible shutdown reasons are power supply shutdown, critical temperature, and critical voltage.

Cisco IOS Configuration Fundamentals Command Reference

887

show through show fm summary show environment

The following example is for the Cisco 7200 series routers. This information lists the temperature and voltage shutdown thresholds for each sensor.

7200# s how environment table

Sample Point LowCritical LowWarning HighWarning HighCritical chassis inlet 40C/104F 50C/122F chassis outlet 1 43C/109F 53C/127F chassis outlet 2 75C/167F 75C/167F chassis outlet 3 55C/131F 65C/149F

+3.45 V +2.76 +3.10 +3.80 +4.14

+5.15 V +4.10 +4.61 +5.67 +6.17

+12.15 V +9.72 +10.91 +13.37 +14.60

-11.95 V -8.37 -9.57 -14.34 -15.53

Shutdown system at 70C/158F

The following table describes the significant fields shown in the display.

Table 72 show environment table Field Descriptions for the Cisco 7200 Series Router

Field

Sample Point

LowCritical

LowWarning

HighWarning

HighCritical

Shutdown system at

Description

Area for which measurements are taken.

Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown.

Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Level at which a warning message is issued. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Level at which a critical message is issued. For the chassis, the router is shut down. For the power supply, the power supply is shut down.

The system is shut down if the specified temperature is met.

Cisco 7500 Series Routers

The sample output for the Cisco 7500 series routers may vary depending on the specific model (for example, the Cisco 7513 router). The following is sample output from the show environment all command on the Cisco 7500 series routers:

7500# show environment all

Arbiter type 1, backplane type 7513 (id 2)

Power supply #1 is 1200W AC (id 1), power supply #2 is removed (id 7)

Active fault conditions: none

Fan transfer point: 100%

Active trip points: Restart_Inhibit

888

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

15 of 15 soft shutdowns remaining before hard shutdown

0123456789012

Dbus slots: X XX X card inlet hotpoint exhaust

RSP(6) 35C/95F 47C/116F 40C/104F

RSP(7) 35C/95F 43C/109F 39C/102F

Shutdown temperature source is ‘hotpoint’ on RSP(6), requested RSP(6)

+12V measured at 12.31

+5V measured at 5.21

-12V measured at -12.07

+24V measured at 22.08

+2.5 reference is 2.49

PS1 +5V Current measured at 59.61 A (capacity 200 A)

PS1 +12V Current measured at 5.08 A (capacity 35 A)

PS1 -12V Current measured at 0.42 A (capacity 3 A)

PS1 output is 378 W

The following table describes the significant fields shown in the display.

Table 73 show environment all Field Descriptions for the Cisco 7500 Series Routers

Field

Arbiter type 1

Power supply

Active fault conditions:

Fan transfer point:

Active trip points:

15 of 15 soft shutdowns remaining

Description

Numbers indicating the arbiter type and backplane type.

Number and type of power supply installed in the chassis.

Lists any fault conditions that exist (such as power supply failure, fan failure, and temperature too high).

Software-controlled fan speed. If the router is operating below its automatic restart temperature, the transfer point is reduced by 10 percent of the full range each minute. If the router is at or above its automatic restart temperature, the transfer point is increased in the same way.

Compares temperature sensor against the values displayed at the bottom of the show environment

table command output.

When the temperature increases above the “board shutdown” level, a soft shutdown occurs (that is, the cards are shut down, and the power supplies, fans, and CI continue to operate). When the system cools to the restart level, the system restarts. The system counts the number of times this occurs and keeps the up/down cycle from continuing forever.

When the counter reaches zero, the system performs a hard shutdown, which requires a power cycle to recover. The soft shutdown counter is reset to its maximum value after the system has been up for 6 hours.

Cisco IOS Configuration Fundamentals Command Reference

889

show through show fm summary show environment

Field

Dbus slots: card, inlet, hotpoint, exhaust

Shutdown temperature source

Voltages (+12V, +5V, -12V, +24V, +2.5)

PS1

Description

Indicates which chassis slots are occupied.

Temperature measurements at the inlet, hotpoint, and exhaust areas of the card. The (6) and (7) indicate the slot numbers. Dual Route Switch

Processor (RSP) chassis can show two RSPs.

Indicates which of the three temperature sources is selected for comparison against the “shutdown” levels listed with the show environment table command.

Voltages measured on the backplane.

Current measured on the power supply.

The following example is for the Cisco 7500 series routers. This example shows the measurements immediately before the last shutdown.

7500# show environment last

RSP(4) Inlet previously measured at 37C/98F

RSP(4) Hotpoint previously measured at 46C/114F

RSP(4) Exhaust previously measured at 52C/125F

+12 Voltage previously measured at 12.26

+5 Voltage previously measured at 5.17

-12 Voltage previously measured at -12.03

+24 Voltage previously measured at 23.78

The following table describes the significant fields shown in the display.

Table 74 show environment last Field Descriptions for the Cisco 7500 Series Routers

Field

RSP(4) Inlet, Hotpoint, Exhaust

Voltages

Description

Temperature measurements at the inlet, hotpoint, and exhaust areas of the card.

Voltages measured on the backplane.

The following example is for the Cisco 7500 series router. This information lists the temperature and voltage thresholds for each sensor. These thresholds indicate when error messages occur. There are two level of messages: warning and critical.

7500# show environment table

Sample Point LowCritical LowWarning HighWarning HighCritical

RSP(4) Inlet 44C/111F 50C/122F

RSP(4) Hotpoint 54C/129F 60C/140F

RSP(4) Exhaust

+12 Voltage 10.90 11.61 12.82 13.38

+5 Voltage 4.61 4.94 5.46 5.70

-12 Voltage -10.15 -10.76 -13.25 -13.86

+24 Voltage 20.38 21.51 26.42 27.65

2.5 Reference 2.43 2.51

Shutdown boards at 70C/158F

Shutdown power supplies at 76C/168F

Restart after shutdown below 40C/104F

The following table describes the significant fields shown in the display.

890

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

Table 75

Field

Sample Point

LowCritical

LowWarning

HighWarning

HighCritical show environment table Field Descriptions for the Cisco 7500 Series Routers

Shutdown boards at

Shutdown power supplies at

Restart after shutdown

Description

Area for which measurements are taken.

Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown.

Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Level at which a warning message is issued. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Level at which a critical message is issued. For the chassis, the router is shut down. For the power supply, the power supply is shut down.

The card is shut down if the specified temperature is met.

The system is shut down if the specified temperature is met.

The system will restart when the specified temperature is met.

Cisco AS5300 Series Access Servers

In the following example, keywords and options are limited according to the physical characteristics of the system is shown: as5300# show environment ?

all All environmental monitor parameters

last Last environmental monitor parameters

table Temperature and voltage ranges

| Output modifiers

<cr> as5300# show environment table

%This option not available on this platform

Cisco 12000 Series GSRs

The following examples are for the Cisco 12000 series GSRs.

The following is sample output from the show environment command for a Cisco 12012 router. Slots 0 through 11 are the line cards, slots 16 and 17 are the clock and scheduler cards, slots 18 through 20 are the switch fabric cards, slots 24 through 26 are the power supplies, and slots 28 and 29 are the blowers. An

“NA” in the table means that no values were returned. In some cases it is because the equipment is not

Cisco IOS Configuration Fundamentals Command Reference

891

show through show fm summary show environment supported for that environmental parameter (for example, the power supply and blowers in slots 24, 26, 28, and 29 do not have a 3V power supply, so an NA is displayed).

Router# show environment

Slot # 3V 5V MBUS 5V Hot Sensor Inlet Sensor

(mv) (mv) (mv) (deg C) (deg C)

0 3300 4992 5040 42.0 37.0

2 3296 4976 5136 40.0 33.0

4 3280 4992 5120 38.5 31.5

7 3280 4984 5136 42.0 32.0

9 3292 4968 5160 39.5 31.5

11 3288 4992 5152 40.0 30.5

16 3308 NA 5056 42.5 38.0

17 3292 NA 5056 40.5 36.5

18 3304 NA 5176 36.5 35.0

19 3300 NA 5184 37.5 33.5

20 3304 NA 5168 36.5 34.0

24 NA 5536 5120 NA 31.5

26 NA 5544 5128 NA 31.5

28 NA NA 5128 NA NA

29 NA NA 5104 NA NA

Slot # 48V AMP_48

(Volt) (Amp)

24 46 12

26 46 19

Slot # Fan 0 Fan 1 Fan 2

(RPM) (RPM) (RPM)

28 2160 2190 2160

29 2130 2190 2070

The following table describes the significant fields shown and lists the equipment supported by each environmental parameter. “NA” indicates that the reading could not be obtained, so the command should be run again.

Table 76 show environment Field Descriptions for the Cisco 12000 Series Routers

Field

Slot #

3V (mv)

5V (mv)

MBUS 5V (mv)

Hot Sensor (deg C)

Description

Slot number of the equipment. On the Cisco 12012 router, slots 0 through 11 are the line cards, slots 16 and 17 are the clock and scheduler cards, slots 18 through 20 are the switch fabric cards, slots 24 through 27 are the power supplies, and slots 28 and

29 are the blowers.

Measures the 3V power supply on the card. The 3V power supply is on the line cards, GRP card, clock and scheduler cards, and switch fabric cards.

Measures the 5V power supply on the card. The 5V power supply is on the line cards, GRP card, and power supplies.

Measures the 5V MBus on the card. The 5V MBus is on all equipment.

Measures the temperature at the hot sensor on the card. The hot sensor is on the line cards, GRP card, clock and scheduler cards, switch fabric cards, and blowers.

892

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

Field

Inlet Sensor (deg C)

48V (Volt)

AMP_48 (Amp)

Fan 0, Fan 1, Fan 2 (RPM)

Description

Measures the current inlet temperature on the card.

The inlet sensor is on the line cards, GRP card, clock and scheduler cards, switch fabric cards, and power supplies.

Measures the DC power supplies.

Measures the AC power supplies.

Measures the fan speed in rotations per minute.

The following is sample output from the show environment all command for the Cisco 12008 router. Slots

0 through 7 are the line cards, slots 16 and 17 are the clock scheduler cards (the clock scheduler cards control the fans), slots 18 through 20 are the switch fabric cards, and slots 24 and 26 are the power supplies.

The Cisco 12008 router does not support slots 25, 27, 28, and 29. An “NA” in the table means that no values were returned. In some cases it is because the equipment is not supported for that environmental parameter (for example, the power supplies in slots 24 and 26 do not have a hot sensor, so an NA is displayed).

Router# show environment all

Slot # Hot Sensor Inlet Sensor

(deg C) (deg C)

2 31.0 22.0

5 33.5 26.5

16 25.5 21.5

18 22.0 21.0

19 22.5 21.0

24 NA 29.5

26 NA 24.5

Slot # 3V 5V MBUS 5V

(mv) (mv) (mv)

2 3292 5008 5136

5 3292 5000 5128

16 3272 NA 5128

18 3300 NA 5128

19 3316 NA 5128

Slot # 5V MBUS 5V 48V AMP_48

(mv) (mv) (Volt) (Amp)

24 0 5096 3 0

26 5544 5144 47 3

Slot # Fan Information

16 Voltage 16V Speed slow: Main Fans Ok Power Supply fans Ok

Alarm Indicators

No alarms

Slot # Card Specific Leds

16 Mbus OK SFCs Failed

18 Mbus OK

19 Mbus OK

24 Input Failed

26 Input Ok

The following is sample output from the show environment table command for a Cisco 12012 router. The

show environment table command lists the warning, critical, and shutdown limits on your system and includes the GRP card and line cards (slots 0 to 15), clock and scheduler cards (slots 16 and 17), switch fabric cards (slots 18 to 20), and blowers.

Router# show environment table

Hot Sensor Temperature Limits (deg C):

Warning Critical Shutdown

GRP/GLC (Slots 0-15) 40 46 57

CSC (Slots 16-17) 46 51 65

SFC (Slots 18-20) 41 46 60

Cisco IOS Configuration Fundamentals Command Reference

893

show through show fm summary show environment

Inlet Sensor Temperature Limits (deg C):

Warning Critical Shutdown

GRP/GLC (Slots 0-15) 35 40 52

CSC (Slots 16-17) 40 45 59

SFC (Slots 18-20) 37 42 54

3V Ranges (mv):

Warning Critical Shutdown

Below Above Below Above Below Above

GRP/GLC (Slots 0-15) 3200 3400 3100 3500 3050 3550

CSC (Slots 16-17) 3200 3400 3100 3500 3050 3550

SFC (Slots 18-20) 3200 3400 3100 3500 3050 3550

5V Ranges (mv):

Warning Critical Shutdown

Below Above Below Above Below Above

GRP/GLC (Slots 0-15) 4850 5150 4750 5250 4680 5320

MBUS_5V Ranges (mv):

Warning Critical Shutdown

Below Above Below Above Below Above

GRP/GLC (Slots 0-15) 5000 5250 4900 5350 4750 5450

CSC (Slots 16-17) 4820 5150 4720 5250 4750 5450

SFC (Slots 17-20) 5000 5250 4900 5350 4750 5450

Blower Operational Range (RPM):

Top Blower:

Warning Critical

Below Below

Fan 0 1000 750

Fan 1 1000 750

Fan 2 1000 750

Bottom Blower:

Warning Critical

Below Below

Fan 0 1000 750

Fan 1 1000 750

Fan 2 1000 750

The following is sample output from the show environment leds command for a Cisco 12012 router. The

show environment leds command lists the status of the MBus LEDs on the clock, scheduler, and the switch fabric cards.

Router# show environment leds

16 leds Mbus OK

18 leds Mbus OK

19 leds Mbus OK

20 leds Mbus OK

Cisco 7304 Router

The following is sample output from the show environment allcommand on a Cisco 7304 router with modular services cards (MSCs) and shared port adapters (SPAs) installed:

Router# show environment all

Power Supplies:

Power supply 1 is AC power supply. Unit is on.

Power supply 2 is empty.

Fans:

Fan 1 is on.

Fan 2 is on.

Temperature readings:

Active RP (NPEG100, slot 0):

npeg100 outlet measured at 29C/84F

npeg100 inlet measured at 34C/93F

npeg100 hotspot measured at 35C/95F

Line card (7304-MSC-100, slot 4):

894

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

7304-MSC-100 measured at 32C/89F

Card in subslot 4/0:

SPA-4FE-7304 inlet measured at 31C/87F

SPA-4FE-7304 outlet measured at 32C/89F

Voltage readings:

Active RP (NPEG100, slot 0):

npe outlet 2.5 V measured at 2.496 V

npe outlet 3.3 V measured at 3.302 V

npe outlet 5.0 V measured at 4.992 V

npe outlet 12.0 V measured at 11.812 V

npe outlet 3.3c V measured at 3.199 V

npe inlet 1.5 V measured at 1.494 V

npe outlet 1.8 V measured at 1.790 V

npe outlet 1.2 V measured at 1.198 V

npe outlet 1.2c V measured at 1.198 V

Line card (7304-MSC-100, slot 4):

7304-MSC-100 0.75 V measured at 0.733 V

7304-MSC-100 1.5 V measured at 1.494 V

7304-MSC-100 2.5 V measured at 2.483 V

7304-MSC-100 3.3 V measured at 3.250 V

7304-MSC-100 12 V measured at 11.937 V

Card in subslot 4/0:

SPA-4FE-7304 1.8V measured at 1.802 V

SPA-4FE-7304 1.5V measured at 1.503 V

SPA-4FE-7304 2.5V measured at 2.474 V

SPA-4FE-7304 3.3V measured at 3.252 V

SPA-4FE-7304 1.0V measured at 1.015 V

Envm stats saved 13 time(s) since reload

The following is sample output from the show environment lastcommand on a Cisco 7304 router with

MSCs and SPAs installed and an NSE-100:

Router# show environment last

Temperature information:

NSE board:

nse outlet is unmeasured

nse inlet is unmeasured

nse hotspot is unmeasured

nse db is unmeasured

Line card slot 4:

7304-MSC-100 is unmeasured

Card in subslot 4/1:

SPA-4FE-7304 inlet previously measured at 30C/86F

SPA-4FE-7304 outlet previously measured at 32C/89F

Voltage information:

NSE board:

nse outlet 1.8 V is unmeasured

nse outlet 2.5 V is unmeasured

nse outlet 3.3 V is unmeasured

nse outlet 5 V is unmeasured

nse outlet 12 V is unmeasured

nse inlet 1.8 V is unmeasured

nse inlet 3.3 V is unmeasured

nse inlet 1.5 V is unmeasured

nse hotspot 1.8 V is unmeasured

nse db 1.65 V is unmeasured

nse db 1.8 V is unmeasured

Line card slot 4:

7304-MSC-100 0.75 V is unmeasured

7304-MSC-100 1.5 V is unmeasured

7304-MSC-100 2.5 V is unmeasured

7304-MSC-100 3.3 V is unmeasured

7304-MSC-100 12 V is unmeasured

Card in subslot 4/1:

SPA-4FE-7304 1.8V previously measured at 1.823 V

SPA-4FE-7304 1.5V previously measured at 1.512 V

SPA-4FE-7304 2.5V previously measured at 2.504 V

SPA-4FE-7304 3.3V previously measured at 3.258 V

SPA-4FE-7304 1.0V previously measured at 1.014 V

Last shutdown reason: shutdown undefined

Cisco IOS Configuration Fundamentals Command Reference

895

show through show fm summary show environment

The following is sample output from the show environment tablecommand on a Cisco 7304 router with

MSCs and SPAs installed:

Router# show environment table

Temperature tables:

Active RP (NPEG100, slot 0):

Sample Point HighWarning HighCritical HighShutdown

npeg100 outlet 53C/127F 68C/154F 73C/163F

npeg100 inlet 53C/127F 68C/154F 73C/163F

npeg100 hotspot 53C/127F 68C/154F 73C/163F

Line card (7304-MSC-100, slot 4):

Sample Point HighWarning HighCritical HighShutdown

7304-MSC-100 48C/118F 63C/145F 68C/154F

Card in subslot 4/0:

Sample Point HighWarning HighCritical HighShutdown

SPA-4FE-7304 inlet 52C/125F 67C/152F 72C/161F

SPA-4FE-7304 outlet 52C/125F 67C/152F 72C/161F

Voltage tables:

Active RP (NPEG100, slot 0):

Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut

npe outlet 2.5 V 2.275 V 2.375 V 2.400 V 2.600 V 2.625 V 2.725 V

npe outlet 3.3 V 3.003 V 3.135 V 3.185 V 3.415 V 3.465 V 3.597 V

npe outlet 5.0 V 4.500 V 4.750 V 4.800 V 5.200 V 5.250 V 5.500 V

npe outlet 12.0 V 9.960 V 10.440 V 10.800 V 13.200 V 13.560 V 14.040 V

npe outlet 3.3c V 3.003 V 3.135 V 3.185 V 3.415 V 3.465 V 3.597 V

npe inlet 1.5 V 1.350 V 1.425 V 1.455 V 1.545 V 1.575 V 1.650 V

npe outlet 1.8 V 1.620 V 1.710 V 1.728 V 1.872 V 1.890 V 1.980 V

npe outlet 1.2 V 1.128 V 1.164 V 1.167 V 1.233 V 1.236 V 1.272 V

npe outlet 1.2c V 1.128 V 1.164 V 1.167 V 1.233 V 1.236 V 1.272 V

Line card (7304-MSC-100, slot 4):

Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut

7304-MSC-100 0.75 0.559 V 0.600 V 0.600 V 0.900 V 0.900 V 0.941 V

7304-MSC-100 1.5 V 1.350 V 1.440 V 1.455 V 1.545 V 1.560 V 1.650 V

7304-MSC-100 2.5 V 2.250 V 2.375 V 2.400 V 2.600 V 2.625 V 2.750 V

7304-MSC-100 3.3 V 2.970 V 3.135 V 3.168 V 3.432 V 3.465 V 3.630 V

7304-MSC-100 12 V 9.960 V 10.440 V 10.800 V 13.200 V 13.560 V 14.040 V

Card in subslot 4/0:

Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut

SPA-4FE-7304 1.8V 1.620 V 1.710 V 1.728 V 1.872 V 1.890 V 1.980 V

SPA-4FE-7304 1.5V 1.350 V 1.425 V 1.440 V 1.560 V 1.575 V 1.650 V

SPA-4FE-7304 2.5V 2.250 V 2.375 V 2.400 V 2.600 V 2.625 V 2.750 V

SPA-4FE-7304 3.3V 2.970 V 3.135 V 3.168 V 3.432 V 3.465 V 3.630 V

SPA-4FE-7304 1.0V 0.900 V 0.950 V 0.960 V 1.040 V 1.050 V 1.100 V

The following table describes the significant fields shown in the display.

Table 77 show environment table Field Descriptions for the Cisco 7304 Router

Field

Sample Point

LowShut

LowCrit/LowCritical

Description

Area for which measurements are taken.

Lowest level for an out-of-tolerance condition at which the system shuts itself down. For out-oftolerance conditions with SPA environment variables, only the SPA is shut down.

Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown.

896

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment

Field

LowWarn/LowWarning

HighWarn/HighWarning

HighCrit/HighCritical

HighShut/HighShutdown

Description

Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state.

Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown.

Highest level for an out-of-tolerance condition at which the system shuts itself down. For out-oftolerance conditions with SPA environment variables, only the SPA is shut down.

Cisco uBR10012 Router

The following is sample output from the show environment subslot slot/subslotcommand on a Cisco uBR10012 router:

Router# show environment subslot 7/0

------------------------------------------------------------------------

TEMPERATURE/POWER INFORMATION

------------------------------------------------------------------------

Number of Temperature Sensors : 11

Sampling frequency : 2 minutes

------------------------------------------------------------------------

| | 0C | 0C | |

------------------------------------------------------------------------

Nickel 10G 1 48 82 87 92 Normal

Inlet #1 2 36 68 73 78 Normal

CPU 3 44 73 78 83 Normal

Remora 4 48 82 87 92 Normal

Coldplay 5 40 75 80 85 Normal

Waxbill 6 53 92 97 102 Normal

Fauna 7 46 82 87 92 Normal

Flora 8 47 80 85 90 Normal

Toucan FPGA A 9 45 94 97 100 Normal

Toucan FPGA B 10 36 94 97 100 Normal

Toucan FPGA C 11 47 94 97 100 Normal

------------------------------------------------------------------------

Power: 168.813 watts

------------------------------------------------------------------------

------------------------------------------------------------------------------------------

Time Stamp | Power | Sensor Temperature 0C

MM/DD/YYYY HH:MM:SS | watts | 1 2 3 4 5 6 7 8 9 10 11

------------------------------------------------------------------------------------------

09/30/2009 10:24:26 168.813 48 36 44 48 40 53 46 47 45 36 47

09/30/2009 10:22:26 168.813 48 36 44 48 40 53 46 47 45 36 47

09/30/2009 10:20:26 168.813 48 36 44 47 40 53 46 47 45 36 47

Cisco IOS Configuration Fundamentals Command Reference

897

show through show fm summary show environment

09/30/2009 10:18:26 168.813 48 36 44 47 40 53 46 47 45 36 47

09/30/2009 10:16:26 168.813 47 36 44 47 40 53 46 47 45 36 47

09/30/2009 10:14:26 168.813 47 36 44 47 40 53 46 47 45 36 47

09/30/2009 10:12:26 168.813 47 36 44 46 40 52 45 47 45 36 47

09/30/2009 10:10:26 168.813 47 35 44 45 39 51 45 47 45 36 47

09/30/2009 10:08:26 168.132 46 35 44 43 38 50 43 47 45 36 47

------------------------------------------------------------------------------------------

The following table describes the significant fields shown in the display.

Table 78 show environment subslot Field Descriptions for the Cisco uBR10012 Router

Field

Number of Temperature Sensors

Sampling frequency

Sensor

Current Temperature

Minor

Major Threshold

Critical

Time Stamp

Alarm Condition

Power Watts

Sensor

Temperature

Description

The number of temperature sensors for which measurements are taken.

Temperature sampling frequency.

Sensor name.

Temperature sensor identifier.

Current temperature level.

Minor temperature tolerance threshold level.

Major temperature tolerance threshold level.

Critical temperature tolerance threshold level.

Temperature level sampling time.

Alarm state.

Current power consumption of the router.

Temperature sensor identifier.

Temperature level for each sensor at various periods.

Related Commands

Command

snmp-server enable traps envmon

snmp-server host

Description

Controls (enables or disables) environmental monitoring SNMP notifications.

Specifies how SNMP notifications should be sent

(as traps or informs), the version of SNMP to use, the security level of the notifications (for

SNMPv3), and the recipient (host) of the notifications.

898

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment alarm

show environment alarm

To display the information about the environmental alarm, use the show environment alarm command in user EXEC or privileged EXEC mode.

show environment alarm [{status | threshold} [frutype]]

Syntax Description status threshold frutype

(Optional) Displays the operational FRU status.

(Optional) Displays the preprogrammed alarm thresholds.

(Optional) Alarm type; valid values are all,

backplane, clock number, earl slot, fan-tray,

module slot, rp slot, power-supply number,

supervisor slot, and vtt number. See the Note for a list of valid values for number and slot.

Command Default If you do not enter a frutype, all the information about the environmental alarm status is displayed.

Command Modes User EXEC

Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Valid values for the frutype are as follows:

• clock number --1 and 2.

• earl slot -- See the Note for valid values.

• module slot -- See the Note for valid values.

• rp slot -- See the Note for valid values.

Cisco IOS Configuration Fundamentals Command Reference

899

show through show fm summary show environment alarm

• power-supply number --1 and 2.

• supervisor slot -- See the Note for valid values.

• vtt number --1 to 3.

Note The slotargument designates the module and port number. Valid values for slot depend on the chassis and module that are used. For example, if you have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the slot number are from 1 to 13 and valid values for the port number are from 1 to 48.

Examples This example shows how to display all the information about the status of the environmental alarm:

Router> show environment alarm

threshold environmental alarm thresholds: power-supply 1 fan-fail: OK

threshold #1 for power-supply 1 fan-fail:

(sensor value != 0) is system minor alarm power-supply 1 power-output-fail: OK

threshold #1 for power-supply 1 power-output-fail:

(sensor value != 0) is system minor alarm fantray fan operation sensor: OK

threshold #1 for fantray fan operation sensor:

(sensor value != 0) is system minor alarm operating clock count: 2

threshold #1 for operating clock count:

(sensor value < 2) is system minor alarm

threshold #2 for operating clock count:

(sensor value < 1) is system major alarm operating VTT count: 3

threshold #1 for operating VTT count:

(sensor value < 3) is system minor alarm

threshold #2 for operating VTT count:

(sensor value < 2) is system major alarm

VTT 1 OK: OK

threshold #1 for VTT 1 OK:

(sensor value != 0) is system minor alarm

VTT 2 OK: OK

threshold #1 for VTT 2 OK:

(sensor value != 0) is system minor alarm

VTT 3 OK: OK

threshold #1 for VTT 3 OK:

(sensor value != 0) is system minor alarm clock 1 OK: OK

threshold #1 for clock 1 OK:

(sensor value != 0) is system minor alarm clock 2 OK: OK

threshold #1 for clock 2 OK:

(sensor value != 0) is system minor alarm module 1 power-output-fail: OK

threshold #1 for module 1 power-output-fail:

(sensor value != 0) is system major alarm module 1 outlet temperature: 21C

threshold #1 for module 1 outlet temperature:

(sensor value > 60) is system minor alarm

threshold #2 for module 1 outlet temperature:

(sensor value > 70) is system major alarm module 1 inlet temperature: 25C

threshold #1 for module 1 inlet temperature:

(sensor value > 60) is system minor alarm

threshold #2 for module 1 inlet temperature:

(sensor value > 70) is system major alarm module 1 device-1 temperature: 30C

900

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment alarm

threshold #1 for module 1 device-1 temperature:

(sensor value > 60) is system minor alarm

threshold #2 for module 1 device-1 temperature:

(sensor value > 70) is system major alarm module 1 device-2 temperature: 29C

threshold #1 for module 1 device-2 temperature:

(sensor value > 60) is system minor alarm

threshold #2 for module 1 device-2 temperature:

(sensor value > 70) is system major alarm module 5 power-output-fail: OK

threshold #1 for module 5 power-output-fail:

(sensor value != 0) is system major alarm module 5 outlet temperature: 26C

threshold #1 for module 5 outlet temperature:

(sensor value > 60) is system minor alarm

threshold #2 for module 5 outlet temperature:

(sensor value > 75) is system major alarm module 5 inlet temperature: 23C

threshold #1 for module 5 inlet temperature:

(sensor value > 50) is system minor alarm

threshold #2 for module 5 inlet temperature:

(sensor value > 65) is system major alarm

EARL 1 outlet temperature: N/O

threshold #1 for EARL 1 outlet temperature:

(sensor value > 60) is system minor alarm

threshold #2 for EARL 1 outlet temperature:

(sensor value > 75) is system major alarm

EARL 1 inlet temperature: N/O

threshold #1 for EARL 1 inlet temperature:

(sensor value > 50) is system minor alarm

threshold #2 for EARL 1 inlet temperature:

(sensor value > 65) is system major alarm

Router>

Related Commands

Command

show environment status

show environment temperature

Description

Displays the information about the operational FRU status.

Displays the current temperature readings.

Cisco IOS Configuration Fundamentals Command Reference

901

show through show fm summary show environment connector

show environment connector

To display the connector rating and power consumption of modules or the backplane, use the show

environment connector command in user EXEC or privileged EXEC mode.

show environment connector [all | backplane | module number]

Syntax Description all backplane

module number

(Optional) Displays the connector rating of the backplane and the connector rating and power consumption of all modules.

(Optional) Displays the connector rating of the backplane.

(Optional) Displays the connector rating and power consumption of the specified module.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.2(33)SXI 4

Modification

This command was introduced.

Usage Guidelines

The output of the show environment connector command displays the connector rating of the backplane

(chassis) power connector, the connector rating of module connectors, and the power consumption of each installed module.

If your system contains the necessary components for auxiliary power, the auxiliary power connector rating is displayed.

If an installed module contains a voice daughterboard (VDB), the VDB connector rating is displayed.

If you enter the show environment connector command with no keywords, the information for the backplane and all modules is displayed.

Examples This example shows how to display the connector rating and power consumption of the backplane and all modules:

Router> show environment connector all chassis connector rating: 1302.00 Watts (31.00 Amps @ 42V) chassis auxiliary connector rating: 2016.00 Watts (48.00 Amps @ 42V) module 3

module 3 connector rating: 1260.00 Watts (30.00 Amps @ 42V)

902

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment connector

module 3 vdb connector rating: 1050.00 Watts (25.00 Amps @ 42V)

module 3 power consumption: 140.70 Watts ( 3.35 Amps @ 42V) module 6

module 6 connector rating: 1260.00 Watts (30.00 Amps @ 42V)

module 6 power consumption: 282.24 Watts ( 6.72 Amps @ 42V) module 9

module 9 connector rating: 1260.00 Watts (30.00 Amps @ 42V)

module 9 auxiliary connector rating: 2016.00 Watts (48.00 Amps @ 42V)

module 9 vdb connector rating: 1060.00 Watts (25.24 Amps @ 42V)

module 9 vdb auxiliary rating: 530.00 Watts (12.62 Amps @ 42V)

module 9 power consumption: 112.56 Watts ( 2.68 Amps @ 42V)

This example shows how to display the connector rating of the backplane:

Router> show environment connector backplane chassis connector rating: 1302.00 Watts (31.00 Amps @ 42V) chassis auxiliary connector rating: 2016.00 Watts (48.00 Amps @ 42V)

Related Commands

Command

show environment status

Description

Displays the information about the operational field-replaceable unit (FRU) status.

Cisco IOS Configuration Fundamentals Command Reference

903

show through show fm summary show environment cooling

show environment cooling

To display the information about the cooling parameter, use the show environment cooling command in user EXEC or privileged EXEC mode.

show environment cooling

Syntax Description This command has no arguments or keywords.

Command Default

This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is not supported in Cisco 7600 series routers that are configured with a Supervisor Engine 2.

Examples This example shows how to display the information about the cooling parameter:

Router> show environment cooling fan-tray 1:

fan-tray 1 fan-fail: failed fan-tray 2:

fan 2 type: FAN-MOD-9

fan-tray 2 fan-fail: OK chassis cooling capacity: 690 cfm ambient temperature: 55C chassis per slot cooling capacity: 75 cfm

module 1 cooling requirement: 70 cfm

module 2 cooling requirement: 70 cfm

module 5 cooling requirement: 30 cfm

module 6 cooling requirement: 70 cfm

module 8 cooling requirement: 70 cfm

module 9 cooling requirement: 30 cfm

Router>

904

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

hw-module fan-tray version show environment cooling

Description

Sets the fan-type (high or low power) version.

Cisco IOS Configuration Fundamentals Command Reference

905

show through show fm summary show environment status

show environment status

To display the information about the operational FRU status, use the show environment status command in user EXEC or privileged EXEC mode.

show environment status [frutype]

Syntax Description frutype (Optional) FRU type; see the Note for a list of valid values.

Command Default

If you do not enter a frutype, all FRU status information is displayed.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(18)SXF

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

The output of the show environment status

power-supply command was changed to include information about the high-capacity power supplies.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Valid values for the frutype are as follows:

• all --No arguments.

• backplane --No arguments.

• clock number --1 and 2.

• earl slot -- See the Note for valid values.

• fan-tray --No arguments.

• module slot -- See the Note for valid values.

• power-supply number --1 and 2.

• rp slot -- See the Note for valid values.

• supervisor slot -- See the Note for valid values.

906

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment status

• vtt number --1 to 3.

Examples This example shows how to display the information about the environmental status:

Router> show environment status backplane:

operating clock count: 2

operating VTT count: 3 fan-tray:

fantray fan operation sensor: OK

VTT 1:

VTT 1 OK: OK

VTT 2:

VTT 2 OK: OK

VTT 3:

VTT 3 OK: OK clock 1:

clock 1 OK: OK, clock 1 clock-inuse: not-in-use clock 2:

clock 2 OK: OK, clock 2 clock-inuse: in-use power-supply 1:

power-supply 1 fan-fail: OK

power-supply 1 power-output-fail: OK module 1:

module 1 power-output-fail: OK

module 1 outlet temperature: 21C

module 1 inlet temperature: 25C

module 1 device-1 temperature: 30C

module 1 device-2 temperature: 29C

EARL 1 outlet temperature: N/O

EARL 1 inlet temperature: N/O module 5:

module 5 power-output-fail: OK

module 5 outlet temperature: 26C

module 5 inlet temperature: 23C

module 5 device-1 temperature: 26C

module 5 device-2 temperature: 27C

Router>

This example shows how to display the information about the high-capacity power supplies:

Route># show environment status

power-supply 2 power-supply 2:

power-supply 2 fan-fail: OK

power-supply 2 power-input 1: none

power-supply 2 power-input 2: AC low

power-supply 2 power-input 3: AC high

power-supply 2 power-input 4: AC high

power-supply 2 power-output: low (mode 1)

power-supply 2 power-output-fail: OK

The table below describes the fields that are shown in the example.

Cisco IOS Configuration Fundamentals Command Reference

907

show through show fm summary show environment status

Table 79

Field operating clock count operating VTT count fan tray fan operation sensor

VTT 1, VTT2, and VTT3 clock # clock-inuse power-supply # fan-fail power-input-fail s how environment status Command Output Fields power-output-fail outlet temperature inlet temperature device-1 and device-2 temperature

Description

Physical clock count.

Physical VTT count.

System fan tray failure status. The failure of the system fan tray is indicated as a minor alarm.

Status of the chassis backplane power monitors that are located on the rear of the chassis, under the rear cover. Operation of at least two VTTs is required for the system to function properly. A minor system alarm is signaled when one of the three VTTs fails.

A major alarm is signaled when two or more VTTs fail and the supervisor engine is accessible through the console port.

Clock status. Failure of either clock is considered to be a minor alarm.

Fan failure. Fan failures on either or both (if any) power supplies are considered minor alarms.

Power input failure status (none, AC high, AC low).

Power output failure status (high, low).

Exhaust temperature value.

Intake temperature value.

Two devices that measure the internal temperature on each indicated module. The temperature shown indicates the temperature that the device is recording. The devices are not placed at an inlet or an exit but are additional reference points.

Related Commands

Command

show environment alarm

show environment temperature

Description

Displays the information about the environmental alarm.

Displays the current temperature readings.

908

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment temperature

show environment temperature

To display the current temperature readings, use the show environment temperature command in user

EXEC or privileged EXEC mode.

show environment temperature [frutype]

Syntax Description frutype (Optional) Field replaceable unit (FRU) type; see the “Usage Guidelines” section for a list of valid values.

Command Default If you do not enter a frutype, the module and EARL temperature readings are displayed.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17a)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

The show environment temperature module command output was updated to include the following information:

• The name of the ASIC of this sensor.

• The names of the ASIC are listed if there is more than one ASIC.

• The type of sensor is listed if there is more than one sensor on the ASIC.

• Current temperature.

• Major/minor threshold as read in the

IDPROM.

• Status of whether the current temperature has exceeded any temperature thresholds.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

909

show through show fm summary show environment temperature

Usage Guidelines Valid values for the frutype are as follows:

• earl slot -- See the Note below for valid values.

• module slot -- See the Note below for valid values.

• rp slot -- See the the Note below for valid values.

• vtt number --1 to 3.

• clock number --1 and 2.

The show environment temperature module command output includes the updated information after an

SCP response is received.

In the output display, the following applies:

• N/O means not operational--The sensor is broken, returning impossible values.

• N/A means not available--The sensor value is presently not available; try again later.

• VTT 1, 2, and 3 refer to the power monitors that are located on the chassis backplane under the rear cover.

Examples This example shows how to display the temperature information for a specific module:

Router> show environment temperature

module 5 module 5 outlet temperature: 34C module 5 inlet temperature: 27C module 5 device-1 temperature: 42C module 5 device-2 temperature: 41C module 5 asic-1 (SSO-1) temp: 29C module 5 asic-2 (SSO-2) temp: 29C module 5 asic-3 (SSO-3) temp: 29C module 5 asic-4 (SSO-4) temp: 28C module 5 asic-5 (SSA-1) temp: 29C module 5 asic-6 (HYPERION-1) temp: 29C

Router>

This example shows how to display the temperature readings for all modules:

Router> show environment temperature

VTT 1 outlet temperature: 25C

VTT 2 outlet temperature: 24C

VTT 3 outlet temperature: 28C

module 1 outlet temperature: 24C

module 1 device-2 temperature: 29C

RP 1 outlet temperature: 25C

910

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show environment temperature

RP 1 inlet temperature: 29C

EARL 1 outlet temperature: 25C

EARL 1 inlet temperature: 22C

module 5 outlet temperature: 27C

module 5 inlet temperature: 22C

Router>

The following table describes the fields that are shown in the example.

Table 80 s how environment temperature Command Output Fields

Field outlet temperature inlet temperature device-1 and device-2 temperature

Description

Exhaust temperature value.

Intake temperature value.

Two devices that measure the internal temperature on the indicated module. The temperature shown indicates the temperature that the device is recording. The devices are not placed at an inlet or an exit but are additional reference points.

Related Commands

Command

show environment alarm

show environment status

Description

Displays the information about the environmental alarm.

Displays the information about the operational FRU status.

Cisco IOS Configuration Fundamentals Command Reference

911

show through show fm summary show errdisable detect

show errdisable detect

To display the error-disable detection status, use the show errdisable detect command in user EXEC or privileged EXEC mode.

show errdisable detect

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17b)SXA

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

This command was changed to include packetbuffer error status information.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to display the error-disable detection status:

Router> show errdisable detect

ErrDisable Reason Detection status

----------------- ---------------udld Enabled bpduguard Enabled rootguard Enabled packet-buffer-err Enabled pagp-flap Enabled dtp-flap Enabled link-flap Enabled

Router#

912

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

errdisable detect cause show errdisable detect

Description

Enables the error-disable detection.

Cisco IOS Configuration Fundamentals Command Reference

913

show through show fm summary show errdisable recovery

show errdisable recovery

To display the information about the error-disable recovery timer, use the show errdisable recovery command in EXEC mode.

show errdisable recovery

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples

This example shows how to display the information about the error-disable recovery timer:

Router# show errdisable recovery

ErrDisable Reason Timer Status

----------------- -------------udld Enabled bpduguard Enabled rootguard Enabled pagp-flap Enabled dtp-flap Enabled link-flap Enabled

Timer interval:300 seconds

Interfaces that will be enabled at the next timeout:

Interface Errdisable reason Time left(sec)

--------- ----------------- --------------

Fa9/4 link-flap 279

914

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

errdisable recovery

show interfaces status show errdisable recovery

Description

Configures the recovery mechanism variables.

Displays the interface status or a list of interfaces in an error-disabled state on LAN ports only.

Cisco IOS Configuration Fundamentals Command Reference

915

show through show fm summary show fastblk

show fastblk

To display fast block memory information, use the show fastblkcommand in privileged EXEC mode.

show fastblk [detailed]

Syntax Description detailed (Optional) Displays detailed allocated fast block memory pool information.

Command Modes Privileged EXEC (#)

Command History

Release

12.4(22)T

Modification

This command was introduced.

Usage Guidelines Use this command to display allocated fast block memory pool details. When no memory pools are allocated, the “no fastblk memory pools allocated” message is displayed.

Examples

The following is sample output from the show fastblk command using the detailed keyword. The fields are self-explanatory.

Router# show fastblk detailed

Pool name: SCTP ApplReq flags:DYN_POOL

total = 400 inuse = 0, free = 400, max = 0

increment = 200, threshold = 100, hist max = 400

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62968A2C, total = 400, inuse= 0, free = 400

delete count = 0, flags:

Pool name: SCTP BufSegHdr flags:DYN_POOL

total = 9000 inuse = 0, free = 9000, max = 0

increment = 4500, threshold = 6750, hist max = 9000

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62B8E2F4, total = 9000, inuse= 0, free = 9000

delete count = 0, flags:

Pool name: SCTP DestAddr flags:DYN_POOL

total = 80 inuse = 0, free = 80, max = 0

increment = 40, threshold = 20, hist max = 80

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62972534, total = 80, inuse= 0, free = 80

delete count = 0, flags:

Pool name: SCTP Addr flags:DYN_POOL POOL_HAS_GRWN

total = 200 inuse = 100, free = 100, max = 0

increment = 50, threshold = 50, hist max = 200

alloc failures = 31, sub-pool creation failures = 0

subpool: blks = 0x6271B6D0, total = 50, inuse= 0, free = 50

delete count = 0, flags: DYN_SUBPOOL

subpool: blks = 0x6271D730, total = 50, inuse= 0, free = 50

delete count = 0, flags: DYN_SUBPOOL

916

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

subpool: blks = 0x6297680C, total = 100, inuse= 100, free = 0

delete count = 0, flags:

Pool name: SCTP ChunkDesc flags:DYN_POOL

total = 9000 inuse = 0, free = 9000, max = 0

increment = 4500, threshold = 6750, hist max = 9000

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62BE6160, total = 1471, inuse= 0, free = 1471

delete count = 0, flags:

subpool: blks = 0x62D8D768, total = 7529, inuse= 0, free = 7529

delete count = 0, flags:

Pool name: SCTP DgramHdr flags:DYN_POOL

total = 9000 inuse = 0, free = 9000, max = 0

increment = 4500, threshold = 6750, hist max = 9000

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62BFE848, total = 9000, inuse= 0, free = 9000

delete count = 0, flags:

Pool name: SCTP Assoc flags:DYN_POOL

total = 100 inuse = 0, free = 100, max = 0

increment = 50, threshold = 25, hist max = 100

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62E0A778, total = 100, inuse= 0, free = 100

delete count = 0, flags:

Pool name: SCTP Instance flags:DYN_POOL

total = 200 inuse = 50, free = 150, max = 0

increment = 100, threshold = 50, hist max = 200

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62C33434, total = 200, inuse= 50, free = 150

delete count = 0, flags:

Pool name: SCTP Assoc Stats flags:DYN_POOL

total = 100 inuse = 0, free = 100, max = 0

increment = 50, threshold = 25, hist max = 100

alloc failures = 0, sub-pool creation failures = 0

subpool: blks = 0x62C39EA0, total = 100, inus show fastblk

Cisco IOS Configuration Fundamentals Command Reference

917

show through show fm summary show file descriptors

show file descriptors

To display a list of open file descriptors, use the show file descriptorscommand in EXEC mode.

show file descriptors

Syntax Description This command has no arguments or keywords.

Command Modes EXEC

Command History

Release

11.3 AA

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines File descriptors are the internal representations of open files. You can use this command to learn if another user has a file open.

Examples The following is sample output from the show file descriptors command:

Router# show file descriptors

File Descriptors:

FD Position Open PID Path

0 187392 0001 2 tftp://dirt/hampton/c4000-i-m.a

1 184320 030A 2 flash:c4000-i-m.a

The table below describes the fields shown in the display.

Table 81 show file descriptors Field Descriptions

Field

Position

Open

PID

Description

File descriptor. The file descriptor is a small integer used to specify the file once it has been opened.

Byte offset from the start of the file.

Flags supplied when opening the file.

Process ID of the process that opened the file.

918

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Field

Path

Description

Location of the file.

show file descriptors

Cisco IOS Configuration Fundamentals Command Reference

919

show through show fm summary show file information

show file information

To display information about a file, use the show file informationcommand in EXEC mode.

show file information file-url

Syntax Description file-url The URL of the file to display.

Command Modes EXEC

Command History

Release

11.3 AA

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples The following is sample output from the show file information command:

Router# show file information tftp://dirt/hampton/c2500-j-l.a tftp://dirt/hampton/c2500-j-l.a:

type is image (a.out) [relocatable, run from flash]

file size is 8624596 bytes, run size is 9044940 bytes [8512316+112248+420344]

Foreign image

Router# show file information slot0:c7200-js-mz slot0:c7200-js-mz:

type is image (elf) []

file size is 4770316 bytes, run size is 4935324 bytes

Runnable image, entry point 0x80008000, run from ram

Router1# show file information nvram:startup-config nvram:startup-config:

type is ascii text

The table below describes the possible file types.

Table 82 Possible File Types

Types image (a.out) image (elf) ascii text coff

Description

Runnable image in a.out format.

Runnable image in elf format.

Configuration file or other text file.

Runnable image in coff format.

920

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Types ebcdic lzw compression tar show file information

Description

Text generated on an IBM mainframe.

Lzw compressed file.

Text archive file used by the Channel Interface

Processor (CIP).

Cisco IOS Configuration Fundamentals Command Reference

921

show through show fm summary show file systems

show file systems

To list available file systems, use the show file systems command in privileged EXEC mode.

show file systems

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History

Release

11.3AA

12.3(7)T

12.2(25)S

12.2(33)SRA

12.2(33)SXI

12.4(24)T

15.0(01)XO

Modification

This command was introduced.

This command was enhanced to display information about the ATA ROM monitor library

(monlib) file.

This command was integrated into Cisco IOS

Release 12.2(25)S.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

This command was integrated into Cisco IOS

Release 12.2(33)SXI and the output was modified.

This command was integrated into Cisco IOS

Release 12.4(24)T and the output was modified.

Note added to explain different byte and usage calculations for show file systems and dir commands on cat4000 series routers.

Usage Guidelines Use this command to learn the alias names, the Prefixes column in the output of the file systems that your router supports.

Examples

The following is sample output from the show file systems command:

Router# show file systems

File Systems:

Size(b) Free(b) Type Flags Prefixes

922

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show file systems

- - ram rw tmp:

- - opaque rw system:

42541056 42541056 disk rw disk1: disk1:0:#

* 512065536 30834688 disk rw disk0:#

65536000 19811932 flash rw bootflash: sup-bootflash:

- - opaque ro ivfs:

129004 102228 nvram rw const_nvram:

125802334 0 opaque ro microcode: sup-microcode:

0 609689428 opaque rw image: sup-image:

- - opaque rw null:

- - opaque ro tar:

1964024 1949453 nvram rw nvram:

- - network rw rcp:

- - network rw tftp:

- - network rw http:

- - network rw ftp:

- - disk rw disk1:1:

- - disk rw disk1:2:

512065536 30842880 disk rw slavedisk0:#

- - disk rw slavedisk1: slavedisk1:0:

65536000 19328264 flash rw slavesup-bootflash:

1964024 1919757 nvram rw slavenvram:

129004 102228 nvram rw slaveconst_nvram:

65536000 65536000 flash rw slavebootflash:

- - nvram rw slavercsf:

- - opaque rw slavesystem:

- - disk rw slavedisk1:1:

- - disk rw slavedisk1:2:

- - disk rw slavedisk1:3:

The table below describes the significant fields shown in the display.

Table 83 show file systems Field Descriptions

Field

Size(b)

Free(b)

Description

Amount of memory in the file system (in bytes).

The "*" references the default device/directory when flash is used in a generic manner. For example, if you were to type sh flash and the device actually has bootflash:, the output of sh flash will actually be the output of dir bootflash: show file systems shows the devices that this rtr can access.

The "*" indicates the default device.

Amount of free memory in the file system (in bytes).

Cisco IOS Configuration Fundamentals Command Reference

923

show through show fm summary show file systems

Field

Type

Flags

Prefixes

Description

Type of file system. The file system can be one of the following types:

• disk-- The file system is for a rotating medium.

• flash-- The file system is for a flash memory device.

• network-- The file system is a network file system (TFTP, rcp, FTP, and so on).

• nvram-- The file system is for an NVRAM device.

• opaque-- The file system is a locally generated

“pseudo” file system (for example, the

“system”) or a download interface, such as brimux.

• ram-- The file system is for a RAM or EPROM device.

• tty-- The file system is for a collection of terminal devices.

• unknown -- The file system is of unknown type.

Permissions for the file system. The file system can have one of the following permission states:

• ro--The file system is Read Only.

• wo--The file system is Write Only.

• rw--The file system is Read/Write.

Alias for the file system. Prefixes marked with a pound symbol (#) indicate a bootable disk.

Note As of release 15.0(01)XO, on cat4000 series routers, the show file systems and dirwill display slightly different byte count and usage information for the same file system. This is due to slight difference in how

IOS computes these figures for this platform.

924

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show flh-log

show flh-log

The show flh-log command has been replaced by the more flh:logfile command. See the description of the

more flh:logfile command for more information.

Cisco IOS Configuration Fundamentals Command Reference

925

show through show fm summary show fm inspect

show fm inspect

To display the list and status of the access control lists (ACLs) and ports on which context based access control (CBAC) is configured, use the show fm inspect command in user EXEC or privileged EXEC mode.

show fm inspect [detail | interface type mod/port]

Syntax Description detail

interface type

mod / port

(Optional) Displays all of the flow information.

Interface type; possible valid values are ethernet,

fastethernet, gigabitethernet, tengigabitethernet,

port-channel, pos, atm, null, tunnel, and ge-wan

Module and port number.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you can configure a VLAN access control list (VACL) on the port before you configure CBAC, the status displayed is INACTIVE; otherwise, it is ACTIVE. If policy feature card (PFC) resources are exhausted, the command displays BRIDGE and is followed by the number of failed currently active

NetFlow requests that have been sent to the MSFC2 for processing.

The show fm inspect command output includes this information:

• interface:--Interface on which the internet protocol (IP) inspect feature is enabled

• (direction)--Direction in which the IP inspect feature is enabled (IN or OUT)

• acl name:--Name that is used to identify packets being inspected

926

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Examples show fm inspect

• status:--(ACTIVE or INACTIVE) displays if HW-assist is provided for this interface+direction

(ACTIVE=hardware assisted or INACTIVE)

The optional detail keyword displays the ACEs that are part of the ACL that is used for IP inspect on the given interface direction.

This example shows how to display the list and status of CBAC-configured ACLs and ports:

Router> show fm inspect interface:Vlan305(in) status :ACTIVE

acl name:deny

interfaces:

Vlan305(out):status ACTIVE

Related Commands

Command

show fm summary

Description

Displays a summary of FM Information.

Cisco IOS Configuration Fundamentals Command Reference

927

show through show fm summary show fm interface

show fm interface

To display the detailed information about the feature manager on a per-interface basis, use the show fm

interface command in user EXEC or privileged EXEC mode.

show fm interface {interface type mod/port | null interface-number | port-channel number | vlan

vlan-id}

Syntax Description type

mod / port

null interface-number

port-channel number

vlan vlan-id

Interface type; possible valid values are ethernet,

fastethernet, gigabitethernet, tengigabitethernet,

port-channel, pos, atm, null, tunnel, and ge-wan

Module and port number.

Specifies the null interface; the valid value is 0.

Specifies the channel interface; valid values are a maximum of 64 values ranging from 1 to 282.

Specifies the virtual local area network (VLAN); valid values are from 1 to 4094.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17a)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

The order of the information that is displayed in the

show fm interface vlan command output was changed.

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

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

928

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show fm interface

Usage Guidelines The pos, atm, and ge-wan keywords are supported on Cisco 7600 series routers that are configured with a

Supervisor Engine 2

The interface-number argument designates the module and port number. Valid values for interface-number depend on the specified interface type and the chassis and module that are used. For example, if you specify a Gigabit Ethernet interface and have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the module number are from 1 to 13 and valid values for the port number are from 1 to 48.

The port-channel numbervalues from 257 to 282 are supported on the CSM and the FWSM only.

Examples This example shows how to display the detailed information about the feature manager on a specified interface:

Router> show fm interface fastethernet 2/26

Interface:FastEthernet2/26 IP is enabled

hw[EGRESS] = 1, hw[INGRESS] = 0

hw_force_default[EGRESS] = 0, hw_force_default[INGRESS] = 1

mcast = 0

priority = 2

reflexive = 0

inbound label:24

protocol:ip

feature #:1

feature id:FM_IP_ACCESS

ACL:113

vmr IP value #1:0, 0, 0, 0, 0, 0, 0, 6 - 1

vmr IP mask #1:0, 0, FFFF, FFFF, 0, 0, 0, FF

vmr IP value #2:642D4122, 0, 0, 0, 1, 0, 0, 6 - 1

vmr IP mask #2:FFFFFFFF, 0, 0, 0, 1, 0, 0, FF

vmr IP value #3:0, 64020302, 0, 0, 6, 0, 0, 6 - 1

vmr IP mask #3:0, FFFFFFFF, 0, 0, 6, 0, 0, FF

vmr IP value #4:0, 64020302, 0, 0, A, 0, 0, 6 - 1

vmr IP mask #4:0, FFFFFFFF, 0, 0, A, 0, 0, FF

vmr IP value #5:0, 64020302, 0, 0, 12, 0, 0, 6 - 1

vmr IP mask #5:0, FFFFFFFF, 0, 0, 12, 0, 0, FF

vmr IP value #6:0, 0, 0, 0, 0, 0, 0, 0 - 2

vmr IP mask #6:0, 0, 0, 0, 0, 0, 0, 0

outbound label:3

protocol:ip

feature #:1

feature id:FM_IP_WCCP

Service ID:0

Service Type:0

Router>

This example shows how to display the detailed information about the feature manager on a specific

VLAN:

Router> show fm interface vlan 21

Interface: Vlan21 IP is disabled hw_state[INGRESS] = not reduced, hw_state[EGRESS] = not reduced mcast = 0 priority = 0 flags = 0x0 inbound label: 8

Feature IP_VACL:

-----------------------------------------------------------------------------

FM_FEATURE_IP_VACL_INGRESS i/f: Vl21 map name: test

=============================================================================

------------------------------------------------------------

IP Seq. No: 10 Seq. Result : VACL_ACTION_FORWARD_CAPTURE

------------------------------------------------------------

DPort - Destination Port SPort - Source Port Pro - Protocol

Cisco IOS Configuration Fundamentals Command Reference

929

show through show fm summary show fm interface

X - XTAG TOS - TOS Value Res - VMR Result

RFM - R-Recirc. Flag MRTNP - M-Multicast Flag R - Reflexive flag

- F-Fragment flag - T-Tcp Control N - Non-cachable

- M-More Fragments - P-Mask Priority(H-High, L-Low)

Adj. - Adj. Index T - M(Mask)/V(Value) FM - Flow Mask

NULL - Null FM SAO - Source Only FM DAO - Dest. Only FM

SADA - Sour.& Dest. Only VSADA - Vlan SADA Only FF - Full Flow

VFF - Vlan Full Flow F-VFF - Either FF or VFF A-VSD - Atleast VSADA

A-FF - Atleast FF A-VFF - Atleast VFF A-SON - Atleast SAO

A-DON - Atleast DAO A-SD - Atleast SADA SHORT - Shortest

A-SFF - Any short than FF A-EFF - Any except FF A-EVFF- Any except VFF

A-LVFF- Any less than VFF ERR - Flowmask Error

+----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+

|Indx|T| Dest Ip Addr | Source Ip Addr|DPort|SPort|Pro|RFM|X|ToS|MRTNP|Adj.| FM |

+----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+

1 V 22.2.2.2 21.1.1.1 0 0 0 --- 0 0 ----L ---- SHORT

M 255.255.255.255 255.255.255.255 0 0 0 000 0 0

TM_PERMIT_RESULT

2 V 32.2.2.2 31.1.1.1 0 0 0 --- 0 0 ----L ---- SHORT

M 255.255.255.255 255.255.255.255 0 0 0 000 0 0

TM_PERMIT_RESULT

3 V 0.0.0.0 0.0.0.0 0 0 0 --- 0 0 ----L ---- SHORT

M 0.0.0.0 0.0.0.0 0 0 0 000 0 0

TM_L3_DENY_RESULT

------------------------------------------------------------

IP Seq. No: 65536 Seq. Result : VACL_ACTION_DROP

------------------------------------------------------------

+----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+

|Indx|T| Dest Ip Addr | Source Ip Addr|DPort|SPort|Pro|RFM|X|ToS|MRTNP|Adj.| FM |

+----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+

1 V 0.0.0.0 0.0.0.0 0 0 0 --- 0 0 ----L ---- SHORT

M 0.0.0.0 0.0.0.0 0 0 0 000 0 0

TM_PERMIT_RESULT

Router>

Related Commands

Command

show fm summary

Description

Displays a summary of FM Information.

930

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show fm reflexive

show fm reflexive

To display the information about the reflexive entry for the dynamic feature manager, use the show fm

reflexive command in privileged EXEC mode.

show fm reflexive

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to display the information about the reflexive entry for the dynamic feature manager:

Router# show fm reflexive

Reflexive hash table:

Vlan613:refacl, OUT-REF, 64060E0A, 64060D0A, 0, 0, 7, 783, 6

Router#

Cisco IOS Configuration Fundamentals Command Reference

931

show through show fm summary show fm summary

show fm summary

To display a summary of feature manager information, use the show fm summary command in user EXEC or privileged EXEC mode.

show fm summary

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes User EXEC Privileged EXEC

Command History

Release

12.2(14)SX

12.2(17d)SXB

12.2(33)SRA

Modification

Support for this command was introduced on the

Supervisor Engine 720.

Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to display a summary of feature manager information:

Router> show fm summary

Current global ACL merge algorithm:BDD

Interface:FastEthernet2/10

ACL merge algorithm used:

inbound direction: ODM

outbound direction:BDD

TCAM screening for features is ACTIVE outbound

TCAM screening for features is ACTIVE inbound

Interface:FastEthernet2/26

ACL merge algorithm used:

inbound direction: ODM

outbound direction:BDD

TCAM screening for features is ACTIVE outbound

TCAM screening for features is INACTIVE inbound

Router>

932

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary

Related Commands

Command

show fm interface show fm summary

Description

Displays the detailed information about the feature manager on a per-interface basis.

Cisco IOS Configuration Fundamentals Command Reference

933

show through show fm summary show funi

show funi

To display the frame-based user-network interface information, use the show funicommand in user EXEC or privileged EXEC mode.

show funi {arp-server [atm atm-interface-number] | class-links {vpi/vci-value | vci-value |

connection-name} | ilmi-configuration | ilmi-status [atm atm-interface-number] | map | pvc[vpi/

vci-value | vci-value | connection-name | dbs | ppp] | route | traffic | vp atm-vpi-number | vc {atm-

vcd-number | connection-name | detail [prefix {interface | vc-name | vcd | vpi/vci}]} | interface

atm atm-interface-number{connection-name | detail [prefix {interface | vc-name | vcd | vpi/vci}]} |

range lower-vcd-limit upper-vcd-limit{connection-name | detail [prefix {interface | vc-name | vcd |

vpi/vci}]} | interface atm atm-interface-number{connection-name | detail [prefix {interface | vc-

name | vcd | vpi/vci}]} | summary [atm atm-interface-number]}

Syntax Description arp-server

atm atm-interface-number class-links

vpi /vci-value vci-value connection-name ilmi-configuration ilmi-status map pvc dbs ppp route traffic

Displays Asynchronous Transfer Mode (ATM) address resolution protocol server table information.

(Optional) Specifies the ATM interface and the

ATM interface number.

Displays ATM VC-class links information.

(Optional) Specifies the Virtual Path Identifier or

Virtual Channel Identifier (VPI/VCI) value (slash is mandatory).

(Optional) Specifies the virtual circuit interface value.

(Optional) Specifies the connection name.

Displays the top-level Integrated Local

Management Interface (ILMI) information.

Display ATM interface ILMI information.

Displays ATM static mapping information.

Displays ATM Permanent Virtual Circuits (PVC) information.

Displays the DBS information on a virtual circuit.

Displays the PPP over ATM information

Displays ATM route information.

Displays ATM statistics.

934

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show funi

Command Modes

User EXEC (>) Privileged EXEC (#)

Command History vp atm-vpi-number vc atm-vcd-number detail prefix interface vc_name vcd vpi/vci range lower-vcd-limit upper-vcd-limit summary

Release

12.4(24)T

Cisco IOS XE 2.3

Displays ATM virtual path information.

(Optional) Specifies the VPI number.

Displays ATM virtual circuit information.

(Optional) Specifies the ATM Virtual Circuit

Descriptor (VCD) number.

Displays the detailed information of all VCs.

(Optional) Specifies the prefix for the output ordering.

Specifies the type of interface. When this keyword is used along with the prefix keyword it displays the interface values in ascending order.

Displays the VC names in the alphabetical order.

Displays the VCD value in the ascending order.

Displays the VPI/VCI value in the ascending order.

Displays the range of VCs.

Specifies the lower limit VCD value.

Specifies the upper limit VCD value.

Display summary of VCs.

Modification

This command was introduced.

This command was implemented on Cisco ASR

1000 series routers.

Usage Guidelines Use this command to display the frame-based user-network interface information with the available keywords and arguments.

Cisco IOS Configuration Fundamentals Command Reference

935

show through show fm summary show funi

Examples The following is sample output from the show funi trafficcommand. The fields are self-explanatory:

Router# show funi traffic

Input OAM Queue: 0/4136 (size/max)

0 Input packets

0 Output packets

0 Broadcast packets

0 Packets received on non-existent VC

0 Packets attempted to send on non-existent VC

0 OAM cells received

F5 InEndloop: 0, F5 InSegloop: 0, F5 InAIS: 0, F5 InRDI: 0

F5 InEndcc: 0, F5 InSegcc: 0,

F4 InEndloop: 0, F4 InSegloop: 0, F4 InAIS: 0, F4 InRDI: 0

0 OAM cells sent

F5 OutEndloop: 0, F5 OutSegloop: 0, F5 OutAIS: 0 F5 OutRDI: 0

F5 OutEndcc: 0, F5 OutSegcc: 0,

F4 OutEndloop: 0, F4 OutSegloop: 0, F4 OutRDI: 0 F4 OutAIS: 0

0 OAM cell drops

The following is sample out from the show funi vc detail prefix interface command. The fields are selfexplanatory:

Router# show funi vc detail prefix interface

Description: N/A

ATM2/0 ATM2/0: VCD: 1, VPI: 1, VCI: 100

ATM2/0 UBR, PeakRate: 0 (0 cps)

ATM2/0 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12

ATM2/0 OAM frequency: 0 second(s)

ATM2/0 InARP frequency: 15 minutes(s)

ATM2/0 Transmit priority 6

ATM2/0 InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0

InCells: 0, OutCells: 0

ATM2/0 InPRoc: 0, OutPRoc: 0, Broadcasts: 0

ATM2/0 InFast: 0, OutFast: 0, InAS: 0, OutAS: 0

ATM2/0 InPktDrops: 0, OutPktDrops: 0

ATM2/0 CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation: 0, CPIE0

ATM2/0 Out CLP=1 Pkts: 0, Cells: 0

ATM2/0 OAM cells received: 0

ATM2/0 OAM cells sent: 0

ATM2/0 Status: INACTIVE

Description: N/A

ATM2/0 ATM2/0: VCD: 2, VPI: 1, VCI: 101

ATM2/0 UBR, PeakRate: 0 (0 cps)

ATM2/0 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12

ATM2/0 OAM frequency: 0 second(s)

The following is sample out from the show funi vc detail prefix vc_name command. The fields are selfexplanatory:

Router# show funi vc detail prefix vc_name

Description: N/A

ATM2/0: VCD: 1, VPI: 1, VCI: 100

UBR, PeakRate: 0 (0 cps)

AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12

OAM frequency: 0 second(s)

InARP frequency: 15 minutes(s)

Transmit priority 6

InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0

InCells: 0, OutCells: 0

InPRoc: 0, OutPRoc: 0, Broadcasts: 0

InFast: 0, OutFast: 0, InAS: 0, OutAS: 0

InPktDrops: 0, OutPktDrops: 0

CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation: 0, CPIErrors: 0

Out CLP=1 Pkts: 0, Cells: 0

OAM cells received: 0

OAM cells sent: 0

Status: INACTIVE

Description: N/A

ATM2/0: VCD: 2, VPI: 1, VCI: 101

UBR, PeakRate: 0 (0 cps)

AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12

936

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show funi

OAM frequency: 0 second(s)

InARP frequency: 15 minutes(s)

The following is sample out from the show funi vc detail prefix pvi/vci command. The fields are selfexplanatory:

Router# show funi vc detail prefix vpi/vci

Description: N/A

VPI/VCI: 1/100 ATM2/0: VCD: 1, VPI: 1, VCI: 100

VPI/VCI: 1/100 UBR, PeakRate: 0 (0 cps)

VPI/VCI: 1/100 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 2

VPI/VCI: 1/100 OAM frequency: 0 second(s)

VPI/VCI: 1/100 InARP frequency: 15 minutes(s)

VPI/VCI: 1/100 Transmit priority 6

VPI/VCI: 1/100 InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0

InCells: 0, OutCells: 0

VPI/VCI: 1/100 InPRoc: 0, OutPRoc: 0, Broadcasts: 0

VPI/VCI: 1/100 InFast: 0, OutFast: 0, InAS: 0, OutAS: 0

VPI/VCI: 1/100 InPktDrops: 0, OutPktDrops: 0

VPI/VCI: 1/100 CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation:0

VPI/VCI: 1/100 Out CLP=1 Pkts: 0, Cells: 0

VPI/VCI: 1/100 OAM cells received: 0

VPI/VCI: 1/100 OAM cells sent: 0

VPI/VCI: 1/100 Status: INACTIVE

Description: N/A

VPI/VCI: 1/101 ATM2/0: VCD: 2, VPI: 1, VCI: 101

VPI/VCI: 1/101 UBR, PeakRate: 0 (0 cps)

VPI/VCI: 1/101 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 2

Cisco IOS Configuration Fundamentals Command Reference

937

show through show fm summary show identity policy

show identity policy

To display identity policy information in a tabular form, use the show identity policycommand in privileged EXEC mode.

show identity policy [name]

Syntax Description name (Optional) Name of the identity policy.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(18)SX

Modification

This command was introduced.

Examples The following is output from the show identity policy command:

Router# show identity policy

Policy Name ACL Redirect ACL Redirect URL

=============================================================================== p1 some-acl NONE NONE p2 another-acl redirect-acl http://www.foo.com/ bar.html

Router#

The following is output for the policy named p2:

Router# show identity policy p2

Name: p2

Description: NONE

Access-Group: another-acl

URL-Redirect Match ACL: redirect-acl

URL-Redirect URL: http://www.foo.com/bar.html

Router#

Related Commands

Command

show running-configuration

Description

Displays the running configuration for a router.

938

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show identity profile

show identity profile

To display identity profile information in a tabular form, use the show identity profilecommand in privileged EXEC mode.

show identity profile [default | dot1x | eapoudp]

Syntax Description default dot1x eapoudp

(Optional) Displays default identity profile information.

(Optional) Displays 802.1x identity profile information.

(Optional) Displays EAPoUDP identity profile information.

Command Modes Privileged EXEC (#)

Command History

Release

12.2(18)SX

Examples

Modification

This command was introduced.

The following is output from the show identity profilecommand:

Router# show running identity profile

Service Type: default

Default Authorized Device Policy: NONE

Default Non-Authorized Device Policy: NONE

Device / Address / Mask Allowed Policy

==============================================================

Cisco IP Phone Authorized DEFAULT

Service Type: dot1x

Default Authorized Device Policy: NONE

Default Non-Authorized Device Policy: NONE

Device / Address / Mask Allowed Policy

==============================================================

0001.0203.0405 / ffff.ffff.ffff Authorized p2

Service Type: eapoudp

Device / Address / Mask Allowed Policy

==============================================================

10.0.0.0 / 255.0.0.0 Authorized p1

Router#

Cisco IOS Configuration Fundamentals Command Reference

939

show identity profile

Related Commands

Command

show running-configuration show through show fm summary

Description

Displays the running configuration for a router.

940

Cisco IOS Configuration Fundamentals Command Reference

show through show fm summary show platform software snapshot status

show platform software snapshot status

To display the status of a bootflash snapshot action, use the show platform software snapshot status command in privilege EXEC mode.

show platform software snapshot slot status

Syntax Description snapshot slot status

Requests snapshot actions.

Specifies the hardware slot. Options include:

• number --The number of the SIP slot of the hardware module where the trace level is being set. For instance, if you wanted to specify the

SIP in SIP slot 2 of the router, enter 2 as the

number.

• f0 --The ESP in ESP slot 0.

• f1 --The ESP in ESP slot 1

• fp active --The active ESP.

• fp standby --The standby ESP.

• r0 --The RP in RP slot 0.

• r1 --The RP in RP slot 1.

• rp active --The active RP.

• rp standby --The standby RP.

Displays the status of snapshot operations.

Command Default No default behavior or values

Command Modes Privileged EXEC (#) Diagnostic Mode (diag)

Command History

Release

Cisco IOS XE Release 2.1

Modification

This command was introduced.

Usage Guidelines Use the show platform software snapshot status command to view the status of a bootflash snapshot request.

Cisco IOS Configuration Fundamentals Command Reference

941

show through show fm summary show platform software snapshot status

Examples This example shows how to view the status of bootflash snapshot requests on the processor in the RO slot.

router#show platform software snapshot R0 status

Related Commands

Command request platform software snapshot

Description

Use this command to display a snapshot of the bootflash.

942

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace

•

show gsr, page 945

•

show gt64010 (7200), page 947

•

show hardware, page 949

•

show health-monitor, page 951

•

show history, page 952

•

show history all, page 954

•

show hosts, page 957

•

show html, page 961

•

show idb, page 963

•

show idprom, page 965

•

show inventory, page 971

•

show location, page 975

•

show logging, page 978

•

show logging count, page 985

•

show logging history, page 988

•

show logging system, page 991

•

show logging xml, page 994

•

show memory, page 996

•

show memory allocating-process, page 1003

•

show memory dead, page 1006

•

show memory debug incremental, page 1008

•

show memory debug leaks, page 1011

•

show memory debug references, page 1017

•

show memory debug unused, page 1019

•

show memory detailed, page 1021

•

show memory ecc, page 1029

•

show memory events, page 1031

•

show memory failures alloc, page 1033

•

show memory fast, page 1035

•

show memory fragment, page 1038

•

show memory lite-chunks, page 1041

•

show memory multibus, page 1043

•

show memory pci, page 1045

•

show memory processor, page 1047

•

show memory scan, page 1052

Cisco IOS Configuration Fundamentals Command Reference

943

•

show memory statistics history, page 1054

•

show memory traceback, page 1057

•

show memory transient, page 1059

•

show microcode, page 1061

•

show mls statistics, page 1063

•

show module, page 1066

•

show monitor event-trace, page 1069

show gsr through show monitor event trace

944

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace show gsr

show gsr

To display hardware information on the Cisco 12000 series Gigabit Switch Routers (GSRs), use the show

gsr command in EXEC mode.

show gsr [chassis-info [details]]

Syntax Description chassis-info details

(Optional) Displays backplane NVRAM information.

(Optional) In addition to the information displayed, this option includes hexadecimal output of the backplane NVRAM information.

Command Modes EXEC

Command History

Release

11.2GS

12.2(33)SRA

Modification

This command was introduced to support the Cisco

12000 series GSRs.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to determine the type of hardware installed in your Cisco 12000 series GSR router.

Examples The following is sample output from the show gsr command for a Cisco 12012 router. This command shows the type and state of the card installed in the slot.

Router# show gsr

Slot 0 type = Route Processor

state = IOS Running MASTER

Slot 7 type = 1 Port Packet Over SONET OC-12c/STM-4c

state = Card Powered

Slot 16 type = Clock Scheduler Card

state = Card Powered PRIMARY CLOCK

The following is sample output from the show gsr chassis-info command for a Cisco 12012 router:

Router# show gsr chassis-info

Backplane NVRAM [version 0x20] Contents -

Chassis: type 12012 Fab Ver: 1

Chassis S/N: ZQ24CS3WT86MGVHL

PCA: 800-3015-1 rev: A0 dev: 257 HW ver: 1.0

Cisco IOS Configuration Fundamentals Command Reference

945

show gsr

Backplane S/N: A109EXPR75FUNYJK

MAC Addr: base 0000.EAB2.34FF block size: 1024

RMA Number: 0x5F-0x2D-0x44 code: 0x01 hist: 0x1A show gsr through show monitor event trace

946

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace show gt64010 (7200)

show gt64010 (7200)

To display all GT64010 internal registers and interrupt status on the Cisco 7200 series routers, use the

show gt64010 command in EXEC mode.

show gt64010

Syntax Description This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

11.2

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command displays information about the CPU interface, DRAM/device address space, device parameters, direct memory access (DMA) channels, timers and counters, and protocol control information

(PCI) internal registers. The information is generally useful for diagnostic tasks performed by technical support only.

Examples The following is a partial sample output for the show gt64010 command:

Router# show gt64010

GT64010 Channel 0 DMA:

dma_list=0x6088C3EC, dma_ring=0x4B018480, dma_entries=256

dma_free=0x6088CECC, dma_reqt=0x6088CECC, dma_done=0x6088CECC

thread=0x6088CEAC, thread_end=0x6088CEAC

backup_thread=0x0, backup_thread_end=0x0

dma_working=0, dma_complete=6231, post_coalesce_frames=6231

exhausted_dma_entries=0, post_coalesce_callback=6231

GT64010 Register Dump: Registers at 0xB4000000

CPU Interface:

cpu_interface_conf : 0x80030000 (b/s 0x00000380)

addr_decode_err : 0xFFFFFFFF (b/s 0xFFFFFFFF)

Processor Address Space :

ras10_low : 0x00000000 (b/s 0x00000000)

ras10_high : 0x07000000 (b/s 0x00000007)

ras32_low : 0x08000000 (b/s 0x00000008)

ras32_high : 0x0F000000 (b/s 0x0000000F)

cs20_low : 0xD0000000 (b/s 0x000000D0)

cs20_high : 0x74000000 (b/s 0x00000074)

cs3_boot_low : 0xF8000000 (b/s 0x000000F8)

cs3_boot_high : 0x7E000000 (b/s 0x0000007E)

pci_io_low : 0x00080000 (b/s 0x00000800)

Cisco IOS Configuration Fundamentals Command Reference

947

show gt64010 (7200)

pci_io_high : 0x00000000 (b/s 0x00000000)

pci_mem_low : 0x00020000 (b/s 0x00000200)

pci_mem_high : 0x7F000000 (b/s 0x0000007F)

internal_spc_decode : 0xA0000000 (b/s 0x000000A0)

bus_err_low : 0x00000000 (b/s 0x00000000)

bus_err_high : 0x00000000 (b/s 0x00000000)

show gsr through show monitor event trace

948

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace show hardware

show hardware

To display the hardware-specific information for a router, use the show hardwarecommand in user EXEC or privileged EXEC mode.

show hardware

Syntax Description This command has no arguments or keywords.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.4(22)T

Modification

This command was introduced.

Usage Guidelines Use the show hardware command to display the hardware specific information for a router.

Examples The following is sample output from the show hardware command:

Router# show hardware

Cisco IOS Software, 7200 Software (C7200-ADVENTERPRISEK9-M), Version 12.4(22)T,)

Technical Support: http://www.cisco.com/techsupport

Compiled Fri 10-Oct-08 10:10 by prod_rel_team

ROM: System Bootstrap, Version 12.2(4r)B2, RELEASE SOFTWARE (fc2)

BOOTLDR: 7200 Software (C7200-KBOOT-M), Version 12.3(16), RELEASE SOFTWARE (fc4)

Router uptime is 1 day, 16 hours, 32 minutes

System returned to ROM by reload at 04:13:23 UTC Wed Aug 12 2009

System image file is "disk0:Default-IOS-Image-Do-Not-Delete"

Last reload reason: Reload Command

This product contains cryptographic features and is subject to United

States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption.

Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html

If you require further assistance please contact us by sending email to [email protected].

Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memo.

Processor board ID 31410931

R7000 CPU at 350MHz, Implementation 39, Rev 3.3, 256KB L2 Cache

6 slot VXR midplane, Version 2.7

Last reset from power-on

PCI bus mb0_mb1 (Slots 0, 1, 3 and 5) has a capacity of 600 bandwidth points.

Current configuration on bus mb0_mb1 has a total of 600 bandwidth points.

This configuration is within the PCI bus capacity and is supported.

Cisco IOS Configuration Fundamentals Command Reference

949

show gsr through show monitor event trace show hardware

PCI bus mb2 (Slots 2, 4, 6) has a capacity of 600 bandwidth points.

Current configuration on bus mb2 has a total of 180 bandwidth points

This configuration is within the PCI bus capacity and is supported.

Please refer to the following document "Cisco 7200 Series Port Adaptor

Hardware Configuration Guidelines" on Cisco.com <http://www.cisco.com> for c7200 bandwidth points oversubscription and usage guidelines.

2 FastEthernet interfaces

4 Serial interfaces

125K bytes of NVRAM.

62976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes).

125440K bytes of ATA PCMCIA card at slot 1 (Sector size 512 bytes).

8192K bytes of Flash internal SIMM (Sector size 256K).

Configuration register is 0x2002

Related Commands

Command

show interfaces

Description

Displays statistics for all interfaces configured on the router or access server.

950

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace show health-monitor

show health-monitor

To display the system Health Monitor status information, use the show health-monitorcommand in user

EXEC or privileged EXEC mode.

show health-monitor [summary]

Syntax Description summary (Optional) Displays a summary of the status information.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

15.0(1)M

Modification

This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.

Usage Guidelines Use this command to display the state of the hardware and software subsystem. Health Monitor is a Cisco

IOS subsystem that monitors the state of the individual hardware and software subsystems. This monitoring helps in early detection and recovery of faults in the subsystem.

Examples The following is sample output from show health-monitorcommand. The fields are self explanatory.

Router# show health-monitor summary

Chassis:

Power Supply Failure

Temperature OK

Fans OK

Memory:

Free Memory processor OK

Memory Fragmentation Processor OK

Free Memory I/O OK

Memory Fragmentation I/O OK

DFC's:

Slot 1 - Empty DFC Not in operation

Slot 2 - Empty DFC Not in operation

Slot 3 - AS5X-FC OK

Slot 4 - Empty DFC Not in operation

Slot 5 - Empty DFC Not in operation

Slot 6 - Empty DFC Not in operation

Slot 7 - Empty DFC Not in operation

Cisco IOS Configuration Fundamentals Command Reference

951

show gsr through show monitor event trace show history

show history

To list the commands you have entered in the current EXEC session, use the show history command in

EXEC mode.

show history

Syntax Description This command has no arguments or keywords.

Command Modes EXEC

Command History

Release

10.0

12.2(33)SRA

Modification

This command was introduced.

This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The command history feature provides a record of EXEC commands you have entered. The number of commands that the history buffer will record is determined by the history size line configuration command or the terminal history size EXEC command.

The table below lists the keys and functions you can use to recall commands from the command history buffer.

Table 84 History Keys

Key

Ctrl-P or Up Arrow

Ctrl-N or Down Arrow1

Function

Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.

Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the

Up Arrow. Repeat the key sequence to recall successively more recent commands.

3 The arrow keys function only with ANSI-compatible terminals.

952

Cisco IOS Configuration Fundamentals Command Reference

show gsr through show monitor event trace show history

Examples The following is sample output from the show history command, which lists the commands the user has entered in EXEC mode for this session:

Router# show history

help

where

show hosts

show history

Router#

Related Commands

Command

history size

terminal history size

Description

Enables the command history function, or changes the command history buffer size for a particular line.

Enables the command history feature for the current terminal session, or changes the size of the command history buffer for the current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

953

show gsr through show monitor event trace show history all

show history all

To display command history and reload information of a router, use the show history allcommand in user

EXEC or privileged EXEC mode.

show history all

Syntax Description This command has no arguments or keywords.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History

Release

12.4(22)T

Modification

This command was introduced.

Usage Guidelines Use the show history allcommand to display command history and reload information of a router.

Examples The following is sample output from the show history allcommand:

Router# show history all

This product contains cryptographic features and is subject to United

A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html

If you require further assistance please contact us by sending email to [email protected].

Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memo.

Processor board ID 31410931

R7000 CPU at 350MHz, Implementation 39, Rev 3.3, 256KB L2, 4096KB L3 Cache