Cisco IOS

Configuration Fundamentals
Command Reference
Release 12.2

Corporate Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 526-4100

Customer Order Number: DOC-7811740=

Text Part Number: 78-11740-02

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT
NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE
PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR
APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION
PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO
LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of
UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED
AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED,
INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL
DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR
INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

AccessPath, AtmDirector, Browse with Me, CCDA, CCDE, CCDP, CCIE, CCNA, CCNP, CCSI, CD-PAC, CiscoLink, the Cisco NetWorks logo, the Cisco
Powered Network logo, Cisco Systems Networking Academy, the Cisco Systems Networking Academy logo, Fast Step, Follow Me Browsing, FormShare,
FrameShare, GigaStack, IGX, Internet Quotient, IP/VC, iQ Breakthrough, iQ Expertise, iQ FastTrack, the iQ Logo, iQ Net Readiness Scorecard, MGX,
the Networkers logo, Packet, PIX, RateMUX, ScriptBuilder, ScriptShare, SlideCast, SMARTnet, TransPath, Unity, Voice LAN, Wavelength Router, and
WebViewer are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, Discover All Thats Possible, and Empowering
the Internet Generation, are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, Cisco, the Cisco Certified Internetwork Expert logo,
Cisco IOS, the Cisco IOS logo, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Enterprise/Solver, EtherChannel, EtherSwitch, FastHub,
FastSwitch, IOS, IP/TV, LightStream, MICA, Network Registrar, Post-Routing, Pre-Routing, Registrar, StrataView Plus, Stratm, SwitchProbe, TeleRouter,
and VCO are registered trademarks of Cisco Systems, Inc. or its affiliates in the U.S. and certain other countries.
All other brands, names, or trademarks mentioned in this document or Web site are the property of their respective owners. The use of the word partner
does not imply a partnership relationship between Cisco and any other company. (0102R)
Cisco IOS Configuration Fundamentals Command Reference
2001 2006 Cisco Systems, Inc.
All rights reserved.

CONTENTS
About Cisco IOS Software Documentation
Using Cisco IOS Software

xiii

CISCO IOS USER INTERFACE COMMANDS

Basic Command-Line Interface Commands
The Setup Command

FR-3

FR-45

Terminal Operating Characteristics Commands

FR-53

Connection, Menu, and System Banner Commands

FR-123

Cisco IOS Web Browser User Interface Commands

FR-167

FILE MANAGEMENT COMMANDS

Cisco IOS File System Commands

FR-179

Configuration File Management Commands

System Image and Microcode Commands
Router Memory Commands
Booting Commands

FR-231
FR-267

FR-293

FR-311

Basic File Transfer Services Commands

FR-343

SYSTEM MANAGEMENT COMMANDS

Basic System Management Commands

FR-375

Troubleshooting and Fault Management Commands

SNMP Commands
CDP Commands
RMON Commands

FR-481

FR-667
FR-743
FR-767

Cisco Service Assurance Agent Commands

FR-805

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

iii

Contents

WCCP Commands

FR-895

APPENDIXES
ASCII Character Set and Hex Values

FR-919

Cisco 7500 Series Line Card Configuration Commands

FR-925

INDEX

Cisco IOS Configuration Fundamentals Command Reference

iv

78-11740-02

About Cisco IOS Software Documentation

This chapter discusses the objectives, audience, organization, and conventions of Cisco IOS software
documentation. It also provides sources for obtaining documentation from Cisco Systems.

Documentation Objectives
Cisco IOS software documentation describes the tasks and commands necessary to configure and
maintain Cisco networking devices.

Audience
The Cisco IOS software documentation set is intended primarily for users who configure and maintain
Cisco networking devices (such as routers and switches) but who may not be familiar with the tasks,
the relationship between tasks, or the Cisco IOS software commands necessary to perform particular
tasks. The Cisco IOS software documentation set is also intended for those users experienced with
Cisco IOS software who need to know about new features, new configuration options, and new software
characteristics in the current Cisco IOS software release.

Documentation Organization
The Cisco IOS software documentation set consists of documentation modules and master indexes. In
addition to the main documentation set, there are supporting documents and resources.

Documentation Modules
The Cisco IOS documentation modules consist of configuration guides and corresponding command
reference publications. Chapters in a configuration guide describe protocols, configuration tasks, and
Cisco IOS software functionality and contain comprehensive configuration examples. Chapters in a
command reference publication provide complete Cisco IOS command syntax information. Use each
configuration guide in conjunction with its corresponding command reference publication.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

About Cisco IOS Software Documentation

Documentation Organization

Figure 1 shows the Cisco IOS software documentation modules.

Note

Figure 1

The abbreviations (for example, FC and FR) next to the book icons are page designators,
which are defined in a key in the index of each document to help you with navigation. The
bullets under each module list the major technology areas discussed in the corresponding
books.

Cisco IOS Software Documentation Modules

IPC

FC

Cisco IOS
Configuration
Fundamentals
Configuration
Guide

Cisco IOS
Configuration
Fundamentals
Command
Reference

FR

IP2R

Module FC/FR:
Cisco IOS User
Interfaces
File Management
System Management

WR

Cisco IOS
Wide-Area
Networking
Command
Reference

Module WC/WR:
ATM
Broadband Access
Frame Relay
SMDS
X.25 and LAPB

Cisco IOS
IP Command
Reference,
Volume 1 of 3:
Addressing
and Services

Cisco IOS
IP Command
Reference,
Volume 2 of 3:
Routing
Protocols

P2C

IP3R

Cisco IOS
IP Command
Reference,
Volume 3 of 3:
Multicast

Cisco IOS
Interface
Configuration
Guide

IR

Cisco IOS
Interface
Command
Reference

Module IC/IR:
LAN Interfaces
Serial Interfaces
Logical Interfaces

P3C

Cisco IOS
AppleTalk and
Novell IPX
Configuration
Guide

P2R

Module IPC/IP1R/IP2R/IP3R:
IP Addressing and Services
IP Routing Protocols
IP Multicast

IC

Cisco IOS
Wide-Area
Networking
Configuration
Guide

IP1R

Cisco IOS
AppleTalk and
Novell IPX
Command
Reference

P3R

Module P2C/P2R:
AppleTalk
Novell IPX

MWC

Cisco IOS
Mobile
Wireless
Configuration
Guide

MWR

Cisco IOS
Mobile
Wireless
Command
Reference

Module MWC/MWR:
General Packet
Radio Service

Cisco IOS
Apollo Domain,
Banyan VINES,
DECnet, ISO
CLNS, and XNS
Configuration
Guide

SC

Cisco IOS
Apollo Domain,
Banyan VINES,
DECnet, ISO
CLNS, and XNS
Command
Reference

Module P3C/P3R:
Apollo Domain
Banyan VINES
DECnet
ISO CLNS
XNS

Cisco IOS
Security
Configuration
Guide

SR

Cisco IOS
Security
Command
Reference

Module SC/SR:
AAA Security Services
Security Server Protocols
Traffic Filtering and Firewalls
IP Security and Encryption
Passwords and Privileges
Neighbor Router Authentication
IP Security Options
Supported AV Pairs

47953

WC

Cisco IOS
IP
Configuration
Guide

Cisco IOS Configuration Fundamentals Command Reference

vi

78-11740-02

About Cisco IOS Software Documentation

Documentation Organization

Cisco IOS
Dial
Technologies
Configuration
Guide

TC

BC

Cisco IOS
Terminal
Services
Configuration
Guide

Cisco IOS
Bridging and
IBM Networking
Configuration
Guide

B2R

B1R

DR

Cisco IOS
Dial
Technologies
Command
Reference

TR

Module DC/DR:
Preparing for Dial Access
Modem and Dial Shelf Configuration
and Management
ISDN Configuration
Signalling Configuration
Dial-on-Demand Routing
Configuration
Dial-Backup Configuration
Dial-Related Addressing Services
Virtual Templates, Profiles, and
Networks
PPP Configuration
Callback and Bandwidth Allocation
Configuration
Dial Access Specialized Features
Dial Access Scenarios

VC

Cisco IOS
Voice, Video,
and Fax
Configuration
Guide

VR

Cisco IOS
Voice, Video,
and Fax
Command
Reference

Module VC/VR:
Voice over IP
Call Control Signalling
Voice over
Frame Relay
Voice over ATM
Telephony Applications
Trunk Management
Fax, Video, and
Modem Support

Cisco IOS
Bridging
and IBM
Networking
Command
Reference,
Volume 1 of 2

Cisco IOS
Terminal
Services
Command
Reference

Module BC/B1R:
Transparent
Bridging
SRB
Token Ring
Inter-Switch Link
Token Ring Route
Switch Module
RSRB
DLSw+
Serial Tunnel and
Block Serial Tunnel
LLC2 and SDLC
IBM Network
Media Translation
SNA Frame Relay
Access
NCIA Client/Server
Airline Product Set

Module TC/TR:
ARA
LAT
NASI
Telnet
TN3270
XRemote
X.28 PAD
Protocol Translation

QC

XC

Cisco IOS
Quality of
Service
Solutions
Configuration
Guide

QR

Cisco IOS
Bridging
and IBM
Networking
Command
Reference,
Volume 2 of 2

Cisco IOS
Quality of
Service
Solutions
Command
Reference

Cisco IOS
Switching
Services
Configuration
Guide

XR

Module QC/QR:
Packet Classification
Congestion Management
Congestion Avoidance
Policing and Shaping
Signalling
Link Efficiency
Mechanisms

Module BC/B2R:
DSPU and SNA
Service Point
SNA Switching
Services
Cisco Transaction
Connection
Cisco Mainframe
Channel Connection
CLAW and TCP/IP
Offload
CSNA, CMPC,
and CMPC+
TN3270 Server

Cisco IOS
Switching
Services
Command
Reference

Module XC/XR:
Cisco IOS
Switching Paths
NetFlow Switching
Multiprotocol Label Switching
Multilayer Switching
Multicast Distributed Switching
Virtual LANs
LAN Emulation

47954

DC

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

vii

About Cisco IOS Software Documentation

Documentation Organization

Master Indexes
Two master indexes provide indexing information for the Cisco IOS software documentation set:
an index for the configuration guides and an index for the command references. Individual books also
contain a book-specific index.
The master indexes provide a quick way for you to find a command when you know the command name
but not which module contains the command. When you use the online master indexes, you can click
the page number for an index entry and go to that page in the online document.

Supporting Documents and Resources

The following documents and resources support the Cisco IOS software documentation set:

Cisco IOS Command Summary (two volumes)This publication explains the function and syntax
of the Cisco IOS software commands. For more information about defaults and usage guidelines,
refer to the Cisco IOS command reference publications.

Cisco IOS System Error MessagesThis publication lists and describes Cisco IOS system error
messages. Not all system error messages indicate problems with your system. Some are purely
informational, and others may help diagnose problems with communications lines, internal
hardware, or the system software.

Cisco IOS Debug Command ReferenceThis publication contains an alphabetical listing of the
debug commands and their descriptions. Documentation for each command includes a brief
description of its use, command syntax, usage guidelines, and sample output.

Dictionary of Internetworking Terms and AcronymsThis Cisco publication compiles and defines
the terms and acronyms used in the internetworking industry.

New feature documentationThe Cisco IOS software documentation set documents the mainline
release of Cisco IOS software (for example, Cisco IOS Release 12.2). New software features are
introduced in early deployment releases (for example, the Cisco IOS T release train for 12.2,
12.2(x)T). Documentation for these new features can be found in standalone documents called
feature modules. Feature module documentation describes new Cisco IOS software and hardware
networking functionality and is available on Cisco.com and the Documentation CD-ROM.

Release notesThis documentation describes system requirements, provides information about

new and changed features, and includes other useful information about specific software releases.
See the section Using Software Release Notes in the chapter Using Cisco IOS Software for
more information.

Caveats documentationThis documentation provides information about Cisco IOS software

defects in specific software releases.

RFCsRFCs are standards documents maintained by the Internet Engineering Task Force (IETF).
Cisco IOS software documentation references supported RFCs when applicable. The full text of
referenced RFCs may be obtained on the World Wide Web at http://www.rfc-editor.org/.

MIBsMIBs are used for network monitoring. For lists of supported MIBs by platform and
release, and to download MIB files, see the Cisco MIB website on Cisco.com at
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.

Cisco IOS Configuration Fundamentals Command Reference

viii

78-11740-02

About Cisco IOS Software Documentation

Document Conventions

Document Conventions
Within Cisco IOS software documentation, the term router is generally used to refer to a variety of Cisco
products (for example, routers, access servers, and switches). Routers, access servers, and other
networking devices that support Cisco IOS software are shown interchangeably within examples. These
products are used only for illustrative purposes; that is, an example that shows one product does not
necessarily indicate that other products are not supported.
The Cisco IOS documentation set uses the following conventions:
Convention

Description

^ or Ctrl

The ^ and Ctrl symbols represent the Control key. For example, the key combination ^D or Ctrl-D
means hold down the Control key while you press the D key. Keys are indicated in capital letters but
are not case sensitive.

string

A string is a nonquoted set of characters shown in italics. For example, when setting an SNMP
community string to public, do not use quotation marks around the string or the string will include the
quotation marks.
Command syntax descriptions use the following conventions:

Convention

Description

boldface

Boldface text indicates commands and keywords that you enter literally as shown.

italics

Italic text indicates arguments for which you supply values.

[x]

Square brackets enclose an optional element (keyword or argument).

A vertical line indicates a choice within an optional or required set of keywords or arguments.

[x | y]

Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional
choice.

{x | y}

Braces enclosing keywords or arguments separated by a vertical line indicate a required choice.
Nested sets of square brackets or braces indicate optional or required choices within optional or
required elements. For example:

Convention

Description

[x {y | z}]

Braces and a vertical line within square brackets indicate a required choice within an optional element.
Examples use the following conventions:

Convention

Description

screen

Examples of information displayed on the screen are set in Courier font.

boldface screen

Examples of text that you must enter are set in Courier bold font.

<

Angle brackets enclose text that is not printed to the screen, such as passwords.

>

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

ix

About Cisco IOS Software Documentation

Obtaining Documentation

Convention

Description

An exclamation point at the beginning of a line indicates a comment line. (Exclamation points are also
displayed by the Cisco IOS software for certain processes.)

Square brackets enclose default responses to system prompts.

The following conventions are used to attract the attention of the reader:

Caution

Note

Timesaver

Means reader be careful. In this situation, you might do something that could result in
equipment damage or loss of data.

Means reader take note. Notes contain helpful suggestions or references to materials not
contained in this manual.

Means the described action saves time. You can save time by performing the action
described in the paragraph.

Obtaining Documentation
The following sections provide sources for obtaining documentation from Cisco Systems.

World Wide Web

The most current Cisco documentation is available on the World Wide Web at the following website:
http://www.cisco.com
Translated documentation is available at the following website:
http://www.cisco.com/public/countries_languages.html

Documentation CD-ROM
Cisco documentation and additional literature are available in a CD-ROM package, which ships
with your product. The Documentation CD-ROM is updated monthly and may be more current than
printed documentation. The CD-ROM package is available as a single unit or through an
annual subscription.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

About Cisco IOS Software Documentation

Documentation Feedback

Ordering Documentation
Cisco documentation can be ordered in the following ways:

Registered Cisco Direct Customers can order Cisco product documentation from the Networking
Products MarketPlace:
http://www.cisco.com/cgi-bin/order/order_root.pl

Registered Cisco.com users can order the Documentation CD-ROM through the online
Subscription Store:
http://www.cisco.com/go/subscription

Nonregistered Cisco.com users can order documentation through a local account representative by
calling Cisco corporate headquarters (California, USA) at 408 526-7208 or, in North America, by
calling 800 553-NETS(6387).

Documentation Feedback
If you are reading Cisco product documentation on the World Wide Web, you can submit technical
comments electronically. Click Feedback in the toolbar and select Documentation. After you complete
the form, click Submit to send it to Cisco.
You can e-mail your comments to [email protected].
To submit your comments by mail, use the response card behind the front cover of your document, or
write to the following address:
Cisco Systems, Inc.
Document Resource Connection
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.

Obtaining Technical Assistance

Cisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can
obtain documentation, troubleshooting tips, and sample configurations from online tools. For
Cisco.com registered users, additional troubleshooting tools are available from the TAC website.

Cisco.com
Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open
access to Cisco information and resources at anytime, from anywhere in the world. This highly
integrated Internet application is a powerful, easy-to-use tool for doing business with Cisco.
Cisco.com provides a broad range of features and services to help customers and partners streamline
business processes and improve productivity. Through Cisco.com, you can find information about Cisco
and our networking solutions, services, and programs. In addition, you can resolve technical issues with
online technical support, download and test software packages, and order Cisco learning materials and
merchandise. Valuable online skill assessment, training, and certification programs are also available.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

xi

About Cisco IOS Software Documentation

Obtaining Technical Assistance

Customers and partners can self-register on Cisco.com to obtain additional personalized information
and services. Registered users can order products, check on the status of an order, access technical
support, and view benefits specific to their relationships with Cisco.
To access Cisco.com, go to the following website:
http://www.cisco.com

Technical Assistance Center

The Cisco TAC website is available to all customers who need technical assistance with a Cisco product
or technology that is under warranty or covered by a maintenance contract.

Contacting TAC by Using the Cisco TAC Website

If you have a priority level 3 (P3) or priority level 4 (P4) problem, contact TAC by going to the TAC
website:
http://www.cisco.com/tac
P3 and P4 level problems are defined as follows:

P3Your network performance is degraded. Network functionality is noticeably impaired, but

most business operations continue.

P4You need information or assistance on Cisco product capabilities, product installation, or basic
product configuration.

In each of the above cases, use the Cisco TAC website to quickly find answers to your questions.
To register for Cisco.com, go to the following website:
http://www.cisco.com/register/
If you cannot resolve your technical issue by using the TAC online resources, Cisco.com registered
users can open a case online by using the TAC Case Open tool at the following website:
http://www.cisco.com/tac/caseopen

Contacting TAC by Telephone

If you have a priority level 1 (P1) or priority level 2 (P2) problem, contact TAC by telephone and
immediately open a case. To obtain a directory of toll-free numbers for your country, go to the following
website:
http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml
P1 and P2 level problems are defined as follows:

P1Your production network is down, causing a critical impact to business operations if service
is not restored quickly. No workaround is available.

P2Your production network is severely degraded, affecting significant aspects of your business
operations. No workaround is available.

Cisco IOS Configuration Fundamentals Command Reference

xii

78-11740-02

Using Cisco IOS Software

This chapter provides helpful tips for understanding and configuring Cisco IOS software using the
command-line interface (CLI). It contains the following sections:

Understanding Command Modes

Getting Help

Using the no and default Forms of Commands

Saving Configuration Changes

Filtering Output from the show and more Commands

Identifying Supported Platforms

For an overview of Cisco IOS software configuration, refer to the Release 12.2 Cisco IOS
Configuration Fundamentals Configuration Guide.
For information on the conventions used in the Cisco IOS software documentation set, see the previous
chapter, About Cisco IOS Software Documentation.

Understanding Command Modes

You use the CLI to access Cisco IOS software. Because the CLI is divided into many different modes,
the commands available to you at any given time depend on the mode you are currently in. Entering a
question mark (?) at the CLI prompt allows you to obtain a list of commands available for each
command mode.
When you log in to the CLI, you are in user EXEC mode. User EXEC mode contains only a limited
subset of commands. To have access to all commands, you must enter privileged EXEC mode, normally
by using a password. From privileged EXEC mode you can issue any EXEC commanduser or
privileged modeor you can enter global configuration mode. Most EXEC commands are one-time
commands. For example, show commands show important status information, and clear commands
clear counters or interfaces. The EXEC commands are not saved when the software reboots.
Configuration modes allow you to make changes to the running configuration. If you later save the
running configuration to the startup configuration, these changed commands are stored when the
software is rebooted. To enter specific configuration modes, you must start at global configuration
mode. From global configuration mode, you can enter interface configuration mode and a variety of
other modes, such as protocol-specific modes.
ROM monitor mode is a separate mode used when the Cisco IOS software cannot load properly. If a
valid software image is not found when the software boots or if the configuration file is corrupted at
startup, the software might enter ROM monitor mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

xiii

Using Cisco IOS Software

Getting Help

Table 1 describes how to access and exit various common command modes of the Cisco IOS software.
It also shows examples of the prompts displayed for each mode.
Table 1

Accessing and Exiting Command Modes

Command
Mode

Access Method

Prompt

Exit Method

User EXEC

Log in.

Router>

Use the logout command.

Privileged
EXEC

From user EXEC mode,

use the enable EXEC
command.

Router#

To return to user EXEC mode, use the disable

command.

Global
configuration

From privileged EXEC

mode, use the configure
terminal privileged
EXEC command.

Router(config)#

To return to privileged EXEC mode from global

configuration mode, use the exit or end command,
or press Ctrl-Z.

Interface
configuration

Router(config-if)#
From global
configuration mode,
specify an interface using
an interface command.

To return to global configuration mode, use the exit

command.

>
From privileged EXEC
mode, use the reload
EXEC command. Press
the Break key during the
first 60 seconds while the
system is booting.

To exit ROM monitor mode, use the continue

command.

ROM monitor

To return to privileged EXEC mode, use the end

command, or press Ctrl-Z.

For more information on command modes, refer to the Using the Command-Line Interface chapter in
the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Getting Help
Entering a question mark (?) at the CLI prompt displays a list of commands available for each command
mode. You can also get a list of keywords and arguments associated with any command by using the
context-sensitive help feature.
To get help specific to a command mode, a command, a keyword, or an argument, use one of the
following commands:
Command

Purpose

help

Provides a brief description of the help system in any command mode.

abbreviated-command-entry?

Provides a list of commands that begin with a particular character string. (No space
between command and question mark.)

abbreviated-command-entry<Tab>

Completes a partial command name.

Lists all commands available for a particular command mode.

command ?

Lists the keywords or arguments that you must enter next on the command line.
(Space between command and question mark.)

Cisco IOS Configuration Fundamentals Command Reference

xiv

78-11740-02

Using Cisco IOS Software

Getting Help

Example: How to Find Command Options

This section provides an example of how to display syntax for a command. The syntax can consist of
optional or required keywords and arguments. To display keywords and arguments for a command, enter
a question mark (?) at the configuration prompt or after entering part of a command followed by a space.
The Cisco IOS software displays a list and brief description of available keywords and arguments. For
example, if you were in global configuration mode and wanted to see all the keywords or arguments for
the arap command, you would type arap ?.
The <cr> symbol in command help output stands for carriage return. On older keyboards, the carriage
return key is the Return key. On most modern keyboards, the carriage return key is the Enter key. The
<cr> symbol at the end of command help output indicates that you have the option to press Enter to
complete the command and that the arguments and keywords in the list preceding the <cr> symbol are
optional. The <cr> symbol by itself indicates that no more arguments or keywords are available and that
you must press Enter to complete the command.
Table 2 shows examples of how you can use the question mark (?) to assist you in entering commands.
The table steps you through configuring an IP address on a serial interface on a Cisco 7206 router that
is running Cisco IOS Release 12.0(3).
Table 2

How to Find Command Options

Command

Comment

Router> enable
Password: <password>
Router#

Enter the enable command and

password to access privileged EXEC
commands. You are in privileged
EXEC mode when the prompt changes
to Router#.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#

Enter the configure terminal

privileged EXEC command to enter
global configuration mode. You are in
global configuration mode when the
prompt changes to Router(config)#.

Router(config)# interface serial ?

<0-6>
Serial interface number
Router(config)# interface serial 4 ?
/
Router(config)# interface serial 4/ ?
<0-3>
Serial interface number
Router(config)# interface serial 4/0
Router(config-if)#

Enter interface configuration mode by

specifying the serial interface that you
want to configure using the interface
serial global configuration command.
Enter ? to display what you must enter
next on the command line. In this
example, you must enter the serial
interface slot number and port number,
separated by a forward slash.
You are in interface configuration mode
when the prompt changes to
Router(config-if)#.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

xv

Using Cisco IOS Software

Getting Help

Table 2

How to Find Command Options (continued)

Command

Comment

Router(config-if)# ?
Interface configuration commands:
.
.
.
ip
Interface Internet Protocol config commands
keepalive
Enable keepalive
lan-name
LAN Name command
llc2
LLC2 Interface Subcommands
load-interval
Specify interval for load calculation for an
interface
locaddr-priority
Assign a priority group
logging
Configure logging for interface
loopback
Configure internal loopback on an interface
mac-address
Manually set interface MAC address
mls
mls router sub/interface commands
mpoa
MPOA interface configuration commands
mtu
Set the interface Maximum Transmission Unit (MTU)
netbios
Use a defined NETBIOS access list or enable
name-caching
no
Negate a command or set its defaults
nrzi-encoding
Enable use of NRZI encoding
ntp
Configure NTP
.
.
.
Router(config-if)#

Enter ? to display a list of all the

interface configuration commands
available for the serial interface. This
example shows only some of the
available interface configuration
commands.

Router(config-if)# ip ?
Interface IP configuration subcommands:
access-group
Specify access control for packets
accounting
Enable IP accounting on this interface
address
Set the IP address of an interface
authentication
authentication subcommands
bandwidth-percent
Set EIGRP bandwidth limit
broadcast-address
Set the broadcast address of an interface
cgmp
Enable/disable CGMP
directed-broadcast Enable forwarding of directed broadcasts
dvmrp
DVMRP interface commands
hello-interval
Configures IP-EIGRP hello interval
helper-address
Specify a destination address for UDP broadcasts
hold-time
Configures IP-EIGRP hold time
.
.
.
Router(config-if)# ip

Enter the command that you want to

configure for the interface. This
example uses the ip command.
Enter ? to display what you must enter
next on the command line. This
example shows only some of the
available interface IP configuration
commands.

Cisco IOS Configuration Fundamentals Command Reference

xvi

78-11740-02

Using Cisco IOS Software

Using the no and default Forms of Commands

Table 2

How to Find Command Options (continued)

Command

Comment

Router(config-if)# ip address ?
A.B.C.D
IP address
negotiated
IP Address negotiated over PPP
Router(config-if)# ip address

Enter the command that you want to

configure for the interface. This
example uses the ip address command.
Enter ? to display what you must enter
next on the command line. In this
example, you must enter an IP address
or the negotiated keyword.
A carriage return (<cr>) is not
displayed; therefore, you must enter
additional keywords or arguments to
complete the command.
Enter the keyword or argument you
want to use. This example uses the
172.16.0.1 IP address.

Router(config-if)# ip address 172.16.0.1 ?

A.B.C.D
IP subnet mask
Router(config-if)# ip address 172.16.0.1

Enter ? to display what you must enter

next on the command line. In this
example, you must enter an IP subnet
mask.
A <cr> is not displayed; therefore, you
must enter additional keywords or
arguments to complete the command.
Router(config-if)# ip address 172.16.0.1 255.255.255.0 ?
secondary
Make this IP address a secondary address
<cr>
Router(config-if)# ip address 172.16.0.1 255.255.255.0

Enter the IP subnet mask. This example

uses the 255.255.255.0 IP subnet mask.
Enter ? to display what you must enter
next on the command line. In this
example, you can enter the secondary
keyword, or you can press Enter.
A <cr> is displayed; you can press
Enter to complete the command, or
you can enter another keyword.

Router(config-if)# ip address 172.16.0.1 255.255.255.0

Router(config-if)#

In this example, Enter is pressed to

complete the command.

Using the no and default Forms of Commands

Almost every configuration command has a no form. In general, use the no form to disable a function.
Use the command without the no keyword to reenable a disabled function or to enable a function that
is disabled by default. For example, IP routing is enabled by default. To disable IP routing, use the no
ip routing command; to reenable IP routing, use the ip routing command. The Cisco IOS software
command reference publications provide the complete syntax for the configuration commands and
describe what the no form of a command does.
Configuration commands also can have a default form, which returns the command settings to the
default values. Most commands are disabled by default, so in such cases using the default form has the
same result as using the no form of the command. However, some commands are enabled by default and

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

xvii

Using Cisco IOS Software

Saving Configuration Changes

have variables set to certain default values. In these cases, the default form of the command enables the
command and sets the variables to their default values. The Cisco IOS software command reference
publications describe the effect of the default form of a command if the command functions differently
than the no form.

Saving Configuration Changes

Use the copy system:running-config nvram:startup-config command to save your configuration
changes to the startup configuration so that the changes will not be lost if the software reloads or a
power outage occurs. For example:
Router# copy system:running-config nvram:startup-config
Building configuration...

It might take a minute or two to save the configuration. After the configuration has been saved, the
following output appears:
[OK]
Router#

On most platforms, this task saves the configuration to NVRAM. On the Class A Flash file system
platforms, this task saves the configuration to the location specified by the CONFIG_FILE environment
variable. The CONFIG_FILE variable defaults to NVRAM.

Filtering Output from the show and more Commands

In Cisco IOS Release 12.0(1)T and later releases, you can search and filter the output of show and more
commands. This functionality is useful if you need to sort through large amounts of output or if you
want to exclude output that you need not see.
To use this functionality, enter a show or more command followed by the pipe character (|); one of
the keywords begin, include, or exclude; and a regular expression on which you want to search or filter
(the expression is case-sensitive):
command | {begin | include | exclude} regular-expression
The output matches certain lines of information in the configuration file. The following example
illustrates how to use output modifiers with the show interface command when you want the output to
include only lines in which the expression protocol appears:
Router# show interface | include protocol
FastEthernet0/0 is up, line protocol is up
Serial4/0 is up, line protocol is up
Serial4/1 is up, line protocol is up
Serial4/2 is administratively down, line protocol is down
Serial4/3 is administratively down, line protocol is down

For more information on the search and filter functionality, refer to the Using the Command-Line
Interface chapter in the Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

xviii

78-11740-02

Using Cisco IOS Software

Identifying Supported Platforms

Identifying Supported Platforms

Cisco IOS software is packaged in feature sets consisting of software images that support specific
platforms. The feature sets available for a specific platform depend on which Cisco IOS software
images are included in a release. To identify the set of software images available in a specific release
or to find out if a feature is available in a given Cisco IOS software image, see the following sections:

Using Feature Navigator

Using Software Release Notes

Using Feature Navigator

Feature Navigator is a web-based tool that enables you to quickly determine which Cisco IOS software
images support a particular set of features and which features are supported in a particular Cisco IOS
image.
Feature Navigator is available 24 hours a day, 7 days a week. To access Feature Navigator, you must
have an account on Cisco.com. If you have forgotten or lost your account information, e-mail the
Contact Database Administration group at [email protected]. If you do not have an account on
Cisco.com, go to http://www.cisco.com/register and follow the directions to establish an account.
To use Feature Navigator, you must have a JavaScript-enabled web browser such as Netscape 3.0 or
later, or Internet Explorer 4.0 or later. Internet Explorer 4.0 always has JavaScript enabled. To enable
JavaScript for Netscape 3.x or Netscape 4.x, follow the instructions provided with the web browser. For
JavaScript support and enabling instructions for other browsers, check with the browser vendor.
Feature Navigator is updated when major Cisco IOS software releases and technology releases occur.
You can access Feature Navigator at the following URL:
http://www.cisco.com/go/fn

Using Software Release Notes

Cisco IOS software releases include release notes that provide the following information:

Platform support information

Memory recommendations

Microcode support information

Feature set tables

Feature descriptions

Open and resolved severity 1 and 2 caveats for all platforms

Release notes are intended to be release-specific for the most current release, and the information
provided in these documents may not be cumulative in providing information about features that first
appeared in previous releases.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

xix

Using Cisco IOS Software

Identifying Supported Platforms

Cisco IOS Configuration Fundamentals Command Reference

xx

78-11740-02

Cisco IOS User Interface Commands

Basic Command-Line Interface Commands

This chapter describes the commands used to enter and exit the various Cisco IOS configuration
command modes. It provides a description of help features, command-line interface (CLI) navigation
commands, and the command history feature.
The CLI allows you to enter partial Cisco IOS configuration commands. The software recognizes a
command when you enter enough characters of the command to uniquely identify it.
For user interface task information and examples, see the Using the Command-Line Interface chapter
of the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-3

Basic Command-Line Interface Commands

disable

disable
To exit privileged EXEC mode and return to user EXEC mode, or to exit to a lower privilege level, enter
the disable EXEC command.
disable [privilege-level]

Syntax Description

privilege-level

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

(Optional) Specific privilege level (other than user EXEC mode).

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.

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>

Related Commands

Command

Description

enable

Enables higher privilege level access, such as privileged EXEC mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-4

78-11740-02

Basic Command-Line Interface Commands

editing

editing
To reenable Cisco IOS enhanced editing features for a particular line after they have been disabled, use
the editing line configuration command. To disable these features, use the no form of this command.
editing
no editing

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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.
Table 3 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 (Table 3), characters are bolded in the
Function Summary column to indicate the relation between the letter used and the function.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-5

Basic Command-Line Interface Commands

editing

Table 3

Command Editing Keys and Functions

Keys

Function Summary

Function Details

Tab

Complete command

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.

Return
(at the command
line)

Execute

Executes the command.

Return
(at the --More-prompt)

Continue

Displays the next line of output.

Space Bar
(at the --More-prompt)

Continue

Displays the next screen of output. The amount of

output you see will depend on the screen depth
setting of your terminal.

Delete or
Backspace

Backspace

Erases the character to the left of the cursor.

Left Arrow1 or
Ctrl-B

Back character

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.

Right Arrow1 or
Ctrl-F

Forward character

Moves the cursor one character to the right.

Esc, B

Back word

Moves the cursor back one word.

Esc, F

Forward word

Moves the cursor forward one word.

Ctrl-A

Beginning of line

Moves the cursor to the beginning of the line.

Ctrl-E

End of line

Moves the cursor to the end of the command line.

Ctrl-D

Delete character

Deletes the character at the cursor.

Esc, D

Delete next word

Deletes from the cursor to the end of the word .

Ctrl-W

Delete previous word

Deletes the word to the left of the cursor.

Ctrl-K

Delete line forward

Deletes all characters from the cursor to the end of

the command line.

Ctrl-U or Ctrl-X

Delete line backward

Deletes all characters from the cursor back to the

beginning of the command line.

Ctrl-T

Transpose characters

Transposes the character to the left of the cursor with

the character located at the cursor.

Cisco IOS Configuration Fundamentals Command Reference

FR-6

78-11740-02

Basic Command-Line Interface Commands

editing

Table 3

Command Editing Keys and Functions (continued)

Keys

Function Summary

Function Details

Ctrl-R or Ctrl-L

Redisplay line

Redisplays the system prompt and command line.

Ctrl-V or Esc, Q

Ignore editing

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.

Up Arrow1 or
Ctrl-P

Previous command

Recalls commands in the history buffer, beginning

with the most recent command. Repeat the key
sequence to recall successively older commands.

Down Arrow1 or
Ctrl-N (next)

Next command

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.

Ctrl-Y

Recall last deleted

command

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.

Esc, Y

Recall next deleted

command

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.

Esc, C

Capitalize word

Capitalizes the word from the cursor to the end of the

word.

Esc, U

Make word uppercase

Changes all letters from the cursor to the next space

on the line appear in uppercase letters.

Esc, L

Make word lowercase

Changes the word to lowercase from the cursor to the

end of the word.

1. The arrow keys function only with ANSI-compatible terminals.

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

Description

terminal editing

Controls CLI enhanced editing feature for the current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-7

Basic Command-Line Interface Commands

enable

enable
To enter privileged EXEC mode, or any other security level set by a system administrator, use the enable
EXEC command.
enable [privilege-level]

Syntax Description

privilege-level

Defaults

Privilege-level 15 (privileged EXEC)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

(Optional) Privilege level at which to log in.

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 it before being allowed access to privileged
EXEC mode. The password is case sensitive.
If an enable password has not been set, enable mode only 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 Passwords and Privileges chapters of the
Cisco IOS Security 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).

Cisco IOS Configuration Fundamentals Command Reference

FR-8

78-11740-02

Basic Command-Line Interface Commands

enable

Examples

In the following example, the user enters privileged EXEC mode using the enable command. 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 >, and the prompt for privileged EXEC mode is #.
Router> enable
Password: <letmein>
Router# disable
Router>

Related Commands

Command

Description

disable

Exits from privileged EXEC mode to user EXEC mode, or, if privilege
levels are set, to the specified privilege level.

enable password

Sets a local password to control access to various privilege levels.

privilege level (global)

Sets a privilege level for a command.

privilege level (line)

Sets a privilege level for a command for a specific line.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-9

Basic Command-Line Interface Commands

end

end
To end the current configuration session and return to privileged EXEC mode, use the end global
configuration command.
end

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

This command will bring you back to privileged EXEC mode regardless of what configuration mode or
configuration submode you are in.

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

Related Commands

Command

Description

exit (global)

Exits from the current configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-10

78-11740-02

Basic Command-Line Interface Commands

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.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use the exit (EXEC) command in EXEC mode to exit the active session (log off the device).

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

Description

disconnect

Disconnects a line.

end

Exits configuration mode, or any of the configuration submodes.

exit (global)

Exits from the current configuration mode to the next highest configuration
mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-11

Basic Command-Line Interface Commands

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.

Defaults

No default behavior or values

Command Modes

All configuration modes

Command History

Release

Modification

10.0

This command was introduced.

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 displays an exit from the subinterface configuration mode 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)#

Related Commands

Command

Description

disconnect

Disconnects a line.

end

Exits from any configuration mode to privileged EXEC mode.

exit (EXEC)

Closes the active terminal session by logging off the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-12

78-11740-02

Basic Command-Line Interface Commands

full-help

full-help
To get help for the full set of user-level commands, use the full-help line configuration command.
full-help

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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
calendar
clock
context
dialer
history
hosts
isdn
kerberos
modemcap
ppp
rmon
sessions
snmp
terminal
users
version

Boot Flash information

Display the hardware calendar
Display the system clock
Show context information
Dialer parameters and statistics
Display the session command history
IP domain-name, lookup style, nameservers, and host table
ISDN information
Show Kerberos Values
Show Modem Capabilities database
PPP parameters and statistics
rmon statistics
Information about Telnet connections
snmp statistics
Display terminal configuration parameters
Display information about terminal lines
System hardware and software status

Router> enable
Password:<letmein>

Router# configure terminal

Enter configuration commands, one per line.

End with CNTL/Z.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-13

Basic Command-Line Interface Commands

full-help

Router(config)# line console 0

Router(config-line)# full-help
Router(config-line)# ^Z
Router#
%SYS-5-CONFIG_I: Configured from console by console
Router# disable
Router> show ?
access-expression
access-lists
aliases
apollo
appletalk
arp
async
bootflash
bridge
bsc
bstun
buffers
calendar

List access expression

List access lists
Display alias commands
Apollo network information
AppleTalk information
ARP table
Information on terminal lines used as router interfaces
Boot Flash information
Bridge Forwarding/Filtering Database [verbose]
BSC interface information
BSTUN interface information
Buffer pool statistics
Display the hardware calendar

translate
ttycap
users
version
vines
vlans
whoami
x25
xns
xremote

Protocol translation information

Terminal capability tables
Display information about terminal lines
System hardware and software status
VINES information
Virtual LANs Information
Info on current tty line
X.25 information
XNS information
XRemote statistics

.
.
.

Related Commands

Command

Description

help

Displays a brief description of the help system.

Cisco IOS Configuration Fundamentals Command Reference

FR-14

78-11740-02

Basic Command-Line Interface Commands

help

help
To display a brief description of the help system, enter the help command.
help

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

All command modes

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

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.

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
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?'.)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-15

Basic Command-Line Interface Commands

help

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
Router# co

copy

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 Return 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

Description

full-help

Gets help for the full set of user-level commands.

Cisco IOS Configuration Fundamentals Command Reference

FR-16

78-11740-02

Basic Command-Line Interface Commands

history

history
To enable the command history function, use the history line configuration command. To disable the
command history feature, use the no form of this command.
history
no history

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled, ten command lines in buffer

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The command history feature provides a record of EXEC commands that you have entered. This feature
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 feature.
The show history EXEC command will list the commands you have entered, but you can also use your
keyboard to display individual commands. Table 4 lists the keys you can use to recall commands from
the command history buffer.
Table 4

History Keys

Key(s)
Ctrl-P or Up Arrow

Functions
1

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.

Ctrl-N or Down Arrow1 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.
1. The arrow keys function only with ANSI-compatible terminals.

Examples

In the following example, line 4 is configured with a history buffer size of 35 lines:
Router(config)# line 4

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-17

Basic Command-Line Interface Commands

history

Router(config-line)# history size 35

Related Commands

Command

Description

history size

Sets the command history buffer size for a particular line.

show history

Lists the commands you have entered in the current EXEC session.

terminal history

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

FR-18

78-11740-02

Basic Command-Line Interface Commands

history size

history size
To change the command history buffer size for a particular line, use the history size line configuration
command. 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

Defaults

Ten command lines

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

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 ten.

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.

The history size command only sets the size of the buffer; it does not reenable the history feature. If
the no history command is used, the history command must be used to reenable this feature.

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

Related Commands

Command

Description

history

Enables or disables the command history function.

show history

Lists the commands you have entered in the current EXEC session.

terminal history size

Enables the command history function 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

78-11740-02

FR-19

Basic Command-Line Interface Commands

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.

Defaults

No default behavior or values.

Command Modes

User EXEC

Command History

Release

Modification

10.0

This command was introduced.

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

Related Commands

Command

Description

exit (global)

Exits any configuration mode to the next highest mode in the CLI mode
hierarchy.

Cisco IOS Configuration Fundamentals Command Reference

FR-20

78-11740-02

Basic Command-Line Interface Commands

menu (EXEC)

menu (EXEC)
To display a preconfigured user menu, use the menu command in user or privileged EXEC mode.
menu menu-name

Syntax Description

menu-name

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The name of the menu.

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. The description of these commands can be found in the Connection, Menu, and
System Banner Commands chapter of this document.
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

UNIX Internet access

Resume UNIX connection

Resume next connection

Exit menu system

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-21

Basic Command-Line Interface Commands

menu (EXEC)

Related Commands

Command

Description

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user interface menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an option number.

menu options

Sets options for items in user interface menus.

menu prompt

Specifies the prompt for a user interface menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu text

Specifies the text of a menu item in a user interface menu.

menu title

Creates a title, or banner, for a user menu.

no menu

Deletes a specified menu from a menu configuration.

Cisco IOS Configuration Fundamentals Command Reference

FR-22

78-11740-02

Basic Command-Line Interface Commands

more begin

more begin
To search the output of any more command, use the more 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 file-url | begin regular-expression

Syntax Description

file-url

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.

regular-expression

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

EXEC

Command History

Release

Usage Guidelines

Modification

11.3 AA

The more command was introduced.

12.0(1)T

This extension of the more command was introduced.

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-23

Basic Command-Line Interface Commands

more begin

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 | begin command 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

Description

more exclude

Filters more command output so that it excludes lines that contain a

particular regular expression.

more include

Filters more command output so that it displays only lines that contain a
particular regular expression.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show exclude

Filters show command output so that it excludes lines that contain a

particular regular expression.

show include

Filters show command output so that it displays only lines that contain a
particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-24

78-11740-02

Basic Command-Line Interface Commands

more exclude

more exclude
To filter more command output so that it excludes lines that contain a particular regular expression, use
the more exclude command in EXEC mode.
more file-url | exclude regular-expression

Syntax Description

file-url

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.

regular-expression

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

Modification

11.3 AA

The more command was introduced.

12.0(1)T

This extension of the more command was introduced.

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 | exclude command. 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
!

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-25

Basic Command-Line Interface Commands

more exclude

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

Description

more begin

Begins unfiltered output of the more command with the first line that
contains the regular expression you specify.

more include

Filters more command output so that it displays only lines that contain a
particular regular expression.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show exclude

Filters show command output so that it excludes lines that contain a

particular regular expression.

show include

Filters show command output so that it displays only lines that contain a
particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-26

78-11740-02

Basic Command-Line Interface Commands

more include

more include
To filter more command output so that it displays only lines that contain a particular regular expression,
use the more include command in EXEC mode.
more file-url | include regular-expression

Syntax Description

file-url

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.

regular-expression

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

Modification

11.3 AA

The more command was introduced.

12.0(1)T

This extension of the more command was introduced.

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.

Examples

The following is partial sample output of the more nvram:startup-config | include command. 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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-27

Basic Command-Line Interface Commands

more include

Related Commands

Command

Description

more begin

Begins unfiltered output of the more command with the first line that
contains the regular expression you specify.

more exclude

Filters more command output so that it excludes lines that contain a

particular regular expression.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show exclude

Filters show command output so that it excludes lines that contain a

particular regular expression.

show include

Filters show command output so that it displays only lines that contain a
particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-28

78-11740-02

Basic Command-Line Interface Commands

show begin

show begin
To begin the output of any show command from a specified string, use the show begin command in
EXEC mode.
show any-command | begin regular-expression

Syntax Description

any-command

Any supported show command.

A vertical bar (the pipe symbol) indicates that an output processing

specification follows.

regular-expression

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 case-sensitive. 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

Usage Guidelines

Modification

8.3

The show command was introduced.

12.0(1)T

This extension of the show command was introduced.

The regular-expression argument 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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-29

Basic Command-Line Interface Commands

show begin

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

Examples

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.

The following is partial sample output of the show interface | begin command 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

Related Commands

Command

Description

more begin

Begins unfiltered output of the more command with the first line that
contains the regular expression you specify.

more exclude

Filters more command output so that it excludes lines that contain a

particular regular expression.

more include

Filters more command output so that it displays only lines that contain a
particular regular expression.

show exclude

Filters show command output so that it excludes lines that contain a

particular regular expression.

show include

Filters show command output so that it displays only lines that contain a
particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-30

78-11740-02

Basic Command-Line Interface Commands

show exclude

show exclude
To filter show command output so that it excludes lines that contain a particular regular expression, use
the show exclude command in EXEC mode.
show any-command | exclude regular-expression

Syntax Description

any-command

Any supported show command.

A vertical bar (the pipe symbol) indicates that an output processing

specification follows.

regular-expression

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

Modification

8.3

The show command was introduced.

12.0(1)T

This extension of the show command was introduced.

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.

Note

Examples

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.

The following is partial sample output of the show | exclude command used with the show buffers
command. 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:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-31

Basic Command-Line Interface Commands

show exclude

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

Description

more begin

Begins unfiltered output of the more command with the first line that
contains the regular expression you specify.

more exclude

Filters more command output so that it excludes lines that contain a

particular regular expression.

more include

Filters more command output so that it displays only lines that contain a
particular regular expression.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show include

Filters show command output so that it displays only lines that contain a
particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-32

78-11740-02

Basic Command-Line Interface Commands

show history

show history
To list the commands you have entered in the current EXEC session, use the show history EXEC
command.
show history

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

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.
Table 5 lists the keys and functions you can use to recall commands from the command history buffer.
Table 5

History Keys

Key
Ctrl-P or Up Arrow

Function
1

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.

Ctrl-N or Down Arrow1 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.
1. The arrow keys function only with ANSI-compatible terminals.

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#

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-33

Basic Command-Line Interface Commands

show history

Related Commands

Command

Description

history size

Enables the command history function, or changes the command history

buffer size for a particular line.

terminal history size

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

FR-34

78-11740-02

Basic Command-Line Interface Commands

show include

show include
To filter show command output so that it only displays lines that contain a particular regular expression,
use the show include command in EXEC mode.
show any-command | include regular-expression

Syntax Description

any-command

Any supported show command.

A vertical bar (the pipe symbol) indicates that an output processing

specification follows.

regular-expression

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

Modification

8.3

The show command was introduced.

12.0(1)T

This extension of the show command was introduced.

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.

Note

Examples

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.

The following is partial sample output of the show interface | include command. 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 )

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-35

Basic Command-Line Interface Commands

show include

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

Description

more begin

Begins unfiltered output of the more command with the first line that
contains the regular expression you specify.

more exclude

Filters more command output so that it excludes lines that contain a

particular regular expression.

more include

Filters more command output so that it displays only lines that contain a
particular regular expression.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show exclude

Filters show command output so that it excludes lines that contain a

particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

FR-36

78-11740-02

Basic Command-Line Interface Commands

terminal editing

terminal editing
To reenable the enhanced editing mode for only the current terminal session, use the terminal editing
EXEC command. To disable the enhanced editing mode on the current line, use the no form of this
command.
terminal editing
terminal no editing

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command is identical to the editing EXEC mode command, except that it controls (enables or
disables) enhanced editing for only the terminal session you are using. For a description of the available
editing keys, see the description of the editing command in this chapter.

Examples

In the following example, enhanced editing mode is reenabled for only the current terminal session:
Router> terminal editing

Related Commands

Command

Description

editing

Controls CLI enhanced editing features for a particular line.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-37

Basic Command-Line Interface Commands

terminal full-help

terminal full-help
To get help for the full set of user-level commands, use the terminal full-help EXEC mode command.
terminal full-help

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The terminal full-help command enables a user to see all of the help messages available from the
terminal. It is used with the show ? command.

Examples

In the following example, the difference between the output of the show ? command before and after
using the terminal full-help command is shown:
Router> show ?
bootflash
calendar
clock
context
dialer
history
hosts
isdn
kerberos
modemcap
ppp
rmon
sessions
snmp
terminal
users
version

Boot Flash information

Display the hardware calendar
Display the system clock
Show context information
Dialer parameters and statistics
Display the session command history
IP domain-name, lookup style, nameservers, and host table
ISDN information
Show Kerberos Values
Show Modem Capabilities database
PPP parameters and statistics
rmon statistics
Information about Telnet connections
snmp statistics
Display terminal configuration parameters
Display information about terminal lines
System hardware and software status

Router> terminal full-help

Router> show ?
access-expression
access-lists
aliases
apollo

List access expression

List access lists
Display alias commands
Apollo network information

Cisco IOS Configuration Fundamentals Command Reference

FR-38

78-11740-02

Basic Command-Line Interface Commands

terminal full-help

appletalk
arp
async
bootflash
bridge
bsc
bstun
buffers
calendar
cdp
clns
clock
cls
cmns
compress
.
.
.
x25
xns
xremote

Related Commands

AppleTalk information
ARP table
Information on terminal lines used as router interfaces
Boot Flash information
Bridge Forwarding/Filtering Database [verbose]
BSC interface information
BSTUN interface information
Buffer pool statistics
Display the hardware calendar
CDP information
CLNS network information
Display the system clock
DLC user information
Connection-Mode networking services (CMNS) information
Show compression statistics.

X.25 information
XNS information
XRemote statistics

Command

Description

full-help

Gets help for the full set of user-level commands.

help

Displays a brief description of the help system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-39

Basic Command-Line Interface Commands

terminal history

terminal history
To enable the command history feature for the current terminal session, use the terminal history
command in user EXEC mode or privileged EXEC mode. To disable the command history feature, use
the no form of this command.
terminal history
terminal no history

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled, history buffer of 10 lines

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The history feature provides a record of commands you have entered. This feature is particularly useful
for recalling long or complex commands or entries for the purposes of modifying them slightly and
reexecuting them.
The terminal history command enables the command history feature with the default buffer size or the
last buffer size specified using the terminal history size command.
Table 6 lists the keys and functions you can use to recall commands from the history buffer.
Table 6

History Keys

Key(s)
Ctrl-P or Up Arrow

Function
1

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.

Ctrl-N or Down Arrow1 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.
1. The arrow keys function only with ANSI-compatible terminals.

Examples

In the following example, the command history feature is disabled for the current terminal session:
Router> terminal no history

Cisco IOS Configuration Fundamentals Command Reference

FR-40

78-11740-02

Basic Command-Line Interface Commands

terminal history

Related Commands

Command

Description

history

Enables the command history function, or changes the command history

buffer size for a particular line.

show history

Lists the commands you have entered in the current EXEC session.

terminal history size

Sets the size of the history buffer for the command history feature for the
current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-41

Basic Command-Line Interface Commands

terminal history size

terminal history size

To change the size of the command history buffer for the current terminal session, use the terminal
history size EXEC mode command. To reset the command history buffer to its default size of 10 lines,
use the no form of this command.
terminal history size number-of-lines
terminal no history size

Syntax Description

number-of-lines

Defaults

10 lines of command history

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Number of command lines that the system will record in its history
buffer. The range is from 0 to 256. The default is 10.

The history feature provides a record of commands you have entered. This feature is particularly useful
for recalling long or complex commands or entries for the purposes of modifying them slightly and
reissuing them.
The terminal history size command enables the command history feature and sets the command history
buffer size. The terminal no history size command resets the buffer size to the default of 10 command
lines.
Table 6 lists the keys and functions you can use to recall commands from the history buffer. When you
use these keys, the commands recalled will be from EXEC mode if you are in EXEC mode, or from all
configuration modes if you are in any configuration mode.
Table 7

History Keys

Key
Ctrl-P or Up Arrow

Function
1

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.

Ctrl-N or Down Arrow1 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.
1. The arrow keys function only with ANSI-compatible terminals.

Cisco IOS Configuration Fundamentals Command Reference

FR-42

78-11740-02

Basic Command-Line Interface Commands

terminal history size

In EXEC mode, you can also use the show history command to show the contents of the command
history buffer.
To check the current settings for the command history feature on your line, use the show line command.

Examples

In the following example, the number of command lines recorded is set to 15 for the current terminal
session. The user then checks to see what line he/she is connected to using the show users command.
The user uses this line information to issue the show line command. (In this example, the user uses the
show begin option in the show line command to start the output at the Editing is enabled/disabled
line.)
Router# terminal history size 15
Router# show users
Line
User
Host(s)
Idle
Location
* 50 vty 0
admin
idle
00:00:00
! the * symbol indicates the active terminal session for the user (line 50)
Router# show line 50 | begin Editing
Editing is enabled.
! the following line shows the history settings for the line
History is enabled, history size is 15.
DNS resolution in show commands is enabled
Full user help is disabled
Allowed transports are telnet. Preferred is none.
No output characters are padded
No special data dispatching characters

Related Commands

Command

Description

history

Enables the command history function, or changes the command history

buffer size for a particular line.

show begin

Searches the output of any show command and displays the output from the
first instance of a specified string.

show history

Lists the commands you have entered in the current EXEC session.

terminal history

Enables the command history feature for the current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-43

Basic Command-Line Interface Commands

terminal history size

Cisco IOS Configuration Fundamentals Command Reference

FR-44

78-11740-02

The Setup Command

The Using AutoInstall and Setup chapter of the Release 12.2 Cisco IOS Configuration Fundamentals
Configuration Guide describes the tasks associated with using the AutoInstall and Setup features.
The AutoInstall process does not require you to use any commands on the new routing device. Therefore,
this chapter discusses only the setup command, which is used to enter Setup mode.
To locate documentation of other commands that appear in the Using AutoInstall and Setup chapter,
use the Cisco IOS Command Reference Master Index or search online.
Setup is an interactive Cisco IOS software feature that allows you to perform first-time configuration or
other basic configuration procedures on all Cisco devices. Setup mode guides you through the
configuration process by prompting you for the information required to make the routing device
function in the network.
While the use of the setup command is a quick way to set up a Cisco device, you can also use it after
first-time startup to perform configuration changes. This chapter focuses on using the setup command
after first-time startup.
Refer to the hardware-specific documentation that came with your platform for details on how to use
Setup mode for first-time startup.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-45

The Setup Command

setup

setup
To enter Setup mode, use the setup privileged EXEC command.
setup

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Setup mode gives you the option of configuring your system without using the Cisco IOS 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 Setup 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 Setup, 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 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-46

78-11740-02

The Setup Command

setup

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 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 answer
Yes, 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.

Examples

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
Ethernet0
Serial0
Serial1

IP-Address
172.16.72.2
unassigned
172.16.72.2

OK?
YES
YES
YES

Method
manual
not set
not set

Status
up
administratively down
up

Protocol
up
down
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]:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-47

The Setup Command

setup

Configure Async lines? [yes]:

Async line speed [9600]: 57600
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]:

Cisco IOS Configuration Fundamentals Command Reference

FR-48

78-11740-02

The Setup Command

setup

Default client IP address for

Configuring interface Async3:
IPX network number [6]:
Default client IP address for
Configuring interface Async4:
IPX network number [7]:
Default client IP address for
Configuring interface Async5:
IPX network number [8]:
Default client IP address for
Configuring interface Async6:
IPX network number [9]:
Default client IP address for
Configuring interface Async7:
IPX network number [A]:
Default client IP address for
Configuring interface Async8:
IPX network number [B]:
Default client IP address for
Configuring interface Async9:
IPX network number [C]:
Default client IP address for
Configuring interface Async10:
IPX network number [D]:
Default client IP address for
Configuring interface Async11:
IPX network number [E]:
Default client IP address for
Configuring interface Async12:
IPX network number [F]:
Default client IP address for
Configuring interface Async13:
IPX network number [10]:
Default client IP address for
Configuring interface Async14:
IPX network number [11]:
Default client IP address for
Configuring interface Async15:
IPX network number [12]:
Default client IP address for
Configuring interface Async16:
IPX network number [13]:
Default client IP address for

this interface [172.16.72.5]:

this interface [172.16.72.6]:

this interface [172.16.72.7]:

this interface [172.16.72.8]:

this interface [172.16.72.9]:

this interface [172.16.72.10]:

this interface [172.16.72.11]:

this interface [172.16.72.12]:

this interface [172.16.72.13]:

this interface [172.16.72.14]:

this interface [172.16.72.15]:

this interface [172.16.72.16]:

this interface [172.16.72.17]:

this interface [172.16.72.18]:

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-49

The Setup Command

setup

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
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

Cisco IOS Configuration Fundamentals Command Reference

FR-50

78-11740-02

The Setup Command

setup

peer default ip address

async mode interactive
!
Interface Async6
ipx network 9
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async7
ipx network A
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async8
ipx network B
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async9
ipx network C
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async10
ipx network D
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async11
ipx network E
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async12
ipx network F
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async13
ipx network 10
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async14
ipx network 11
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async15
ipx network 12
ip unnumbered Ethernet0
peer default ip address
async mode interactive
!
Interface Async16

172.16.72.8

172.16.72.9

172.16.72.10

172.16.72.11

172.16.72.12

172.16.72.13

172.16.72.14

172.16.72.15

172.16.72.16

172.16.72.17

172.16.72.18

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-51

The Setup Command

setup

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

Description

erase nvram:

Erases a file system.

show running-config

Displays the running configuration file. Command alias for the

more system:running-config command.

show startup-config

Displays the startup configuration file. Command alias for the more
system:startup-config command.

show version

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

FR-52

78-11740-02

Terminal Operating Characteristics Commands

This chapter describes the commands used to control terminal operating characteristics.
For terminal operating characteristic task information and examples, refer to the Configuring Operating
Characteristics for Terminals chapter in the Release 12.2 Cisco IOS Configuration Fundamentals
Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-53

Terminal Operating Characteristics Commands

activation-character

activation-character
To define the character you enter at a vacant terminal to begin a terminal session, use the
activation-character line configuration command. 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

Defaults

Return (decimal 13)

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

Decimal representation of the activation character.

See the ASCII Character Set and Hex Values appendix for a list of ASCII characters.

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

The following example sets 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

FR-54

78-11740-02

Terminal Operating Characteristics Commands

autobaud

autobaud
To set the line for automatic baud rate detection (autobaud), use the autobaud line configuration
command. To disable automatic baud detection, use the no form of this command.
autobaud
no autobaud

Syntax Description

This command has no arguments or keywords.

Defaults

Autobaud detection disabled. Fixed line speed of 9600 bps.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

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).

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

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

78-11740-02

FR-55

Terminal Operating Characteristics Commands

buffer-length

buffer-length
To specify the maximum length of the data stream to be forwarded, use the buffer-length command in
line configuration mode. To restore the default setting, use the no form of this command.
buffer-length length
no buffer-length

Syntax Description

length

Defaults

1536 bytes

Command Modes

Line configuration

Command History

Release

Modification

12.1

This command was introduced.

Specifies the length of the buffer in bytes. Valid values for the length argument
range from 16 to 1536. The default buffer length is 1536 bytes.

Usage Guidelines

The buffer-length command configures the size of the forwarded data stream. The higher the value used
for the length argument is, the longer the delay between data transmissions will be. Configuring a smaller
buffer length can prevent connections from timing out inappropriately.

Examples

The following example configures a buffer length of 500 bytes:

buffer-length 500

Cisco IOS Configuration Fundamentals Command Reference

FR-56

78-11740-02

Terminal Operating Characteristics Commands

databits

databits
To set the number of data bits per character that are interpreted and generated by the router hardware,
use the databits line configuration command. 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.

Defaults

Eight data bits per character

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

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.

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

Related Commands

Command

Description

data-character-bits

Sets the number of data bits per character that are interpreted and
generated by the Cisco IOS software.

terminal databits

Changes the number of data bits per character for the current
terminal line for this session.

terminal data-character-bits

Sets the number of data bits per character that are interpreted and
generated by the Cisco IOS software for the current line and session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-57

Terminal Operating Characteristics Commands

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-bits line configuration command. 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.

Defaults

Eight data bits per character

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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 1:
Router(config)# line vty 1
Router(config-line)# data-character-bits 7

Related Commands

Command

Description

terminal data-character-bits

Sets the number of data bits per character that are interpreted and
generated by the Cisco IOS software for the current line and session.

Cisco IOS Configuration Fundamentals Command Reference

FR-58

78-11740-02

Terminal Operating Characteristics Commands

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
global configuration command. 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.

Defaults

7-bit ASCII character set

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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 help command.

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

Related Commands

Command

Description

default-value special-character-bits

Configures the flow control default value from a 7-bit width

to an 8-bit width.

exec-character-bits

Configures the character widths of EXEC and configuration

command characters.

length

Sets the terminal screen length.

terminal exec-character-bits

Locally changes the ASCII character set used in EXEC and

configuration command characters for the current session.

terminal special-character-bits

Changes the ASCII character widths to accept special

characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-59

Terminal Operating Characteristics Commands

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 global configuration command. To restore the default value, use the no form of
this command.
default-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.

Defaults

7-bit character set

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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

Description

default-value exec-character-bits

Defines the EXEC character width for either 7 bits or 8 bits.

exec-character-bits

Configures the character widths of EXEC and configuration

command characters.

length

Sets the terminal screen length.

terminal exec-character-bits

Locally changes the ASCII character set used in EXEC and

configuration command characters for the current session.

terminal special-character-bits

Changes the ASCII character widths to accept special

characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

FR-60

78-11740-02

Terminal Operating Characteristics Commands

disconnect-character

disconnect-character
To define a character to disconnect a session, use the disconnect-character line configuration
command. To remove the disconnect character, use the no form of this command.
disconnect-character ascii-number
no disconnect-character

Syntax Description

ascii-number

Defaults

No disconnect character is defined.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Decimal representation of the session disconnect character.

See theASCII 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

78-11740-02

FR-61

Terminal Operating Characteristics Commands

dispatch-character

dispatch-character
To define a character that causes a packet to be sent, use the dispatch-character line configuration
command. To remove the definition of the specified dispatch character, use the no form of this command.
dispatch-character ascii-number1 [ascii-number2 . . . ascii-number]
no dispatch-character ascii-number1 [ascii-number2 . . . ascii-number]

Syntax Description

ascii-number1

Decimal representation of the desired dispatch character.

ascii-number2 . . . ascii-number

(Optional) Additional decimal representations of characters. This

syntax indicates that you can define any number of characters as
dispatch characters.

Defaults

No dispatch character is defined.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

See theASCII 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.

Examples

The following example defines the Return character (decimal 13) as the dispatch character for vty line 4:
Router(config)# line vty 4
Router(config-line)# dispatch-character 13

Related Commands

Command

Description

dispatch-machine

Specifies an identifier for a TCP packet dispatch state machine on a

particular line.

dispatch-timeout

Sets the character dispatch timer.

Cisco IOS Configuration Fundamentals Command Reference

FR-62

78-11740-02

Terminal Operating Characteristics Commands

dispatch-character

Command

Description

state-machine

Specifies the transition criteria for the state of a particular state

machine.

terminal dispatch-character

Defines a character that causes a packet to be sent for the current

session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-63

Terminal Operating Characteristics Commands

dispatch-machine

dispatch-machine
To specify an identifier for a TCP packet dispatch state machine on a particular line, use the
dispatch-machine line configuration command. 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

Defaults

No dispatch state machine identifier is defined.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Name of the state machine that determines when to send packets on

the asynchronous line.

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 linefeed for 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
Router(config)# line 1
Router(config-line)# dispatch-machine linefeed

Related Commands

Command

Description

dispatch-character

Defines a character that causes a packet to be sent.

dispatch-timeout

Sets the character dispatch timer.

state-machine

Specifies the transition criteria for the state of a particular state machine.

Cisco IOS Configuration Fundamentals Command Reference

FR-64

78-11740-02

Terminal Operating Characteristics Commands

dispatch-timeout

dispatch-timeout
To set the character dispatch timer, use the dispatch-timeout line configuration command. To remove
the timeout definition, use the no form of this command.
dispatch-timeout milliseconds
no dispatch-timeout

Syntax Description

milliseconds

Defaults

No dispatch timeout is defined.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

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.

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-timeout and 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.

Note

Examples

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.

The following example sets the dispatch timer to 80 milliseconds for vty lines 0 through 4:
Router(config)# line vty 0 4
Router(config-line)# dispatch-timeout 80

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-65

Terminal Operating Characteristics Commands

dispatch-timeout

Related Commands

Command

Description

dispatch-character

Defines a character that causes a packet to be sent.

dispatch-machine

Specifies an identifier for a TCP packet dispatch state machine on a

particular line.

state-machine

Specifies the transition criteria for the state of a particular state

machine.

terminal dispatch-timeout

Sets the character dispatch timer for the current session.

Cisco IOS Configuration Fundamentals Command Reference

FR-66

78-11740-02

Terminal Operating Characteristics Commands

escape-character

escape-character
To define a system escape character, use the escape-character line configuration command. To set the
escape character to Break, use the no or default form of this command.
escape-character {break | char | default | none | soft}
no escape-character [soft]
default escape-character [soft]

Syntax Description

Defaults

break

Sets the escape character to Break. Note that the Break key should not
be used as an escape character on a console terminal.

char

Character (for example, !) or its ASCII decimal representation

(integer in the range of 0 to 255) to be used as the escape character.

default

Sets the escape key sequence to the default of Ctrl-^, X.

none

Disables escape entirely.

soft

Sets an escape character that will wait until pending input is

processed before it executes.

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

Usage Guidelines

Modification

10.0

This command was introduced.

11.3

The soft keyword was added.

See the ASCII Character Set and Hex Values appendix for a list of ASCII characters and their
numerical representation.
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).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-67

Terminal Operating Characteristics Commands

escape-character

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:

Examples

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.

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
.
.
.

Related Commands

Command

Description

show line

Displays information about the specified line connection, or all the

lines.

terminal escape-character

Sets the escape character for the current terminal line for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

FR-68

78-11740-02

Terminal Operating Characteristics Commands

exec-character-bits

exec-character-bits
To configure the character widths of EXEC and configuration command characters, use the
exec-character-bits line configuration command. 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.

Defaults

7-bit ASCII character set

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

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.

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.

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-69

Terminal Operating Characteristics Commands

exec-character-bits

Related Commands

Command

Description

default-value exec-character-bits

Defines the EXEC character width for either 7 bits or 8 bits.

default-value
special-character-bits

Configures the flow control default value from a 7-bit width to

an 8-bit width.

length

Sets the terminal screen length.

terminal exec-character-bits

Locally changes the ASCII character set used in EXEC and

configuration command characters for the current session.

terminal special-character-bits

Changes the ASCII character widths to accept special

characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

FR-70

78-11740-02

Terminal Operating Characteristics Commands

hold-character

hold-character
To define the local hold character used to pause output to the terminal screen, use the hold-character
line configuration command. To restore the default, use the no form of this command.
hold-character ascii-number
no hold-character

Syntax Description

ascii-number

Defaults

No hold character is defined.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

ASCII decimal representation of a character or control sequence (for

example, Ctrl-P).

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

Description

terminal hold-character

Sets or changes the hold character for the current session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-71

Terminal Operating Characteristics Commands

insecure

insecure
To configure a line as insecure, use the insecure line configuration command. To disable this feature,
use the no form of this command.
insecure
no insecure

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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

FR-72

78-11740-02

Terminal Operating Characteristics Commands

length

length
To set the terminal screen length, use the length line configuration command. To restore the default
value, use the no form of this command.
length screen-length
no length

Syntax Description

screen-length

Defaults

Screen length of 24 lines

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

The number of lines on the screen. A value of zero disables pausing

between screens of output.

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

Related Commands

Command

Description

terminal length

Sets the number of lines on the current terminal screen for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-73

Terminal Operating Characteristics Commands

location

location
To provide a description of the location of a serial device, use the location line configuration command.
To remove the description, use the no form of this command.
location text
no location

Syntax Description

text

Defaults

No location description provided.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Location description.

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

Cisco IOS Configuration Fundamentals Command Reference

FR-74

78-11740-02

Terminal Operating Characteristics Commands

lockable

lockable
To enable use of the lock EXEC command, use the lockable line configuration command. To reinstate
the default (the terminal session cannot be locked), use the no form of this command.
lockable
no lockable

Syntax Description

This command has no arguments or keywords.

Defaults

Sessions on the line are not lockable (the lock EXEC command has no effect).

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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#

Related Commands

Command

Description

lock

Prevents access to your session by other users by setting a temporary

password on your terminal line.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-75

Terminal Operating Characteristics Commands

logout-warning

logout-warning
To warn users of an impending forced timeout, use the logout-warning line configuration command. To
restore the default, use the no form of this command.
logout-warning [seconds]
logout-warning

Syntax Description

seconds

Defaults

No warning is sent to the user.

Command Modes

Line configuration

Command History

Release

Modification

10.3

This command was introduced.

(Optional) Number of seconds that are counted down before session

termination. If no number is specified, the default of 20 seconds is used.

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

Description

absolute-timeout

Sets the interval for closing user connections on a specific line or port.

session-timeout

Sets the interval for closing the connection when there is no input or output
traffic.

Cisco IOS Configuration Fundamentals Command Reference

FR-76

78-11740-02

Terminal Operating Characteristics Commands

notify

notify
To enable terminal notification about pending output from other Telnet connections, use the notify line
configuration command. To disable notifications, use the no form of this command.
notify
no notify

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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

Description

terminal notify

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-77

Terminal Operating Characteristics Commands

padding

padding
To set the padding on a specific output character, use the padding line configuration command. 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

ACII decimal representation of the character.

count

Number of NULL bytes sent after the specified character, up to 255

padding characters in length.

Defaults

No padding

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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

Related Commands

Command

Description

terminal padding

Changes the character padding on a specific output character for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

FR-78

78-11740-02

Terminal Operating Characteristics Commands

parity

parity
To define generation of a parity bit, use the parity line configuration command. To specify no parity, use
the no form of this command.
parity {none | even | odd | space | mark}
no parity

Syntax Description

none

No parity. This is the default.

even

Even parity.

odd

Odd parity.

space

Space parity.

mark

Mark parity.

Defaults

No parity.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems will sometimes require a
specific parity bit setting. Refer to the documentation for your device to determine required parity
settings.

Examples

In the following example even parity is configured for line 34:

Router(config)# line 34
Router(config-line)# parity even

Related Commands

Command

Description

terminal parity

Defines the generation of the parity bit for the current for the current session
and line.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-79

Terminal Operating Characteristics Commands

printer

printer
To configure a printer and assign a server tty line (or lines) to it, use the printer global configuration
command. To disable printing on a tty line, use the no form of this command.
printer printer-name {line number | rotary number} [newline-convert | formfeed]
no printer

Syntax Description

printer-name

Printer name.

line number

Assigns a tty line to the printer.

rotary number

Assigns a rotary group of tty lines to the printer.

newline-convert

(Optional) Converts newline (linefeed) characters to a two-character

sequence carriage-return, linefeed (CR+LF).

formfeed

(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.

Defaults

No printers are defined by default.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

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 Release 12.2 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

In the following example a printer named printer1 is configured and output is assigned to tty line 4:
Router(config)# printer printer1 line 4

Cisco IOS Configuration Fundamentals Command Reference

FR-80

78-11740-02

Terminal Operating Characteristics Commands

printer

Related Commands

Command

Description

clear line

Returns a terminal line to idle state.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-81

Terminal Operating Characteristics Commands

private

private
To save user EXEC command changes between terminal sessions, use the private line configuration
command. To restore the default condition, use the no form of this command.
private
no private

Syntax Description

This command has no arguments or keywords.

Defaults

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

Modification

10.0

This command was introduced.

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

Description

exec-timeout

Sets the interval that the EXEC command interpreter waits until user input
is detected.

exit

Exits any configuration mode, or closes an active terminal session and

terminates the EXEC.

Cisco IOS Configuration Fundamentals Command Reference

FR-82

78-11740-02

Terminal Operating Characteristics Commands

show whoami

show whoami
To display information about the terminal line of the current user, including host name, line number, line
speed, and location, use the show whoami EXEC command.
show whoami [text]

Syntax Description

text

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

(Optional) Additional data to print to the screen.

If text is included as an argument in the command, that text is displayed as part of the additional data
about the line.
To prevent the information from being lost if the menu display clears the screen, this command always
displays a More prompt before returning. Press the space bar to return to the prompt.

Examples

The following example is sample output from the show whoami command:
Router> show whoami

Comm Server "Router", Line 0 at 0bps.

Location "Second floor, West"

--More-Router>

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-83

Terminal Operating Characteristics Commands

special-character-bits

special-character-bits
To configure the number of data bits per character for special characters such as software flow control
characters and escape characters, use the special-character-bits line configuration command. To restore
the default value, use the no form of this command.
special-character-bits {7 | 8}
no special-character-bits

Syntax Description

Selects the 7-bit ASCII character set. This is the default.

Selects the full 8-bit character set for special characters.

Defaults

7-bit ASCII character set

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Setting the special character bits to 8 allows you to use twice as many special characters as with the 7-bit
ASCII character set. The special characters affected by this setting are the escape, hold, stop, start,
disconnect, and activation characters.

Examples

The following example allows the full 8-bit international character set for special characters on line 5:
Router(config)# line 5
Router(config-line)# special-character-bits 8

Related Commands

Command

Description

default-value exec-character-bits

Defines the EXEC character width for either 7 bits or 8 bits.

default-value
special-character-bits

Configures the flow control default value from a 7-bit width to

an 8-bit width.

exec-character-bits

Configures the character widths of EXEC and configuration

command characters.

terminal exec-character-bits

Locally changes the ASCII character set used in EXEC and

configuration command characters for the current session.

terminal special-character-bits

Changes the ASCII character widths to accept special

characters for the current terminal line and session.

Cisco IOS Configuration Fundamentals Command Reference

FR-84

78-11740-02

Terminal Operating Characteristics Commands

state-machine

state-machine
To specify the transition criteria for the state of a particular state machine, use the state-machine global
configuration command. To remove a particular state machine from the configuration, use the no form
of this command.
state-machine name state first-character last-character [nextstate | transmit]
no state-machine name

Syntax Description

name

Name for the state machine (used in the dispatch-machine line configuration
command). The user can specify any number of state machines, but each line can
have only one state machine associated with it.

state

State being modified. There are a maximum of eight states per state machine.
Lines are initialized to state 0 and return to state 0 after a packet is transmitted.

first-character
last-character

Specifies a range of characters. Use ASCII numerical values.

If the state machine is in the indicated state, and the next character input is within
this range, the process goes to the specified next state. Full 8-bit character
comparisons are done, so the maximum value is 255. Ensure that the line is
configured to strip parity bits (or not generate them), or duplicate the low
characters in the upper half of the space.

nextstate

(Optional) State to enter if the character is in the specified range.

transmit

(Optional) Causes the packet to be transmitted and the state machine to be reset
to state 0. Recurring characters that have not been explicitly defined to have a
particular action return the state machine to state 0.

Defaults

No transition criteria are specified.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command is paired with the dispatch-machine line configuration command, which defines the line
on which the state machine is effective.

Examples

In the following example a dispatch machine named function is configured to ensure that the function
key characters on an ANSI terminal are kept in one packet. Because the default in the example is to
remain in state 0 without sending anything, normal key signals are sent immediately.
Router(config)# line 1 20
Router(config-line)# dispatch-machine function
Router(config-line)# exit

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-85

Terminal Operating Characteristics Commands

state-machine

Router(config)# state-machine function 0 0 255 transmit

Related Commands

Command

Description

dispatch-character

Defines a character that causes a packet to be sent.

dispatch-machine

Specifies an identifier for a TCP packet dispatch state machine on a

particular line.

dispatch-timeout

Sets the character dispatch timer.

Cisco IOS Configuration Fundamentals Command Reference

FR-86

78-11740-02

Terminal Operating Characteristics Commands

stopbits

stopbits
To set the number of the stop bits transmitted per byte, use the stopbits line configuration command. To
restore the default value, use the no form of this command.
stopbits {1 | 1.5 | 2}
no stopbits

Syntax Description

One stop bit.

1.5

One and one-half stop bits.

Two stop bits.This is the default.

Defaults

2 stop bits per byte

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems often require a specific
stop-bit setting.

Examples

In the following example, the stop bits transmitted per byte are changed from the default of two stop bits
to one stop bit as a performance enhancement for line 4:
Router(config)# line 4
Router(config-line)# stopbits 1

Related Commands

Command

Description

terminal stopbits

Changes the number of stop bits sent per byte by the current terminal line
during an active session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-87

Terminal Operating Characteristics Commands

terminal databits

terminal databits
To change the number of data bits per character for the current terminal line for this session, use the
terminal databits EXEC command.
terminal databits {5 | 6 | 7 | 8}

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.

Defaults

8 data bits per character

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems often require a specific
data bit setting. The terminal databits 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 (5 and 6) are supplied
for compatibility with older devices and are generally not used.

Examples

In the following example, the databits per character is changed to seven for the current session:
Router# terminal databits 7

Related Commands

Command

Description

databits

Sets the number of data bits per character that are interpreted and generated
by the router hardware.

terminal parity

Defines the generation of the parity bit for the current terminal line and
session.

Cisco IOS Configuration Fundamentals Command Reference

FR-88

78-11740-02

Terminal Operating Characteristics Commands

terminal data-character-bits

terminal data-character-bits
To set the number of data bits per character that are interpreted and generated by the Cisco IOS software
for the current line and session, use the terminal data-character-bits EXEC command.
terminal data-character-bits {7 | 8}

Syntax Description

Seven data bits per character.

Eight data bits. This is the default.

Defaults

8 data bits per character

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command is used primarily to strip parity from X.25 connections on routers with the protocol
translation software option. The terminal data-character-bits command does not work on hard-wired
lines.

Examples

The following example sets the data bits per character to seven on the current line:
Router# terminal data-character-bits 7

Related Commands

Command

Description

data-character-bits

Sets the number of data bits per character that are interpreted and generated
by the Cisco IOS software.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-89

Terminal Operating Characteristics Commands

terminal dispatch-character

terminal dispatch-character
To define a character that causes a packet to be sent for the current session, use the
terminal dispatch-character EXEC command.
terminal dispatch-character ascii-number [ascii-number2 . . . ascii-number]

Syntax Description

ascii-number

The ASCII decimal representation of the character, such as Return (ASCII

character 13) for line-at-a-time transmissions.

ascii-number2 . . .
ascii-number

(Optional) Additional decimal representations of characters. This syntax

indicates that you can define any number of characters as dispatch
characters.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

At times, you might want to queue up a string of characters until they fill a complete packet and then
transmit the packet to a remote host. This can make more efficient use of a line, because the access server
or router normally dispatches each character as it is entered.

Examples

The following example defines the characters Ctrl-D (ASCII decimal character 4) and Ctrl-Y (ASCII
decimal character 25) as the dispatch characters:
Router# terminal dispatch-character 4 25

Related Commands

Command

Description

dispatch-character

Defines a character that causes a packet to be sent.

Cisco IOS Configuration Fundamentals Command Reference

FR-90

78-11740-02

Terminal Operating Characteristics Commands

terminal dispatch-timeout

terminal dispatch-timeout
To set the character dispatch timer for the current terminal line for the current session, use the
terminal dispatch-timeout EXEC command.
terminal dispatch-timeout milliseconds

Syntax Description

milliseconds

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Integer that specifies the number of milliseconds that the router waits after it puts
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.

Use this command to increase the processing efficiency of 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 terminal dispatch-timeout and terminal
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.

Note

Examples

The router response time might appear intermittent if the timeout interval is greater than
100 milliseconds and remote echoing is used.

In the following example, the dispatch timeout timer is set to 80 milliseconds:

Router# terminal dispatch-timeout 80

Related Commands

Command

Description

dispatch-timeout

Sets the character dispatch timer for a specified line or group of lines.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-91

Terminal Operating Characteristics Commands

terminal download

terminal download
To temporarily set the ability of a line to act as a transparent pipe for file transfers for the current session,
use the terminal download EXEC command.
terminal download

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

You can use this feature to run a program such as KERMIT, XMODEM, or CrossTalk that downloads a
file across an access server or router line. This command configures the terminal line to send data and is
equivalent to entering all the following commands:

terminal telnet transparent

terminal no escape-character (see terminal escape-character)

terminal no hold-character (see terminal hold-character)

terminal no padding 0 (see terminal padding)

terminal no padding 128 (see terminal padding)

terminal parity none

terminal databits 8

The following example configures a line to act as a transparent pipe:

Router# terminal download

Cisco IOS Configuration Fundamentals Command Reference

FR-92

78-11740-02

Terminal Operating Characteristics Commands

terminal escape-character

terminal escape-character
To set the escape character for the current terminal line for the current session, use the
terminal escape-character EXEC command.
terminal escape-character ascii-number

Syntax Description

ascii-number

Defaults

Ctrl-^ (Ctrl-Shift-6)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

ASCII decimal representation of the escape character or control sequence (for

example, Ctrl-P ).

See the ASCII Character Set and Hex Values appendix for a list of ASCII characters and their
numerical representation.
This command is useful, for example, if you have the default escape character defined for a different
purpose in your keyboard file. Entering the escape character followed by the X key returns you to EXEC
mode when you are connected to another computer.

Note

Examples

The Break key generally cannot be used as an escape character on the console terminal because the
operating software interprets the Break command on a console line as an instruction to halt the
system.

In the following example the escape character to Ctrl-P (ASCII decimal character 16) for the current
session:
Router# terminal escape-character 16

Related Commands

Command

Description

escape-character

Defines a system escape character.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-93

Terminal Operating Characteristics Commands

terminal exec-character-bits

terminal exec-character-bits
To locally change the ASCII character set used in EXEC and configuration command characters for the
current session, use the terminal exec-character-bits EXEC command.
terminal exec-character-bits {7 | 8}

Syntax Description

Selects the 7-bit ASCII character set. This is the default.

Selects the full 8-bit character set.

Defaults

7-bit ASCII character set (unless set otherwise in global configuration mode)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This EXEC command overrides the default-value exec-character-bits global configuration command.
Configuring the EXEC character width to 8 bits enables you to view special graphical and international
characters in banners, prompts, and so on.
When the user exits the session, the character width is reset to the default value established by the
exec-character-bits global configuration command. However, setting the EXEC character width to
8 bits can also cause failures. For example, 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.

Examples

The following example temporarily configures the system to use a full 8-bit user interface for system
banners and prompts, allowing the use of additional graphical and international characters:
Router# terminal exec-character-bits 8

Related Commands

Command

Description

exec-character-bits

Configures the character widths of EXEC and configuration command

characters.

Cisco IOS Configuration Fundamentals Command Reference

FR-94

78-11740-02

Terminal Operating Characteristics Commands

terminal flowcontrol

terminal flowcontrol
To set flow control for the current terminal line for the current session, use the terminal flowcontrol
EXEC command.
terminal flowcontrol {none | software [in | out] | hardware}

Syntax Description

none

Prevents flow control.

software

Sets software flow control.

in | out

(Optional) Specifies the direction of flow control: in causes the router to listen to flow
control from the attached device, and out causes the router to send flow control
information to the attached device. If you do not specify a direction, both directions
are assumed.

hardware

Sets hardware flow control. For information about setting up the EIA/TIA-232 line,
see the manual that was shipped with your product.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Flow control enables you to regulate the rate at which data can be transmitted from one point so that it
is equal to the rate at which it can be received at another point. Flow control protects against loss of data
because the terminal is not capable of receiving data at the rate it is being sent. You can set up data flow
control for the current terminal line in one of two ways: software flow control, which you do with control
key sequences, and hardware flow control, which you do at the device level.
For software flow control, the default stop and start characters are Ctrl-S and Ctrl-Q (XOFF and XON).
You can change them with the terminal stop-character and terminal start-character EXEC
commands.

Examples

In the following example incoming software flow control is set for the current session:
Router# terminal flowcontrol software in

Related Commands

Command

Description

flowcontrol

Sets the method of data flow control between the terminal or other serial
device and the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-95

Terminal Operating Characteristics Commands

terminal hold-character

terminal hold-character
To define the hold character for the current session, use the terminal hold-character EXEC command.
To return the hold character definition to the default, use the terminal no hold-character command.
terminal hold-character ascii-number
terminal no hold-character

Syntax Description

ascii-number

Defaults

The default hold character is defined by the hold-character global configuration command.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

ASCII decimal representation of a character or control sequence (for example,

Ctrl-P).

You can define a local hold character that temporarily suspends the flow of output on the terminal. When
information is scrolling too quickly, you can enter the hold character to pause the screen output, then
enter any other character to resume the flow of output.
You cannot suspend output on the console terminal. To send the hold character to the host, precede it
with the escape character.

Examples

In the following example the hold character for the current (local) session is set to Ctrl-P. The show
terminal output is included to show the verification of the setting (the value for the hold character is
shown in the Special Characters listing).
Router# terminal hold-character 16
"^P" is the local hold character
Router# show terminal
Line 50, Location: "", Type: "VT220"
Length: 24 lines, Width: 80 columns
Baud rate (TX/RX) is 9600/9600
Status: PSI Enabled, Ready, Active, No Exit Banner, Automore On
Capabilities: none
Modem state: Ready
Group codes:
0
Special Chars: Escape Hold Stop Start Disconnect Activation
^^x
^P
none
Timeouts:
Idle EXEC
Idle Session
Modem Answer Session
00:10:00
never
none
Idle Session Disconnect Warning
never
Login-sequence User Response

Dispatch
not set

Cisco IOS Configuration Fundamentals Command Reference

FR-96

78-11740-02

Terminal Operating Characteristics Commands

terminal hold-character

00:00:30
Autoselect Initial Wait
not set
Modem type is unknown.
Session limit is not set.
Time since activation: 00:04:13
Editing is enabled.
History is enabled, history size is 10.
.
.
.

Related Commands

Command

Description

hold-character

Defines the local hold character used to pause output to the terminal screen.

show terminal

Displays settings for terminal operating characteristics.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-97

Terminal Operating Characteristics Commands

terminal keymap-type

terminal keymap-type
To specify the current keyboard type for the current session, use the terminal keymap-type EXEC
command.
terminal keymap-type keymap-name

Syntax Description

keymap-name

Defaults

VT100

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Name defining the current keyboard type.

Usage Guidelines

You must use this command when you are using a keyboard other than the default of VT100.

Examples

The following example specifies a VT220 keyboard as the current keyboard type:
Router# terminal keymap-type vt220

Related Commands

Command

Description

show keymap

Displays the current keymap settings.

Cisco IOS Configuration Fundamentals Command Reference

FR-98

78-11740-02

Terminal Operating Characteristics Commands

terminal length

terminal length
To set the number of lines on the current terminal screen for the current session, use the terminal length
EXEC command.
terminal length screen-length

Syntax Description

screen-length

Defaults

24 lines

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Number of lines on the screen. A value of zero disables pausing between screens
of output.

The system uses the length value to determine when to pause during multiple-screen output. A value of
zero prevents the router from pausing between screens of output.
Some types of terminal sessions do not require you to specify the screen length because the screen length
specified can be learned by some remote hosts. For example, the rlogin protocol uses the screen length
to set up terminal parameters on a remote UNIX host.

Examples

In the following example the system is configured to prevent output from pausing if it exceeds the length
of the screen:
Router# terminal length 0

Related Commands

Command

Description

length

Sets the terminal screen length.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-99

Terminal Operating Characteristics Commands

terminal monitor

terminal monitor
To display debug command output and system error messages for the current terminal and session, use
the terminal monitor EXEC command.
terminal monitor

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Remember that all terminal parameter-setting commands are set locally and do not remain in effect after
a session is ended.

Examples

In the following example the system is configured to display debug command output and error messages
during the current terminal session:
Router# terminal monitor

Cisco IOS Configuration Fundamentals Command Reference

FR-100

78-11740-02

Terminal Operating Characteristics Commands

terminal notify

terminal notify
To enable terminal notification about pending output from other Telnet connections for the current
session, use the terminal notify EXEC command. To disable notifications for the current session, use
the no form of this command.
terminal notify
terminal no notify

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Enabling notifications may be useful if, for example, you want to know when another connection
receives mail, or when a process has been completed.
This command enables or disables notifications for only the current session. To globally set these
notifications, use the notify line configuration command.

Examples

In the following example notifications will be displayed to inform the user when output is pending on
another connection:
Router# terminal notify

Related Commands

Command

Description

notify

Enables terminal notification about pending output from other Telnet

connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-101

Terminal Operating Characteristics Commands

terminal padding

terminal padding
To change the character padding on a specific output character for the current session, use the
terminal padding EXEC command.
terminal padding ascii-number count

Syntax Description

ascii-number

ACII decimal representation of the character.

count

Number of NULL bytes sent after the specified character, up to 255 padding
characters in length.

Defaults

No padding

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Character padding adds a number of null bytes to the end of the string and can be used to make a string
an expected length for conformity.
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

The following example pads Ctrl-D (ASCII decimal character 4) with 164 NULL bytes:
Router# terminal padding 4 164

Related Commands

Command

Description

padding

Sets the padding on a specific output character.

Cisco IOS Configuration Fundamentals Command Reference

FR-102

78-11740-02

Terminal Operating Characteristics Commands

terminal parity

terminal parity
To define the generation of the parity bit for the current terminal line and session, use the
terminal parity EXEC command.
terminal parity {none | even | odd | space | mark}

Syntax Description

none

No parity. This is the default.

even

Even parity.

odd

Odd parity.

space

Space parity.

mark

Mark parity.

Defaults

No parity.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems will sometimes require a
specific parity bit setting. Refer to the documentation for your device to determine required parity
settings.

Examples

In the following example odd parity checking is enabled for the current session:
Router# terminal parity odd

Related Commands

Command

Description

parity

Defines generation of a parity bit for connections on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-103

Terminal Operating Characteristics Commands

terminal-queue entry-retry-interval

terminal-queue entry-retry-interval
To change the retry interval for a terminal port queue, use the terminal-queue global configuration
command. To restore the default terminal port queue interval, use the no form of this command.
terminal-queue entry-retry-interval interval
no terminal-queue entry-retry-interval

Syntax Description

interval

Defaults

60 seconds

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Number of seconds between terminal port retries.

Usage Guidelines

If a remote device (such as a printer) is busy, the connection attempt is placed in a terminal port queue.
If you want to decrease the waiting period between subsequent connection attempts, decrease the default
of 60 to an interval of 10 seconds. Decrease the time between subsequent connection attempts when, for
example, a printer queue stalls for long periods.

Examples

The following example changes the terminal port queue retry interval from the default of 60 seconds to
10 seconds:
Router# terminal-queue entry-retry-interval 10

Cisco IOS Configuration Fundamentals Command Reference

FR-104

78-11740-02

Terminal Operating Characteristics Commands

terminal rxspeed

terminal rxspeed
To set the terminal receive speed (how fast information is sent to the terminal) for the current line and
session, use the terminal rxspeed EXEC command.
terminal rxspeed bps

Syntax Description

bps

Defaults

9600 bps

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Baud rate in bits per second (bps).

Usage Guidelines

Set the speed to match the baud rate of whatever device you have connected to the port. Some baud rates
available on devices connected to the port might not be supported on the system. The system will indicate
if the speed you select is not supported.

Examples

The following example sets the current auxiliary line receive speed to 115200 bps:
Router# terminal rxspeed 115200

Related Commands

Command

Description

rxspeed

Sets the terminal receive speed for a specified line or lines.

terminal rxspeed

Sets the terminal receive speed for the current session.

terminal txspeed

Sets the terminal transmit speed for a specified line or lines.

terminal speed

Sets the transmit and receive speeds for the current session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-105

Terminal Operating Characteristics Commands

terminal special-character-bits

terminal special-character-bits
To change the ASCII character widths to accept special characters for the current terminal line and
session, use the terminal special-character-bits EXEC command.
terminal special-character-bits {7 | 8}

Syntax Description

Selects the 7-bit ASCII character set. This is the default.

Selects the full 8-bit ASCII character set.

Defaults

7-bit ASCII character set

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Configuring the width to 8 bits enables you to use twice as many special characters as with the 7-bit
setting. This selection enables you to add special graphical and international characters in banners,
prompts, and so on.
This command is useful, for example, if you want the router to provide temporary support for
international character sets. It overrides the default-value special-character-bits global configuration
command and is used to compare character sets typed by the user with the special character available
during a data connection, which includes software flow control and escape characters.
When you exit the session, character width is reset to the width established by the default-value
exec-character-bits global configuration command.
Note that setting the EXEC character width to eight bits can cause failures. For example, if a user on a
terminal that is sending parity enters the help command, an unrecognized command message appears
because the Cisco IOS software is reading all eight bits, and the eighth bit is not needed for the help
command.

Examples

The following example temporarily configures a router to use a full 8-bit user interface for system
banners and prompts.
Router# terminal special-character-bits 8

Cisco IOS Configuration Fundamentals Command Reference

FR-106

78-11740-02

Terminal Operating Characteristics Commands

terminal special-character-bits

Related Commands

Command

Description

default-value
exec-character-bits

Globally defines the character width as 7-bit or 8-bit.

special-character-bits

Configures the number of data bits per character for special characters
such as software flow control characters and escape characters.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-107

Terminal Operating Characteristics Commands

terminal speed

terminal speed
To set the transmit and receive speeds of the current terminal line for the current session, use the
terminal speed EXEC command.
terminal speed bps

Syntax Description

bps

Defaults

9600 bps

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Baud rate in bits per second (bps).

Usage Guidelines

Set the speed to match the transmission rate of whatever device you have connected to the port. Some
baud rates available on devices connected to the port might not be supported on the router. The router
indicates whether the speed you selected is not supported.

Examples

The following example restores the transmit and receive speed on the current line to 9600 bps:
Router# terminal speed 9600

Related Commands

Command

Description

speed

Sets the terminal baud rate.

Cisco IOS Configuration Fundamentals Command Reference

FR-108

78-11740-02

Terminal Operating Characteristics Commands

terminal start-character

terminal start-character
To change the flow control start character for the current session, use the terminal start-character
EXEC command.
terminal start-character ascii-number

Syntax Description

ascii-number

Defaults

Ctrl-Q (ASCII decimal character 17)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

ASCII decimal representation of the start character.

Usage Guidelines

The flow control start character signals the start of data transmission when software flow control is in
effect.

Examples

The following example changes the start character to Ctrl-O (ASCII decimal character 15):
Router# terminal start-character 15

Related Commands

Command

Description

start-character

Sets the flow control start character.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-109

Terminal Operating Characteristics Commands

terminal stopbits

terminal stopbits
To change the number of stop bits sent per byte by the current terminal line during an active session, use
the terminal stopbits EXEC command.
terminal stopbits {1 | 1.5 | 2}

Syntax Description

One stop bit.

1.5

One and one-half stop bits.

Two stop bits. This is the default.

Defaults

2 stop bits

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Communication protocols provided by devices such as terminals and modems often require a specific
stop-bit setting.

Examples

In the following example the setting for stop bits is changed to one for the current session:
Router# terminal stopbits 1

Related Commands

Command

Description

stopbits

Sets the number of the stop bits sent per byte.

Cisco IOS Configuration Fundamentals Command Reference

FR-110

78-11740-02

Terminal Operating Characteristics Commands

terminal stop-character

terminal stop-character
To change the flow control stop character for the current session, use the terminal stop-character
EXEC command.
terminal stop-character ascii-number

Syntax Description

ascii-number

Defaults

Ctrl-S (ASCII character decimal 19)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

ASCII decimal representation of the stop character.

The flow control stop character signals the end of data transmission when software flow control is in
effect.
See the ASCII Character Set and Hex Values appendix for a list of ASCII characters.

Examples

In the following example the stop character is configured as Ctrl-E (ASCII character decimal 5) for the
current session:
Router# terminal stop-character 5

Related Commands

Command

Description

stop-character

Sets the flow control stop character.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-111

Terminal Operating Characteristics Commands

terminal telnet break-on-ip

terminal telnet break-on-ip

To cause an access server to generate a hardware Break signal when an interrupt-process (ip) command
is received, use the terminal telnet break-on-ip EXEC command.
terminal telnet break-on-ip

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

The hardware Break signal occurs when a Telnet interrupt-process (ip) command is received on that
connection. The terminal telnet break-on-ip command can be used to control the translation of Telnet
interrupt-process commands into X.25 Break indications.

In this command, the acronym ip indicates interrupt-process, not internet protocol (IP).
This command is also a useful workaround in the following situations:

Several user Telnet programs send an ip command, but cannot send a Telnet Break signal.

Some Telnet programs implement a Break signal that sends an IP command.

Some EIA/TIA-232 hardware devices use a hardware Break signal for various purposes. A hardware
Break signal is generated when a Telnet Break command is received.
You can verify if this command is enabled with the show terminal EXEC command. If enabled the
following line will appear in the output: Capabilities: Send BREAK on IP.

In the following example, a Break signal is generated for the current connection when an
interrupt-process command is issued:

Examples

Router# terminal telnet break-on-ip

Related Commands

Command

Description

terminal telnet ip-on-break

Configures the system to send an interrupt-process (ip) signal when

the Break command is issued.

Cisco IOS Configuration Fundamentals Command Reference

FR-112

78-11740-02

Terminal Operating Characteristics Commands

terminal telnet refuse-negotiations

terminal telnet refuse-negotiations

To configure the current session to refuse to negotiate full-duplex, remote echo options on incoming
connections, use the terminal telnet refuse-negotiations EXEC command.
terminal telnet refuse-negotiations

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

You can set the line to allow access server to refuse full-duplex, remote echo connection requests from
the other end. This command suppresses negotiation of the Telnet Remote Echo and Suppress Go Ahead
options.

Examples

In the following example the current session is configured to refuse full-duplex, remote echo requests:
Router# terminal telnet refuse-negotiations

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-113

Terminal Operating Characteristics Commands

terminal telnet speed

terminal telnet speed

To allow an access server to negotiate transmission speed for the current terminal line and session, use
the terminal telnet speed EXEC command.
terminal telnet speed default-speed maximum-speed

Syntax Description

default-speed

Line speed, in bits per second (bps), that the access server will use if the device
on the other end of the connection has not specified a speed.

maximum-speed

Maximum line speed in bits per second (bps), that the device on the other end
of the connection can use.

Defaults

9600 bps (unless otherwise set using the speed, txspeed or rxspeed line configuration commands)

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

You can match line speeds on remote systems in reverse Telnet, on host machines connected to an access
server to access the network, or on a group of console lines connected to the access server when disparate
line speeds are in use at the local and remote ends of the connections listed above. Line speed negotiation
adheres to the Remote Flow Control option, defined in RFC 1080.

This command applies only to access servers. It is not supported on standalone routers.

The following example enables the access server to negotiate a bit rate on the line using the Telnet
option. If no speed is negotiated, the line will run at 2400 bps. If the remote host requests a speed greater
than 9600 bps, then 9600 bps will be used.
Router# terminal telnet speed 2400 9600

Cisco IOS Configuration Fundamentals Command Reference

FR-114

78-11740-02

Terminal Operating Characteristics Commands

terminal telnet sync-on-break

terminal telnet sync-on-break

To cause the access server to send a Telnet Synchronize signal when it receives a Telnet Break signal on
the current line and session, use the terminal telnet sync-on-break EXEC command.
terminal telnet sync-on-break

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

You can configure the session to cause a reverse Telnet line to send a Telnet Synchronize signal when it
receives a Telnet Break signal. The TCP Synchronize signal clears the data path, but still interprets
incoming commands.

This command applies only to access servers. It is not supported on standalone routers.

The following example sets an asynchronous line to cause the access server to send a Telnet Synchronize
signal:
Router# terminal telnet sync-on-break

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-115

Terminal Operating Characteristics Commands

terminal telnet transparent

terminal telnet transparent

To cause the current terminal line to send a Return character (CR) as a CR followed by a NULL instead
of a CR followed by a Line Feed (LF) for the current session, use the terminal telnet transparent EXEC
command.
terminal telnet transparent

Syntax Description

This command has no arguments or keywords.

Defaults

CR followed by an LF

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

The end of each line typed at the terminal is ended with a Return (CR). This command permits
interoperability with different interpretations of end-of-line demarcation in the Telnet protocol
specification.

This command applies only to access servers. It is not supported on stand-alone routers.

In the following example the session is configured to send a CR signal as a CR followed by a NULL:
Router# terminal telnet transparent

Cisco IOS Configuration Fundamentals Command Reference

FR-116

78-11740-02

Terminal Operating Characteristics Commands

terminal terminal-type

terminal terminal-type
To specify the type of terminal connected to the current line for the current session, use the
terminal terminal-type EXEC command.
terminal terminal-type terminal-type

Syntax Description

terminal-type

Defaults

VT100

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Defines the terminal name and type, and permits terminal negotiation by hosts
that provide that type of service.

Indicate the terminal type if it is different from the default of VT100.

The terminal type name is used by TN3270s for display management and by Telnet and rlogin to inform
the remote host of the terminal type.

Examples

In the following example the terminal type is defined as VT220 for the current session:
Router# terminal terminal-type VT220

Related Commands

Command

Description

terminal keymap-type

Specifies the current keyboard type for the current session.

terminal-type

Specifies the type of terminal connected to a line.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-117

Terminal Operating Characteristics Commands

terminal txspeed

terminal txspeed
To set the terminal transmit speed (how fast the terminal can send information) for the current line and
session, use the terminal txspeed EXEC command.
terminal txspeed bps

Syntax Description

bps

Defaults

9600 bps

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

Baud rate in bits per second (bps).

In the following example the line transmit speed is set to 2400 bps for the current session:
Router# terminal txspeed 2400

Related Commands

Command

Description

rxspeed

Sets the terminal receive speed for a specified line or lines.

terminal rxspeed

Sets the terminal receive speed for the current line and session.

terminal terminal-type

Specifies the type of terminal connected to the current line for the current
session.

txspeed

Sets the terminal transmit speed for a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

FR-118

78-11740-02

Terminal Operating Characteristics Commands

terminal-type

terminal-type
To specify the type of terminal connected to a line, use the terminal-type line configuration command.
To remove any information about the type of terminal and reset the line to the default terminal emulation,
use the no form of this command.
terminal-type {terminal-name | terminal-type}
no terminal-type

Syntax Description

terminal-name

Terminal name.

terminal-type

Terminal type.

Defaults

VT100

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command records the type of terminal connected to the line. The terminal-name argument provides
a record of the terminal type and allows terminal negotiation of display management by hosts that
provide that type of service.
For TN3270 applications, this command must follow the corresponding ttycap entry in the configuration
file.

Examples

The following example defines the terminal on line 7 as a VT220:

Router(config)# line 7
Router(config-line)# terminal-type VT220

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-119

Terminal Operating Characteristics Commands

terminal width

terminal width
To set the number of character columns on the terminal screen for the current line for a session, use the
terminal width EXEC command.
terminal width characters

Syntax Description

characters

Defaults

80 characters

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Number of character columns displayed on the terminal.

By default, the route provides a screen display width of 80 characters. You can reset this value for the
current session if it does not meet the needs of your terminal.
The rlogin protocol uses the value of the characters argument to set up terminal parameters on a remote
host.

Examples

The following example sets the terminal character columns to 132:

Router# terminal width 132

Related Commands

Command

Description

width

Sets the terminal screen width (the number of character columns displayed
on the attached terminal).

Cisco IOS Configuration Fundamentals Command Reference

FR-120

78-11740-02

Terminal Operating Characteristics Commands

where

where
To list the open sessions, use the where EXEC command.
where

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command first appeared in a release prior to Cisco IOS Release 10.0.

Usage Guidelines

The where command displays all open sessions associated with the current terminal line.
The break (Ctrl-Shift-6, x), where, and resume commands are available with all supported connection
protocols.

Examples

The following is sample output from the where command:

Router# where
Conn Host
1 MATHOM
* 2 CHAFF

Address
192.31.7.21
131.108.12.19

Byte
0
0

Idle
0
0

Conn Name
MATHOM
CHAFF

The asterisk (*) indicates the current terminal session.

Table 8 describes the significant fields shown in the display.
Table 8

Related Commands

where Field Descriptions

Field

Description

Conn

Name or address of the remote host to which the connection is made.

Host

Remote host to which the router is connected through a Telnet session.

Address

IP address of the remote host.

Byte

Number of unread bytes for the user to see on the connection.

Idle

Interval (in minutes) since data was last sent on the line.

Conn Name

Assigned name of the connection.

Command

Description

show line

Displays information about all lines on the system or the specified line.

show sessions

Displays information about open LAT, Telnet, or rlogin connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-121

Terminal Operating Characteristics Commands

width

width
To set the terminal screen width, use the width line configuration command. To return to the default
screen width, use the no form of this command.
width characters
no width

Syntax Description

characters

Defaults

80 character columns

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Number of character columns displayed on the terminal.

By default, the route provides a screen display width of 80 characters. You can reset this value for the
current session if it does not meet the needs of your terminal.
The rlogin protocol uses the value of the characters argument to set up terminal parameters on a remote
host.

Examples

In the following example the location for line 7 is defined as console terminal and the display is set to
132 columns wide:
Router(config)# line 7
Router(config-line)# location console terminal
Router(config-line)# width 132

Related Commands

Command

Description

terminal width

Sets the number of character columns on the terminal screen for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

FR-122

78-11740-02

Connection, Menu, and System Banner

Commands
This chapter describes commands used for connection management, and the commands used to
configure user menus and banners.
For connection and system banner task information and examples, refer to the Managing Connections,
Menus, and System Banners chapter in the Release 12.2 Cisco IOS Configuration Fundamentals
Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-123

Connection, Menu, and System Banner Commands

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 global configuration command. To delete the existing EXEC banner, use the no
form of this command.
banner exec d message d
no banner exec

Syntax Description

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the banner message.

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 Table 9.

Defaults

Disabled (no EXEC banner is displayed).

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

11.3(7.5) AA

Token functionality was introduced.

12.0(3) T

Token functionality was integrated in the 12.0 T release train.

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 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 routers host name and IP address. The tokens are
described in Table 9.

Cisco IOS Configuration Fundamentals Command Reference

FR-124

78-11740-02

Connection, Menu, and System Banner Commands

banner exec

Table 9

banner exec Tokens

Token

Information Displayed in the Banner

$(hostname) Displays the host name for the router.

Examples

$(domain)

Displays the domain name for the router.

$(line)

Displays the vty or tty (asynchronous) line number.

$(line-desc)

Displays the description attached to the line.

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

Description

banner incoming

Defines a customized banner to be displayed when there is an incoming

connection to a terminal line from a host on the network.

banner login

Defines a customized banner to be displayed before the username and

password login prompts.

banner motd

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

banner slip-ppp

Defines a customized banner to be displayed when a Serial-line IP or

Point-to-Point connection is made.

exec-banner

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

78-11740-02

FR-125

Connection, Menu, and System Banner Commands

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 global configuration command. To delete the
incoming connection banner, use the no form of this command.
banner incoming d message d
no banner incoming

Syntax Description

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the banner message.

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 Table 10.

Defaults

Disabled (no incoming banner is displayed).

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

11.3(7.5) AA

Token functionality was introduced.

12.0(3) T

Token functionality was integrated in the 12.0 T release train.

Usage Guidelines

Follow the banner incoming 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.
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 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 routers host name and IP address. The tokens are
described in Table 10.

Cisco IOS Configuration Fundamentals Command Reference

FR-126

78-11740-02

Connection, Menu, and System Banner Commands

banner incoming

Table 10

Examples

banner incoming Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays the host name for the router.

$(domain)

Displays the domain name for the router.

$(line)

Displays the vty or tty (asynchronous) line number.

$(line-desc)

Displays the description attached to the line.

The following example sets an incoming connection banner. The pound sign (#) is used as a delimiting
character.
Router# 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

Description

banner exec

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

initiated.

banner login

Defines a customized banner to be displayed before the username and

password login prompts.

banner motd

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

banner slip-ppp

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

78-11740-02

FR-127

Connection, Menu, and System Banner Commands

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 global configuration command. To disable the login banner, use no form
of this command.
banner login d message d
no banner login

Syntax Description

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the banner message.

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 Table 11.

Defaults

Disabled (no login banner is displayed).

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

11.3(7.5) AA

Token functionality was introduced.

12.0(3) T

Token functionality was integrated in the 12.0 T release train.

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.
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 routers host name and IP address. The tokens are
described in Table 11.
Table 11

Token

banner login Tokens

Information Displayed in the Banner

$(hostname) Displays the host name for the router.

$(domain)

Displays the domain name for the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-128

78-11740-02

Connection, Menu, and System Banner Commands

banner login

Table 11

Examples

banner login Tokens (continued)

Token

Information Displayed in the Banner

$(line)

Displays the vty or tty (asynchronous) line number.

$(line-desc)

Displays the description attached to the line.

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

Description

banner exec

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

initiated.

banner incoming

Defines a customized message to be displayed when there is an incoming

connection to a terminal line from a host on the network.

banner motd

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

banner slip-ppp

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

78-11740-02

FR-129

Connection, Menu, and System Banner Commands

banner motd

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

Syntax Description

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the banner message.

message

Message text. You can include tokens in the form $(token) in the
message text. Tokens will be replaced with the corresponding
configuration variable.

Defaults

Disabled (no MOTD banner is displayed).

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

11.3(7.5) AA

Token functionality was introduced.

12.0(3) T

Token functionality was integrated in the 12.0 T release train.

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
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 routers host name and IP address. The tokens are
described in Table 12.

Cisco IOS Configuration Fundamentals Command Reference

FR-130

78-11740-02

Connection, Menu, and System Banner Commands

banner motd

Table 12

Examples

banner motd Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays the host name for the router.

$(domain)

Displays the domain name for the router.

$(line)

Displays the vty or tty (asynchronous) line number.

$(line-desc)

Displays the description attached to the line.

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

Description

banner exec

Defines and enables a customized banner to be displayed whenever the

EXEC process is initiated.

banner incoming

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.

banner login

Defines and enables a customized banner to be displayed before the

username and password login prompts.

banner slip-ppp

Defines and enables a customized banner to be displayed when a Serial-line

IP or Point-to-Point connection is made.

exec-banner

Controls (enables or disables) the display of EXEC banners and

message-of-the-day banners on a specified line or lines.

motd-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

78-11740-02

FR-131

Connection, Menu, and System Banner Commands

banner slip-ppp

banner slip-ppp
To customize the banner that is displayed when a SLIP or PPP connection is made, use the banner
slip-ppp global configuration command. 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

Defaults

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the banner message.

message

Message text. You can include tokens in the form $(token) in the
message text. Tokens will be replaced with the corresponding
configuration variable.

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

Modification

12.0(3)T

This command was introduced.

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.
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 MTU size. The banner tokens are described in
Table 13.

Cisco IOS Configuration Fundamentals Command Reference

FR-132

78-11740-02

Connection, Menu, and System Banner Commands

banner slip-ppp

Table 13

Examples

banner slip-ppp Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays the host name of the router.

$(domain)

Displays the domain name of the router.

$(peer-ip)

Displays the IP address of the peer machine.

$(gate-ip)

Displays the IP address of the gateway machine.

$(encap)

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

$(encap-alt)

Displays the encapsulation type as SL/IP instead of SLIP.

$(mtu)

Displays the Maximum Transmission Unit (MTU) size.

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

Description

banner exec

Defines and enables a customized banner to be displayed whenever the

EXEC process is initiated.

banner incoming

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.

banner motd

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

slip

Initiates a connection to a remote host using Serial Line Internet Protocol

(SLIP).

ppp

Initiates a connection to a remote host using Point-to-Point Protocol (PPP).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-133

Connection, Menu, and System Banner Commands

clear tcp

clear tcp
To clear a TCP connection, use the clear tcp privileged EXEC command.
clear tcp {line line-number | local hostname port remote hostname port | tcb address}

Syntax Description

line line-number

Line number of the TCP connection to clear.

local hostname port

remote hostname port

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

tcb address

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

Modification

11.1

This command was introduced.

Usage Guidelines

The clear tcp command is particularly useful for clearing hung TCP connections.
The clear tcp line line-number command 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 port command 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
Enqueued packets for retransmit: 0, input: 0, saved: 0
Event Timers (current time is 0x36144):
Timer
Starts
Wakeups
Retrans
4
0
TimeWait
0
0
AckHold
7
4
SendWnd
0
0
KeepAlive
0
0
GiveUp
0
0
PmtuAger
0
0

Next
0x0
0x0
0x0
0x0
0x0
0x0
0x0

Cisco IOS Configuration Fundamentals Command Reference

FR-134

78-11740-02

Connection, Menu, and System Banner Commands

clear tcp

iss: 4151109680
irs: 1249472001

snduna: 4151109752
rcvnxt: 1249472032

sndnxt: 4151109752
rcvwnd:
4258

sndwnd:
delrcvwnd:

24576
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
60B75E48

Local Address
router1.cisco.com.23

Foreign Address
router20.cisco.1054

(state)
ESTAB

Router# clear tcp tcb 60B75E48

[confirm]
[OK]

Related Commands

Command

Description

show tcp

Displays the status of TCP connections.

show tcp brief

Displays a concise description of TCP connection endpoints.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-135

Connection, Menu, and System Banner Commands

exec

exec
To allow an EXEC process on a line, use the exec line configuration command. 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.

Defaults

The EXEC processes start is activated automatically on all lines.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

When you want to allow an outgoing connection only for a line, use the no exec command. When a user
tries to Telnet to a line with the no exec command configured, the user will get no response when
pressing the Return key at the login screen.

Examples

The following example turns off the EXEC process on line 7. You might want to do this on the auxiliary
port if the attached device (for example, the control port of a rack of modems) sends unsolicited data. If
this happens, an EXEC process starts, which makes the line unavailable.
line 7
no exec

Cisco IOS Configuration Fundamentals Command Reference

FR-136

78-11740-02

Connection, Menu, and System Banner Commands

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 line configuration command. 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.

Defaults

Enabled on all lines

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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 motd global configuration commands. 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-banner command is enabled or disabled.
Table 14 summarizes the effects of the exec-banner command and the motd-banner command.
Table 14

Banners Displayed Based On exec-banner and motd-banner Combinations

exec-banner (default)

no exec-banner

MOTD banner

None

motd-banner (default)

EXEC banner

no motd-banner

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. Table 15 summarizes the effects of the
exec-banner command and the motd-banner command for reverse Telnet connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-137

Connection, Menu, and System Banner Commands

exec-banner

Table 15

Examples

Banners Displayed Based On exec-banner and motd-banner Combinations

for Reverse Telnet Sessions to Async Lines

exec-banner (default)

no exec-banner

MOTD banner

Incoming banner

motd-banner (default)

Incoming banner

no motd-banner

Incoming banner

Incoming banner

The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4:
line vty 0 4
no exec-banner

Related Commands

Command

Description

banner exec

Defines and enables a customized banner to be displayed whenever the

EXEC process is initiated.

banner incoming

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.

banner motd

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

motd-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

FR-138

78-11740-02

Connection, Menu, and System Banner Commands

exec-timeout

exec-timeout
To set the interval that the EXEC command interpreter waits until user input is detected, use the
exec-timeout line configuration command. To remove the timeout definition, use the no form of this
command.
exec-timeout minutes [seconds]
no exec-timeout

Syntax Description

minutes

Integer that specifies the number of minutes.

seconds

(Optional) Additional time intervals in seconds.

Defaults

10 minutes

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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 exec-timeout 0 0 command.

Examples

The following example sets a time interval of 2 minutes, 30 seconds:

line console
exec-timeout 2 30

The following example sets a time interval of 10 seconds:

line console
exec-timeout 0 10

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-139

Connection, Menu, and System Banner Commands

lock

lock
To configure a temporary password on a line, use the lock EXEC command.
lock

Syntax Description

This command has no arguments or keywords.

Defaults

Not locked

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced in a release prior to Cisco IOS Release 10.0.

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:

Step 1

Enter the lock command. The system prompts you for a password.

Step 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.

Step 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...
OK
Router# lock
Password: <password>
Again: <password>
Locked
Password: <password>
Router#

Cisco IOS Configuration Fundamentals Command Reference

FR-140

78-11740-02

Connection, Menu, and System Banner Commands

lock

Related Commands

Command

Description

lockable

Enables the lock EXEC command.

login (EXEC)

Enables or changes a login username.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-141

Connection, Menu, and System Banner Commands

menu clear-screen

menu clear-screen
To clear the terminal screen before displaying a menu, use the menu clear-screen global configuration
command.
menu menu-name clear-screen

Syntax Description

menu-name

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Name of the menu this command should be applied to.

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:
menu Access1 clear-screen

Related Commands

Command

Description

menu (EXEC)

Invokes a user menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

no menu

Deletes a specified menu from a menu configuration.

Cisco IOS Configuration Fundamentals Command Reference

FR-142

78-11740-02

Connection, Menu, and System Banner Commands

menu command

menu command
To specify underlying commands for user menus, use the menu command global configuration
command.
menu menu-name command menu-item {command | menu-exit}

Syntax Description

menu-name

Name of the menu. You can specify a maximum of 20 characters.

menu-item

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

Command to issue when the user selects an item.

menu-exit

Provides a way for menu users to return to a higher-level menu or exit the
menu system.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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.

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-143

Connection, Menu, and System Banner Commands

menu command

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 users list of
connections. This function allows you to create a single menu entry that steps through all of the users
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 autocommand
command 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

Description

autocommand

Configures the Cisco IOS software to automatically execute a command

when a user connects to a particular line.

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-144

78-11740-02

Connection, Menu, and System Banner Commands

menu default

menu default
To specify the menu item to use as the default, use the menu default global configuration command.
menu menu-name default menu-item

Syntax Description

menu-name

Name of the menu. You can specify a maximum of 20 characters.

menu-item

Number, character, or string key of the item to use as the default.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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 9

Related Commands

Command

Description

menu (EXEC)

Invokes a preconfigured user menu.

menu command

Specifies underlying commands for user menus.

menu prompt

Specifies the prompt for a user menu.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-145

Connection, Menu, and System Banner Commands

menu line-mode

menu line-mode
To require the user to press Enter after specifying an item, use the menu line-mode global configuration
command.
menu menu-name line-mode

Syntax Description

menu-name

Defaults

Enabled for menus with more than nine items. Disabled for menus with nine or fewer items.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Name of the menu this command should be applied to.

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

Related Commands

Command

Description

menu (EXEC)

Invokes a preconfigured user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for a user menu.

menu default

Specifies the menu item to use as the default.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu text

Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-146

78-11740-02

Connection, Menu, and System Banner Commands

menu options

menu options
To set options for items in user menus, use the menu options global configuration command.
menu menu-name options menu-item {login | pause}

Syntax Description

menu-name

The name of the menu. You can specify a maximum of 20 characters.

menu-item

Number, character, or string key of the item affected by the option.

login

Requires a login before issuing the command.

pause

Pauses after the command is entered before redrawing the menu.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use the menu command and menu text global configuration commands to define a menu entry.

Examples

In the following example, a login is required before issuing the command specified by menu entry 3 of
the menu named Access1:
menu Access1 options 3 login

Related Commands

Command

Description

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-147

Connection, Menu, and System Banner Commands

menu prompt

menu prompt
To specify the prompt for a user menu, use the menu prompt global configuration command.
menu menu-name prompt d prompt d

Syntax Description

menu-name

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

Prompt string for the menu.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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)#

Related Commands

Command

Description

menu (EXEC)

Invokes a user menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-148

78-11740-02

Connection, Menu, and System Banner Commands

menu single-space

menu single-space
To display menu items single-spaced rather than double-spaced, use the menu single-space global
configuration command.
menu menu-name single-space

Syntax Description

menu-name

Defaults

Enabled for menus with more than nine items; disabled for menus with nine or fewer items.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Name of the menu this command should be applied to.

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

Description

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu status-line

Displays a line of status information about the current user at the top of a
menu.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-149

Connection, Menu, and System Banner Commands

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 global configuration command.
menu menu-name status-line

Syntax Description

menu-name

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Name of the menu this command should be applied to.

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 routers host name, the users 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

Description

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item in a menu.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-150

78-11740-02

Connection, Menu, and System Banner Commands

menu text

menu text
To specify the text of a menu item in a user menu, use the menu text global configuration command.
menu menu-name text menu-item menu-text

Syntax Description

menu-name

Name of the menu. You can specify a maximum of 20 characters.

menu-item

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.

menu-text

Text of the menu item.

Defaults

No text appears for the menu item.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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
menu Access1 text 2 UNIX Internet Access
menu Access1 text 3 Exit menu system

Related Commands

Command

Description

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-151

Connection, Menu, and System Banner Commands

menu text

Command

Description

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-152

78-11740-02

Connection, Menu, and System Banner Commands

menu title

menu title
To create a title (banner) for a user menu, use the menu title global configuration command.
menu menu-name title d menu-title d

Syntax Description

menu-name

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.

menu-title

Lines of text to appear at the top of the menu.

Defaults

The menu does not have a title.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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.
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-153

Connection, Menu, and System Banner Commands

menu title

Type a number to select an option;

Type 9 to exit the menu.
/
Router(config)#

Related Commands

Command

Description

menu (EXEC)

Invokes a user menu.

menu clear-screen

Clears the terminal screen before displaying a menu.

menu command

Specifies underlying commands for user menus.

menu default

Specifies the menu item to use as the default.

menu line-mode

Requires the user to press Enter after specifying an item.

menu options

Sets options for items in user menus.

menu prompt

Specifies the prompt for a user menu.

menu single-space

Displays menu items single-spaced rather than double-spaced.

menu status-line

Displays a line of status information about the current user at the top of a
menu

menu text

Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

FR-154

78-11740-02

Connection, Menu, and System Banner Commands

no menu

no menu
To delete a user menu from the configuration file, use the no menu global configuration command.
no menu menu-name

Syntax Description

menu-name

Defaults

None

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Name of the menu to delete from the configuration file.

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

Description

menu (EXEC)

Invokes a user menu.

menu command

Specifies underlying commands for user menus.

menu prompt

Specifies the prompt for a user menu.

menu text

Specifies the text of a menu item in a user menu.

menu title

Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-155

Connection, Menu, and System Banner Commands

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 line configuration command. 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.

Defaults

Enabled on all lines.

Command Modes

Line configuration

Command History

Release

Modification

11.1

This command was introduced.

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-banner
command is enabled or disabled. Table 16 summarizes the effects of the exec-banner command and the
motd-banner command.
Table 16

Banners Displayed Based On exec-banner and motd-banner Combinations

exec-banner (default)

no exec-banner

MOTD banner

None

motd-banner (default)

EXEC banner

no motd-banner

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. Table 17 summarizes the effects of the
exec-banner command and the motd-banner command for reverse Telnet connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-156

78-11740-02

Connection, Menu, and System Banner Commands

motd-banner

Table 17

Examples

Banners Displayed Based On exec-banner and motd-banner Combinations

for Reverse Telnet Sessions to Async Lines

exec-banner (default)

no exec-banner

MOTD banner

Incoming banner

motd-banner (default)

Incoming banner

no motd-banner

Incoming banner

Incoming banner

The following example suppresses the MOTD banner on vty lines 0 through 4:
line vty 0 4
no motd-banner

Related Commands

Command

Description

banner exec

Defines and enables a customized banner to be displayed whenever the

EXEC process is initiated.

banner incoming

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.

banner motd

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

motd-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

78-11740-02

FR-157

Connection, Menu, and System Banner Commands

name-connection

name-connection
To assign a logical name to a connection, use the name-connection user EXEC command.
name-connection

Syntax Description

This command has no arguments or keywords.

Defaults

No logical name is defined.

Command Modes

User EXEC

Command History

Release

Modification

10.0

This command was introduced.

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 blue to the connection:
Router> where
Conn Host
* 1 doc-2509

Address
172.30.162.131

Byte
0

Idle Conn Name

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

Description

where

Lists open sessions associated with the current terminal line.

Cisco IOS Configuration Fundamentals Command Reference

FR-158

78-11740-02

Connection, Menu, and System Banner Commands

refuse-message

refuse-message
To define and enable a line-in-use message, use the refuse-message line configuration command. To
disable the message, use the no form of this command.
refuse-message d message d
no refuse-message

Syntax Description

Delimiting character of your choicea pound sign (#), for example.

You cannot use the delimiting character in the message.

message

Message text.

Defaults

Disabled (no line-in-use message is displayed).

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

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. 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:

Examples

1.

Accepts the connection.

2.

Prints the custom message.

3.

Clears the connection.

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
refuse-message

/The dial-out modem is currently in use.

Please try again later./

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-159

Connection, Menu, and System Banner Commands

send

send
To send messages to one or all terminal lines, use the send EXEC command.
send {line-number | * | aux number | console number | tty number | vty number}

Syntax Description

line-number

Line number to which the message will be sent.

Sends a message to all lines.

aux number

Sends a message to the specified AUX port.

console number

Sends a message to the specified console port.

tty number

Sends a message to the specified asynchronous line.

vty number

Sends a message to the specified virtual asynchronous line.

Defaults

No messages are sent.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Caution

Examples

After entering this command, the system prompts for the message to be sent, which can be up to 500
characters long. Enter Ctrl-Z to end the message. Enter Ctrl-C to abort this command.

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 a
valid Unix command) will be interpreted as a command. For this reason you should limit your use of any
unmonitored connection to a router that uses an interactive shell.

The following example sends a message to all lines:

2509# 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]
2509#

***
***
*** Message from tty0 to all terminals:
***
The system 2509 will be shut down in 10 minutes for repairs.

Cisco IOS Configuration Fundamentals Command Reference

FR-160

78-11740-02

Connection, Menu, and System Banner Commands

send

2509#

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-161

Connection, Menu, and System Banner Commands

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 global configuration command. 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.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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.
Router2(config)# service linenumber
Router2(config)# end
Router2# logout

End with CNTL/Z.

[Connection to Router2 closed by foreign host]

Router1> telnet Router2

Cisco IOS Configuration Fundamentals Command Reference

FR-162

78-11740-02

Connection, Menu, and System Banner Commands

service linenumber

Trying Router2 (172.30.162.131)... Open

Welcome to Router2.
Router2 line 10

User Access Verification

Password:
Router2>

Related Commands

Command

Description

show users

Displays information about the active lines on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-163

Connection, Menu, and System Banner Commands

vacant-message

vacant-message
To display an idle terminal message, use the vacant-message line configuration command. To remove
the default vacant message or any other vacant message that may have been set, use the no form of this
command.
vacant-message [d message d]
no vacant-message

Syntax Description

Defaults

(Optional) Delimiting character that marks the beginning and end of

the vacant-message. Text delimiters are characters that do not
ordinarily appear within the text of a title, such as slash ( / ), double
quote ("), or tilde (~). ^C is reserved for special use and should not be
used in the message.

message

(Optional) Vacant terminal message.

The format of the default vacant message is as follows:

<blank lines>
hostname tty# is now available
<blank lines>
Press RETURN to get started.

This message is generated by the system.

Command Modes

Line configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command enables the banner to be displayed on the screen of an idle terminal. The vacant-message
command without any arguments restores the default message.
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.

Note

Examples

For a rotary group, you need to define only the message for the first line in the group.

The following example turns on the system banner and displays this message:
line 0
vacant-message #
Welcome to Cisco Systems, Inc.

Cisco IOS Configuration Fundamentals Command Reference

FR-164

78-11740-02

Connection, Menu, and System Banner Commands

vacant-message

Press Return to get started.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-165

Connection, Menu, and System Banner Commands

vacant-message

Cisco IOS Configuration Fundamentals Command Reference

FR-166

78-11740-02

Cisco IOS Web Browser User Interface

Commands
This chapter provides descriptions of the commands used to enable the HTTP server on your router to
allow the use of the Cisco IOS Web browser user interface (UI) and ClickStart.
For configuration tasks and examples, refer to the Using the Cisco Web Browser User Interface chapter
in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-167

Cisco IOS Web Browser User Interface Commands

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 line configuration command. 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.

Defaults

Disabled

Command Modes

Line configuration

Command History

Release

Modification

11.3

This command was introduced.

Usage Guidelines

If you are configuring a Cisco IOS platform using the Cisco Web browser UI, this feature 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

Related Commands

Command

Description

terminal international

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

FR-168

78-11740-02

Cisco IOS Web Browser User Interface Commands

ip http access-class

ip http access-class
To assign an access list to the HTTP server used by the Cisco IOS ClickStart software or the Cisco Web
browser UI, use the ip http access-class global configuration command. To remove the assigned access
list, use the no form of this command.
ip http access-class {access-list-number | access-list-name}
no ip http access-class {access-list-number | access-list-name}

Syntax Description

access-list-number

Standard IP access list number in the range 0 to 99, as configured by the

access-list (standard) global configuration command.

access-list-name

Name of a standard IP access list, as configured by the ip access-list

command.

Defaults

No access list is applied to the HTTP server.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

If this command is configured, the specified access list is assigned to the HTTP server. Before the HTTP
server accepts a connection, it checks the access list. If the check fails, the HTTP server does not accept
the request for a connection.

Examples

The following example assigns the access list named marketing to the HTTP server:
ip http access-class marketing
ip access-list standard marketing
permit 192.168.34.0 0.0.0.255
permit 172.16.0.0 0.0.255.255
permit 10.0.0.0 0.255.255.255
! (Note: all other access implicitly denied)

Related Commands

Command

Description

ip access-list

Defines an IP access list by name.

ip http server

Enables monitoring or configuring of routers using the Cisco Web browser

UI.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-169

Cisco IOS Web Browser User Interface Commands

ip http authentication

ip http authentication
To specify a particular authentication method for HTTP server users, use the ip http authentication
global configuration command. To disable a configured authentication method, use the no form of this
command.
ip http authentication {aaa | enable | local | tacacs}
no ip http authentication {aaa | enable | local | tacacs}

Syntax Description

aaa

Indicates that the AAA facility is used for authentication.

enable

Indicates that the enable password method, which is the default method of HTTP
server user authentication, is used for authentication.

local

Indicates that the local user database as defined on the Cisco router or access
server is used for authentication.

tacacs

Indicates that the TACACS or XTACACS server is used for authentication.

Defaults

The default method of authentication for the HTTP server interface is the enable password method.

Command Modes

Global configuration

Command History

Release

Modification

11.2 F

This command was introduced.

Usage Guidelines

The ip http authentication command specifies the authentication method to be used for login when a
client connects to the HTTP server. Use of the ip http authentication aaa command option is
recommended. The enable, local, and tacacs methods should be specified using the aaa authentication
login command.
The enable password method is the default HTTP server authentication method. If the enable password
is used as the HTTP server login authentication method, the client connects to the HTTP server with a
default privilege level of 15.

Note

When the enable password is used as the HTTP server login authentication method, any username
entered will be ignored; the server will only verify the enable password. This may make it easier for
an attacker to access the router. Because a username and password pair is more secure than using only a
password for authentication, using only enable password for authentication is strongly discouraged.
Instead, use of the local or tacacs authentication options, configured as part of a global Authentication,
Authorization, and Accounting (AAA) framework, is recommended.
To configure HTTP access as part of a AAA policy, use the ip http authentication aaa command option.
The local, tacacs, or enable authentication methods should then be configured using the aaa
authentication login command.

Cisco IOS Configuration Fundamentals Command Reference

FR-170

78-11740-02

Cisco IOS Web Browser User Interface Commands

ip http authentication

For information about adding users into the local username database, refer to the Cisco IOS Security
Configuration Guide.

Examples

The following example specifies that the method configured for AAA should be used for authentication
for HTTP server users. The AAA login method is configured as the local username/password
authentication method.
Router(config)# ip http authentication aaa
Router(config)# aaa authentication login default local

Related Commands

Command

Description

ip http server

Enables the HTTP server.

aaa authentication login

Specifies the login authentication method to be used by the

authentication, authorization, and accounting (AAA) service.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-171

Cisco IOS Web Browser User Interface Commands

ip http port

ip http port
To specify the port to be used by the Cisco IOS ClickStart software or the Cisco Web browser UI, use
the ip http port global configuration command. To use the default port, use the no form of this
command.
ip http port port-number
no ip http port

Syntax Description

port-number

Defaults

The HTTP server uses port 80.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Port number for use by the HTTP server.

Usage Guidelines

Use this command if ClickStart or the Cisco Web browser UI cannot use port 80.

Examples

The following example configures the router so that you can use ClickStart or the Cisco Web browser
UI through port 60:
ip http server
ip http port 60

Related Commands

Command

Description

ip http server

Enables a Cisco 1003, Cisco 1004, or Cisco 1005 router to be configured

from a browser using the Cisco IOS ClickStart software, and enables any
router to be monitored or have its configuration modified from a browser
using the Cisco Web browser UI.

Cisco IOS Configuration Fundamentals Command Reference

FR-172

78-11740-02

Cisco IOS Web Browser User Interface Commands

ip http server

ip http server
To enable the Cisco Web browser UI on a router or access server, use the ip http server global
configuration command. To disable this feature, use the no form of this command.
ip http server
no ip http server

Syntax Description

This command has no arguments or keywords.

Defaults

This feature is automatically enabled on Cisco 1003, Cisco 1004, and Cisco 1005 routers that have not
yet been configured. For Cisco 1003, Cisco 1004, and Cisco 1005 routers that have already been
configured, and for all other routers, this feature is disabled.
The HTTP server is disabled on the Cisco Catalyst 4000 series switch. The HTTP server is enabled for
clustering and on the following Cisco switches: Catalyst 3700 series, Catalyst 3750 series, Catalyst 3550
series, Catalyst 3560 series, and Catalyst 2950 series.

Command History

Release

Modification

11.2

This command was introduced.

Command Modes

Global configuration

Usage Guidelines

This command enables a simple HTTP server on your system. The HTTP server in Cisco IOS software
is used primarily for the Cisco Web browser user interface (UI) and ClickStart.
The Cisco Web browser UI allows configuration and monitoring of a router or access server using any
web browser. Enabling the Cisco Web browser UI also allows Cisco 1003, Cisco 1004, and Cisco 1005
routers to be configured from a browser using ClickStart.
To view the home page of the router, use a Web browser pointed to http://x.y.z.t, where x.y.z.t is the IP
address of your router or access server, or, if a name has been set, use http://router-name. Varying forms
of authentication for login can be set using the ip http authentication command, but the default login
method is entering the enable password when prompted.
For information on accessing a router Web page at a privilege level other the default of 15 (privileged
EXEC mode), see the Using the Cisco Web Browser to Issue Commands section of the Cisco IOS
Configuration Fundamentals Configuration Guide.

Examples

The following example enables the HTTP server on the router, allowing use of the Cisco Web browser
UI to monitor the router and issue commands to it:
ip http server

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-173

Cisco IOS Web Browser User Interface Commands

ip http server

Related Commands

Command

Description

ip http access-class

Assigns an access list to the HTTP server used by the Cisco IOS ClickStart
software or the Cisco Web browser UI.

ip http authentication Specifies an authentication method for HTTP server users.

ip http port

Specifies the port to be used by the Cisco IOS ClickStart software or the
Cisco Web browser UI.

Cisco IOS Configuration Fundamentals Command Reference

FR-174

78-11740-02

Cisco IOS Web Browser User Interface Commands

terminal international

terminal 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 (^[) for a current Telnet session, use the terminal international
EXEC command. To display characters in 7-bit format for a current Telnet session, use the no form of
this command.
terminal international
no terminal international

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

EXEC

Command History

Release

Modification

11.3

This command was introduced.

Usage Guidelines

If you are configuring a Cisco IOS platform using the Cisco Web browser UI, this feature 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 for the current Telnet session:
Router# terminal international

Related Commands

Command

Description

international

Prints the Escape character as a single character instead of as the caret and
bracket symbols (^[) 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

78-11740-02

FR-175

Cisco IOS Web Browser User Interface Commands

terminal international

Cisco IOS Configuration Fundamentals Command Reference

FR-176

78-11740-02

File Management Commands

Cisco IOS File System Commands

This chapter describes the basic set of commands used to manipulate files on your routing device using
the Cisco IOS File System (IFS) in Cisco IOS Release 12.2.
Commands in this chapter use URLs as part of the command syntax. URLs used in the Cisco 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
chapter. The prefixes listed below can also be used in the filesystem arguments in this chapter.
Table 18 lists common URL network prefixes used to indicate a device on the network.
Table 18

Network Prefixes for Cisco IFS URLs

Prefix

Description

ftp:

Specifies a File Transfer Protocol (FTP) network server.

rcp:

Specifies an remote copy protocol (rcp) network server.

tftp:

Specifies a TFTP server.

Table 19 lists the available suffix options (file indentification suffixes) for the URL prefixes used in
Table 18.
Table 19

File ID Suffixes for Cisco IFS URLs

Prefix

Suffix Options

ftp:

[[//[username[:password]@]location]/directory]/filename
For example:
ftp://network-config (prefix://filename)
ftp://jeanluc:[email protected]/ship-config

rcp:

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

tftp:

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

Table 20 lists common URL prefixes used to indicate memory locations on the system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-179

Cisco IOS File System Commands

Table 20

File System Prefixes for Cisco IFS URLs

Prefix

Description

bootflash:

Bootflash memory.

disk0:

Rotating disk media.

flash:
Flash memory. This prefix is available on most platforms. For platforms that do
[partition-number] 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
flh:

Flash load helper log files.

null:

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

nvram:

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

slavebootflash:

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

Dual RSPs.

slavenvram:

NVRAM on a slave RSP card.

slaveslot0:

First PCMCIA card on a slave RSP card.

slaveslot1:

Second PCMCIA card on a slave RSP card.

slot0:

First PCMCIA Flash memory card.

slot1:

Second PCMCIA Flash memory card.

xmodem:

Obtain the file from a network machine using the Xmodem protocol.

ymodem:

Obtain the file from a network machine using the Ymodem protocol.

For details about the Cisco IFS, and for IFS configuration tasks, refer to the Configuring the Cisco IOS
File System chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.
For details about Flash File System types (Class A, B, and C), refer to PCMCIA Filesystem
Compatibility Matrix and Filesystem Information Tech Note on Cisco.com

Cisco IOS Configuration Fundamentals Command Reference

FR-180

78-11740-02

Cisco IOS File System Commands

cd

cd
To change the default directory or file system, use the cd EXEC command.
cd [filesystem:]

Syntax Description

filesystem:

Defaults

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.

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

colon.

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

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

For all EXEC commands that have an optional filesystem argument, the system uses the file system
specified by the cd command when you omit the optional filesystem argument. For example, the dir
EXEC command, which displays a list of files on a file system, contain an optional filesystem argument.
When you omit this argument, the system lists the files on the file system specified by the cd command.

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:/

Related Commands

Command

Description

copy

Copies any file from a source to a destination.

delete

Deletes a file on a Flash memory device.

dir

Displays a list of files on a file system.

pwd

Displays the current setting of the cd command.

show file systems

Lists available file systems and their alias prefix names.

undelete

Recovers a file marked deleted on a Class A or Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-181

Cisco IOS File System 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 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 in this chapter command for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-182

78-11740-02

Cisco IOS File System Commands

copy

copy
To copy any file from a source to a destination, use the copy EXEC command.
copy [/erase] source-url destination-url

Syntax Description

/erase

(Optional) Erases the destination file system before copying.

source-url

The location URL or alias of the source file or directory to be copied.

destination-url

The destination URL or alias of the copied file or directory.

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).

Timesaver

Aliases are used to cut down on 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-config command). These aliases also allow you to continue using some of the
common commands used in previous versions of Cisco IOS software.
Table 21 shows two keyword shortcuts to URLs.
Table 21

Common Keyword Aliases to URLs

Keyword

Source or Destination

running-config

(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.

startup-config

(Optional) Keyword alias for the nvram:startup-config URL.

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-config command. 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 router looks for
a file in the current directory.
Table 22 lists URL aliases for Special (opaque) file systems. Table 23 lists them for network file systems,
and Table 24 lists them for local writable storage.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-183

Cisco IOS File System Commands

copy

Table 22

URL Prefix Aliases for Special File Systems

Alias

Source or Destination

flh:

Source URL for flash load helper log files.

modem:

Destination URL for loading modem firmware on Cisco 5200 and

5300 Series routers.

nvram:

Router NVRAM. You can copy the startup configuration into or

from NVRAM. You can also display the size of a private
configuration file.

null:

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

system:

Source or destination URL for system memory, which includes the

running configuration.

xmodem:

Source destination for the file from a network machine that uses the
Xmodem protocol.

ymodem:

Source destination for the file from a network machine that uses the
Xmodem protocol.

Table 23

URL Prefix Aliases for Network File Systems

Alias

Source or Destination

ftp:

Source or destination URL for an File Transfer Protocol (FTP)

network server. The syntax for this alias is as follows:
ftp:[[[//username [:password]@]location]/directory]/filename.

rcp:

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.

tftp:

Source or destination URL for a TFTP network server. The syntax

for this alias is tftp:[[//location]/directory]/filename.

Table 24

URL Prefix Aliases for Local Writable Storage File Systems

Alias

Source or Destination

bootflash:

Source or destination URL for boot flash memory.

disk0: and disk1:

Source or destination URL of rotating media.

flash:

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.

slavebootflash:

Source or destination URL for internal Flash memory on the slave

RSP card of a router configured for HSA.

slaveram:

NVRAM on a slave RSP card of a router configured for HSA.

slaveslot0:

Source or destination URL of the first PCMCIA card on a slave

RSP card of a router configured for HSA.

Cisco IOS Configuration Fundamentals Command Reference

FR-184

78-11740-02

Cisco IOS File System Commands

copy

Table 24

URL Prefix Aliases for Local Writable Storage File Systems (continued)

Alias

Source or Destination

slaveslot1:

Source or destination URL of the second PCMCIA slot on a slave

RSP card of a router configured for HSA.

slot0:

Source or destination URL of the first PCMCIA Flash memory

card.

slot1:

Source or destination URL of the second PCMCIA Flash memory

card.

Command Modes

EXEC

Command History

Release

Modification

11.3 T

This command was introduced.

Usage Guidelines

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.
If you enter information, choose one of the following three options: running-config, startup-config, or
a file system alias (see previous tables.) 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 not requiring 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 host name. The
filename is specified relative to the directory used for file transfers.
This section contains usage guidelines for the following topics:

Understanding Invalid Combinations of Source and Destination

Understanding Character Descriptions

Understanding Partitions

Using rcp

Using FTP

Storing Images on Servers

Copying from a Server to Flash Memory

Verifying Images

Copying a Configuration File from a Server to the Running Configuration

Copying a Configuration File from a Server to the Startup Configuration

Storing the Running or Startup Configuration on a Server

Saving the Running Configuration to the Startup Configuration

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-185

Cisco IOS File System Commands

copy

Using CONFIG_FILE, BOOT, and BOOTLDR Environment Variables

Using the Copy Command with the Dual RSP Feature

Understanding Invalid Combinations of Source and Destination

Some invalid combinations of source and destination exist. Specifically, you cannot copy the following:

From a running configuration to a running configuration

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

Table 25 describes the characters that you may see during processing of the copy command.
Table 25

copy Character Descriptions

Character

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 EXEC command.
Using rcp

The rcp protocol 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-186

78-11740-02

Cisco IOS File System Commands

copy

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 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 user
name 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 remote username and password upon each FTP request to a
server. When you copy a configuration 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 [email protected]. 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.
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 user name as the remote username.
Refer to the documentation for your FTP server for more details.
Use the ip ftp username and ip ftp password global configuration commands to specify a username
and password for all copies. Include the username in the copy command if you want to specify a
username for that copy operation only.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-187

Cisco IOS File System Commands

copy

Storing Images on Servers

Use the copy flash: destination-url command (for example, copy flash: tftp:) to copy a system image
or boot image from Flash memory to a network server. Use the copy of the image as a backup copy. Also,
use it to verify that the copy 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. Depending on the destination filesystem 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.

Caution

If the checksum values do not match, do not reboot the router. Instead, reissue the copy command
and compare the checksums again. If the checksum is repeatedly wrong, copy the original image back
into Flash memory before you 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.
An alternate method for file verification is to 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: | tftp:} running-config command 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-188

78-11740-02

Cisco IOS File System Commands

copy

Copying a Configuration File from a Server to the Startup Configuration

Use the copy {ftp: | rcp: | tftp:} nvram:startup-config command 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: | tftp:} command to copy the current configuration
file to a network server using FTP, rcp, or TFTP. Use the copy nvram:startup-config {ftp: | rcp: | 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.

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-config command 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 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 IOS Configuration Fundamentals Command Reference

78-11740-02

FR-189

Cisco IOS File System Commands

copy

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-config command.
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.
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 asks if 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.

Examples

The following examples illustrate uses of the copy command.

Copying an Image from a Server to Flash Memory Examples

Saving a Copy of an Image on a Server Examples

Copying a Configuration File from a Server to the Running Configuration Example

Copying a Configuration File from a Server to the Startup Configuration Example

Copying the Running Configuration to a Server Example

Copying the Startup Configuration to a Server Example

Saving the Current Running Configuration Example

Moving Configuration Files to Other Locations Examples

Copying an Image from the Master RSP Card to the Slave RSP Card Example

Copying an Image from a Server to Flash Memory Examples

The following three 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

Copying an Image from a Server to a Flash Memory Using Flash Load Helper Example

Copying an Image from a Server to a Flash Memory Card Partition Example

Cisco IOS Configuration Fundamentals Command Reference

FR-190

78-11740-02

Cisco IOS File System Commands

copy

Copying an Image from a Server to Flash Memory Example

This 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
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
1
4096K
2048K
2048K
2
4096K
2048K
2048K

Bank-Size
2048K
2048K

State
Read Only
Read/Write

Copy-Mode
RXBOOT-FLH
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: !

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-191

Cisco IOS File System Commands

copy

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 asks 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
1
2
3
4

Size
4096K
4096K
4096K
4096K

Used
3068K
1671K
0K
3825K

Free
1027K
2424K
4095K
270K

Bank-Size
4096K
4096K
4096K
4096K

State
Read/Write
Read/Write
Read/Write
Read/Write

Copy Mode
Direct
Direct
Direct
Direct

[Type ?<no> for partition directory; ? for full directory; q to abort]

Which partition? [default = 1]
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-i-mz:
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Verifying checksum... OK (0xF89A)
Flash device copy took 00:00:18 [hh:mm:ss]

Cisco IOS Configuration Fundamentals Command Reference

FR-192

78-11740-02

Cisco IOS File System Commands

copy

Saving a Copy of an Image on a Server Examples

The following four examples use copy commands to copy image files to a server for storage:

Copy an Image from Flash Memory to an rcp Server Example

Copy an Image from a Partition of Flash Memory to a Server Example

Copying an Image from a Flash Memory File System to an FTP Server Example

Copying an Image from Boot Flash Memory to a TFTP Server Example

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 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.
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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-193

Cisco IOS File System Commands

copy

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]

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 is172.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.

Cisco IOS Configuration Fundamentals Command Reference

FR-194

78-11740-02

Cisco IOS File System Commands

copy

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]

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:
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...

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-195

Cisco IOS File System Commands

copy

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:
copy flash:router-image nvram:startup-config

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
1
2

Size
4096K
16384K

Used
3070K
1671K

Free
1025K
14712K

Bank-Size
4096K
8192K

State
Read/Write
Read/Write

Copy Mode
Direct
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)

Cisco IOS Configuration Fundamentals Command Reference

FR-196

78-11740-02

Cisco IOS File System 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:
copy slot1:router-image slaveslot0:

Related Commands

Command

Description

boot config

Specifies the device and filename of the configuration file from which the
router configures itself during initialization (startup).

boot system

Specifies the system image that the router loads at startup.

cd

Changes the default directory or file system.

copy xmodem: flash:

Copies any file from a source to a destination.

copy ymodem: flash:

Copies any file from a source to a destination.

delete

Deletes a file on a Flash memory device.

dir

Displays a list of files on a file system.

erase

Erases a file system.

ip rcmd
remote-username

Configures the remote username to be used when requesting a remote

copy using rcp.

reload

Reloads the operating system.

show bootvar

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.

show (Flash file system)

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

slave auto-sync config

Turns on automatic synchronization of configuration files for a

Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Backup.

verify bootflash:

Either of the identical verify bootflash: or verify bootflash commands

replaces the copy verify bootflash command. Refer to the verify
command for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-197

Cisco IOS File System Commands

delete

delete
To delete a file from a Flash memory device or NVRAM, use the delete EXEC command.
delete URL [/force | /recursive]

Syntax Description

URL

IFS URL of the file to be deleted. Include the filesystem prefix,

followed by a colon, and, optionally, the name of a file or directory.

/force

(Optional) Deletes the specified file or directory with prompting you

for verification.
Note

/recursive

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

Command History

Release

Modification

11.0

This command was 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.
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 (Class A only), use the undelete EXEC
command. 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.

Examples

The following example deletes the file named test from the Flash filesystem:
Router# delete flash:test
Delete flash:test? [confirm]

Related Commands

Command

Description

cd

Changes the default directory or file system.

dir

Displays a list of files on a file system.

Cisco IOS Configuration Fundamentals Command Reference

FR-198

78-11740-02

Cisco IOS File System Commands

delete

Command

Description

show bootvar

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.

squeeze

Permanently deletes Flash files by squeezing a Class A Flash file system.

undelete

Recovers a file marked deleted on a Class A or Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-199

Cisco IOS File System Commands

dir

dir
To display a list of files on a file system, use the dir EXEC command.
dir [/all] [filesystem: ][file-url]

Syntax Description

/all

(Optional) Lists deleted files, undeleted files, and files with errors.

filesystem:

(Optional) File system or directory containing the files to list,

followed by a colon.

file-url

(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.

Defaults

The default file system is specified by the cd command. When you omit the /all keyword, the Cisco IOS
software displays only undeleted files.

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

Use the show (Flash file system) command to display more detail about the files in a particular file
system.

Examples

The following is sample output from the dir command:

Router# dir slot0:
Directory of slot0:/
1
2
5
7

-rw-rw-rw-rw-

4720148
4767328
639
639

Aug
Oct
Oct
Oct

29
01
02
02

1997
1997
1997
1997

17:49:36 hampton/nitro/c7200-j-mz
18:42:53 c7200-js-mz
12:09:32 rally
12:37:13 the_time

20578304 bytes total (3104544 bytes free)

Router# dir /all slot0:
Directory of slot0:/
1
2
3
4

-rw-rw-rw-rw-

4720148
4767328
7982828
639

Aug
Oct
Oct
Oct

29
01
01
02

1997
1997
1997
1997

17:49:36
18:42:53
18:48:14
12:09:17

hampton/nitro/c7200-j-mz
c7200-js-mz
[rsp-jsv-mz]
[the_time]

Cisco IOS Configuration Fundamentals Command Reference

FR-200

78-11740-02

Cisco IOS File System Commands

dir

5
6
7

-rw-rw-rw-

639
639
639

Oct 02 1997 12:09:32

Oct 02 1997 12:37:01
Oct 02 1997 12:37:13

rally
[the_time]
the_time

Table 26 describes the significant fields shown in the displays.

Table 26

Related Commands

dir Field Descriptions

Field

Description

Index number of the file.

-rw-

Permissions. The file can be any or all of the following:

ddirectory

rreadable

wwritable

xexecutable

4720148

Size of the file.

Aug 29 1997 17:49:36

Last modification date.

hampton/nitro/c7200-j-mz

Filename. Deleted files are indicated by square brackets around the

filename.

Command

Description

cd

Changes the default directory or file system.

delete

Deletes a file on a Flash memory device.

undelete

Recovers a file marked deleted on a Class A or Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-201

Cisco IOS File System Commands

erase

erase
To erase a file system, use the erase EXEC command. The erase nvram: command replaces the write
erase command and the erase startup-config command.
erase filesystem:

Syntax Description

filesystem:

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

File system name, followed by a colon. For example, flash: or

nvram:

When a file system is erased, none of the files in the file system can be recovered.
The erase command can be used on both Class B and Class C Flash file systems only. To reclaim space
on Flash file systems after deleting files using the delete command, you must use the erase command.
This command erases all of the files in the Flash file system.
Class A Flash file systems cannot be erased. You can delete individual files using the delete EXEC
command and then reclaim the space using the squeeze EXEC command. You can use the format EXEC
command to format the Flash file system.
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.
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.

Examples

The following example erases the NVRAM, including the startup configuration located there:
erase nvram:

The following example erases 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 erases Flash memory when Flash is partitioned, but no partition is specified in
the command:

Cisco IOS Configuration Fundamentals Command Reference

FR-202

78-11740-02

Cisco IOS File System Commands

erase

Router# erase flash:

System flash partition information:
Partition
Size
Used
Free
1
4096K
2048K
2048K
2
4096K
2048K
2048K

Bank-Size
2048K
2048K

State
Read Only
Read/Write

Copy-Mode
RXBOOT-FLH
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

Description

boot config

Specifies the device and filename of the configuration file from which
the router configures itself during initialization (startup).

delete

Deletes a file on a Flash memory device.

more
nvram:startup-config

Displays the startup configuration file contained in NVRAM or

specified by the CONFIG_FILE environment variable.

show bootvar

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

undelete

Recovers a file marked deleted on a Class A or Class B Flash file

system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-203

Cisco IOS File System Commands

erase bootflash

erase bootflash
The erase bootflash: and erase bootflash commands have identical functions. See the description of the
erase command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-204

78-11740-02

Cisco IOS File System Commands

file prompt

file prompt
To specify the level of prompting, use the file prompt global configuration command.
file prompt [alert | noisy | quiet]

Syntax Description

alert

(Optional) Prompts only for destructive file operations. This is the

default.

noisy

(Optional) Confirms all file operation parameters.

quiet

(Optional) Seldom prompts for file operations.

Defaults

alert

Command Modes

Global configuration

Command History

Release

Modification

11.0

This command was introduced.

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:
file prompt noisy

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-205

Cisco IOS File System Commands

format

format
To format a Class A or Class C Flash file system, use the format EXEC command.
Class C Flash File System

format filesystem1:
Class A Flash File System

format [spare spare-number] filesystem1: [[filesystem2:][monlib-filename]]

Caution

Syntax Description

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 when some of the sectors
fail.

spare

(Optional) Reserves spare sectors as specified by the spare-number

argument when formatting Flash memory.

spare-number

(Optional) Number of the spare sectors to reserve on formatted Flash

memory. Valid values are from 0 to 16. The default value is zero.

filesystem1:

Flash memory to format, followed by a colon.

filesystem2:

(Optional) File system containing the monlib file to use for

formatting filesystem1 followed by a colon.

monlib-filename

(Optional) Name of the ROM monitor library file (monlib file) to use
for formatting the filesystem1 argument. The default monlib file is the
one bundled with the system software.
When used with HSA and you do not specify the monlib-filename
argument, the system takes 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.

Defaults

The default monlib file is the one bundled with the system software.
The default number of spare sectors is zero (0).

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

Use this command to format Class A or C Flash memory file systems.

Cisco IOS Configuration Fundamentals Command Reference

FR-206

78-11740-02

Cisco IOS File System Commands

format

In some cases, you might need to insert a new PCMCIA Flash memory card and load images or backup
configuration files onto it. Before you can use a new Flash memory card, you must format it.
Sectors in Flash memory cards can fail. Reserve certain Flash memory sectors as spares by using the
optional spare argument on the format command to specify 0 to 16 sectors as spares. If you reserve a
small number of spare sectors for emergencies, you can still use most of the Flash memory card. If you
specify 0 spare sectors and some sectors fail, you must reformat the Flash memory 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.
In the command syntax, filesystem1: specifies the device to format and filesystem2: specifies the optional
device containing the monlib file used to format filesystem1:. If you omit the optional filesystem2: and
monlib-filename arguments, the system formats filesystem1: using the monlib file already bundled with
the system software. If you omit only the optional filesystem2: argument, the system formats
filesystem1: using 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 argumentsfilesystem2: and monlib-filenamethe system formats
filesystem1: using the monlib file from the specified device. You can specify filesystem1:s own monlib
file in this argument. If the system cannot find a monlib file, it terminates its formatting.

Caution

Examples

You can read from or write to Flash memory cards formatted for Cisco 7000 series Route Processor
(RP) cards in your Cisco 7200 and 7500 series routers, but you cannot boot the Cisco 7200 and 7500
series routers from a Flash memory card formatted for the Cisco 7000 series routers. Similarly, you
can read from or write to Flash memory cards formatted for the Cisco 7200 and 7500 series routers
in your Cisco 7000 series routers, but you cannot boot the Cisco 7000 series routers from a Flash
memory card formatted for the Cisco 7200 and 7500 series routers.

The following example formats a Flash memory card inserted in slot 0:

Router# format slot0:
Running config file
All sectors will be
Enter volume id (up
Formatting sector 1
Format device slot0

on this device, proceed? [confirm]y

erased, proceed? [confirm]y
to 31 characters): <Return>
(erasing)
completed

When the console returns to the EXEC prompt, the new Flash memory card is formatted and ready for
use.

Related Commands

Command

Description

cd

Changes the default directory or file system.

copy

Copies any file from a source to a destination.

delete

Deletes a file on a Flash memory device.

show file systems (Flash file

system)

Lists available file systems.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-207

Cisco IOS File System Commands

format

Command

Description

squeeze

Permanently deletes Flash files by squeezing a Class A Flash

file system.

undelete

Recovers a file marked deleted on a Class A or Class B Flash

file system.

Cisco IOS Configuration Fundamentals Command Reference

FR-208

78-11740-02

Cisco IOS File System Commands

fsck

fsck
To check a Class C Flash file system for damage and repair any problems, use the fsck EXEC command.
fsck [/nocrc] filesystem:

Syntax Description

/nocrc

(Optional) Omits cyclic redundancy checks (CRCs).

filesystem:

The file system to check.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Usage Guidelines

This command is only valid on Class C Flash file systems.

Examples

The following example checks the Flash file system:

Router# fsck flash:
Fsck operation may take a while. Continue? [confirm]
flashfs[4]: 0 files, 2 directories
flashfs[4]: 0 orphaned files, 0 orphaned directories
flashfs[4]: Total bytes: 8128000
flashfs[4]: Bytes used: 1024
flashfs[4]: Bytes available: 8126976
flashfs[4]: flashfs fsck took 23 seconds.
Fsck of flash: complete

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-209

Cisco IOS File System Commands

mkdir

mkdir
To create a new directory in a Class C Flash file system, use the mkdir EXEC command.
mkdir directory

Syntax Description

directory

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Usage Guidelines

The name of the directory to create.

This command is only valid on Class C Flash file systems.

If you do not specify the directory name in the command line, the router prompts you for it.

Examples

The following example creates a directory named newdir:

Router# mkdir newdir
Mkdir file name [newdir]?
Created dir flash:newdir
Router# dir
Directory of flash:
2

drwx

Mar 13 1993 13:16:21

newdir

8128000 bytes total (8126976 bytes free)

Related Commands

Command

Description

dir

Displays a list of files on a file system.

rmdir

Removes an existing directory in a Class C Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

FR-210

78-11740-02

Cisco IOS File System Commands

more

more
To display a file, use the more EXEC command.
more [/ascii | /binary | /ebcdic] file-url

Syntax Description

/ascii

(Optional) Displays a binary file in ASCII format.

/binary

(Optional) Displays a file in hex/text format.

/ebcdic

(Optional) Displays a binary file in EBCDIC format.

file-url

The URL of the file to display.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Usage Guidelines

The more system:running-config command displays the same output as the show running-config
command. The more nvram:startup-config command replaces 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
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 display files on remote systems using the more command.

Examples

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
.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-211

Cisco IOS File System Commands

more

.
.
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
!
.
.
.
!
end

Related Commands

Command

Description

boot config

Specifies the device and filename of the configuration file from which the
router configures itself during initialization (startup).

service
compress-config

Compresses startup configuration files.

show bootvar

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

FR-212

78-11740-02

Cisco IOS File System Commands

pwd

pwd
To show the current setting of the cd command, use the pwd EXEC command.
pwd

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

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 filesystem argument, the system uses the file
system specified by the cd command when you omit the optional filesystem argument.
For example, the dir command contains an optional filesystem argument and displays a list of files on a
particular file system. When you omit this filesystem argument, 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:/

Related Commands

Command

Description

cd

Changes the default directory or file system.

dir

Displays a list of files on a file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-213

Cisco IOS File System Commands

rename

rename
To rename a file in a Class C Flash file system, use the rename EXEC command.
rename url1 url2

Syntax Description

url1

The original path and filename.

url2

The new path and filename.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

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
0
0
0
243

-rw-rw-rw-rw-rw-

0
0
0
0
165

Jan
Jan
Jan
Jan
Jan

21
21
21
21
21

1998
1998
1998
1998
1998

09:51:29
09:51:29
09:51:29
09:51:31
09:53:17

Karen.1
Karen.2
Karen.3
Karen.4
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/
0
0
0
243
0

-rw-rw-rw-rw-rw-

0
0
0
165
0

Jan
Jan
Jan
Jan
Apr

21
21
21
21
24

1998
1998
1998
1998
1998

09:51:29
09:51:29
09:51:31
09:53:17
09:49:19

Karen.2
Karen.3
Karen.4
Karen.cur
test

340492288 bytes total (328384512 bytes free)

Cisco IOS Configuration Fundamentals Command Reference

FR-214

78-11740-02

Cisco IOS File System Commands

rmdir

rmdir
To remove an existing directory in a Class C Flash file system, use the rmdir EXEC command.
rmdir directory

Syntax Description

directory

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Directory to delete.

Usage Guidelines

This command is valid only on Class C Flash file systems.

Examples

The following example deletes the directory named newdir:

Router# dir
Directory of flash:
2

drwx

Mar 13 1993 13:16:21

newdir

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

Description

dir

Displays a list of files on a file system.

mkdir

Creates a new directory in a Class C Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-215

Cisco IOS File System Commands

show configuration

show configuration
The show configuration command is replaced by the show startup-config and more
nvram:startup-config commands. See the description of the show startup-config and more commands
for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-216

78-11740-02

Cisco IOS File System Commands

show file descriptors

show file descriptors

To display a list of open file descriptors, use the show file descriptors EXEC command.
show file descriptors

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

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
0
1

Position
187392
184320

Open
0001
030A

PID
2
2

Path
tftp://dirt/hampton/c4000-i-m.a
flash:c4000-i-m.a

Table 27 describes the significant fields shown in the display.

Table 27

show file descriptors Field Descriptions

Field

Description

FD

File descriptor. The file descriptor is a small integer used to specify

the file once it has been opened.

Position

Byte offset from the start of the file.

Open

Flags supplied when opening the file.

PID

Process ID of the process that opened the file.

Path

Location of the file.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-217

Cisco IOS File System Commands

show file information

show file information

To display information about a file, use the show file information EXEC command.
show file information file-url

Syntax Description

file-url

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Examples

The URL of the file to display.

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

Table 28 describes the possible file types.

Table 28

Possible File Types

Types

Description

image (a.out)

Runnable image in a.out format.

image (elf)

Runnable image in elf format.

ascii text

Configuration file or other text file.

coff

Runnable image in coff format.

ebcdic

Text generated on an IBM mainframe.

lzw compression

Lzw compressed file.

tar

Text archive file used by the Channel Interface Processor (CIP).

Cisco IOS Configuration Fundamentals Command Reference

FR-218

78-11740-02

Cisco IOS File System Commands

show file systems

show file systems

To list available file systems, use the show file systems command in EXEC mode.
show file systems

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Usage Guidelines

Use this command to learn the alias names (Prefixes) of the file systems your router supports.

Examples

The following is sample output from the show file systems command:
Router# show file systems
File Systems:

Size(b)
4194304
131066
-

Free(b)
Type
opaque
opaque
opaque
opaque
network
network
network
4190616
flash
129185
nvram
opaque

Flags
rw
rw
ro
ro
rw
rw
rw
rw
rw
wo

Prefixes
null:
system:
xmodem:
ymodem:
tftp:
rcp:
ftp:
flash:
nvram:
lex:

Table 29 describes the significant fields shown in the display.

Table 29

show file systems Field Descriptions

Type

Description

Size(b)

Amount of memory in the file system (in bytes).

Free(b)

Amount of free memory in the file system (in bytes).

Type

Type of file system.

Flags

Permissions for file system.

Prefixes

Alias for file system.

disk

The file system is for a rotating medium.

flash

The file system is for a Flash memory device.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-219

Cisco IOS File System Commands

show file systems

Table 29

show file systems Field Descriptions (continued)

Type

Description

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.

rom

The file system is for a ROM or EPROM device.

tty

The file system is for a collection of terminal devices.

unknown

The file system is of unknown type.

Table 30 describes file system flags.

Table 30

Possible File System Flags

Flag

Description

ro

The file system is Read Only.

wo

The file system is Write Only.

rw

The file system is Read/Write.

Cisco IOS Configuration Fundamentals Command Reference

FR-220

78-11740-02

Cisco IOS File System Commands

squeeze

squeeze
To permanently erase files tagged as deleted or error on Class A Flash file systems, use the squeeze
command in EXEC mode.
squeeze [/nolog] [/quiet] filesystem:

Syntax Description

/nolog

(Optional) Disables the squeeze log (recovery data) and accelerates

the squeeze process.

/quiet

(Optional) Disables status messages during the squeeze process.

filesystem:

The Flash file system, followed by a colon. Typically flash: or slot0:.

Command Modes

EXEC

Command History

Release

Modification

11.1

This command was introduced.

12.2(1)

This command was implemented in images for the Cisco 2600 and Cisco
3600 series.

12.2(4)XL

This command was implemented in images for the Cisco 1700 series.

12.1(9), 12.0(17)S
12.0(17)ST, 12.2(2),
12.2(2)T, 12.2(2)B,
12.1(9)E

The /nolog and /quiet keywords were added.

Usage Guidelines

When Flash memory is full, you might need to rearrange the files so that the space used by the files
marked deleted can be reclaimed. (This squeeze process is required for linear Flash memory cards
to make sectors contiguous; the free memory must be in a block to be usable.)
When you enter the squeeze command, the router copies all valid files to the beginning of Flash memory
and erases all files marked deleted. After the squeeze process is completed, you can write to the
reclaimed Flash memory space.

Caution

After performing the squeeze process you cannot recover deleted files using the undelete EXEC
mode command.
In addition to removing deleted files, the squeeze command removes any files that the system has
marked as error. An error file is created when a file write fails (for example, the device is full). To
remove error files, you must use the squeeze command.
Rewriting Flash memory space during the squeeze operation may take several minutes.
Using the /nolog keyword disables the log for the squeeze process. In most cases this will speed up the
squeeze process. However, if power is lost or the Flash card is removed during the squeeze process, all
the data on the Flash card will be lost, and the device will have to be reformatted.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-221

Cisco IOS File System Commands

squeeze

Note

Using the /nolog keyword makes the squeeze process uninterruptible.

Using the /quiet keyword disables the output of status messages to the console during the squeeze
process.
If the optional keywords are not used, the progress of squeeze process will be displayed to the console,
a log for the process will be maintained, and the squeeze process is interruptible.
On Cisco 2600 or Cisco 3600 series routers, the entire file system needs to be erased once before the
squeeze command can be used. After being erased once, the squeeze command should operate properly
on the Flash file system for the rest of the Flash file systems history.
To erase an entire flash file system on a Cisco 2600 or 3600 series router, perform the following steps:

Examples

Step 1

If the Flash file system has multiple partitions, enter the no partition command to remove the partitions.
The reason for removing partitions is to ensure that the entire Flash file system is erased. The squeeze
command can be used in a Flash file system with partitions after the Flash file system is erased once.

Step 2

Enter the erase command to erase the Flash file system.

In the following example, the file named config1 is deleted, and then the squeeze command is used to
reclaim the space used by that file. The /nolog option is used to speed up the squeeze process.
Router# delete config1
Delete filename [config1]?
Delete slot0:conf? [confirm]
Router# dir slot0:
! Note that the deleted file name appears in square brackets
Directory of slot0:/
1 -rw4300244
Apr 02 2001 03:18:07 c7200-boot-mz.122-0.14
2 -rw2199
Apr 02 2001 04:45:15 [config1]
3 -rw4300244
Apr 02 2001 04:45:23 image
20578304 bytes total (11975232 bytes free)
!20,578,304 - 4,300,244 - 4,300,244 - 2,199 - 385 = 11975232

Router# squeeze /nolog slot0:

%Warning: Using /nolog option would render squeeze operation uninterruptible.
All deleted files will be removed. Continue? [confirm]
Squeeze operation may take a while. Continue? [confirm]
Squeeze of slot0 completed in 291.832 secs .
Router# dir slot0:
Directory of slot0:/
1
2

-rw-rw-

4300244
4300244

Apr 02 2001 03:18:07

Apr 02 2001 04:45:23

c7200-boot-mz.122-0.14
image

20578304 bytes total (11977560 bytes free)

!20,578,304 - 4,300,244 - 4,300,244 - 256 = 11977560

Cisco IOS Configuration Fundamentals Command Reference

FR-222

78-11740-02

Cisco IOS File System Commands

squeeze

Related Commands

Command

Description

delete

Deletes a file on a Flash memory device.

dir

Displays a list of files on a file system.

undelete

Recovers a file marked deleted on a Class A or Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-223

Cisco IOS File System Commands

undelete

undelete
To recover a file marked deleted on a Class A Flash file system, use the undelete EXEC command.
undelete index [filesystem:]

Syntax Description

index

A number that indexes the file in the dir command output.

filesystem:

(Optional) A file system containing the file to undelete, followed by

a colon.

Defaults

The default file system is the one specified by the cd command.

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced for Class A Flash File Systems (platforms
include the Cisco 7500 series and Cisco 12000 series).

Usage Guidelines

For Class A Flash file systems, when you delete a file, the Cisco IOS software simply marks the file as
deleted, but it does not erase the file. This command allows you to recover a deleted file on a specified
Flash memory device. You must undelete a file by its index because you could have multiple deleted files
with the same name. For example, the deleted list could contain multiple configuration files with the
name router-config. You undelete by index to indicate which of the many router-config files from the list
to undelete. Use the dir command to learn the index number of the file you want to undelete.
You cannot undelete a file if a valid (undeleted) file with the same name exists. Instead, you first delete
the existing file and then undelete the file you want. For example, if you had an undeleted version of the
router-config file and you wanted to use a previous, deleted version instead, you could not simply
undelete the previous version by index. You would first delete the existing router-config file and then
undelete the previous router-config file by index. You can delete and undelete a file up to 15 times.
On Class A Flash file systems, if you try to recover the configuration file pointed to by the
CONFIG_FILE environment variable, the system prompts you to confirm recovery of the file. This
prompt reminds you that the CONFIG_FILE environment variable points to an undeleted file. To
permanently delete all files marked deleted on a Flash memory device, use the squeeze EXEC
command.

Examples

The following example recovers the deleted file whose index number is 1 to the Flash memory card
inserted in slot 0:
undelete 1 slot0:

Related Commands

Cisco IOS Configuration Fundamentals Command Reference

FR-224

78-11740-02

Cisco IOS File System Commands

undelete

Command

Description

delete

Deletes a file on a Flash memory device.

dir

Displays a list of files on a file system.

squeeze

Permanently deletes Flash files by squeezing a Class A Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-225

Cisco IOS File System Commands

verify

verify
To verify the checksum of a file on a Flash memory file system, use the verify EXEC command.
verify filesystem:[file-url]

Syntax Description

filesystem:

Flash memory file system containing the files to list, followed

by a colon. Standard file system keywords for this command
include flash:, bootflash:, and slot0:.

file-url

(Optional) URL of the file to verify. Generally this consists only

of the filename(s), but you may also specify directories (file
paths), separated by forward-slashes (/). 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.

Defaults

The current working device is the default device.

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

This command replaces the copy verify and copy verify flash commands.
Use the verify command to verify the checksum of a file before using it.
Each software image that is distributed on disk uses a single checksum for the entire image. This
checksum is displayed only when the image is copied into Flash memory; it is not displayed when the
image file is copied from one disk to another.
To display the contents of Flash memory, use the show flash command. The Flash contents listing does
not include the checksum of individual files. To recompute and verify the image checksum after the
image has been copied into Flash memory, use the verify command.

Note

The verify command only performs a check on the integrity of the file after it has been saved in the file
system. It is possible for a corrupt image to be transferred to the router and saved in the file system
without detection.
To verify that a Cisco IOS software image was not corrupted while it was transfered to the router, copy
the image from where it is stored on your router to a Unix server. Also copy the same image from CCO
(Cisco.com) to the same Unix server. (The name may need to be modified if you try to save the image
in the same directory as the image that you copied from the router.) Then run a Unix diff command on
the two Cisco IOS software images. If there is no difference then the image stored on the router has not
been corrupted.

Cisco IOS Configuration Fundamentals Command Reference

FR-226

78-11740-02

Cisco IOS File System Commands

verify

Examples

The following example verifies that the file named c7200-js-mz is on the Flash memory card inserted in
slot 0:
Router# dir slot0:
Directory of slot0:/
1
2
5
7

-rw-rw-rw-rw-

4720148
4767328
639
639

Aug
Oct
Oct
Oct

29
01
02
02

1997
1997
1997
1997

17:49:36
18:42:53
12:09:32
12:37:13

hampton/nitro/c7200-j-mz
c7200-js-mz
rally
the_time

20578304 bytes total (3104544 bytes free)

tw3-7200-1# verify slot0:
Verify filename []? c7200-js-mz
Verified slot0:

The following example also verifies that the file named c7200-js-mz is on the Flash memory card
inserted in slot 0:
Router# verify slot0:?
slot0:c7200-js-mz slot0:rally slot0:hampton/nitro/c7200-j-mz

slot0:the_time

Router# verify slot0:c7200-js-mz

Verified slot0:c7200-js-mz

Related Commands

Command

Description

cd

Changes the default directory or file system.

copy

Copies any file from a source to a destination, use the copy

EXEC command.

dir

Displays a list of files on a file system.

pwd

Displays the current setting of the cd command.

show file systems

Lists available file systems.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-227

Cisco IOS File System Commands

write erase

write erase
The write erase command is replaced by the erase nvram: command. See the description of the erase
command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-228

78-11740-02

Cisco IOS File System Commands

write terminal

write terminal
The more system:running-config command replaces the write terminal command. See the description
of the more command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-229

Cisco IOS File System Commands

write terminal

Cisco IOS Configuration Fundamentals Command Reference

FR-230

78-11740-02

Configuration File Management Commands

This chapter provides detailed descriptions of commands used to manage configuration files in Cisco
IOS Release 12.2. Configuration files contain the set of commands used to customize the function of the
Cisco IOS software.
For configuration information and examples, refer to the Managing Configuration Files chapter in the
Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Flash Memory File System Types

Cisco platforms generally use one of three different Flash memory file system types. Some commands
are supported on only one or two file system types. This chapter notes commands that are not supported
on all file system types.
Use Table 31 to determine which Flash memory file system type your platform uses.
Table 31

Flash Memory File System Types

Type

Platforms

Class A

Cisco 7000 family, Cisco 12000 series routers, LightStream1010 switch

Class B

Cisco 1003, Cisco 1004, Cisco 1005, Cisco 2500 series, Cisco 3600
series, and Cisco 4000 series routers, and Cisco AS5200 access servers

Class C

Cisco MC3810 multiservice concentrators, disk0 of Cisco SC3640

System Controllers

Replaced Commands
Some commands found in this chapter in previous releases of this book have been replaced. Older
commands generally continue to provide the same functionality in the current release, but are no longer
documented. Support for the older version of these commands may already be removed on your system,
or may be removed in a future Cisco IOS software release.
Table 32 maps the old commands to their replacements.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-231

Configuration File Management Commands

Table 32

Replaced Commands

Old Command

New Command

configure network

copy ftp:[[[//[username[:password]@]location]/directory]/filename]
system:running-config

configure
overwrite-network

copy ftp:[[[//[username[:password]@]location]/directory]/filename]
nvram:startup-config

copy rcp running-config

copy rcp:[[[//[username@]location]/directory]/filename]
system:running-config

copy running-config rcp

copy system:running-config
rcp:[[[//[username@]location]/directory]/filename]

copy running-config
startup-config

copy system:running-config nvram:startup-config

copy running-config tftp

copy system:running-config tftp:[[[//location]/directory]/filename]

copy tftp running-config

copy tftp:[[[//location]/directory]/filename] system:running-config

copy tftp startup-config

copy tftp:[[[//location]/directory]/filename] nvram:startup-config

erase startup-config

erase nvram:

show configuration

more nvram:startup-config

show file

more

show running-config

more system:running-config

Note

Note

show startup-config

The copy running-config startup-config command has been

replaced by the command shown here. However, the copy
running-config startup-config command will continue to be
supported as a command alias for the copy
system:running-config nvram:startup-config command.

The show running-config command has been replaced by the

command shown here. However, the show running-config
command will continue to be supported as a command alias
for the more system:running-config command.

more nvram:startup-config
Note

The show startup-config command has been replaced by the

command shown here. However, the show startup-config
command will continue to be supported as a command alias
for the more nvram:startup-config command.

write erase

erase nvram:

write memory

copy running-config startup-config

or
copy system:running-config nvram:startup-config

Cisco IOS Configuration Fundamentals Command Reference

FR-232

78-11740-02

Configuration File Management Commands

Table 32

Replaced Commands (continued)

Old Command

New Command

write network

copy system:running-config
ftp:[[[//[username[:password]@]location]/directory]/filename]

write terminal

show running-config
or
more system:running-config

For more information about these command replacements, see the description of the Cisco IOS File
System (IFS) in the Using the Cisco IOS File System chapter in the Release 12.2 Cisco IOS
Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-233

Configuration File Management Commands

boot buffersize

boot buffersize
The boot buffersize global configuration command no longer functions.
Executing this command has no effect on the system. Using this command will not generate CLI errors;
the boot buffersize command syntax is still allowed to be entered at the CLI and in configuration files
in order to accommodate existing configuration scripts used by customers.

Cisco IOS Configuration Fundamentals Command Reference

FR-234

78-11740-02

Configuration File Management Commands

boot config

boot config
To specify the device and filename of the configuration file from which the router configures itself
during initialization (startup), use the boot config global configuration command. This command is only
available on Class A file system platforms. To remove the specification, use the no form of this
command.
boot config file-system-prefix:[directory/]filename
no boot config

Syntax Description

file-system-prefix:

File system, followed by a colon (for example, nvram:, flash:, or

slot0:).

directory/

(Optional) File system directory the configuration file is located in,

followed by a forward slash (/).

filename

Name of the configuration file.

Defaults

NVRAM (nvram:)

Command Modes

Global configuration

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

This command is only available on Class A 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.

Note

When you use this global configuration 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

78-11740-02

FR-235

Configuration File Management Commands

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. See the Setup Command
chapter in this publication for more information on the setup command facility.
When you use the no form of this command, the router returns to using the default NVRAM
configuration file as the startup configuration.

Examples

In the following example, the first line specifies that the router should use the configuration file named
router-config 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
router-config located on the Flash memory card inserted in the second PCMCIA slot of the 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

Description

show bootvar

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

FR-236

78-11740-02

Configuration File Management Commands

boot host

boot host
To specify the host-specific configuration file to be used at the next system startup, use the boot host
global configuration command. To restore the host configuration filename to the default, use the no form
of this command.
boot 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]

Defaults

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

Modification

10.0

This command was introduced.

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
information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service
config command is enabled automatically.
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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-237

Configuration File Management Commands

boot host

Note

In releases prior to Cisco IOS Release 12.3(2)T and 12.3(1)B, the service config command is used in
conjunction with the boot host or boot network command. To enable the router to automatically
configure the system from the file specified by the boot host or boot network command you must enter
the service config command.
With Cisco IOS Release 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 router-confg.
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:

Note

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.

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 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

FR-238

78-11740-02

Configuration File Management Commands

boot host

3.

Examples

The router forms a password [email protected]. 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 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

Description

boot network

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

service config

Enables autoloading of configuration files from a network server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-239

Configuration File Management Commands

boot network

boot network
To change the default name of the network configuration file from which to load configuration
commands, use the boot network global configuration command. 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]

Defaults

The default filename is network-config.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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
information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service
config command is enabled automatically.
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.

Cisco IOS Configuration Fundamentals Command Reference

FR-240

78-11740-02

Configuration File Management Commands

boot network

Note

In releases prior to Cisco IOS Release 12.3(2)T and 12.3(1)B, the service config command is used in
conjunction with the boot host or boot network command. To enable the router to automatically
configure the system from the file specified by the boot host or boot network command you must enter
the service config command.
With Cisco IOS Release 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 router-confg.
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:

Note

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.

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 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.

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-241

Configuration File Management Commands

boot network

3.

Examples

The router forms a password [email protected]. 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 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

Description

boot host

Specifies the remote location and filename of the host-specific configuration

file to be used at the next system boot (startup).

service config

Enables autoloading of configuration files from a remote host.

Cisco IOS Configuration Fundamentals Command Reference

FR-242

78-11740-02

Configuration File Management 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 cache command in privileged EXEC mode.
clear parser cache

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1(5)T

This command was introduced.

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

Related Commands

Command

Description

parser cache

Enables or disables the Parser Cache feature.

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-243

Configuration File Management Commands

configure terminal

configure terminal
To enter global configuration mode or to configure the system from the system memory, use the
configure terminal privileged EXEC command.
configure terminal

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

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 or Carriage Return).
After you enter the configure command, the system prompt changes from <router-name># to
indicating that the router is in global configuration mode. To leave global
configuration mode and return to the privileged EXEC prompt, type end or press Ctrl-Z.
<router-name>(config)#,

To view the changes to the configuration you have made, use the more system:running-config
command or show running-config command in EXEC mode.

Examples

In the following example, the user enters global configuration mode:

Router# configure
Configuring from terminal, memory, or network [terminal]?terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#

Related Commands

Command

Description

boot config

Specifies the device and filename of the configuration file from which
the router configures itself during initialization (startup).

copy system:running-config Saves the running configuration as the startup configuration file.
nvram:startup-config
more
system:running-config

Displays the currently running configuration.

Cisco IOS Configuration Fundamentals Command Reference

FR-244

78-11740-02

Configuration File Management Commands

configure memory

configure memory
To configure the system from the system memory, use the configure memory privileged EXEC
command.
configure memory

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

On all platforms except Class A Flash file system platforms, this command executes the commands
located in 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.
After you enter the configure terminal command, 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 the privileged EXEC prompt, use the end 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

Related Commands

Command

Description

boot config

Specifies the device and filename of the configuration file from which
the router configures itself during initialization (startup).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-245

Configuration File Management Commands

configure memory

Command

Description

copy system:running-config Saves the running configuration as the startup configuration file.
nvram:startup-config
show bootvar

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

FR-246

78-11740-02

Configuration File Management 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 copy command in the Cisco IOS File
System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-247

Configuration File Management Commands

parser cache

parser cache
To reenable the Cisco IOS software parser cache after disabling it, use the parser cache global
configuration command. 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.

Defaults

Parser cache is enabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(5)T

This command was introduced.

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 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

Related Commands

Command

Description

clear parser cache

Clears the parse cache entries and hit/miss statistics stored for the Parser
Cache feature.

show parser statistics

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

Cisco IOS Configuration Fundamentals Command Reference

FR-248

78-11740-02

Configuration File Management Commands

service compress-config

service compress-config
To compress startup configuration files, use the service compress-config global configuration
command. 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.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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 -b12
command.
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-249

Configuration File Management Commands

service compress-config

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

Description

partition nvram:startup-config

Separates Flash memory into partitions on Class B file system

platforms.

Cisco IOS Configuration Fundamentals Command Reference

FR-250

78-11740-02

Configuration File Management Commands

service config

service config
To enable autoloading of configuration files from a network server, use the service config global
configuration command. 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.

Defaults

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

Command History

Release

Modification

10.0

This command was introduced.

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 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 router-confg.

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-251

Configuration File Management Commands

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

Description

boot host

Changes the default name of the host configuration filename from which to
load configuration commands.

boot network

Changes the default name of the network configuration file from which to
load configuration commands.

Cisco IOS Configuration Fundamentals Command Reference

FR-252

78-11740-02

Configuration File Management Commands

show configuration

show configuration
The show configuration command has been replaced by the show startup-config and
more nvram:startup-config commands. See the description of the more command in the Cisco IOS
File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-253

Configuration File Management Commands

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

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1

This command was introduced.

Usage Guidelines

(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).

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-config command 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.

Examples

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

Cisco IOS Configuration Fundamentals Command Reference

FR-254

78-11740-02

Configuration File Management Commands

show derived-config

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

78-11740-02

FR-255

Configuration File Management Commands

show derived-config

Related Commands

Command

Description

show running-config

Displays the contents of the currently running configuration file or the

configuration for a specific interface.

Cisco IOS Configuration Fundamentals Command Reference

FR-256

78-11740-02

Configuration File Management Commands

show file

show file
The show file command has been replaced by the more command. See the description of the more
command in the Cisco IOS File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-257

Configuration File Management Commands

show parser statistics

show parser statistics

To displays statistics about the last configuration file parsed and the status of the Parser Cache feature,
use the show parser statistics command in privileged EXEC mode.
show parser statistics

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1(5)T

This command was introduced.

Usage Guidelines

The show parser statistics command displays two sets of data:

The number of commands in the configuration file that was last copied into the running
configuration, and the time it took for the system to parse them (a configuration file can be loaded
into the running configuration at system startup, or by issuing commands such as the copy source
running-config command).

The status of the Parser Cache feature (enabled or disabled) and the number of command matches
(indicated by hits/misses) since the system was started or since the parser cache was cleared.

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.

Examples

The following example shows sample output from the show parser statistics command:
Router# show parser statistics
Last configuration file parsed:Number of Commands:1484, Time:1272 ms
Parser cache:disabled, 0 hits, 2 misses

In this example, the Parser Cache feature is disabled, but shows the hit/miss statistics for the two
commands issued while the parser cache was last enabled.

Cisco IOS Configuration Fundamentals Command Reference

FR-258

78-11740-02

Configuration File Management Commands

show parser statistics

Table 33 describes the key output fields:

Table 33

show parser statistics Output Fields

Last configuration file parsed:

Displays statistics on the last configuration file copied

into the running configuration (at startup or using the
copy command).

Number of commands:

The number of command lines in the last configuration

file parsed.

Time:

Time (in milliseconds) taken for the system to load the

last configuration file.

Parser cache:

Displays whether the Parser Cache feature is enabled

or disabled, and the hit/miss statistics related to the
feature. Statistics are stored since the initialization of
the system, or since the last time the parser cache was
cleared.

hits

Number of commands the parser cache was able to

parse more efficiently by matching them to similar
commands executed previously.

misses

Number of commands the parser cache was unable to

match to previously executed commands. The
performance enhancement provided by the Parser
Cache feature cannot be applied to unmatched
commands.

In the following example the show parser statistics command is used to compare the parse-time of a
large configuration file with the Parser Cache feature disabled and enabled. In this example, a
configuration file with 1484 access list commands is loaded into the running configuration.
Router# configure terminal
!parser cache is disabled
Router(config)# no parser cache
!configuration file is loaded into the running configuration
Router# copy slot0:acl_list running-config
. . .
Router# show parser statistics
Last configuration file parsed:Number of Commands:1484, Time:1272 ms
Parser cache:disabled, 0 hits, 2 misses
!the parser cache is reenabled
Router(config)# parser cache
!configuration file is loaded into the running configuration
Router# copy slot0:acl_list running-config
. . .
Router# show parser statistics
Last configuration file parsed:Number of Commands:1484, Time:820 ms
Parser cache:enabled, 1460 hits, 26 misses

These results show an improvement to the load time for the same configuration file from
1272 milliseconds (ms) to 820 ms when the Parser Cache feature was enabled. As indicated in the hits
field of the show command output, 1460 commands were able to be parsed more efficiently by the parser
cache.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-259

Configuration File Management Commands

show parser statistics

Related Commands

Command

Description

clear parser cache

Clears the parse cache entries and hit/miss statistics stored for the Parser
Cache feature.

parser cache

Enables or disables the Parser Cache feature.

Cisco IOS Configuration Fundamentals Command Reference

FR-260

78-11740-02

Configuration File Management Commands

show running-config

show running-config
To display the contents of the currently running configuration file or the configuration for a specific class
map, interface, map class, policy map, or virtual circuit (VC) class, use the show running-config
command in privileged EXEC mode.
show running-config [options]

Syntax Description

options

(Optional) One of the following options can be entered with the command:

briefDisplays the configuration without certification data.

class-map nameDisplays class map information. The linenum

keyword can be used with the class-map name option.

fullDisplays the full configuration.

interface type numberDisplays interface-specific configuration

information. If you use the interface keyword, you must specify the
interface type and the interface number (for example, interface
ethernet 0). Common interfaces include async, ethernet, fastEthernet,
group-async, loopback, null, serial, and virtual-template. Use the
show run interface ? command to determine the interfaces available on
your system.

linenumDisplays line numbers in the output. The brief or full

keyword can be used with the linenum keyword.

map-classDisplays map class information. This option is described

separately; see the show running-config map-class command page.

policy-map nameDisplays policy map information. The linenum

keyword can be used with the policy-map name option.

vc-class nameDisplays VC class information (display available only

on limited routers such as the Cisco 7500 series). The linenum keyword
can be used with the vc-class name option.

|Allows addition of output modifiers and is available with all the

keywords for this command.

Defaults

The show running-config command without any arguments or keywords displays the entire contents of
the running configuration file.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.0

This command was introduced.

12.0

This command was replaced by the more system:running-config command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-261

Configuration File Management Commands

show running-config

Usage Guidelines

12.0(1)T

The output modifier (|) was added.

12.2(4)T

The linenum keyword was added.

The show running-config command is technically a command alias of the more

system:running-config command. Although more commands are recommended (due to their uniform
structure across platforms and their expandable syntax), the show running-config command remains
enabled to accommodate its widespread use, and to allow typing shortcuts such as show run.
The show running-config interface command is useful when there are multiple interfaces and you want
to look at the configuration of a specific interface.
The linenum keyword causes line numbers to be displayed in the output. This option is useful for
identifying a particular portion of a very large configuration.

Examples

The following example shows the configuration for serial interface 1:

Router# show running-config interface serial 1
Building configuration...
Current configuration:
!
interface Serial1
no ip address
no ip directed-broadcast
no ip route-cache
no ip mroute-cache
shutdown
end

The following example shows the configuration for Ethernet interface 0/0. Line numbers are displayed
in the output.
Router# show running-config interface ethernet 0/0 linenum
Building configuration...
Current configuration : 104 bytes
1 : !
2 : interface Ethernet0/0
3 : ip address 10.4.2.63 255.255.255.0
4 : no ip route-cache
5 : no ip mroute-cache
6 : end

The following example shows how to set line numbers in the command output, and then use the output
modifier to start the display at line 10:
Router# show running-config linenum | begin 10
10
11
12
13
14
15
16
17

:
:
:
:
:
:
:
:

boot-start-marker
boot-end-marker
!
no logging buffered
enable password #####
!
spe 1/0 1/7
firmware location bootflash:mica-modem-pw.2.7.1.0.bin

Cisco IOS Configuration Fundamentals Command Reference

FR-262

78-11740-02

Configuration File Management Commands

show running-config

18 : !
19 : !
20 : resource-pool disable
21 : !
22 : no aaa new-model
23 : ip subnet-zero
24 : ip domain name cisco.com
25 : ip name-server 172.16.11.48
26 : ip name-server 172.16.2.133
27 : !
28 : !
29 : isdn switch-type primary-5ess
30 : !
.
.
.
126 : end

Related Commandsd

Command

Description

boot config

Specifies the device and filename of the configuration file from which
the router configures itself during initialization (startup).

configure terminal

Enters global configuration mode.

copy running-config
startup-config

Copies the running configuration to the startup configuration. (Command

alias for the copy system:running-config nvram:startup-config
command.)

show running-config
map-class

Displays only map-class configuration information from the running

configuration file.

show startup-config

Displays the contents of NVRAM (if present and valid) or displays the
configuration file pointed to by the CONFIG_FILE environment variable.
(Command alias for the more:nvram startup-config command.)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-263

Configuration File Management Commands

show running-config map-class

show running-config map-class

To display only map-class configuration information from the running configuration file, use the
show running-config map-class privileged EXEC command.
show running-config map-class [atm [map-class-name] | dialer [map-class-name]| frame-relay
[map-class-name]]

Syntax Description

atm

(Optional) Displays only ATM map-class configuration lines.

dialer

(Optional) Displays only dialer map-class configuration lines.

frame-relay

(Optional) Displays only Frame Relay map-class configuration lines.

map-class-name

(Optional) Displays only configuration lines for the specified map-class.

Defaults

Displays all map-class configuration in the running configuration file.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1

The map-class extension to the show running-config command was

introduced to show only lines pertaining to dialer or Frame Relay map
classes.

12.1(2)T

The atm, dialer, and frame-relay keywords and map-class-name argument

were introduced.

Usage Guidelines

Examples

Use the show running-config map-class command to display the following information from the
running configuration file:

All map classes configured on the router .

Map classes configured specifically for ATM, Frame Relay, or dialer .

A specific ATM, Frame Relay, or dialer map class.

The following output examples assume that a user has configured 2 Frame Relay map classes named
"cir60" and "cir70," 1 ATM map class named "vc100," and 1 dialer map class named "dialer1."
All Map Classes Configured on the Router Example
Router# show running-config map-class
Building configuration...
Current configuration:
!
map-class frame-relay cir60
frame-relay bc 16000
frame-relay adaptive-shaping becn

Cisco IOS Configuration Fundamentals Command Reference

FR-264

78-11740-02

Configuration File Management Commands

show running-config map-class

!
map-class frame-relay cir70
no frame-relay adaptive-shaping
frame-relay priority-group 2
!
map-class atm vc100
atm aal5mux
!
map-class dialer dialer1
dialer idle-timeout 10
end

All Frame Relay Map Classes Example

Router# show running-config map-class frame-relay
Building configuration...
Current configuration:
!
map-class frame-relay cir60
frame-relay bc 16000
frame-relay adaptive-shaping becn
!
map-class frame-relay cir70
no frame-relay adaptive-shaping
frame-relay priority-group 2
end

A Specific Map Class Example

Router# show running-config map-class frame-relay cir60
Building configuration...
Current configuration:
!
map-class frame-relay cir60
frame-relay bc 16000
frame-relay adaptive-shaping becn
end

Related Commands

Command

Description

map-class atm

Specifies the ATM map class for an SVC.

map-class dialer

Defines a class of shared configuration parameters associated with the

dialer map command for outgoing calls from an ISDN interface and for
PPP callback.

map-class frame-relay

Specifies a map class to define QoS values for a Frame Relay VC.

more
system:running-config

Displays contents of the currently running configuration file (equivalent to the

show running-config command.)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-265

Configuration File Management Commands

show startup-config

show startup-config
To display the contents of the configuration file that will be used at the next system startup, use the show
startup-config or more nvram:startup-config command in Privileged EXEC mode.
show startup-config [| {begin | exclude | include} string]

Syntax Description

| begin string

(Optional) Begin the output from the first line to match the specified string.
The pipe (|) is required.

| exclude string

(Optional) Exclude from the output any line that matches the specified
string. The pipe (|) is required.

| include string

(Optional) Displays only lines that match the specified string. The pipe (|) is
required.

Defaults

None.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

The show startup-config command displays the contents of NVRAM (if present and valid) or displays the
configuration file pointed to by the CONFIG_FILE environment variable.
As with all show commands, you can specify the output you are interested in more precisely using the
pipe (|) option combined with the begin, include, and exclude keywords. For more information on these
options, see the documentation of the more begin, more exclude, more include, show begin, show
exclude, and show include commands.
In Cisco IOS Release 12.0 the show startup-config command was deprecated in favor of the
more nvram:startup-config command. Although more commands are recommended (due to their
uniform structure across platforms and their expandable syntax), the show startup-config command
remains enabled to accommodate its widespread use, and to allow typing shortcuts such as show start.

Related Commands

Command

Description

boot config

Specifies the device and filename of the configuration file from which
the router configures itself during initialization (startup).

copy running-config
startup-config

Copies the running configuration to the startup configuration. (Command

alias for the copy system:running-config nvram:startup-config
command.)

Cisco IOS Configuration Fundamentals Command Reference

FR-266

78-11740-02

System Image and Microcode Commands

This chapter provides detailed descriptions of the commands used to load and copy system images and
microcode images. System images contain the system software. Microcode images contain microcode
to be downloaded to various hardware devices.
For configuration information and examples, refer to the Loading and Maintaining System Images
chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Flash Memory File System Types

Cisco platforms generally use one of three different Flash memory file system types. Some commands
in this chapter are supported on only one or two file system types.
Use Table 34 to determine which Flash memory file system type your platform uses.
Table 34

Flash Memory File System Types

Type

Platforms

Class A

Cisco 7000 family, Cisco 12000 series routers, LightStream LS1010

switches

Class B

Cisco 1003, Cisco 1004, Cisco 1005, Cisco 2500 series, Cisco 3600
series, and Cisco 4000 series routers, and Cisco AS5200
access servers

Class C

Cisco MC3810 multiservice concentrators,

disk0 of Cisco SC3640 system controllers

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-267

System Image and Microcode Commands

Replaced Commands
Some commands found in this chapter in previous releases of this book have been replaced. Older
commands generally continue to provide the same functionality in the current release, but are no longer
documented. Support for the older version of these commands may already be removed on your system,
or may be removed in a future Cisco IOS software release.
Table 35 maps the old commands to their replacements.
Table 35

Replaced Commands

Old Command

New Command

copy erase flash

erase flash: (Class B Flash file systems only)

format (Class A and C Flash file systems only)

copy verify

verify

copy verify bootflash

verify bootflash:

copy verify flash

verify flash:

copy xmodem

xmodem

copy ymodem

xmodem -y

show flh-log

more flh: logfile

verify bootflash

verify bootflash:

verify flash

verify flash:

For a description of the copy and verify commands, see the Cisco IOS File System Commands
chapter.

Cisco IOS Configuration Fundamentals Command Reference

FR-268

78-11740-02

System Image and Microcode 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 in the Cisco IOS File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-269

System Image and Microcode Commands

copy verify

copy verify
The copy verify command has been replaced by the verify command. See the description of the verify
command in the Cisco IOS File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-270

78-11740-02

System Image and Microcode Commands

copy verify bootflash

copy verify bootflash

The copy verify bootflash command has been replaced by the verify bootflash: command. See the
description of the verify command in the Cisco IOS File System Commands chapter for more
information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-271

System Image and Microcode Commands

copy verify flash

copy verify flash

The copy verify flash command has been replaced the verify flash: command. See the description of
the verify command in the Cisco IOS File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-272

78-11740-02

System Image and Microcode 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: EXEC command.
copy xmodem: flash-filesystem:

Syntax Description

flash-filesystem:

Command Modes

EXEC

Command History

Release

Modification

11.2 P

This command was introduced.

Usage Guidelines

Destination of the copied file, followed by a colon.

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 routers internal
Flash memory using the Xmodem protocol:
copy xmodem: flash:

Related Commands

Command

Description

copy

Copies any file from a source to a destination.

copy ymodem:

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-273

System Image and Microcode 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: EXEC command.
copy ymodem: flash-filesystem:

Syntax Description

flash-filesystem:

Command Modes

EXEC

Command History

Release

Modification

11.2 P

This command was introduced.

Usage Guidelines

Destination of the copied file, followed by a colon.

The copy ymodem: and copy ymodem 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 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 routers internal
Flash memory using the Ymodem protocol:
copy ymodem: flash:

Related Commands

Command

Description

copy xmodem:

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.

Cisco IOS Configuration Fundamentals Command Reference

FR-274

78-11740-02

System Image and Microcode Commands

erase flash:

erase flash:
The erase flash: and erase flash commands are identical. See the description of the erase command in
the Cisco IOS File System Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-275

System Image and Microcode Commands

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 global configuration command. 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

One of the following interface processor names: aip, cip, eip, feip, fip, fsip, hip,
mip, sip, sp, ssp, trip, vip, or vip2.

flash-filesystem:

Flash file system, followed by a colon. Valid file systems are bootflash, slot0,
and slot1.
Slave devices such as slaveslot0 are invalid. The slaves file system is not
available during microcode reloads.

filename

Name of the microcode file.

slot

(Optional) Number of the slot. Range is from 0 to 15.

rom

If ROM is specified, the router loads from the onboard ROM microcode.

system

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.

Defaults

The default is to load from the microcode bundled in the system image.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

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 memory
file fip.v141-7 when the system is booted, when a card is inserted or removed, or when the microcode
reload global configuration command is issued. The configuration is then written to the startup
configuration file.

Cisco IOS Configuration Fundamentals Command Reference

FR-276

78-11740-02

System Image and Microcode Commands

microcode (7000/7500)

Router(config)# microcode fip slot0:fip.v141-7

Router(config)# end
Router# copy system:running-config nvram:startup-config

Related Commands

Command

Description

more flh:logfile

Displays the system console output generated during the Flash load helper
operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-277

System Image and Microcode Commands

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 global configuration command. 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

ESCON Channel Port Adapter (CPA) interface.

pcpa

Parallel CPA interface.

location

Location of microcode, including the device and filename.

Defaults

If the default or no form 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

Modification

11.3(3)T

This command was introduced.

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.

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

Cisco IOS Configuration Fundamentals Command Reference

FR-278

78-11740-02

System Image and Microcode Commands

microcode (7200)

Related Commands

Command

Description

microcode reload (7200) Resets and reloads the specified hardware in a Cisco 7200 series router.
show microcode

Displays microcode information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-279

System Image and Microcode Commands

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 global configuration command. 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 | Interface name.

oc3-pos4
flash

Loads the image from the Flash file system.

file-id

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.

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.

system

Loads the image from the software image on the GRP card.

Defaults

The default is to load the image from the GRP card (system).

Command Modes

Global configuration

Command History

Release

Modification

11.2 GS

This command was introduced for Cisco 12000 series GSRs.

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.
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 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-280

78-11740-02

System Image and Microcode Commands

microcode (12000)

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 reload global configuration command is issued.
microcode oc3-POS-4 flash slot0:fip.v141-7 10
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

Description

microcode reload (12000) Reloads microcode on Cisco 12000 series GSRs.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-281

System Image and Microcode Commands

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 global configuration command.
microcode reload

Syntax Description

This command has no arguments or keywords.

Defaults

No default behaviors or values.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced for Cisco 7500 series routers.

Usage Guidelines

Note

Examples

This command reloads the microcode without rebooting the router. Immediately after you enter the
microcode reload command and press Return, the system reloads all microcode. Global configuration
mode remains enabled.

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.

In the following example, all controllers are reset, and the microcode specified in the current
configuration is loaded:
microcode reload

Related Commands

Command

Description

microcode (7000/7500)

Specifes the location from where microcode should be loaded when

the microcode reload command is executed on RSP-based routers.

Cisco IOS Configuration Fundamentals Command Reference

FR-282

78-11740-02

System Image and Microcode Commands

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 configuration mode.
microcode reload {all | ecpa [slot slot#] | pcpa [slot slot#]}

Syntax Description

all

Resets and reloads all hardware types that support downloadable

microcode.

ecpa

Resets and reloads only those slots that contain hardware type ecpa.

pcpa

Resets and reloads only those slots that contain hardware type pcpa.

slot slot#

(Optional) Resets and reloads only the slot specified, and only if it
contains the hardware specified.

Defaults

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.3(3)T

This command was introduced.

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 reload command is executed.

Examples

The following example reloads the ESCON CPA microcode in slot 5 with the currently configured
microcode:
microcode reload ecpa slot 5

Related Commands

Command

Description

microcode (7200)

Configures a default override for the microcode that is downloaded to

the hardware on a Cisco 7200 series router.

show microcode

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

78-11740-02

FR-283

System Image and Microcode Commands

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
global configuration command.
microcode reload [slot-number]

Syntax Description

slot-number

Command Modes

Global configuration

Command History

Release

Modification

11.2 GS

This command was introduced for Cisco 12000 series GSRs.

Usage Guidelines

(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.

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.
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. 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 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.

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.

Cisco IOS Configuration Fundamentals Command Reference

FR-284

78-11740-02

System Image and Microcode Commands

microcode reload (12000)

Examples

In the following example, the Cisco IOS software is reloaded on the line card in slot 10:
microcode reload 10

Related Commands

Command

Description

microcode (12000)

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

78-11740-02

FR-285

System Image and Microcode Commands

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

Modification

11.3 AA

This command was introduced.

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:logfile command:

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
Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK]
F3: 2183364+67924+259584 at 0x3000060

Cisco IOS Configuration Fundamentals Command Reference

FR-286

78-11740-02

System Image and Microcode Commands

more flh:logfile

Restricted Rights Legend

Use, duplication, or disclosure by the Government is
subject to restrictions as set forth in subparagraph
(c) of the Commercial Computer Software - Restricted
Rights clause at FAR sec. 52.227-19 and subparagraph
(c) (1) (ii) of the Rights in Technical Data and Computer
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
Copyright (c) 1986-1995 by cisco Systems, Inc.
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

Description

more

Displays a file.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-287

System Image and Microcode Commands

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 in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-288

78-11740-02

System Image and Microcode Commands

show microcode

show microcode
To display microcode image information available on line cards, use the show microcode EXEC
command.
show microcode

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following is sample output from the show microcode command:

Router# show microcode
Microcode bundled in system
Card
Type
---SP
EIP
TRIP
FIP
HIP
SIP
FSIP

Microcode
Version
--------2.3
1.1
1.2
1.4
1.1
1.1
1.1

Target Hardware
Version
--------------11.x
1.x
1.x
2.x
1.x
1.x
1.x

Description
----------SP version 2.3
EIP version 1.1
TRIP version 1.2
FIP version 1.4
HIP version 1.1
SIP version 1.1
FSIP version 1.1

In the following example for the Cisco 7200 series router, the output from the show microcode
command lists the hardware types that support microcode download. For each type, the default
microcode image name is displayed. If there is a configured default override, that name also is displayed.
router# show microcode
Microcode images for downloadable hardware
HW Type
Microcode image names
-----------------------------------------ecpa
default
slot0:xcpa26-0
configured slot0:xcpa26-2
pcpa
default
slot0:xcpa26-4

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-289

System Image and Microcode Commands

show microcode

Related Commands

Command

Description

microcode (7000/7500)

Specifies where microcode should be loaded from on Cisco

7500/7000RSP routers.

microcode (7200)

Configures a default override for the microcode that is downloaded to the

hardware on a Cisco 7200 series router.

Cisco IOS Configuration Fundamentals Command Reference

FR-290

78-11740-02

System Image and Microcode Commands

xmodem

xmodem
To copy a Cisco IOS image to a router using the ROM monitor and the Xmodem or Ymodem protocol,
use the xmodem ROM monitor command.
xmodem [-c] [-y] [-e] [-f] [-r] [-x] [-s data-rate] [filename]

Syntax Description

-c

(Optional) CRC-16 checksumming, which is more sophisticated and thorough than

standard checksumming.

-y

(Optional) Uses the Ymodem protocol for higher throughput.

-e

(Optional) Erases the first partition in Flash memory before starting the download.
This option is only valid for the Cisco 1600 series.

-f

(Optional) Erases all of Flash memory before starting the download. This option is
only valid for the Cisco 1600 series.

-r

(Optional) Downloads the file to DRAM. The default is Flash memory.

-x

(Optional) Do not execute Cisco IOS image on completion of the download.

-s data-rate

(Optional) Sets the console ports data rate during file transfer. Values are 1200,
2400, 4800, 9600, 19200, 38400, and 115200 bps. The default rate is specified in
the configuration register. This option is only valid for the Cisco 1600 series.

filename

(Optional) Filename to copy. This argument is ignored when the -r keyword is

specified, because only one file can be copied to DRAM. On the Cisco 1600 series
routers, files are loaded to the ROM for execution.

Defaults

Xmodem protocol with 8-bit CRC, file downloaded into Flash memory and executed on completion.

Command Modes

ROM monitor

Command History

Release

Modification

11.2 P

This command was introduced.

Usage Guidelines

The Cisco 3600 series routers does not support XBOOT functionality. If your Cisco IOS image is erased
or damaged, you cannot load a new image over the network.
Use the xmodem ROM monitor command to download a new system image to your router from a local
personal computer (such as a PC, Mac, or UNIX workstation), or a remote computer over a modem
connection, to the routers console port. The computer must have a terminal emulation application that
supports these protocols.
Cisco 3600 Series Routers

Your router must have enough DRAM to hold the file being transferred, even if you are copying to Flash
memory. The image is copied to the first file in internal Flash memory. Any existing files in Flash
memory are erased. There is no support for partitions or copying as a second file.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-291

System Image and Microcode Commands

xmodem

Cisco 1600 Series Routers

If you include the -r option, your router must have enough DRAM to hold the file being transferred. To
run from Flash, an image must be positioned as the first file in Flash memory. If you are copying a new
image to boot from Flash, erase all existing files first.

Caution

Note

Examples

A modem connection from the telephone network to your console port introduces security issues that
you should consider before enabling the connection. For example, remote users can dial in to your
modem and access the routers configuration settings.

If the file to be downloaded is not a valid router image, the copy operation is automatically
terminated.

The following example uses the xmodem -c filename ROM monitor command to copy the file named
new-ios-image from a remote or local computer:
rommon > xmodem -c new-ios-image
Do not start the sending program yet...
File size
Checksum
File name
1738244 bytes (0x1a8604)
0xdd25 george-admin/c3600-i-mz
WARNING: All existing data in bootflash will be lost!
Invoke this application only for disaster recovery.
Do you wish to continue? y/n [n]: yes
Ready to receive file new-ios-image ...

Related Commands

Command

Description

copy xmodem:

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.

copy ymodem:

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.

Cisco IOS Configuration Fundamentals Command Reference

FR-292

78-11740-02

Router Memory Commands

This chapter provides detailed descriptions of the commands used to maintain router memory.
For configuration information and examples, refer to the Maintaining Router Memory chapter in the
Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Flash Memory File System Types

Cisco platforms generally use one of three different Flash memory file system type. Some commands
are supported on only one or two file system types.
Use Table 36 to determine which Flash memory file system type your platform uses.
Table 36

Flash Memory File System Types

Type

Platforms

Class A

Cisco 7000 family, Cisco 12000 series, LightStream LS1010

series

Class B

Cisco 1003, Cisco 1004, Cisco 1005, Cisco 2500 series,

Cisco 3600 series, Cisco 4000 series, Cisco AS5200
access servers

Class C

Cisco MC3810 multiservice concentrators; disk0 and disk1 of

Cisco SC3640 system controllers

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-293

Router Memory Commands

memory scan

memory scan
To enable the Memory Scan feature on a Cisco 7500 series router, use the memory scan command. 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.

Defaults

This command is disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.0(4)XE

This command was introduced.

12.0(7)T

This command was integrated in Cisco IOS Release 12.0 T.

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

Related Commands

Command

Description

show memory scan

Displays the number and type of parity errors on your system (Cisco 7500
series only).

Cisco IOS Configuration Fundamentals Command Reference

FR-294

78-11740-02

Router Memory Commands

memory-size iomem

memory-size iomem
To reallocate the percentage of DRAM to use for I/O memory and processor memory on Cisco 3600
series routers, use the memory-size iomem global configuration command. 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 i/o-memory-percentage

Syntax Description

i/o-memory-percentage

Defaults

The default memory allocation is 25 percent I/O memory and 75 percent processor memory.

Note

The percentage of DRAM allocated to I/O memory. The values

permitted are 10, 15, 20, 25, 30, 40, and 50. A minimum of 4 MB of
memory is required for I/O memory.

If the smartinit process has been enabled, the default memory allocation of 25% to I/O does not
apply. Instead, smartinit examines the network modules and then calculates the I/O memory
required.

Command Modes

Global configuration

Command History

Release

Modification

11.2 P

This command was introduced.

Usage Guidelines

When you specify the percentage of I/O memory in the command line, processor memory automatically
acquires the remaining percentage of DRAM memory.

Examples

The following example allocates 40 percent of the DRAM memory to I/O memory and the remaining
60 percent to processor memory:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# memory-size iomem 40
Router(config)# exit
Router# copy system:running-config nvram:startup-config
Building configuration...
[OK]
Router# reload
rommon 1 > boot
program load complete, entry point: 0x80008000, size: 0x32ea24

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-295

Router Memory Commands

memory-size iomem

Self decompressing the image :

##########################################################################################
##########################################################################################
################################################################## [OK]

Cisco IOS Configuration Fundamentals Command Reference

FR-296

78-11740-02

Router Memory Commands

partition

partition
To separate Flash memory into partitions on Class B file system platforms, use the partition global
configuration command. 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

Defaults

flash-filesystem:

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

number-of-partitions

(Optional) Number of partitions in Flash memory.

partition-size

(Optional) Size of each partition. The number of partition size entries

must be equal to the number of specified partitions.

partitions

Number of partitions in Flash memory. Can be 1 or 2.

size1

(Optional) Size of the first partition (in megabytes).

size2

(Optional) Size of the second partition (in megabytes).

Flash memory consists of one partition.

If the partition size is not specified, partitions of equal size are created.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-297

Router Memory Commands

partition

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-number command 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.

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

Cisco IOS Configuration Fundamentals Command Reference

FR-298

78-11740-02

Router Memory Commands

show (Flash file system)

show (Flash file system)

To display the layout and contents of a Flash memory file system, use the show EXEC command.
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:

Flash memory file system (bootflash:, flash:, slot0:, slot1:,

slavebootflash:, slaveslot0:, or slaveslot1:), followed by a colon.

all

(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.

chips

(Optional) Displays information per partition and per chip, including

which bank the chip is in, plus its code, size, and name.

filesys

(Optional) Displays the Device Info Block, the Status Info, and the
Usage Info.

partition number

(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.

detailed

(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.

err

(Optional) Displays write or erase failures in the form of number of

retries.

summary

(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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-299

Router Memory Commands

show (Flash file system)

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

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:
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.

Examples

The output of the show command 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 flash command 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. Table 37 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 Aug 29 1997 17:49:36
hampton/nitro/c7200-j-mz

Cisco IOS Configuration Fundamentals Command Reference

FR-300

78-11740-02

Router Memory Commands

show (Flash file system)

2
3
4
5
6
7

..
.D
.D
..
.D
..

unknown
unknown
unknown
unknown
unknown
unknown

9237F3FF
71AB01F1
96DACD45
96DACD45
96DACD45
96DACD45

92C574
10C94E0
10C97E0
10C9AE0
10C9DE0
10CA0E0

11
10
8
3
8
8

4767328
7982828
639
639
639
639

Oct
Oct
Oct
Oct
Oct
Oct

01
01
02
02
02
02

1997
1997
1997
1997
1997
1997

18:42:53
18:48:14
12:09:17
12:09:32
12:37:01
12:37:13

c7200-js-mz
rsp-jsv-mz
the_time
the_time
the_time
the_time

3104544 bytes available (17473760 bytes used)

Table 37

show (Class A Flash File System) Field Descriptions

Field

Description

Index number for the file.

ED

Whether the file contains an error (E) or is deleted (D).

type

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.

crc

Cyclic redundant check for the file.

seek

Offset into the file system of the next file.

nlen

name lengthLength of the filename.

length

Length of the file itself.

date/time

Date and time the file was created.

name

Name of the file.

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):
Config Status Reg (4002):
Card Status
Reg (4100):
Write Protect Reg (4104):
Voltage Cntrl Reg (410C):
Rdy/Busy Mode Reg (4140):

2
0
1
4
0
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
8 : B0B0 B0B0 B0B0 B0B0
16 : B0B0 B0B0 B0B0 B0B0
24 : B0B0 B0B0 B0B0 B0B0

B0B0
B0B0
B0B0
B0B0

B0B0
B0B0
B0B0
B0B0

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-301

Router Memory Commands

show (Flash file system)

8 :
16 :
24 :

B0B0
B0B0
B0B0

B0B0
B0B0
B0B0

B0B0
B0B0
B0B0

B0B0
B0B0
B0B0

B0B0
B0B0
B0B0

B0B0
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
8 : B0B0 B0B0 B0B0 B0B0
16 : B0B0 B0B0 B0B0 B0B0
24 : B0B0 B0B0 B0B0 B0B0

B0B0
B0B0
B0B0
B0B0

B0B0
B0B0
B0B0
B0B0

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
8 : B0B0 B0B0 B0B0 B0B0
16 : B0B0 B0B0 B0B0 B0B0
24 : B0B0 B0B0 B0B0 B0B0

B0B0
B0B0
B0B0
B0B0

B0B0
B0B0
B0B0
B0B0

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
8 : B0B0 B0B0 B0B0 B0B0
16 : B0B0 B0B0 B0B0 B0B0
24 : B0B0 B0B0 B0B0 B0B0

B0B0
B0B0
B0B0
B0B0

B0B0
B0B0
B0B0
B0B0

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

Cisco IOS Configuration Fundamentals Command Reference

FR-302

78-11740-02

Router Memory Commands

show (Flash file system)

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: partition 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

Table 38 describes significant fields shown in the displays.

Table 38

show (Class B Flash File System) all Fields

Field

Description

addr

Address of the file in Flash memory.

available

Total number of bytes available in Flash memory.

Bank

Bank number.

Bank-Size

Size of bank in bytes.

bytes used

Total number of bytes used in Flash memory.

ccksum

Computed checksum.

Chip

Chip number.

Code

Code number.

Copy-Mode

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.

fcksum

Checksum recorded in Flash memory.

File

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.

Free

Number of bytes free in partition.

Length

Size of the system image file (in bytes).

Name

Name of chip manufacturer and chip type.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-303

Router Memory Commands

show (Flash file system)

Table 38

show (Class B Flash File System) all Fields (continued)

Field

Description

Name/status

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

Partition number in Flash memory.

Size

Size of partition (in bytes) or size of chip.

State

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.

System flash directory

Flash directory and its contents.

total

Total size of Flash memory (in bytes).

Used

Number of bytes used in partition.

The following is sample output from the show flash: all command:
RouterB> show flash: all
Partition
Size
Used
1
16384K
4040K

Free
12343K

Bank-Size
4096K

State
Read/Write

Copy Mode
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
1
2
3
4
1
2
3
4
1
2
3
4
1
2
3
4

Bank
1
1
1
1
2
2
2
2
3
3
3
3
4
4
4
4

Code
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5

Size
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB

Name
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD

29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080

Cisco IOS Configuration Fundamentals Command Reference

FR-304

78-11740-02

Router Memory Commands

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
1
4096K
3459K
637K
2
4096K
3224K
872K

Bank-Size
4096K
4096K

State
Read Only
Read/Write

Copy-Mode
RXBOOT-FLH
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
1
2
3
4

Bank
2
2
2
2

Code
89A2
89A2
89A2
89A2

Size
1024KB
1024KB
1024KB
1024KB

Name
INTEL
INTEL
INTEL
INTEL

28F008SA
28F008SA
28F008SA
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
1
2
3
4
1
2
3
4
1
2
3
4
1
2
3
4

Bank
1
1
1
1
2
2
2
2
3
3
3
3
4
4
4
4

Code
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5

Size
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB

Name
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD

29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080

The following is sample output from the show flash: detailed command:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-305

Router Memory Commands

show (Flash file system)

RouterB> show flash: detailed

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)

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
1
2
3
4
1
2
3
4
1
2
3
4
1
2
3
4

Bank
1
1
1
1
2
2
2
2
3
3
3
3
4
4
4
4

Code
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5
01D5

Size
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB
1024KB

Name
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD
AMD

erase
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080
29F080

0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

write
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

See Table 38 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
1
4096K
2048K
2048K
2
4096K
2048K
2048K

Related Commands

Bank-Size
2048K
2048K

State
Read Only
Read/Write

Copy-Mode
RXBOOT-FLH
Direct

Command

Description

more

Displays the contents of any file in the Cisco IOS File System.

Cisco IOS Configuration Fundamentals Command Reference

FR-306

78-11740-02

Router Memory Commands

show memory scan

show memory scan

To monitor the number and type of parity (memory) errors on your system, use the show memory scan
EXEC command.
show memory scan

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

12.0(4)XE

This command was introduced.

12.0(7)T

This command was implemented in Cisco IOS Release 12.0(7) T.

Examples

The following example shows a result with no memory errors:

Router# show memory scan
Memory scan is on.
No parity error has been detected.

If errors are detected in the system, the show memory scan command generates an error report. In the
following example, memory scan detected a parity error:
Router# show memory scan
Memory scan is on.
Total Parity Errors 1.
AddressBlockPtrBlckSizeDispositRegion Timestamp
6115ABCD60D5D0909517A4ScrubedLocal 16:57:09 UTC Thu

Mar 18

Table 39 describes the fields contained in the error report.

Table 39

show memory scan Field Descriptions

Field

Description

Address

The byte address where the error occurred.

BlockPtr

The pointer to the block that contains the error.

BlckSize

The size of the memory block

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-307

Router Memory Commands

show memory scan

Table 39

show memory scan Field Descriptions (continued)

Field

Description

Disposit

The action taken in response to the error:

Region

Timestamp

BlockInUseAn error was detected in a busy block.

InFieldPrevAn error was detected in the previous field of

a block header.

InHeaderAn error was detected in a block header.

LinkedA block was linked to a bad list.

MScrubedThe same address was scrubbed more than

once, and the block was linked to a bad list.

MultiErrorMultiple errors have been found in one block.

NoBlkHdrNo block header was found.

NotYetAn error was found; no action has been taken at

this time.

ScrubedAn error was scrubbed.

SplitLinkedA block was split, and only a small portion

was linked to a bad list.

The memory region in which the error was found:

IBSSimage BSS

IDataimagedata

ITextimagetext

localheap

The time the error occurred.

Cisco IOS Configuration Fundamentals Command Reference

FR-308

78-11740-02

Router Memory Commands

write memory

write memory
The write memory command has been replaced by the copy system:running-config nvram:
startup-config command. See the description of the copy command in this Cisco IOS File System
Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-309

Router Memory Commands

write network

write network
The write network command is replaced by the copy system:running-config destination-url. See the
description of the copy command in this Cisco IOS File System Commands chapter for more
information.

Cisco IOS Configuration Fundamentals Command Reference

FR-310

78-11740-02

Booting Commands
This chapter provides detailed descriptions of the commands used to modify the rebooting procedures
of the router.
For configuration information and examples, refer to the Rebooting chapter in the Release 12.2
Cisco IOS Configuration Fundamentals Configuration Guide.

Flash Memory File System Types

Cisco platforms generally use one of three different Flash memory file system types. Some commands
are supported on only one or two file system types. This chapter notes commands that are not supported
on all file system types.
Use Table 40 to determine which Flash memory file system type your platform uses.
Table 40

Flash Memory File System Types

Type

Platforms

Class A

Cisco 7000 family, Cisco 12000 series, LightStreamLS1010

Class B

Cisco 1003, Cisco 1004, Cisco 1005, Cisco 2500 series,

Cisco 3600 series, Cisco 4000 series, Cisco AS5200
access servers

Class C

Cisco MC3810 multiservice concentrators, disk0 of Cisco

SC3640 system controllers

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-311

Booting Commands
boot

boot
To boot the router manually, use the boot ROM monitor command. 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]

Syntax Description

file-url

URL of the image to boot (for example,

boot tftp://172.16.15.112/routertest).

filename

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 filename argument, the first valid file in Flash
memory is loaded.

tftp-ip-address

(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.

flash

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

Cisco IOS Configuration Fundamentals Command Reference

FR-312

78-11740-02

Booting Commands
boot

flash-fs:

partition-number:

Defaults

(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 on the Cisco 1600 series routers

and Cisco 3600 series routers. This is the only valid Flash file
system for the Cisco 1600 series routers.

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.

For most platforms, if you enter the boot command and press Return, 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 Return, the router boots the first image in Flash memory. Refer to the documentation
for your platform for information about the default image.
If the partition-number is not specified, the first partition is used.
If the filename is not specified, the first file in the partition or file system is used.
For other defaults, see the Syntax Description section.

Command Modes

ROM monitor

Command History

Release

Modification

10.3

The command was introduced.

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.

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.
Refer to your hardware documentation for information on correct jumper settings for your platform.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-313

Booting Commands
boot

Note

Examples

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.

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
F3
(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
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
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
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]
F3: 1858676+45204+166896 at 0x1000
(ROM Monitor copyrights)

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

Cisco IOS Configuration Fundamentals Command Reference

FR-314

78-11740-02

Booting Commands
boot

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

Description

continue

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-315

Booting Commands
boot bootldr

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

Syntax Description

file-url

Defaults

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

Command Modes

Global configuration

Command History

Release

Modification

11.0

The command was introduced.

Usage Guidelines

Note

URL of the boot image on a Flash file system.

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

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.
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.

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

Cisco IOS Configuration Fundamentals Command Reference

FR-316

78-11740-02

Booting Commands
boot bootldr

Related Commands

Command

Description

copy system:running-config Copies any file from a source to a destination.

nvram:startup-config
show bootvar

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.

show (Flash file system)

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-317

Booting Commands
boot bootstrap

boot bootstrap
To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap
global configuration command. 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]

Syntax Description

file-url

URL of the bootstrap image.

flash

Boots the router from Flash memory.

filename

(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.

tftp

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

ip-address

(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.

Defaults

No secondary bootstrap

Command Modes

Global configuration

Command History

Release

Modification

10.0

The command was introduced.

Usage Guidelines

The boot bootstrap command causes the router to load a secondary bootstrap image over the network.
The secondary bootstrap image then loads the specified system image file. See the appropriate hardware
installation guide for details on 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 allows you to load a larger system image
through a smaller secondary image.

Cisco IOS Configuration Fundamentals Command Reference

FR-318

78-11740-02

Booting Commands
boot bootstrap

Examples

In the following example, the system image file named sysimage-2 will be loaded by using a secondary
bootstrap image:
boot bootstrap bootflash:sysimage-2

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-319

Booting Commands
boot system

boot system
To specify the system image that the router loads at startup, use one of the following boot system global
configuration commands. To remove the startup system image specification, use the no form of the
command.
boot system file-url
no boot system file-url
boot system flash [flash-fs:][partition-number:][filename]
no boot system flash [flash-fs:][partition-number:][filename]
boot system mop filename [mac-address] [interface]
no boot system mop filename [mac-address] [interface]
boot system rom
no boot system rom
boot system {rcp | tftp | ftp} filename [ip-address]
no boot system {rcp | tftp | ftp} filename [ip-address]
no boot system

Syntax Descriptionn

file-url

URL of the system image to load at system startup.

flash

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 a Flash device, as specified
by the device: 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 PCMCIA slot 0 for the first bootable image.

Cisco IOS Configuration Fundamentals Command Reference

FR-320

78-11740-02

Booting Commands
boot system

flash-fs:

(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.

bootflashInternal Flash memory in the Cisco 7000 family.

slot0First 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.

slot1Flash memory card in the second PCMCIA slot on the

Cisco 3600 series and Cisco 7000 family routers.

partition-number:

(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 only valid on
routers that can be partitioned.

filename

(Optional when used with the boot system flash command) Name of the
system image to load at startup. It is case sensitive. If you do not specify
a filename, the router loads the first valid file in the specified Flash file
system, the specified partition of Flash memory, or the default Flash file
system if you also omit the flash-fs: argument.

mop

Boots the router from a system image stored on a Digital MOP server.
Do not use this keyword with the Cisco 3600 series or Cisco 7000 family
routers.

mac-address

(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.

interface

(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.

rom

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

rcp

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

tftp

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

ftp

Boots the router from a system image stored on an FTP server.

ip-address

(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

78-11740-02

FR-321

Booting Commands
boot system

Defaults

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. For additional information about defaults, see the preceding Syntax Description
section.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

For this command to work, the config-register command must be set properly.
Enter 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 typefor example, if you enter two commands
that instruct the router to boot from different network serversthen 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 commands in the configuration.
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.
This section contains the following usage guideline sections:

Change the List of Boot System Commands

Boot Compressed Images

Understand the rcp Protocol

Stop Booting and Enter ROM Monitor Mode

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

Change 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-322

78-11740-02

Booting Commands
boot system

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.
Boot 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 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 platforms documentation for
the exact usage of the compress command. (You can also uncompress data with the UNIX uncompress
command.)
Understand the rcp Protocol

The rcp protocol requires a client to 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 host name as both the
remote and local usernames by default. For the rcp protocol to 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 host name 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 users name as the remote
username.
Understand TFTP

You need a TFTP server running in order to retrieve the router image from the host.
Understand FTP

You need to an FTP server running in order to fetch the router image from the host. You also need an
account on the server or anonymous file access to the server.
Stop Booting and Enter 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, and Cisco 7000 Family 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 global configuration command on the Cisco 1600 series, Cisco 3600
series, and Cisco 7000 family, 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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-323

Booting Commands
boot system

and to have the variable function as expected. Use the copy system:running-config
nvram:startup-config EXEC command to save the variable from your running configuration to your
startup configuration.
To view the contents of the BOOT variable, use the show bootenv EXEC command.

Examples

The following example illustrates a list specifying two possible internetwork locations for a system
image, with the ROM software being used as a backup:
boot system tftp://192.168.7.24/cs3-rx.90-1
boot system tftp://192.168.7.19/cs3-rx.83-2
boot system rom

The following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of
the Flash device:
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 of the Cisco 7000 RSP7000 card, Cisco 7200 NPE card, or Cisco 7500 series RSP card:
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# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# boot system slot0:4:dirt/images/new-ios-image

This example boots from the image file named c1600-y-l in partition 2 of Flash memory of a Cisco 1600
series router:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# boot system flash:2:c1600-y-l

Related Commands

Command

Description

config-register

Changes the configuration register settings.

copy

Copies any file from a source to a destination.

ip rcmd remote username

Configures the remote username to be used when requesting a

remote copy using rcp.

show bootvar

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

FR-324

78-11740-02

Booting Commands
config-register

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

Syntax Description

value

Defaults

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

Modification

10.0

This command was introduced.

Usage Guidelines

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).

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.

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.

Examples

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

Related Commands

Command

Description

boot system

Specifies the system image that the router loads at startup.

confreg

Changes the configuration register settings while in ROM monitor mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-325

Booting Commands
config-register

Command

Description

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

show version

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

FR-326

78-11740-02

Booting Commands
confreg

confreg
To change the configuration register settings while in ROM monitor mode, use the confreg ROM
monitor command.
confreg [value]

Syntax Description

value

Defaults

Refer to your platform documentation for the default configuration register value.

Command Modes

ROM monitor

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

(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.

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.

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-327

Booting Commands
confreg

Configuration Summary
enabled are:
console baud: 9600
boot: the ROM Monitor
do you wish to change the configuration? y/n [n]:
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
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

[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>

Cisco IOS Configuration Fundamentals Command Reference

FR-328

78-11740-02

Booting Commands
continue

continue
To return to EXEC mode from ROM monitor mode, use the continue ROM monitor command.
continue

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

ROM monitor

Command History

Release

Modification

11.0

The command was introduced.

Usage Guidelines

Caution

Examples

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.

While in ROM monitor mode, the Cisco IOS system software is suspended until you issue either a
reset or the continue command.

In the following example, the continue command switches the router from ROM monitor to EXEC
mode:
> continue
Router#

Related Commands

Command

Description

boot

Boots the router manually.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-329

Booting Commands
reload

reload
To reload the operating system, use the reload EXEC command.
reload [text | in [hh:]mm [text] | at hh:mm [month day | day month] [text] | cancel]

Syntax Description

text

(Optional) Reason for the reload, 1 to 255 characters long.

in [hh:]mm

(Optional) Schedule 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.

at hh:mm

(Optional) Schedule 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 approximately 24 days.

month

(Optional) Name of the month, any number of characters in a unique string.

day

(Optional) Number of the day in the range from 1 to 31.

cancel

(Optional) Cancel a scheduled reload.

Command Modes

EXEC

Command History

Release

Modification

10.0

The command was introduced.

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 prevents
the system from dropping to the ROM monitor and thereby taking the system out of the remote users
control.
If you modify your configuration file, the system prompts you to save the configuration. During a save
operation, the system asks you if you want to proceed with the save if the CONFIG_FILE variable points
to a startup configuration file that no longer exists. If you say yes in this situation, the system goes to
setup mode upon reload.
When you schedule a reload to occur at a later time, it must take place within approximately 24 days.
The at keyword can be used only if the system clock has be set on the router (either through 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, the time on each router must be
synchronized with NTP.
To display information about a scheduled reload, use the show reload EXEC command.

Cisco IOS Configuration Fundamentals Command Reference

FR-330

78-11740-02

Booting Commands
reload

Examples

The following example immediately reloads the software on the router:

Router# reload

The following example reloads 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]
Router#

The following example reloads the software on the router at 1:00 p.m. today:
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]
Router#

The following example reloads the software on the router on April 20 at 2:00 a.m.:
Router# reload at 02:00 apr 20
Router# Reload scheduled for 02:00:00 PDT Sat Apr 20 1996 (in 38 hours and 9 minutes)
Proceed with reload? [confirm]
Router#

The following example cancels a pending reload:

Router# reload cancel
%Reload cancelled.

Related Commands

Command

Description

copy system:running-config
nvram:startup-config

Copies any file from a source to a destination.

show reload

Displays the reload status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-331

Booting Commands
show boot

show boot
The show boot command has been replaced by the show bootvar command. See the description of the
show bootvar command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-332

78-11740-02

Booting Commands
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 EXEC command.
show bootvar

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.3 AA

This command was introduced.

Usage Guidelines

The show bootvar command replaces the show boot command.

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 RSP cards (Dual RSPs), this command also shows
you the variable settings for both the master and slave RSP card.

Examples

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
Router#

In the sample output, the BOOT variable contains a null string. That is, a list of bootable images is not
specified.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-333

Booting Commands
show bootvar

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-config 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 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
Router#

Related Commands

Command

Description

boot bootstrap

Configures the filename that is used to boot a secondary bootstrap image.

boot config

Specifies the device and filename of the configuration file from which the
router configures itself during initialization (startup).

boot system

Specifies the system image that the router loads at startup.

show version

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

FR-334

78-11740-02

Booting Commands
show reload

show reload
To display the reload status on the router, use the show reload EXEC command.
show reload

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

You can use the show reload command to display a pending software reload. To cancel the reload, use
the reload cancel privileged EXEC command.

Examples

The following sample output from the show reload command shows that a reload is schedule for
12:00 a.m. (midnight) on Saturday, April 20:
Router# show reload
Reload scheduled for 00:00:00 PDT Sat April 20 (in 12 hours and 12 minutes)
Router#

Related Commands

Command

Description

reload

Reloads the operating system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-335

Booting Commands
show version

show version
To display information about the currently loaded software version along with hardware and device
information, use the show version command in EXEC mode.
show version

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

User EXEC
Privileged EXEC

Command History

Usage Guidelines

Release

Modification

9.0

This command was introduced.

12.3(4)T

The output format of this command was updated.

12.2(25)S

The output format of this command was updated.

This command displays information about the Cisco IOS software version currently running on a routing
device, the ROM Monitor and Bootflash software versions, and information about the hardware
configuration, including the amount of system memory. Because this command displays both software and
hardware information, the output of this command is the same as the output of the show hardware command.
(The show hardware command is a command alias for the show version command.)
Specifically, the show version command provides the following information:

Software information
Main Cisco IOS image version
Main Cisco IOS image capabilities (feature set)
Location and name of bootfile in ROM
Bootflash image version (depending on platform)

Device-specific information
Device name
System uptime
System reload reason
Config-register setting
Config-register settings for after the next reload (depending on platform)

Cisco IOS Configuration Fundamentals Command Reference

FR-336

78-11740-02

Booting Commands
show version

Hardware information
Platform type
Processor type
Processor hardware revision
Amount of main (processor) memory installed
Amount I/O memory installed
Amount of Flash memory installed on different types (depending on platform)
Processor board ID

The output of this command uses the following format:

Cisco IOS Software, <platform> Software (<image-id>), Version <software-version>,
<software-type>
TAC Support: http://www.cisco.com/tac
Copyright (c) <date-range> by Cisco Systems, Inc.
Compiled <day> <date> <time> by <compiler-id>
ROM: System Bootstrap, Version <software-version>, <software-type>
BOOTLDR: <platform> Software (image-id), Version <software-version>,

<software-type>

<router-name> uptime is <w> weeks, <d> days, <h> hours, <m> minutes
System returned to ROM by reload at <time> <day> <date>
System image file is "<filesystem-location>/<software-image-name>"
Last reload reason: <reload-reason>
Cisco <platform-processor-type> processor (revision <processor-revision-id>) with
<free-DRAM-memory>K/<packet-memory>K bytes of memory.
Processor board ID <ID-number>
<CPU-type> CPU at <clock-speed>Mhz, Implementation <number>, Rev <Revision-number>,
<kilobytes-Processor-Cache-Memory>KB <cache-Level> Cache

See the Examples section for descriptions of the fields in this output.

Examples

The following is sample output from the show version command issued on a Cisco 3660 running Cisco
IOS Release 12.3(4)T:
Router# show version
Cisco IOS Software, 3600 Software (C3660-I-M), Version 12.3(4)T
TAC Support: http://www.cisco.com/tac
Copyright (c) 1986-2003 by Cisco Systems, Inc.
Compiled Thu 18-Sep-03 15:37 by ccai
ROM: System Bootstrap, Version 12.0(6r)T, RELEASE SOFTWARE (fc1)
ROM:
C3660-1 uptime is 1 week, 3 days, 6 hours, 41 minutes
System returned to ROM by power-on
System image file is "slot0:tftpboot/c3660-i-mz.123-4.T"
Cisco 3660 (R527x) processor (revision 1.0) with 57344K/8192K bytes of memory.
Processor board ID JAB055180FF
R527x CPU at 225Mhz, Implementation 40, Rev 10.0, 2048KB L2 Cache

3660 Chassis type: ENTERPRISE

2 FastEthernet interfaces
4 Serial interfaces

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-337

Booting Commands
show version

DRAM configuration is 64 bits wide with parity disabled.

125K bytes of NVRAM.
16384K bytes of processor board System flash (Read/Write)
Flash card inserted. Reading filesystem...done.
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Configuration register is 0x2102

The following is sample output from the show version command issued on a Cisco 7200 router running
Cisco IOS Release 12.4(4)T. This output shows the total bandwidth capacity and the bandwith capacity
that is configured on the Cisco 7200. Displaying bandwidth capacity is available in Cisco IOS Release
12.2 and later releases.
Router# show version
Cisco IOS Software, 7200 Software (C7200-JS-M), Version 12.4(4)T, RELEASE SOFTW)
Technical Support: http://www.cisco.com/techsupport
Copyright (c) 1986-2005 by Cisco Systems, Inc.
Compiled Thu 27-Oct-05 05:58 by ccai
ROM: System Bootstrap, Version 12.1(20000710:044039) [nlaw-121E_npeb 117], DEVEE
BOOTLDR: 7200 Software (C7200-KBOOT-M), Version 12.3(16), RELEASE SOFTWARE (fc4)
router uptime is 5 days, 18 hours, 2 minutes
System returned to ROM by reload at 02:45:12 UTC Tue Feb 14 2006
System image file is "disk0:c7200-js-mz.124-4.T"
Last reload reason: Reload Command

Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memo.

Processor board ID 26793934
R7000 CPU at 350MHz, Implementation 39, Rev 3.2, 256KB L2 Cache
6 slot VXR midplane, Version 2.6
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 440 bandwidth points.
This configuration is within the PCI bus capacity and is supported.
PCI bus mb2 (Slots 2, 4, 6) has a capacity of 600 bandwidth points.
Current configuration on bus mb2 has a total of 390 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.

4 Ethernet interfaces
2 FastEthernet interfaces
2 ATM interfaces
125K bytes of NVRAM.
62976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes).
125952K 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
Router#

Cisco IOS Configuration Fundamentals Command Reference

FR-338

78-11740-02

Booting Commands
show version

For information about PCI buses and bandwidth calculation, go to

http://www.cisco.com/univercd/cc/td/doc/product/core/7206/port_adp/config/3875in.htm#wp1057192.
Table 41 describes the significant fields shown in the display.
Table 41

show version Field Descriptions

Field

Description

Cisco IOS Software,

<platform> Software
(<image-id>), Version
<software-version>,
<release-type>

platformCisco hardware device name.

Example:
Cisco IOS Software, 7200
Software (C7200-G4JS-M),
Version 12.3(4)T

image-idThe coded software image identifier, in the format

platform-features-format (for example, c7200-g4js-mz.
software-versionThe Cisco IOS software release number, in the
format x.y(z)A, where x.y is the main release identifier, z is the
maintenance release number, and A, where applicable, is the special
release train identifier. For example, 12.3(4)T indicates the fourth
maintenance release of the 12.3T special technology release train.
Note

In the full software image filename, 12.3(4)T appears as

123-4.T. In the IOS Upgrade Planner, 12.3(4)T appears as
12.3.4T (ED).

release-typeThe description of the release type. Possible values

include MAINTENANCE [for example, 12.3(3)] or INTERIM [for
example, 12.3(3.2)].
Tips

Refer to The ABCs of Cisco IOS Networking (available

on Cisco.com) for more information on Cisco IOS software
release numbering and software versions.

Cisco IOS is a registered trademark (R) of Cisco Systems, Inc.

TAC Support:
http://www.cisco.com/tac
Copyright (c) <date-range>
by Cisco Systems, Inc.

The Cisco Technical Assistance Center (TAC) contains more than

30,000 pages of searchable technical content, including links to
products, technologies, solutions, technical tips, and tools.
Registered Cisco.com users can log in from this page to access even
more content.
Cisco IOS software, including the source code, user-help, and
documentation, is copyrighted by Cisco Systems, Inc. It is Ciscos
policy to enforce its copyrights against any third party who
infringes on its copyright.

ROM: System Bootstrap,

Version 12.0(6r)T, RELEASE
SOFTWARE (fc1)

The system bootstrap software, stored in ROM memory.

BOOTFLASH:

The system bootflash software, stored in Flash memory (if

applicable).

<device> uptime is ...

The amount of time the system has been up and running.

Example:
C3660-1 uptime is 1 week, 3
days, 6 hours, 41 minutes

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-339

Booting Commands
show version

Table 41

show version Field Descriptions (continued)

Field

Description

System returned to ROM by

<reload-reason> at <time>
<day> <date>

Shows the last recorded reason for a system reload, and time of last
reload.

Example:
System returned to ROM by
reload at 20:56:53 UTC Tue
Nov 4 2003
Last reload reason:
<reload-reason>

Shows the last recorded reason for a system reload.

Example:
Last reload reason: Reload
command
Last reset from
<reset-reason>

Example:
Last reset from power-on

Shows the last recorded reason for a system reset. Possible

reset-reason values include:

power-onSystem was reset with the initial power on or a

power cycling of the device.

s/w peripheralSystem was reset due to a software peripheral.

s/w nmiSystem was reset by a nonmaskable interrupt (NMI)

originating in the system software. For example, on some
systems, you can configure the device to reset automatically if
two or more fans fail.

push-buttonSystem was reset by manual activation of a

RESET push-button (also called a hardware NMI).

watchdogSystem was reset due to a watchdog process.

unexpected valueMay indicate a bus error, such as for an

attempt to access a nonexistent address (for example, System
restarted by bus error at PC 0xC4CA, address 0x210C0C0).

(This field was formerly labeled as the System restarted by

field.)
System image file is
<file-location/file-name>

Displays the file location (local or remote filesystem) and the

system image name.

Example:
System image file is
"slot0:tftpboot/c3660-i-mz.1
23-3.9.T2"

Cisco IOS Configuration Fundamentals Command Reference

FR-340

78-11740-02

Booting Commands
show version

Table 41

show version Field Descriptions (continued)

Field

Description

Cisco <platform>
(<processor-type>) processor
(revision
<processor-revision-id>)
with
<free-DRAM-memory>K/<packetmemory>K bytes of memory.

This line can be used to determine how much Dynamic RAM

(DRAM) is installed on your system, in order to determine if you
meet the Min. Memory requirement for a software image. DRAM
(including SDRAM) is used for system processing memory and for
packet memory.

Example: Separate DRAM and

Packet Memory
Cisco RSP4 (R5000) processor
with 65536K/2072K bytes of
memory

Two values, separated by a slash, are given for DRAM: The first
value tells you how DRAM is available for system processing, and
the second value tells you how much DRAM is being used for
Packet memory.
The first value, Main Processor memory, is either:

The amount of DRAM available for the processor, or

The total amount of DRAM installed on the system.

The second value, Packet memory, is either:

Example: Combined DRAM and
Packet Memory

Cisco 3660 (R527x) processor

(revision 1.0) with
57344K/8192K bytes of
memory.

The total physical input/output (I/O) memory (or Fast

memory) installed on the router (Cisco 4000, 4500, 4700, and
7500 series), or

The amount of shared memory used for packet buffering. In

the shared memory scheme (Cisco 2500, 2600, 3600, and 7200
Series), a percentage of DRAM is used for packet buffering by
the router's network interfaces.

Note

The terms I/O memory or iomem; shared memory;

Fast memory and PCI memory all refer to Packet
Memory. Packet memory is either separate physical RAM
or shared DRAM.

Separate DRAM and Packet Memory

The 4000, 4500, 4700, and 7500 series routers have separate
DRAM and Packet memory, so you only need to look at the first
number to determine total DRAM. In the example to the left for the
Cisco RSP4, the first value shows that the router has 65536K
(65,536 kilobytes, or 64 megabytes) of DRAM. The second value,
8192K, is the Packet memory.
Combined DRAM and Packet Memory

The 2500, 2600, 3600, and 7200 series routers require a minimum
amount of I/O memory to support certain interface processors.
The 1600, 2500, 2600, 3600, and 7200 series routers use a fraction
of DRAM as Packet memory, so you need to add both numbers to
find out the real amount of DRAM. In the example to the left for the
Cisco 3660, the router has 57,344 kilobytes (KB) of free DRAM
and 8,192 KB dedicated to Packet memory. Adding the two
numbers together gives you 57,344K + 8,192K = 65,536K, or 64
megabytes (MB) of DRAM.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-341

Booting Commands
show version

Table 41

show version Field Descriptions (continued)

Field

Description
For more details on memory requirements, see the document How
to Choose a Cisco IOS Software Release on Cisco.com.

Configuration register is
<value>

Shows the current configured hex value of the software

configuration register. If the value has been changed with the
config-register command, the register value that will be used at the
next reload is displayed in parenthesis.

Example:

The boot field (final digit) of the software configuration register

dictates what the system will do after a reset.

Configuration register is
0x2142 (will be 0x2102 at
next reload)

For example, when the boot field of the software configuration

register is set to 00 (for example, 0x0), and you press the NMI
button on a Performance Route Processor (PRP), the user-interface
remains at the ROM monitor prompt (rommon>) and waits for a
user command to boot the system manually. But if the boot field is
set to 01 (for example, 0x1), the system automatically boots the first
Cisco IOS image found in the onboard Flash memory SIMM on the
PRP.
The factory-default setting for the configuration register is 0x2102.
This value indicates that the router will attempt to load a Cisco IOS
software image from Flash memory and load the startup
configuration file.

Related Commands

Command

Description

show inventory

Displays the Cisco Unique Device Identifier information, including the

Product ID, the Version ID, and the Serial Number, for the hardware device
and hardware components.

Cisco IOS Configuration Fundamentals Command Reference

FR-342

78-11740-02

Basic File Transfer Services Commands

This chapter provides detailed descriptions of commands used to configure basic file transfer services
on a Cisco routing device.
For configuration information and examples, refer to the Configuring Basic File Transfer Services
chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-343

Basic File Transfer Services Commands

async-bootp

async-bootp
To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the
async-bootp global configuration command. To restore the default, use the no form of this command.
async-bootp tag [:hostname] data
no async-bootp

Syntax Description

tag

Item being requested; expressed as filename, integer, or IP dotted decimal address.

See Table 42 for possible keywords.

:hostname

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

data

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

number, or a quoted string.

Table 42

tag Keyword Options

Keyword

Description

bootfile

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.

subnet-mask mask

Dotted decimal address specifying the network and local subnetwork

mask (as defined by RFC 950).

time-offset offset

Signed 32-bit integer specifying the time offset of the local subnetwork
in seconds from Coordinated Universal Time (UTC).

gateway address

Dotted decimal address specifying the IP addresses of gateways for this

subnetwork. A preferred gateway should be listed first.

time-server address

Dotted decimal address specifying the IP address of time servers (as

defined by RFC 868).

IEN116-server
address

Dotted decimal address specifying the IP address of name servers (as

defined by IEN 116).

nbns-server address

Dotted decimal address specifying the IP address of Windows NT

servers.

DNS-server address

Dotted decimal address specifying the IP address of domain name servers

(as defined by RFC 1034).

log-server address

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

log server.

quote-server address

Dotted decimal address specifying the IP address of Quote of the Day

servers (as defined in RFC 865).

lpr-server address

Dotted decimal address specifying the IP address of Berkeley UNIX

Version 4 BSD servers.

impress-server
address

Dotted decimal address specifying the IP address of Impress network

image servers.

Cisco IOS Configuration Fundamentals Command Reference

FR-344

78-11740-02

Basic File Transfer Services Commands

async-bootp

Table 42

tag Keyword Options (continued)

Keyword

Description

rlp-server address

Dotted decimal address specifying the IP address of Resource Location

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

hostname name

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

bootfile-size value

A two-octet value specifying the number of 512-octet (byte) blocks in the

default boot file.

Defaults

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

Modification

10.0

This command was introduced.

Usage Guidelines

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

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

Description

show async bootp

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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-345

Basic File Transfer Services Commands

ip ftp passive

ip ftp passive
To configure the router to use only passive File Transfer Protocol (FTP) connections, use the ip ftp
passive global configuration command. To allow all types of FTP connections, use the no form of this
command.
ip ftp passive
no ip ftp passive

Syntax Description

This command has no arguments or keywords.

Defaults

All types of FTP connections are allowed.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following example configures the router to use only passive FTP connections:
ip ftp passive

Related Commands

Command

Description

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp source-interface

Specifies the source IP address for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-346

78-11740-02

Basic File Transfer Services Commands

ip ftp password

ip ftp password
To specify the password to be used for File Transfer Protocol (FTP) connections, use the ip ftp password
global configuration command. 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

(Optional) Type of encryption to use on the password. A value

of 0 disables encryption. A value of 7 indicates proprietary encryption.

password

Password to use for FTP connections.

Defaults

The router forms a password [email protected]. 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

Modification

10.3

This command was introduced.

Examples

The following example configures the router to use the username red and the password blue for FTP
connections:
ip ftp username red
ip ftp password blue

Related Commands

Command

Description

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp source-interface

Specifies the source IP address for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-347

Basic File Transfer Services Commands

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-interface global configuration command. To use the address of the interface where the
connection is made, use the no form of this command.
ip ftp source-interface interface
no ip ftp source-interface

Syntax Description

interface

Defaults

The FTP source address is the IP address of the interface the FTP packets use to leave the router.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

The interface type and number to use to obtain the source address for
FTP connections.

Usage Guidelines

Use this command to set the same source address for all FTP connections.

Examples

The following example configures the router to use the IP address associated with the Ethernet 0
interface as the source address on all FTP packets, regardless of which interface is actually used to send
the packet:
ip ftp source-interface ethernet 0

Related Commands

Command

Description

ip ftp passive

Configures the router to use only passive FTP connections

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-348

78-11740-02

Basic File Transfer Services Commands

ip ftp username

ip ftp username
To configure the username for File Transfer Protocol (FTP) connections, use the ip ftp username global
configuration command. To configure the router to attempt anonymous FTP, use the no form of this
command.
ip ftp username username
no ip ftp username

Syntax Description

username

Defaults

The Cisco IOS software attempts an anonymous FTP.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Username for FTP connections.

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

Description

ip ftp passive

Configures the router to use only passive FTP connections.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp source-interface

Specifies the source IP address for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-349

Basic File Transfer Services Commands

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 no form of this command.
ip rarp-server ip-address
no ip rarp-server ip-address

Syntax Description

ip-address

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

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.

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 its workstations. By bridging RARP packets and using both the ip
helper-address interface configuration command and the ip forward-protocol global configuration
command, the Cisco IOS software should be 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-350

78-11740-02

Basic File Transfer Services Commands

ip 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

Description

ip forward-protocol

Speeds up flooding of UDP datagrams using the spanning-tree algorithm.

ip helper-address

Forwards UDP broadcasts, including BOOTP, received on an interface.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-351

Basic File Transfer Services Commands

ip rcmd domain-lookup

ip rcmd domain-lookup
To reenable the basic DNS security check for rcp and rsh, use the ip rcmd domain-lookup global
configuration command. To disable the basic DNS security check for rcp and 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.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

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-lookup command).
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-lookup command. This means
that if the no 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-352

78-11740-02

Basic File Transfer Services Commands

ip rcmd domain-lookup

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

Description

ip domain-lookup

Enables the IP DNS-based host name-to-address translation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-353

Basic File Transfer Services Commands

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 (rcp), use the ip rcmd rcp-enable global configuration command. 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.

Defaults

To ensure security, the router is not enabled for rcp by default.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

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 netadmin3on 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

Related Commands

Command

Description

ip rcmd remote-host

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

FR-354

78-11740-02

Basic File Transfer Services Commands

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 rsh or 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

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

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.

host-name

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.

remote-username

Name of the user on the remote host from which the router will accept
remotely executed commands.

enable [level]

(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.

Defaults

No entries are in the local authentication database.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-355

Basic File Transfer Services Commands

ip rcmd remote-host

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 .rhosts file
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 hosts 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.

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.
ip rcmd remote-host router1 172.16.101.101 netadmin3 enable

Related Commands

Command

Description

ip rcmd rcp-enable

Configures the Cisco IOS software to allow remote users to copy files to and
from the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-356

78-11740-02

Basic File Transfer Services Commands

ip rcmd remote-host

Command

Description

ip rcmd rsh-enable

Configures the router to allow remote users to execute commands on it using

the rsh protocol.

ip domain-lookup

Enables the IP DNS-based host name-to-address translation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-357

Basic File Transfer Services Commands

ip rcmd remote-username

ip rcmd remote-username
To configure the remote username to be used when requesting a remote copy using rcp, use the ip rcmd
remote-username global configuration command. To remove from the configuration the remote
username, use the no form of this command.
ip rcmd remote-username username
no ip rcmd remote-username username

Syntax Description

username

Defaults

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 username command,
then the software sends that username as the remote username.

Note

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 users account, if the server has
a directory structure, for example, as do UNIX systems.

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

Modification

10.3

This command was introduced.

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 users account.

Cisco IOS Configuration Fundamentals Command Reference

FR-358

78-11740-02

Basic File Transfer Services Commands

ip rcmd remote-username

Note

Examples

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.

The following example configures the remote username to netadmin1:

ip rcmd remote-username netadmin1

Related Commands

Command

Description

boot network rcp

Changes the default name of the network configuration file from which to
load configuration commands.

boot system rcp

Specifies the system image that the router loads at startup.

bridge acquire

Forwards any frames for stations that the system has learned about
dynamically.

copy

Copies any file from a source to a destination.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-359

Basic File Transfer Services Commands

ip rcmd rsh-enable

ip rcmd rsh-enable
To configure the router to allow remote users to execute commands on it using rsh, use the
ip rcmd rsh-enable global configuration command. 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.

Defaults

To ensure security, the router is not enabled for rsh by default.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Remote Shell (rsh), used as a client process, gives users the ability to remotely get router info (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:

ip rcmd rsh-enable

Related Commands

Command

Description

ip rcmd remote-host

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

FR-360

78-11740-02

Basic File Transfer Services Commands

ip rcmd source-interface

ip rcmd source-interface
To force rcp or 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

Defaults

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

Modification

11.3

This command was introduced.

Usage Guidelines

The name and number used to identify the interface. For example,
Loopback2.

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.

Examples

In the following example, the Loopback0 interface 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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-361

Basic File Transfer Services Commands

ip rcmd source-interface

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

Description

ip rcmd remote-host

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

FR-362

78-11740-02

Basic File Transfer Services Commands

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 global configuration
command. To set the identity to the default value, use the no form of this command.
mop device-code {cisco | ds200}
no mop device-code {cisco | ds200}

Syntax Description

cisco

Denotes a Cisco device code.

ds200

Denotes a DECserver 200 device code.

Defaults

Cisco device code

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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

Description

mop sysid

Enables an interface to send out periodic MOP system identification

messages.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-363

Basic File Transfer Services Commands

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 global configuration
command. To reinstate the default value, use the no form of this command.
mop retransmit-timer seconds
no mop retransmit-timer

Syntax Description

seconds

Defaults

4 seconds

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Sets the length of time (in seconds) that the software waits before resending a
message. The value is a number from 1 to 20.

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

Related Commands

Command

Description

mop device-code

Identifies the type of device sending MOP sysid messages and requests
program messages.

mop enabled

Enables an interface to support the MOP.

Cisco IOS Configuration Fundamentals Command Reference

FR-364

78-11740-02

Basic File Transfer Services Commands

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 global configuration command. To reinstate the
default value, use the no form of this command.
mop retries count
no mop retries

Syntax Description

count

Defaults

8 times

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

Indicates the number of times the software will resend a MOP boot request. The
value is a number from 3 to 24.

In the following example, the software will attempt to resend a message to an unresponsive host 11 times
before declaring a failure:
mop retries 11

Related Commands

Command

Description

mop device-code

Identifies the type of device sending MOP sysid messages and requests
program messages.

mop enabled

Enables an interface to support the MOP server.

mop retransmit-timer Configures the length of time that the Cisco IOS software waits before
resending boot requests to a MOP server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-365

Basic File Transfer Services Commands

rsh

rsh
To execute a command remotely on a remote rsh host, use the rsh privileged EXEC command.
rsh {ip-address | host} [/user username] remote-command

Syntax Description

Defaults

ip-address

IP address of the remote host on which to execute the rsh command.

Either the IP address or the host name is required.

host

Name of the remote host on which to execute the command. Either the
host name or the IP address is required.

/user username

(Optional) Remote username.

remote-command

Command to be executed remotely.

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 username command, 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

Modification

10.0

This command was introduced.

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
.

Cisco IOS Configuration Fundamentals Command Reference

FR-366

78-11740-02

Basic File Transfer Services Commands

rsh

..
.alias
.cshrc
.emacs
.exrc
.history
.login
.mailrc
.newsrc
.oldnewsrc
.rhosts
.twmrc
.xsession
jazz

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-367

Basic File Transfer Services Commands

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 privileged EXEC command.
show async bootp

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

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

Table 43 describes the significant fields shown in the display.

Table 43

Related Commands

show async bootp Field Descriptions

Field

Description

bootfile... pcboot

Boot file for address 192.168.1.1 is named pcboot.

subnet-mask 255.255.0.0

Subnet mask.

time-offset -3600

Local time is one hour (3600 seconds) earlier than UTC time.

time-server 192.168.1.1

Address of the time server for the network.

Command

Description

async-bootp

Configures extended BOOTP requests for asynchronous interfaces as

defined in RFC 1084.

Cisco IOS Configuration Fundamentals Command Reference

FR-368

78-11740-02

Basic File Transfer Services Commands

tftp-server

tftp-server
To configure a router or a Flash memory device on the router as a TFTP server, use one of the following
tftp-server global configuration commands. This command replaces the tftp-server system command.
To remove a previously defined filename, use the no tftp-server command with the appropriate
filename.
tftp-server flash [partition-number:]filename1 [alias filename2] [access-list-number]
tftp-server rom alias filename1 [access-list-number]
no tftp-server {flash [partition-number:]filename1 | rom alias filename2}
Cisco 1600 Series and Cisco 3600 Series Routers

tftp-server flash [device:][partition-number:]filename

no tftp-server flash [device:][partition-number:]filename
Cisco 7000 Family Routers

tftp-server flash device:filename

no tftp-server flash device:filename

Syntax Description

flash

Specifies TFTP service of a file in Flash memory.

rom

Specifies TFTP service of a file in ROM.

filename1

Name of a file in Flash or in ROM that the TFTP server uses in answering TFTP
Read Requests.

alias

Specifies an alternate name for the file that the TFTP server uses in answering
TFTP Read Requests.

filename2

Alternate name of the file that the TFTP server uses in answering TFTP Read
Requests. A client of the TFTP server can use this alternate name in its Read
Requests.

access-list-number

(Optional) Basic IP access list number. Valid values are from 0 to 99.

partition-number:

(Optional) Specifies TFTP service of a file in the specified partition of Flash

memory. If the partition number is not specified, the file in the first partition is
used.
For the Cisco 1600 series and Cisco 3600 series routers, you must enter a colon
after the partition number if a filename follows it.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-369

Basic File Transfer Services Commands

tftp-server

device:

filename

(Optional) Specifies TFTP service of a file on a Flash memory device in the

Cisco 1600 series, Cisco 3600 series, and Cisco 7000 family routers. The colon
is required. Valid devices are as follows:

flashInternal Flash memory on the Cisco 1600 series and Cisco 3600
series routers. This is the only valid device for the Cisco 1600 series routers.

bootflashInternal Flash memory in the Cisco 7000 family routers.

slot0First PCMCIA slot on the Cisco 3600 series and Cisco 7000 family
routers.

slot1Second PCMCIA slot on the Cisco 3600 series and Cisco 7000
family.

slavebootflashInternal Flash memory on the slave RSP card of a

Cisco 7507 or Cisco 7513 router configured for HSA.

slaveslot0First PCMCIA slot of the slave RSP card on a Cisco 7507 or

Cisco 7513 router configured for HSA.

slaveslot1Second PCMCIA slot of the slave RSP card on a Cisco 7507 or

Cisco 7513 router configured for HSA.

Name of the file on a Flash memory device that the TFTP server uses in
answering a TFTP Read Request. Use this argument only with the Cisco 1600
series, Cisco 3600 series, Cisco 7000 series, or Cisco 7500 series routers.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

11.0

This command was introduced.

Usage Guidelines

You can specify multiple filenames by repeating the tftp-server command. The system sends a copy of
the system image contained in ROM or one of the system images contained in Flash memory to any client
that issues a TFTP Read Request with this filename.
If the specified filename1 or filename2 argument exists in Flash memory, a copy of the Flash image is
sent. On systems that contain a complete image in ROM, the system sends the ROM image if the
specified filename1 or filename2 argument is not found in Flash memory.
Images that run from ROM cannot be loaded over the network. Therefore, it does not make sense to use
TFTP to offer the ROMs on these images.
On the Cisco 7000 family routers, the system sends a copy of the file contained on one of the Flash
memory devices to any client that issues a TFTP Read Request with its filename.

Cisco IOS Configuration Fundamentals Command Reference

FR-370

78-11740-02

Basic File Transfer Services Commands

tftp-server

Examples

In the following example, the system uses TFTP to send a copy of the version-10.3 file located in Flash
memory in response to a TFTP Read Request for that file. The requesting host is checked against access
list 22.
tftp-server flash version-10.3 22

In the following example, the system uses TFTP to send a copy of the ROM image gs3-k.101 in response
to a TFTP Read Request for the gs3-k.101 file:
tftp-server rom alias gs3-k.101

In the following example, the system uses TFTP to send a copy of the version-11.0 file in response to a
TFTP Read Request for that file. The file is located on the Flash memory card inserted in slot 0.
tftp-server flash slot0:version-11.0

The following example enables a Cisco 3600 series router to operate as a TFTP server. The source
file c3640-i-mz is in the second partition of internal Flash memory.
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
router(config)# tftp-server flash flash:2:dirt/gate/c3640-i-mz

In the following example, the source file is in the second partition of the Flash memory PC card in slot 0
on a Cisco 3600 series:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
router(config)# tftp-server flash slot0:2:dirt/gate/c3640-j-mz

The following example enables a Cisco 1600 series router to operate as a TFTP server. The source
file c1600-i-mz is in the second partition of Flash memory:
router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
router(config)# tftp-server flash flash:2:dirt/gate/c1600-i-mz

Related Commands

Command

Description

access-list

Creates an extended access list.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-371

Basic File Transfer Services Commands

tftp-server system

tftp-server system
The tftp-server system command has been replaced by the tftp-server command. See the description of
the tftp-server command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-372

78-11740-02

System Management Commands

Basic System Management Commands

This chapter describes the commands used to perform basic system management tasks, such as naming
the router and setting time services. This documentation is specific to Cisco IOS Release 12.2.
For basic system management configuration tasks and examples, refer to the Performing Basic System
Management chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-375

Basic System Management Commands

absolute

absolute
To specify an absolute time when a time range is in effect, use the absolute time-range configuration
command. To remove the time limitation, use the no form of this command.
absolute [start time date] [end time date]
no absolute

Syntax Description

start time date

(Optional) Absolute time and date that the permit or deny statement of the
associated access list starts going into effect. The time is expressed in 24-hour
notation, in the form of hours:minutes. For example, 8:00 is 8:00 a.m. and 20:00
is 8:00 p.m. The date is expressed in the format day month year. The minimum
start is 00:00 1 January 1993. If no start time and date are specified, the permit or
deny statement is in effect immediately.

end time date

(Optional) Absolute time and date that the permit or deny statement of the
associated access list is no longer in effect. Same time and date format as
described for the start keyword. The end time and date must be after the start time
and date. The maximum end time is 23:59 31 December 2035. If no end time and
date are specified, the associated permit or deny statement is in effect indefinitely.

Defaults

There is no absolute time when the time range is in effect.

Command Modes

Time-range configuration

Command History

Release

Modification

12.0(1)T

This command was introduced.

Usage Guidelines

Time ranges are used by IP and IPX extended access lists. For more information on using these functions,
see the Release 12.2 Cisco IOS IP Configuration Guide and the Release 12.2 Cisco IOS AppleTalk and
Novell IPX Configuration Guide. Time ranges are applied to the permit or deny statements found in
these access lists.
The absolute command is one way to specify when a time range is in effect. Another way is to specify
a periodic length of time with the periodic command. Use either of these commands after the
time-range command, which enables time-range configuration mode and specifies a name for the time
range. Only one absolute entry is allowed per time-range command.
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 interpreted as local time. To ensure that the time range entries take effect at
the desired times, the software clock should be synchronized using the Network Time Protocol (NTP),
or some other authoritative time source. For more information, refer to the Performing Basic System

Cisco IOS Configuration Fundamentals Command Reference

FR-376

78-11740-02

Basic System Management Commands

absolute

Management chapter of the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Examples

The following example configures an access list named northeast, which references a time range named
xyz. The access list and time range together permit traffic on Ethernet interface 0 starting at noon on
January 1, 2001 and going forever.
time-range xyz
absolute start 12:00 1 January 2001
!
ip access-list extended northeast
permit ip any any time-range xyz
!
interface ethernet 0
ip access-group northeast in

The following example permits UDP traffic until noon on December 31, 2000. After that time, UDP
traffic is no longer allowed out Ethernet interface 0.
time-range abc
absolute end 12:00 31 December 2000
!
ip access-list extended northeast
permit udp any any time-range abc
!
interface ethernet 0
ip access-group northeast out

The following example permits UDP traffic out Ethernet interface 0 on weekends only, from 8:00 a.m.
on January 1, 1999 to 6:00 p.m. on December 31, 2001:
time-range test
absolute start 8:00 1 January 1999 end 18:00 31 December 2001
periodic weekends 00:00 to 23:59
!
ip access-list extended northeast
permit udp any any time-range test
!
interface ethernet 0
ip access-group northeast out

Related Commands

Command

Description

deny

Sets conditions under which a packet does not pass a named access list.

periodic

Specifies a recurring (weekly) start and end time for a time range.

permit

Sets conditions under which a packet passes a named access list.

time-range

Enables time-range configuration mode and names a time range definition.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-377

Basic System Management Commands

alias

alias
To create a command alias, use the alias global configuration command. 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 mode of the original and alias commands.

command-alias

Command alias.

original-command

Original command syntax.

Defaults

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

Modification

10.3

This command was introduced.

Usage Guidelines

You can use simple words or abbreviations as command aliases.

Table 44 lists the basic EXEC mode aliases that are enabled by default.
Table 44

Default Command Aliases

Command Alias

Original Command

help

lo

logout

ping

resume

show

where

The default aliases in Table 44 are predefined. These default aliases can be disabled with the
no alias exec command.
Common keyword aliases (which can not 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-378

78-11740-02

Basic System Management Commands

alias

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

For a list of command modes with descriptions and references to related documentation, refer to the
Cisco IOS Command Modes appendix of the Release 12.2 Cisco IOS Configuration Fundamentals
Configuration Guide.
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-379

Basic System Management Commands

alias

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 /debug and /line switches can 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

Examples

In the following example, the alias fixmyrt is configured for the clear iproute 209.165.201.16 EXEC
mode command:
Router(config)# alias exec fixmyrt clear ip route 209.165.201.16

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
.
.
.

Cisco IOS Configuration Fundamentals Command Reference

FR-380

78-11740-02

Basic System Management Commands

alias

Router(config-if)#exit
Router(config)#alias ?
accept-dialin
accept-dialout
address-family
call-discriminator
cascustom
clid-group
configure
congestion
controller
cptone-set
customer-profile
dhcp
dnis-group
exec
flow-cache
fr-fr
interface
.
.
.

VPDN group accept dialin configuration mode

VPDN group accept dialout configuration mode
Address Family configuration mode
Call Discriminator Configuration
Cas custom configuration mode
CLID group configuration mode
Global configuration mode
Frame Relay congestion configuration mode
Controller configuration mode
custom call progress tone configuration mode
customer profile configuration mode
DHCP pool configuration mode
DNIS group configuration mode
Exec mode
Flow aggregation cache config mode
FR/FR connection configuration mode
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 can not 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

Description

show aliases

Displays command aliases.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-381

Basic System Management Commands

buffers

buffers
To make adjustments to initial buffer pool settings and to the limits at which temporary buffers are
created and destroyed, use the buffers global configuration command. To return the buffers to their
default size, use the no form of this command.
buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free |
min-free | initial} number-of-buffers
no buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free |
min-free | initial} number-of-buffers

Syntax Description

small

Buffer size of this public buffer pool is 104 bytes.

middle

Buffer size of this public buffer pool is 600 bytes.

big

Buffer size of this public buffer pool is 1524 bytes.

verybig

Buffer size of this public buffer pool is 4520 bytes.

large

Buffer size of this public buffer pool is 5024 bytes.

huge

Default buffer size of this public buffer pool is 18024 bytes. This value can be
configured with the buffers huge size command.

type number

Interface type and interface number of the interface buffer pool. The type value
cannot be fddi.

permanent

Number of permanent buffers that the system tries to create and keep. Permanent
buffers are normally not trimmed by the system.

max-free

Maximum number of free or unallocated buffers in a buffer pool. A maximum of

20,480 small buffers can be constructed in the pool.

min-free

Minimum number of free or unallocated buffers in a buffer pool.

initial

Number of additional temporary buffers that are to be allocated when the system
is reloaded. This keyword can be used to ensure that the system has necessary
buffers immediately after reloading in a high-traffic environment.

number-of-buffers

Number of buffers to be allocated.

Defaults

The default number of buffers in a pool is determined by the hardware configuration and can be
displayed with the show buffers EXEC command.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

FR-382

78-11740-02

Basic System Management Commands

buffers

Usage Guidelines

Note

Normally you need not adjust these parameters; do so only after consulting with technical support
personnel.

Improper buffer settings can adversely impact system performance.

You cannot configure FDDI buffers.

Examples

Examples of Public Buffer Pool Tuning

The following example keeps at least 50 small buffers free in the system:
Router(config)# buffers small min-free 50

The following example increases the permanent buffer pool allocation for big buffers to 200:
Router(config)# buffers big permanent 200

Example of Interface Buffer Pool Tuning

A general guideline is to display buffers with the show buffers command, observe which buffer pool is
depleted, and increase that one.
The following example increases the permanent Ethernet interface 0 buffer pool on a Cisco 4000 router
to 96 when the Ethernet 0 buffer pool is depleted:
Router(config)# buffers ethernet 0 permanent 96

Related Commands

Command

Description

load-interval

Changes the length of time for which data is used to compute load statistics.

show buffers

Displays statistics for the buffer pools on the network server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-383

Basic System Management Commands

buffers huge size

buffers huge size

To dynamically resize all huge buffers to the value you specify, use the buffers huge size global
configuration command. To restore the default buffer values, use the no form of this command.
buffers huge size number-of-bytes
no buffers huge size number-of-bytes

Syntax Description

number-of-bytes

Defaults

18,024 bytes

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Examples

Huge buffer size (in bytes).

Use this command only after consulting with technical support personnel. The buffer size cannot be
lowered below the default.

Improper buffer settings can adversely impact system performance.

The following example resizes huge buffers to 20,000 bytes:

Router(config)# buffers huge size 20000

Related Commands

Command

Description

buffers

Adjusts the initial buffer pool settings and the limits at which temporary
buffers are created and destroyed.

show buffers

Displays statistics for the buffer pools on the network server.

Cisco IOS Configuration Fundamentals Command Reference

FR-384

78-11740-02

Basic System Management Commands

calendar set

calendar set
To manually set the hardware clock (calendar), use one of the formats of the calendar set EXEC
command.
calendar set hh:mm:ss day month year
calendar set hh:mm:ss month day year

Syntax Description

hh:mm:ss

Current time in hours (using 24-hour notation), minutes, and seconds.

day

Current day (by date) in the month.

month

Current month (by name).

year

Current year (no abbreviation).

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a hardware clock that is separate from the software clock. In Cisco IOS software
syntax, the hardware clock is called the calendar. The hardware clock is a battery-powered chip that
runs continuously, even if the router is powered off or rebooted. After you set the hardware clock, the
software clock will be automatically set from the hardware clock when the system is restarted or when
the clock read-calendar EXEC command is issued. The time specified in this command is relative to
the configured time zone.

Examples

The following example manually sets the hardware clock to 1:32 p.m. on July 23, 1997:
Router# calendar set 13:32:00 23 July 1997

Related Commands

Command

Description

clock read-calendar

Performs a one-time update of the software clock from the hardware clock
(calendar).

clock set

Sets the software clock.

clock summer-time

Configures the system time to automatically switch to summer time

(daylight saving time).

clock timezone

Sets the time zone for display purposes.

clock update-calendar

Performs a one-time update of the hardware clock from the software clock.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-385

Basic System Management Commands

clock calendar-valid

clock calendar-valid
To configure a system as an authoritative time source for a network based on its hardware clock
(calendar), use the clock calendar-valid global configuration command. To specify that the hardware
clock is not an authoritative time source, use the no form of this command.
clock calendar-valid
no clock calendar-valid

Syntax Description

This command has no arguments or keywords.

Defaults

The router is not configured as a time source.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a hardware clock that is separate from the software clock. The hardware clock runs
continuously, even if the router is powered off or rebooted. If no outside time source is available on your
network, use this command to make the hardware clock an authoritative time source.
Because the hardware clock is not as accurate as other time sources, you should configure this command
only when a more accurate time source (such as NTP) is not available.

Examples

The following example configures a router as the time source for a network based on its hardware clock:
Router(config)# clock calendar-valid

Related Commands

Command

Description

ntp master

Configures the Cisco IOS software as an NTP master clock to which peers
synchronize themselves when an external NTP source is not available.

vines time use-system Sets VINES network time based on the system time.

Cisco IOS Configuration Fundamentals Command Reference

FR-386

78-11740-02

Basic System Management Commands

clock read-calendar

clock read-calendar
To manually read the hardware clock (calendar) settings into the software clock, use the clock
read-calendar EXEC command.
clock read-calendar

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a hardware clock that is separate from the software clock. The hardware clock runs
continuously, even if the router is powered off or rebooted. When the router is rebooted, the hardware
clock is automatically read into the software clock. However, you may use this command to manually
read the hardware clock setting into the software clock. This command is useful if the calendar set
command has been used to change the setting of the hardware clock.

Examples

The following example configures the software clock to set its date and time by the hardware clock
setting:
Router> clock read-calendar

Related Commands

Command

Description

calendar set

Sets the hardware clock.

clock set

Manually sets the software clock.

clock update-calendar

Performs a one-time update of the hardware clock from the software clock.

ntp update-calendar

Periodically updates the hardware clock from the software clock.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-387

Basic System Management Commands

clock set

clock set
To manually set the system software clock, use one of the formats of the clock set command in privileged
EXEC mode.
clock set hh:mm:ss day month year
clock set hh:mm:ss month day year

Syntax Description

hh:mm:ss

Current time in hours (military format), minutes, and seconds.

day

Current day (by date) in the month.

month

Current month (by name).

year

Current year (no abbreviation).

Command Modes

Privileged EXEC mode

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Generally, if the system is synchronized by a valid outside timing mechanism, such as a Network Time
Protocol (NTP) or VINES clock source, or if you have a router with hardware clock, you need not set
the software clock. Use this command if no other time sources are available. The time specified in this
command is relative to the configured time zone.

Examples

The following example manually sets the software clock to 1:32 p.m. on July 23, 1997:
Router# clock set 13:32:00 23 July 1997

Related Commands

Command

Description

calendar set

Sets the hardware clock.

clock read-calendar

Performs a one-time update of the software clock from the hardware clock
(calendar).

clock summer-time

Configures the system to automatically switch to summer time (daylight

saving time).

clock timezone

Sets the time zone for display purposes.

Cisco IOS Configuration Fundamentals Command Reference

FR-388

78-11740-02

Basic System Management Commands

clock summer-time

clock summer-time
To configure the system to automatically switch to summer time (daylight saving time), use one of the
formats of the clock summer-time global configuration command. To configure the Cisco IOS software
not to automatically switch to summer time, use the no form of this command.
clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]]
clock summer-time zone date date month year hh:mm date month year hh:mm [offset]
clock summer-time zone date month date year hh:mm month date year hh:mm [offset]
no clock summer-time

Syntax Description

zone

Name of the time zone (for example, PDT for Pacific Daylight Time) to be displayed
when summer time is in effect.

recurring

Indicates that summer time should start and end on the corresponding specified days
every year.

date

Indicates that summer time should start on the first specific date listed in the command
and end on the second specific date in the command.

week

(Optional) Week of the month (1 to 5 or last).

day

(Optional) Day of the week (Sunday, Monday, and so on).

date

Date of the month (1 to 31).

month

(Optional) Month (January, February, and so on).

year

Year (1993 to 2035).

hh:mm

(Optional) Time (military format) in hours and minutes.

offset

(Optional) Number of minutes to add during summer time (default is 60).

Defaults

Summer time is disabled. If the clock summer-time zone recurring command is specified without
parameters, the summer time rules default to United States rules. Default of the offset argument is 60.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use this command if you want to automatically switch to summer time (for display purposes only). Use
the recurring form of the command if the local summer time rules are of this form. Use the date form
to specify a start and end date for summer time if you cannot use the recurring form.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-389

Basic System Management Commands

clock summer-time

In both the date and recurring forms of the command, the first part of the command specifies when
summer time begins, and the second part specifies when it ends. All times are relative to the local time
zone. The start time is relative to standard time. The end time is relative to summer time. If the starting
month is chronologically after the ending month, the system assumes that you are in the southern
hemisphere.

Examples

The following example specifies that summer time starts on the first Sunday in April at 2 a.m. and ends
on the last Sunday in October at 2 a.m.:
Router(config)# clock summer-time PDT recurring 1 Sunday April 2:00 last Sunday October
2:00

If you live in a place where summer time does not follow the pattern in the first example, you can specify
the exact date and times. In the following example, daylight saving time (summer time) is configured to
start on October 12, 1997 at 2 a.m., and end on April 26, 1998 at 2 a.m.:
Router(config)# clock summer-time date 12 October 1997 2:00 26 April 1998 2:00

Related Commands

Command

Description

calendar set

Sets the hardware clock.

clock timezone

Sets the time zone for display purposes.

Cisco IOS Configuration Fundamentals Command Reference

FR-390

78-11740-02

Basic System Management Commands

clock timezone

clock timezone
To set the time zone for display purposes, use the clock timezone global configuration command. To set
the time to Coordinated Universal Time (UTC), use the no form of this command.
clock timezone zone hours-offset [minutes-offset]
no clock timezone

Syntax Description

zone

Name of the time zone to be displayed when standard time is in effect.

hours-offset

Hours difference from UTC.

minutes-offset

(Optional) Minutes difference from UTC.

Defaults

UTC

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The system internally keeps time in UTC, so this command is used only for display purposes and when
the time is manually set.
Table 45 lists common time zone acronyms used for the zone argument.
Table 45

Acronym

Common Time Zone Acronyms

Time Zone Name and UTC Offset

Europe

GMT

Greenwich Mean Time, as UTC

BST

British Summer Time, as UTC + 1 hour

IST

Irish Summer Time, as UTC + 1 hour

WET

Western Europe Time, as UTC

WEST

Western Europe Summer Time, as UTC + 1 hour

CET

Central Europe Time, as UTC + 1

CEST

Central Europe Summer Time, as UTC + 2

EET

Eastern Europe Time, as UTC + 2

EEST

Eastern Europe Summer Time, as UTC + 3

MSK

Moscow Time, as UTC + 3

MSD

Moscow Summer Time, as UTC + 4

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-391

Basic System Management Commands

clock timezone

Table 45

Common Time Zone Acronyms (continued)

Acronym

Time Zone Name and UTC Offset

United States and Canada

AST

Atlantic Standard Time, as UTC 4 hours

ADT

Atlantic Daylight Time, as UTC 3 hours

ET

Eastern Time, either as EST or EDT, depending on

place and time of year

EST

Eastern Standard Time, as UTC 5 hours

EDT

Eastern Daylight Saving Time, as UTC 4 hours

CT

Central Time, either as CST or CDT, depending on

place and time of year

CST

Central Standard Time, as UTC 6 hours

CDT

Central Daylight Saving Time, as UTC 5 hours

MT

Mountain Time, either as MST or MDT, depending on

place and time of year

MST

Mountain Standard Time, as UTC 7 hours

MDT

Mountain Daylight Saving Time, as UTC 6 hours

PT

Pacific Time, either as PST or PDT, depending on

place and time of year

PST

Pacific Standard Time, as UTC 8 hours

PDT

Pacific Daylight Saving Time, as UTC 7 hours

AKST

Alaska Standard Time, as UTC 9 hours

AKDT

Alaska Standard Daylight Saving Time, as UTC

8 hours

HST

Hawaiian Standard Time, as UTC 10 hours

Australia

WST

Western Standard Time, as UTC + 8 hours

CST

Central Standard Time, as UTC + 9.5 hours

EST

Eastern Standard/Summer Time, as UTC + 10 hours

(+11 hours during summer time)

Table 46 lists an alternative method for referring to time zones, in which single letters are used to refer
to the time zone difference from UTC. Using this method, the letter Z is used to indicate the zero
meridian, equivalent to UTC, and the letter J (Juliet) is used to refer to the local time zone. Using this
method, the International Date Line is between time zones M and Y.
Table 46

Single-Letter Time Zone Designators

Letter Designator

Word Designator

Difference from UTC

Yankee

UTC 12 hours

Xray

UTC 11 hours

Whiskey

UTC 10 hours

Cisco IOS Configuration Fundamentals Command Reference

FR-392

78-11740-02

Basic System Management Commands

clock timezone

Table 46

Single-Letter Time Zone Designators (continued)

Letter Designator

Word Designator

Difference from UTC

Yankee

UTC 12 hours

Victor

UTC 9 hours

Uniform

UTC 8 hours

Tango

UTC 7 hours

Sierra

UTC 6 hours

Romeo

UTC 5 hours

Quebec

UTC 4 hours

Papa

UTC 3 hours

Oscar

UTC 2 hours

November

UTC 1 hour

Zulu

Same as UTC

Alpha

UTC +1 hour

Bravo

UTC +2 hours

Charlie

UTC +3 hours

Delta

UTC +4 hours

Echo

UTC +5 hours

Foxtrot

UTC +6 hours

Golf

UTC +7 hours

Hotel

UTC +8 hours

India

UTC +9 hours

Kilo

UTC +10 hours

Lima

UTC +11 hours

Mike

UTC +12 hours

The following example sets the time zone to Pacific Standard Time (PST), which is 8 hours behind UTC:
Router(config)# clock timezone PST -8

The following example sets the time zone to Atlantic Time (AT) for Newfoundland, Canada, which is
3.5 hours behind UTC:
Router(config)# clock timezone AT -3 30

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-393

Basic System Management Commands

clock timezone

Related Commands

Command

Description

calendar set

Sets the hardware clock.

clock set

Manually set the software clock.

clock summer-time

Configures the system to automatically switch to summer time (daylight

saving time).

show clock

Displays the software clock.

Cisco IOS Configuration Fundamentals Command Reference

FR-394

78-11740-02

Basic System Management Commands

clock update-calendar

clock update-calendar
To perform a one-time update of the hardware clock (calendar) from the software clock, use the clock
update-calendar in user or privileged EXEC mode.
clock update-calendar

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a hardware clock (calendar) in addition to a software clock. The hardware clock is
battery operated, and runs continuously, even if the router is powered off or rebooted.
If the software clock and hardware clock are not synchronized, and the software clock is more accurate,
use this command to update the hardware clock to the correct date and time.

Examples

The following example copies the current date and time from the software clock to the hardware clock:
Router> clock update-calendar

Related Commands

Command

Description

clock read-calendar

Performs a one-time update of the software clock from the hardware clock
(calendar).

ntp update-calendar

Periodically updates the hardware clock from the software clock.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-395

Basic System Management Commands

downward-compatible-config

downward-compatible-config
To generate a configuration that is compatible with an earlier Cisco IOS release, use the
downward-compatible-config global configuration command. To remove this feature, use the no form
of this command.
downward-compatible-config version
no downward-compatible-config

Syntax Description

version

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Cisco IOS release number, not earlier than Release 10.2.

In Cisco IOS Release 10.3, IP access lists changed format. Use the downward-compatible-config
command to regenerate a configuration in a format prior to Release 10.3 if you are going to 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.

Examples

The following example generates a configuration file compatible with Cisco IOS Release 10.2 access
lists:
Router(config)# downward-compatible-config 10.2

Related Commands

Command

Description

access-list (extended)

Provides extended access lists that allow more detailed access lists.

access-list (standard)

Defines a standard XNS access list.

Cisco IOS Configuration Fundamentals Command Reference

FR-396

78-11740-02

Basic System Management Commands

hostname

hostname
To specify or modify the host name for the network server, use the hostname global configuration
command.
hostname name

Syntax Description

name

Defaults

The factory-assigned default host name is Router.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

New host name for the network server.

The host name is used in prompts and default configuration filenames.

Do not expect case to be preserved. Upper- 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 host names. 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 or fewer. For more information, refer to RFC 1035, Domain NamesImplementation and
Specification.

Examples

The following example changes the host name to sandbox:

Router(config)# hostname sandbox

Related Commands

Command

Description

setup

Enables you to make major enhancements to your configurations, for

example, adding a protocol suit, making major addressing scheme changes,
or configuring newly installed interfaces.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-397

Basic System Management Commands

ip bootp server

ip bootp server
To enable the BOOTP service on your routing device, use the ip bootp server global configuration
command. 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.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

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). If both the BOOTP server and DHCP
server are disabled, and a helper address is not configured, "ICMP port unreachable" messages will be
sent in response to incoming requests on port 67, and the original incoming packet will be discarded.

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 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

Description

service dhcp

Enables the integrated Dynamic Host Configuration Protocol (DHCP) server

and relay agent.

Cisco IOS Configuration Fundamentals Command Reference

FR-398

78-11740-02

Basic System Management Commands

ip finger

ip finger
To configure a system to accept Finger protocol requests (defined in RFC 742), use the ip finger global
configuration command. To disable this service, use the no form of this command.
ip finger [rfc-compliant]
no ip finger

Syntax Description

rfc-compliant

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Usage Guidelines

(Optional) Configures the system to wait for Return or /W input when

processing Finger requests. This keyword should not be used for those
systems.

Modification

11.3

This command was introduced.

12.1(5), 12.1(5)T

This command was changed from being enabled by default to being disabled
by default.

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 users command and then closing the connection.
When the ip finger rfc-compliant command is 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.

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-compliant form of this command should not be
configured for devices with more than 20 simultaneous users.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-399

Basic System Management Commands

ip finger

Examples

The following example disables the Finger protocol:

Router(config)# no ip finger

Cisco IOS Configuration Fundamentals Command Reference

FR-400

78-11740-02

Basic System Management Commands

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 global configuration command. 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

Defaults

The address of the closest interface to the destination as the source address.

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

The interface whose address is to be used as the source for Telnet connections.

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

Related Commands

Command

Description

ip radius
source-interface

Forces RADIUS to use the IP address of a specified interface for all

outgoing RADIUS packets.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-401

Basic System Management Commands

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 global configuration command. To return to the default, use the no form of this
command.
ip tftp source-interface interface
no ip tftp source-interface

Syntax Description

interface

Defaults

The address of the closest interface to the destination as the source address.

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

The interface whose address is to be used as the source for TFTP connections.

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.

Examples

In the following example, the IP address assigned to the Loopback0 interface will be used as the source
address for TFTP connections:
Router(config)# ip tftp source-interface Loopback0

Related Commands

Command

Description

ip ftp source-interface

Forces outgoing FTP packets to use the IP address of a specified

interface as the source address.

ip radius source-interface

Forces outgoing RADIUS packets to use the IP address of a

specified interface as the source address.

Cisco IOS Configuration Fundamentals Command Reference

FR-402

78-11740-02

Basic System Management Commands

load-interval

load-interval
To change the length of time for which data is used to compute load statistics, use the load-interval
interface configuration command. To revert to the default setting, use the no form of this command.
load-interval seconds
no load-interval seconds

Syntax Description

seconds

Defaults

300 seconds (5 minutes)

Command Modes

Interface configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Length of time for which data is used to compute load statistics. A value that is
a multiple of 30, from 30 to 600 (30, 60, 90, 120, and so on).

If you want load computations to be more reactive to short bursts of traffic, rather than averaged over
5-minute periods, 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 input rate in bits and packets per second, output
rate in bits and packets per second, load, and reliability.
Load data is gathered every 5 seconds. This data is used for a weighted average calculation in which
more-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.
The load-interval command allows you to change the default interval of 5 minutes to a shorter or longer
period of time. If you change it to a shorter period of time, the input and output statistics that are
displayed when you use the show interface command will be more current, and based on more
instantaneous data, rather than reflecting a more average load over a longer period of time.
This command is often used for dial backup purposes, to increase or decrease the likelihood of a backup
interface being implemented, but it can be used on any interface.

Examples

In the following example, the default 5-minute average is set to a 30-second average. A burst in traffic
that would not trigger a dial backup for an interface configured with the default 5-minute interval might
trigger a dial backup for this interface that is set for a shorter, 30-second interval.
Router(config)# interface serial 0
Router(config-if)# load-interval 30

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-403

Basic System Management Commands

load-interval

Related Commands

Command

Description

show interfaces

Displays statistics for all configured interfaces.

Cisco IOS Configuration Fundamentals Command Reference

FR-404

78-11740-02

Basic System Management Commands

ntp access-group

ntp access-group
To control access to the Network Time Protocol (NTP) services on the system, use the ntp access-group
command in global configuration mode. To remove access control to the NTP services, use the no form
of this command.
ntp access-group {query-only | serve-only | serve | peer} access-list-number
no ntp

Syntax Description

query-only

Allows only NTP control queries. See RFC 1305 (NTP version 3).

serve-only

Allows only time requests.

serve

Allows time requests and NTP control queries, but does not allow the
system to synchronize to the remote system.

peer

Allows time requests and NTP control queries and allows the system to
synchronize to the remote system.

access-list-number

Number (from 1 to 99) of a standard IP access list.

Defaults

No access control (full access granted to all systems)

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The access group options are scanned in the following order from least restrictive to most restrictive:
1.

peer

2.

serve

3.

serve-only

4.

query-only

Access is granted for the first match that is found. If no access groups are specified, all access is granted
to all sources. If any access groups are specified, only the specified access is granted. This facility
provides minimal security for the time services of the system. However, it can be circumvented by a
determined programmer. If tighter security is desired, use the NTP authentication facility.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-405

Basic System Management Commands

ntp access-group

To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp access-group command and you now want to remove not
only the access group, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configure a system to allow itself to be synchronized by a peer
from access list 99. However, the system restricts access to allow only time requests from access list 42.
Router(config)# ntp access-group peer 99
Router(config)# ntp access-group serve-only 42

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

access-list

Configures the access list mechanism for filtering frames by protocol type or
vendor code.

Cisco IOS Configuration Fundamentals Command Reference

FR-406

78-11740-02

Basic System Management Commands

ntp authenticate

ntp authenticate
To enable Network Time Protocol (NTP) authentication, use the ntp authenticate command in global
configuration mode. To disable the function, use the no form of this command.
ntp authenticate
no ntp

Syntax Description

This command has no arguments or keywords.

Defaults

No authentication

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use this command if you want authentication. If this command is specified, the system will not
synchronize to a system unless it carries one of the authentication keys specified in the ntp trusted-key
global configuration command.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp authenticate command and you now want to disable not
only the authentication, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configure the system to synchronize only to systems that provide
authentication key 42 in their NTP packets:
Router(config)# ntp authenticate
Router(config)# ntp authentication-key 42 md5 aNiceKey
Router(config)# ntp trusted-key 42

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-407

Basic System Management Commands

ntp authenticate

Related Commands

Command

Description

ntp
authentication-key

Defines an authentication key for NTP.

ntp trusted-key

Authenticates the identity of a system to which NTP will synchronize.

Cisco IOS Configuration Fundamentals Command Reference

FR-408

78-11740-02

Basic System Management Commands

ntp authentication-key

ntp authentication-key
To define an authentication key for Network Time Protocol (NTP), use the ntp authentication-key
command in global configuration mode. To remove the authentication key for NTP, use the no form of
this command.
ntp authentication-key number md5 value
no ntp

Syntax Description

number

Key number (from 1 to 4294967295).

md5

Authentication key. Message authentication support is provided using the message

digest algorithm 5 (MD5) algorithm. The key type md5 is currently the only key type
supported.

value

Key value (an arbitrary string of up to eight characters).

Defaults

No authentication key is defined for NTP.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Use this command to define authentication keys for use with other NTP commands in order to provide
a higher degree of security.

When this command is written to NVRAM, the key is encrypted so that it is not displayed when the
configuration is viewed.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp authentication-key command and you now want to
remove not only the authentication key, but all NTP functions from the device, use the no ntp command
without any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-409

Basic System Management Commands

ntp authentication-key

Examples

The following example shows how to configure the system to synchronize only to systems providing
authentication key 42 in their NTP packets:
Router(config)# ntp authenticate
Router(config)# ntp authentication-key 42 md5 aNiceKey
Router(config)# ntp trusted-key 42

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp authenticate

Enables NTP authentication.

ntp peer

Configures the software clock to synchronize a peer or to be synchronized

by a peer.

ntp server

Allows the software clock to be synchronized by a time server.

ntp trusted-key

Authenticates the identity of a system to which NTP will synchronize.

Cisco IOS Configuration Fundamentals Command Reference

FR-410

78-11740-02

Basic System Management Commands

ntp broadcast client

ntp broadcast client

To configure the system to receive Network Time Protocol (NTP) broadcast packets on a specified
interface, use the ntp broadcast client command in interface configuration mode. To disable this
capability, use the no form of this command.
ntp broadcast client
no ntp

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use this command to allow the system to listen to broadcast packets on an interface-by-interface basis.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp broadcast client command and you now want to remove
not only the broadcast client capability, but all NTP functions from the device, use the no ntp command
without any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Examples

In the following example, the system is configured to receive (listen to) NTP broadcasts on Ethernet
interface 1:
Router(config)# interface ethernet 1
Router(config-if)# ntp broadcast client

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-411

Basic System Management Commands

ntp broadcast client

Related Commands

Command

Description

ntp broadcast

Configures the specified interface to send NTP broadcast packets.

ntp broadcastdelay

Sets the estimated round-trip delay between the system and an NTP
broadcast server.

Cisco IOS Configuration Fundamentals Command Reference

FR-412

78-11740-02

Basic System Management Commands

ntp broadcast

ntp broadcast
To configure the system to send Network Time Protocol (NTP) broadcast packets on a specified
interface, use the ntp broadcast command in interface configuration mode. To disable this capability,
use the no form of this command.
ntp broadcast [version number]
no ntp

Syntax Description

version

(Optional) Indicates that a version is specified.

number

(Optional) Number from 1 to 3 indicating the NTP version.

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp broadcast command and you now want to remove not only
the broadcast capability, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configures Ethernet interface 0 to send NTP version 2 broadcasts:
Router(config)# interface ethernet 0
Router(config-if)# ntp broadcast version 2

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-413

Basic System Management Commands

ntp broadcast

Related Commands

Command

Description

ntp broadcast client

Allows the system to receive NTP broadcast packets on an interface.

ntp broadcastdelay

Sets the estimated round-trip delay between the Cisco IOS software and an
NTP broadcast server.

Cisco IOS Configuration Fundamentals Command Reference

FR-414

78-11740-02

Basic System Management Commands

ntp broadcastdelay

ntp broadcastdelay
To set the estimated round-trip delay between the Cisco IOS software and a Network Time Protocol
(NTP) broadcast server, use the ntp broadcastdelay command in global configuration mode. To revert
to the default value, use the no form of this command.
ntp broadcastdelay microseconds
no ntp

Syntax Description

microseconds

Defaults

3000 microseconds

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Estimated round-trip time (in microseconds) for NTP broadcasts. The range is
from 1 to 999999.

Use this command when the router is configured as a broadcast client and the round-trip delay on the
network is other than 3000 microseconds.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp broadcastdelay command and you now want to remove
not only the delay setting, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to set the estimated round-trip delay between a router and the
broadcast client to 5000 microseconds:
Router(config)# ntp broadcastdelay 5000

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-415

Basic System Management Commands

ntp broadcastdelay

Related Commands

Command

Description

ntp broadcast

Configures the specified interface to send NTP broadcast packets.

ntp broadcast client

Configures the specified interface to receive NTP broadcast packets.

Cisco IOS Configuration Fundamentals Command Reference

FR-416

78-11740-02

Basic System Management Commands

ntp clock-period

ntp clock-period
Caution

Do not enter this command; it is documented for informational purposes only. The system automatically
generates this command as Network Time Protocol (NTP) determines the clock error and compensates.
As NTP compensates for the error in the software clock, it keeps track of the correction factor for this
error. The system automatically saves this value into the system configuration when the
ntp clock-period command is issued in global configuration mode. To revert to the default, use the no
form of this command.
ntp clock-period value
no ntp

Syntax Description

value

Defaults

17179869 2-32 seconds (4 milliseconds)

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Amount of time to add to the software clock for each clock hardware tick (this
value is multiplied by 2-32).

Do not manually set a value for the NTP clock-period.

If a copy running-config startup-config command is entered to save the configuration to NVRAM, the
ntp clock-period command will automatically be added to the startup configuration. We recommend
saving the running configuration to the startup configuration after NTP has been running for a week or
so specifically for the purpose of capturing the current setting for the clock-period; performing this task
will help NTP synchronize more quickly if the system is restarted.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you want to remove not only the clock period, but all NTP functions from the device,
use the no ntp command without any keywords. This ensures that all NTP functions are removed and
that the NTP service is also terminated.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-417

Basic System Management Commands

ntp clock-period

Examples

The following example shows a typical difference between the values of the NTP clock-period setting
in the running configuration and in the startup configuration:
Router# show startup-config | include clock-period
ntp clock-period 17180239
Router# show running-config | include clock-period
ntp clock-period 17180255

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

FR-418

78-11740-02

Basic System Management Commands

ntp disable

ntp disable
To prevent an interface from receiving Network Time Protocol (NTP) packets, use the ntp disable
command in interface configuration mode. To enable receipt of NTP packets on an interface, use the no
form of this command.
ntp disable
no ntp

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Interface configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command provides a simple method of access control.

When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp disable command and you now want to remove not only
this restriction, but all NTP functions from the device, use the no ntp command without any keywords.
This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to prevent Ethernet interface 0 from receiving NTP packets:
Router(config)# interface ethernet 0
Router(config-if)# ntp disable

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-419

Basic System Management Commands

ntp master

ntp master
To configure the Cisco IOS software as a Network Time Protocol (NTP) master clock to which peers
synchronize themselves when an external NTP source is not available, use the ntp master command in
global configuration mode. To disable the master clock function, use the no form of this command.
ntp master [stratum]
no ntp

Caution

Use this command with caution. It is very easy to override valid time sources using this command,
especially if a low stratum number is configured. Configuring multiple devices in the same network with
the ntp master command can cause instability in keeping time if the devices do not agree on the time.

Syntax Description

stratum

Defaults

By default, the master clock function is disabled. When enabled, the default stratum is 8.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

(Optional) Number from 1 to 15. Indicates the NTP stratum number that the system will
claim.

Because the Cisco implementation of NTP does not support directly attached radio or atomic clocks, the
router is normally synchronized, directly or indirectly, to an external system that has such a clock. In a
network without Internet connectivity, such a time source may not be available. The ntp master
command is used in such cases.
If the system has ntp master configured, and it cannot reach any clock with a lower stratum number, the
system will claim to be synchronized at the configured stratum number, and other systems will be willing
to synchronize to it via NTP.

Note

The software clock must have been set from some source, including manually, before the ntp master
command will have any effect. This protects against distributing erroneous time after the system is
restarted.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.

Cisco IOS Configuration Fundamentals Command Reference

FR-420

78-11740-02

Basic System Management Commands

ntp master

In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp master command and you now want to remove not only
the master clock function, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configure a router as an NTP master clock to which peers may
synchronize:
Router(config)# ntp master 10

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

clock calendar-valid

Configures the system hardware clock an authoritative time source for the
network.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-421

Basic System Management Commands

ntp max-associations

ntp max-associations
To configure the maximum number of Network Time Protocol (NTP) peers and clients for the routing
device, use the ntp max-associations command in global configuration mode. To return the maximum
associations value to the default, use the no form of this command.
ntp max-associations number
no ntp

Syntax Description

number

Defaults

100 maximum associations.

Command Modes

Global configuration

Command History

Release

Modification

12.0

This command was introduced.

Usage Guidelines

Specifies the number of NTP associations. The range is 0 to 4294967295.

The default is 100.

The router can be configured to define the maximum number of NTP peer and client associations that
the router will serve. The ntp max-associations command is used to set this limit.
This command is useful for ensuring that that the router is not overwhelmed by huge numbers of NTP
synchronization requests or, for an NTP master server, to allow large numbers of devices to sync to the
router.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp max-associations command and you now want to remove
not only that maximum value, but all NTP functions from the device, use the no ntp command without
any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Cisco IOS Configuration Fundamentals Command Reference

FR-422

78-11740-02

Basic System Management Commands

ntp max-associations

Examples

In the following example, the router is configured to act as an NTP server to 200 clients:
Router(config)# ntp max-associations 200

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

show ntp associations

Shows all current NTP associations for the device.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-423

Basic System Management Commands

ntp multicast client

ntp multicast client

To configure the system to receive Network Time Protocol (NTP) multicast packets on a specified
interface, use the ntp multicast client interface configuration command. To disable this capability, use
the no form of this command.
ntp multicast client [ip-address]
no ntp

Syntax Description

ip-address

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release

Modification

12.1

This command was introduced.

Usage Guidelines

(Optional) IP address of the multicast group. Default address is 224.0.1.1.

Use this command to allow the system to listen to multicast packets on an interface-by-interface basis.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp multicast client command and you now want to remove
not only the multicast client capability, but all NTP functions from the device, use the no ntp command
without any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Examples

In the following example, the system is configured to receive (listen to) NTP multicast packets on
Ethernet interface 1:
Router(config)# interface ethernet 1
Router(config-if)# ntp multicast client

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Cisco IOS Configuration Fundamentals Command Reference

FR-424

78-11740-02

Basic System Management Commands

ntp multicast client

Related Commands

Command

Description

ntp multicast

Configures the specified interface to send NTP multicast packets.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-425

Basic System Management Commands

ntp multicast

ntp multicast
To configure a system to send Network Time Protocol (NTP) multicast packets on a specified interface,
use the ntp multicast interface configuration command. To disable this capability, use the no form of
this command.
ntp multicast [ip-address] [key key-id] [ttl value] [version number]
no ntp

Syntax Description

ip-address

(Optional) IP address of the multicast group. Default address is 224.0.1.1.

key

(Optional) Defines a multicast authentication key.

key-id

(Optional) Authentication key number in the range from 1 to 4294967295.

ttl

(Optional) Defines the time-to-live (TTL) value of a multicast NTP packet.

value

(Optional) TTL value in the range from 1 to 255. Default TTL value is 16.

version

(Optional) Defines the NTP version number.

number

(Optional) NTP version number in the range from 1 to 3. Default version

number is 3.

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release

Modification

12.1

This command was introduced.

Usage Guidelines

The TTL value is used to limit the scope of an audience for multicast routing.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp multicast command and you now want to remove not only
the multicast capability, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Cisco IOS Configuration Fundamentals Command Reference

FR-426

78-11740-02

Basic System Management Commands

ntp multicast

Examples

The following example shows how to configure Ethernet interface 0 to send NTP version 2 broadcasts:
Router(config)# interface ethernet 0
Router(config-if)# ntp multicast version 2

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp authentication-key

Defines an authentication key for NTP.

ntp multicast client

Allows the system to receive NTP multicast packets on an interface.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-427

Basic System Management Commands

ntp peer

ntp peer
To configure the software clock to synchronize a peer or to be synchronized by a peer, use the ntp peer
command in global configuration mode. To disable this capability, use the no form of this command.
ntp peer ip-address [normal-sync] [version number] [key key-id] [source interface] [prefer]
no ntp

Syntax Description

ip-address

IP address of the peer providing, or being provided, the clock synchronization.

normal-sync

(Optional) Disables the rapid synchronization at startup.

version

(Optional) Defines the Network Time Protocol (NTP) version number.

number

(Optional) NTP version number (1 to 3).

key

(Optional) Defines the authentication key.

keyid

(Optional) Authentication key to use when sending packets to this peer.

source

(Optional) Names the interface.

interface

(Optional) Name of the interface from which to pick the IP source address.

prefer

(Optional) Makes this peer the preferred peer that provides synchronization.

Command Default

No peers are configured.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

12.3(14)T

The normal-sync keyword was added.

Usage Guidelines

When a peer is configured, the default NTP version number is 3, no authentication key is used, and the
source IP address is taken from the outgoing interface.
Use this command to allow a device to synchronize with a peer, or vice versa. Using the prefer keyword
reduces switching between peers.

Tip

If you are using the default version of 3 and NTP synchronization does not occur, try using NTP
version 2 (NTPv2).
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.

Cisco IOS Configuration Fundamentals Command Reference

FR-428

78-11740-02

Basic System Management Commands

ntp peer

In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp peer command and you now want to remove not only the
peer, but all NTP functions from the device, use the no ntp command without any keywords. This
ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configure a router to allow its software clock to be synchronized
with the clock of the peer (or vice versa) at IP address 192.168.22.33 using NTP version 2. The source
IP address is the address of Ethernet 0.
Router(config)# ntp peer 192.168.22.33 version 2 source ethernet 0

The following example shows how to disable rapid synchronization at startup:

Router(config)# ntp peer 192.168.22.33 normal-sync

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp authentication-key

Defines an authentication key for NTP.

ntp server

Allows the software clock to be synchronized by a time server.

ntp source

Uses a particular source address in NTP packets.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-429

Basic System Management Commands

ntp refclock

ntp refclock
To configure an external clock source for use with Network Time Protocol (NTP) services, use the ntp
refclock command in line configuration mode. To disable support of the external time source, use the
no form of this command.
ntp refclock {trimble | telecom-solutions} pps {cts | ri | none} [inverted] [pps-offset number]
[stratum number] [timestamp-offset number]
no ntp

Syntax Description

trimble

Enables the reference clock driver for the Trimble Palisade NTP
Synchronization Kit (Cisco 7200 series routers only).

telecom-solutions

Enables the reference clock driver for a Telecom Solutions GPS device.

pps

Pulse per second (PPS) signal line. Indicate PPS pulse reference clock
support. Choices are cts, ri, or none.

cts

Pulse per second on CTS.

ri

Pulse per second on RI.

none

No PPS signal available.

inverted

(Optional) PPS signal is inverted.

pps-offset number

(Optional) Offset of PPS pulse. The number is the offset (in milliseconds).

stratum number

(Optional) Number from 0 to 14. Indicates the NTP stratum number that the
system will claim.

timestamp-offset
number

(Optional) Offset of time stamp. The number is the offset (in milliseconds).

Defaults

This command is disabled by default.

Command Modes

Line configuration

Command History

Release

Modification

12.1

The trimble keyword was added to provide driver activation for a Trimble
GPS time source on the Cisco 7200 series router.

Usage Guidelines

To configure a PPS signal as the source for NTP synchronization, use the following form of the ntp
refclock command:
ntp refclock pps {cts | ri} [inverted] [pps-offset number] [stratum number] [timestamp-offset
number]
To configure a Trimble Palisade NTP Synchronization Kit as the GPS clock source connected to the
auxiliary port of a Cisco 7200 router, use the following form of the ntp refclock command:
ntp refclock trimble pps none [stratum number]

Cisco IOS Configuration Fundamentals Command Reference

FR-430

78-11740-02

Basic System Management Commands

ntp refclock

To configure a Telecom Solutions product as the GPS clock source, use the ntp refclock
telecom-solutions form of the command:
ntp refclock telecom-solutions pps cts [stratum number]
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp refclock command and you now want to remove not only
the external clock source, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows configuration of a Trimble Palisade GPS time source on a Cisco 7200
router:
Router(config)# ntp master
Router(config)# ntp update-calendar
Router(config)# line aux 0
Router(config-line)# ntp refclock trimble pps none

The following example shows configuration of a Telecom Solutions GPS time source on a Catalyst
switch platform:
Router(config)# ntp master
Router(config)# ntp update-calendar
Router(config)# line aux 0
Router(config-line)# ntp refclock telecom-solutions pps cts stratum 1

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

show ntp associations

Displays the status of NTP associations configured for your system.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-431

Basic System Management Commands

ntp server

ntp server
To allow the software clock to be synchronized by a Network Time Protocol (NTP) time server, use the
ntp server command in global configuration mode. To disable this capability, use the no form of this
command.
ntp server ip-address | hostname [version number] [key key-id] [source interface] [prefer]
no ntp

Syntax Description

ip-address

IP address of the time server providing the clock synchronization.

hostname

Name of the time server providing the clock synchronization.

version

(Optional) Defines the NTP version number.

number

(Optional) NTP version number (1 to 3).

key

(Optional) Defines the authentication key.

key-id

(Optional) Authentication key to use when sending packets to this peer.

source

(Optional) Identifies the interface from which to pick the IP source address.

interface

(Optional) Name of the interface from which to pick the IP source address.

prefer

(Optional) Specifies that the server referenced in this command is preferred over other
configured NTP servers.

Defaults

No peers are configured by default. If a peer is configured, the default NTP version number is 3, no
authentication key is used, and the source IP address is taken from the outgoing interface.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use this command if you want to allow the system to synchronize with the specified server. The server
will not synchronize to this machine.
When you use the hostname option, the router does a domain name server (DNS) lookup on that name,
and stores the IP address in the configuration. For example, if you enter the command ntp server host1
and then check the running configuration, the output shows ntp server 172.16.0.4, assuming that the
router is correctly configured as a DNS client.
Use the prefer keyword if you use this command multiple times, and you want to set a preferred server.
Using the prefer keyword reduces switching between servers.
If you are using the default version of 3 and NTP synchronization does not occur, try NTP version 2.
Some NTP servers on the Internet run version 2.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.

Cisco IOS Configuration Fundamentals Command Reference

FR-432

78-11740-02

Basic System Management Commands

ntp server

In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp server command and you now want to remove not only
the server synchronization capability, but all NTP functions from the device, use the no ntp command
without any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Examples

The following example shows how to configure a router to allow its software clock to be synchronized
with the clock by the device at IP address 172.16.22.44 using NTP version 2:
Router(config)# ntp server 172.16.22.44 version 2

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp authentication-key

Defines an authentication key for NTP.

ntp peer

Configures the software clock to synchronize a peer or to be synchronized

by a peer.

ntp source

Uses a particular source address in NTP packets.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-433

Basic System Management Commands

ntp source

ntp source
To use a particular source address in Network Time Protocol (NTP) packets, use the ntp source
command in global configuration mode. To remove the specified source address, use the no form of this
command.
ntp source type number
no ntp

Syntax Description

type

Type of interface.

number

Number of the interface.

Defaults

Source address is determined by the outgoing interface.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Use this command when you want to use a particular source IP address for all NTP packets. The address
is taken from the named interface. This command is useful if the address on an interface cannot be used
as the destination for reply packets. If the source keyword is present on an ntp server or ntp peer global
configuration command, that value overrides the global value set by this command.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp source command and you now want to remove not only
the configured source address, but all NTP functions from the device, use the no ntp command without
any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Examples

The following example shows how to configure a router to use the IP address of Ethernet 0 as the source
address of all outgoing NTP packets:
Router(config)# ntp source ethernet 0

Cisco IOS Configuration Fundamentals Command Reference

FR-434

78-11740-02

Basic System Management Commands

ntp source

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp peer

Configures the software clock to synchronize a peer or to be synchronized

by a peer.

ntp server

Allows the software clock to be synchronized by a time server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-435

Basic System Management Commands

ntp trusted-key

ntp trusted-key
To authenticate the identity of a system to which Network Time Protocol (NTP) will synchronize, use
the ntp trusted-key command in global configuration mode. To disable authentication of the identity of
the system, use the no form of this command.
ntp trusted-key key-number
no ntp

Syntax Description

key-number

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Key number of authentication key to be trusted.

If authentication is enabled, use this command to define one or more key numbers (corresponding to the
keys defined with the ntp authentication-key command) that a peer NTP system must provide in its
NTP packets, in order for this system to synchronize to it. This function provides protection against
accidentally synchronizing the system to a system that is not trusted, because the other system must
know the correct authentication key.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.
For example, if you previously issued the ntp trusted-key command and you now want to remove not
only the authentication, but all NTP functions from the device, use the no ntp command without any
keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.

Examples

The following example shows how to configure the system to synchronize only to systems providing
authentication key 42 in its NTP packets:
Router(config)# ntp authenticate
Router(config)# ntp authentication-key 42 md5 aNiceKey
Router(config)# ntp trusted-key 42

Cisco IOS Configuration Fundamentals Command Reference

FR-436

78-11740-02

Basic System Management Commands

ntp trusted-key

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

ntp authenticate

Enables NTP authentication.

ntp authentication-key

Defines an authentication key for NTP.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-437

Basic System Management Commands

ntp update-calendar

ntp update-calendar
To periodically update the hardware clock (calendar) from a Network Time Protocol (NTP) time source,
use the ntp update-calendar command in global configuration mode. To disable the periodic updates,
use the no form of this command.
ntp update-calendar
no ntp

Syntax Description

This command has no arguments or keywords.

Defaults

The hardware clock (calendar) is not updated.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a battery-powered hardware clock, referred to in the command-line interface (CLI)
as the calendar, in addition to the software based system clock. The hardware clock runs continuously,
even if the router is powered off or rebooted.
If the software clock is synchronized to an outside time source via NTP, it is a good practice to
periodically update the hardware clock with the time learned from NTP. Otherwise, the hardware clock
will tend to gradually lose or gain time (drift), and the software clock and hardware clock may become
out of synchronization with each other. The ntp update-calendar command will enable the hardware
clock to be periodically updated with the time specified by the NTP source. The hardware clock will be
updated only if NTP has synchronized to an authoritative time server.
Many lower-end routers (for example, the Cisco 2500 series or the Cisco 2600 series) do not have
hardware clocks, so this command is not available on those platforms.
To force a single update of the hardware clock from the software clock, use the clock update-calendar
EXEC command.
When you configure NTP, you must include at least one of the available keywords; the NTP service is
activated and the keyword takes effect.
In the no form of ntp commands, all the keywords are optional. When you enter the no ntp command
followed by one or more of its keywords, only the functions activated by those keywords are removed
from the NTP service. The NTP service itself remains active, along with all functions you have not
specified in the no ntp command.
To terminate NTP service on a device, you must enter the no ntp command without keywords.

Cisco IOS Configuration Fundamentals Command Reference

FR-438

78-11740-02

Basic System Management Commands

ntp update-calendar

For example, if you previously issued the ntp update-calendar command and you now want to disable
not only the periodic updates, but all NTP functions running on the device, use the no ntp command
without any keywords. This ensures that all NTP functions are removed and that the NTP service is also
terminated.

Examples

The following example shows how to configure the system to periodically update the hardware clock
from the NTP time source:
Router(config)# ntp update-calendar

The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp

Related Commands

Command

Description

clock read-calendar

Performs a one-time update of the software clock from the hardware clock
(calendar).

clock update-calendar

Performs a one-time update of the hardware clock (calendar) from the

software clock.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-439

Basic System Management Commands

periodic

periodic
To specify a recurring (weekly) time range for functions that support the time-range feature, use the
periodic time-range configuration command. 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 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:

dailyMonday through Sunday

weekdaysMonday through Friday

weekendSaturday and Sunday

If the ending days of the week are the same as the starting days of the week, they
can be omitted.
hh:mm

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.

to

Entry of the to keyword is required to complete the range from start-time to

end-time.

Defaults

No recurring time range is defined.

Command Modes

Time-range configuration

Command History

Release

Modification

12.0(1)T

This command was introduced.

Usage Guidelines

For Cisco IOS Release 12.2, 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
Release 12.2 Cisco IOS IP Configuration Guide and the Release 12.2 Cisco IOS AppleTalk and Novell
IPX Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

FR-440

78-11740-02

Basic System Management Commands

periodic

The periodic command 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 periodic entries
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).
Table 47 lists some typical settings for your convenience:
Table 47

Typical Examples of periodic Command Syntax

If you want:

Configure this:

Monday through Friday, 8:00 a.m. to 6:00 p.m.

only

periodic weekday 8:00 to 18:00

Every day of the week, from 8:00 a.m. to 6:00 p.m. periodic daily 8:00 to 18:00
only

Examples

Every minute from Monday 8:00 a.m. to Friday

8:00 p.m.

periodic monday 8:00 to friday 20:00

All weekend, from Saturday morning through

Sunday night

periodic weekend 00:00 to 23:59

Saturdays and Sundays, from noon to midnight

periodic weekend 12:00 to 23:59

The following example denies HTTP traffic on Monday through Friday from 8:00 a.m. to 6:00 p.m.:
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 permits Telnet traffic on Mondays, Tuesdays, and Fridays from 9:00 a.m. to
5:00 p.m.:
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-441

Basic System Management Commands

periodic

Related Commands

Command

Description

absolute

Specifies an absolute start and end time for a time range.

access-list (extended)

Defines an extended IP access list.

deny (IP)

Sets conditions under which a packet does not pass a named IP access list.

permit (IP)

Sets conditions under which a packet passes a named IP access list.

time-range

Enables time-range configuration mode and names a time range definition.

Cisco IOS Configuration Fundamentals Command Reference

FR-442

78-11740-02

Basic System Management Commands

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-time command 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

Defaults

Default maximum process time is 200 milliseconds.

Command Modes

Global configuration

Command History

Release

Modification

12.1

This command was introduced.

Usage Guidelines

Maximum duration (in milliseconds) that a process can run before

suspension. The range is from 20-200 milliseconds.

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 time to 100 milliseconds that a process can run without suspending:
process-max-time 100

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-443

Basic System Management Commands

prompt

prompt
To customize the CLI prompt, use the prompt global configuration command. To revert to the default
prompt, use the no form of this command.
prompt string
no prompt [string]

Syntax Description

string

Defaults

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

Modification

10.3

This command was introduced.

Usage Guidelines

Text that will be diplayed on screen as the CLI prompt, including any
desired prompt variables.

You can include customized variables when specifying the prompt. All prompt variables are preceded by
a percent sign (%). Table 48 lists the availble prompt variables.
Table 48

Custom Prompt Variables

Prompt Variable

Interpretation

%h

Host name. This is either Router or the name defined with the
hostname global configuration command.

%n

Physical terminal line (tty) number of the EXEC user.

%p

Prompt character itself. It is either an angle bracket (>) for

user EXEC mode or a pound sign (#) for privileged EXEC
mode.

%s

Space.

%t

Tab.

%%

Percent sign (%)

Issuing the prompt %h command has the same effect as issuing the no prompt command.

Cisco IOS Configuration Fundamentals Command Reference

FR-444

78-11740-02

Basic System Management Commands

prompt

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

Description

hostname

Specifies or modifies the host name for the network server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-445

Basic System Management Commands

scheduler allocate

scheduler allocate
To guarantee CPU time for processes, use the scheduler allocate global configuration command on the
Cisco 7200 series and Cisco 7500 series routers. To restore the default, use the no form of this command.
scheduler allocate interrupt-time process-time
no scheduler allocate

Syntax Description

interrupt-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.
process-time

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.

Defaults

Approximately 5 percent of the CPU is available for process tasks.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Note

Examples

This command applies to the Cisco 7200 series and Cisco 7500 series routers.

Changing settings associated with CPU processes can negatively impact system performance.

The following example makes 20 percent of the CPU available for process tasks:
Router(config)# scheduler allocate 2000 500

Related Commands

Command

Description

scheduler interval

Controls the maximum amount of time that can elapse without running
system processes.

Cisco IOS Configuration Fundamentals Command Reference

FR-446

78-11740-02

Basic System Management Commands

scheduler interval

scheduler interval
To control the maximum amount of time that can elapse without running system processes, use the
scheduler interval global configuration command. To restore the default, use the no form of this
command.
scheduler interval milliseconds
no scheduler interval

Syntax Description

milliseconds

Defaults

High-priority operations are allowed to use as much of the CPU as needed.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Note

Integer that specifies the interval (in milliseconds). The minimum interval that you
can specify is 500 milliseconds; there is no maximum value.

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.

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

Related Commands

Command

Description

scheduler allocate

Guarantees CPU time for processes.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-447

Basic System Management Commands

service decimal-tty

service decimal-tty
To specify that line numbers be displayed and interpreted as decimal numbers rather than octal numbers,
use the service decimal-tty global configuration command. To display octal numbers, use the no form
of this command.
service decimal-tty
no service decimal-tty

Syntax Description

This command has no arguments or keywords.

Defaults

Decimal numbers are displayed.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following example displays decimal rather than octal line numbers:
Router(config)# service decimal-tty

Cisco IOS Configuration Fundamentals Command Reference

FR-448

78-11740-02

Basic System Management Commands

service exec-wait

service exec-wait
To delay the startup of the EXEC on noisy lines, use the service exec-wait global configuration
command. 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.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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

78-11740-02

FR-449

Basic System Management Commands

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 in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-450

78-11740-02

Basic System Management Commands

service hide-telnet-address

service hide-telnet-address
To hide addresses while trying to establish a Telnet session, use the service hide-telnet-address global
configuration command. To remove this service, use the no form of this command.
service hide-telnet-address
no service hide-telnet-address

Syntax Description

This command has no arguments or keywords.

Defaults

Addresses are displayed.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

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

Related Commands

Command

Description

busy-message

Creates a host failed message that is displayed when a connection fails.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-451

Basic System Management Commands

service nagle

service nagle
To enable the Nagle congestion control algorithm, use the service nagle global configuration command.
To 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.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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 TCP-based 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

FR-452

78-11740-02

Basic System Management Commands

service prompt config

service prompt config

To display the configuration prompt (config), use the service prompt config global configuration
command. 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.

Defaults

The configuration prompts appear in all configuration modes.

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

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.
Router(config)# no service prompt config
hostname newname
end
newname# configure terminal
Enter configuration commands, one per line.
service prompt config
newname(config)# hostname Router
Router(config)# end
Router#

Related Commands

End with CNTL/Z.

End with CNTL/Z.

Command

Description

hostname

Specifies or modifies the host name for the network server.

prompt

Customizes the prompt.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-453

Basic System Management Commands

service tcp-small-servers

service tcp-small-servers
To access minor TCP/IP services available from hosts on the network, use the service tcp-small-servers
command in global configuration mode. To disable these services, use the no form of the command.
service tcp-small-servers
no service tcp-small-servers

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

By default, the TCP servers for Echo, Discard, Chargen, and Daytime services are disabled.
When the minor TCP/IP servers are disabled, access to the Echo, Discard, Chargen, and Daytime ports
cause the Cisco IOS software to send a TCP RESET packet to the sender and discard the original
incoming packet.

Examples

The following example enables minor TCP/ IP services available from the network:
Router(config)# service tcp-small-servers

Cisco IOS Configuration Fundamentals Command Reference

FR-454

78-11740-02

Basic System Management Commands

service telnet-zero-idle

service telnet-zero-idle
To set the TCP window to zero (0) when the Telnet connection is idle, use the service telnet-zero-idle
global configuration command. To disable this service, use the no form of this command.
service telnet-zero-idle
no service telnet-zero-idle

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

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 EXEC is sitting in command 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 sets the TCP window to zero when the Telnet connection is idle:
Router(config)# service telnet-zero-idle

Related Commands

Command

Description

resume

Switches to another open Telnet, rlogin, LAT, or PAD session.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-455

Basic System Management Commands

service udp-small-servers

service udp-small-servers
To access minor User Datagram Protocol (UDP) services available from hosts on the network, use the
service udp-small-servers global configuration command. To disable these services, use the no form of
this command.
service udp-small-servers
no service udp-small-servers

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

By default the UPD servers for Echo, Discard, and Chargen services are disabled.
When the servers are disabled, access to Echo, Discard, and Chargen ports causes the Cisco IOS software
to send an ICMP port unreachable message to the sender and discard the original incoming packet.

Examples

In the following example minor UDP services are enabled on the router:
Router(config)# service udp-small-servers

Cisco IOS Configuration Fundamentals Command Reference

FR-456

78-11740-02

Basic System Management Commands

show aliases

show aliases
To display all alias commands, or the alias commands in a specified mode, use the show aliases EXEC
command.
show aliases [mode]

Syntax Description

mode

Command Modes

EXEC

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

(Optional) Command mode.

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. For a list of command modes, refer to the Cisco IOS Command Modes appendix in the
Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Examples

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
lo
p
r
s
w

Related Commands

help
logout
ping
resume
show
where

Command

Description

alias

Creates a command alias.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-457

Basic System Management Commands

show buffers

show buffers
To display statistics for the buffer pools on the network server, use the show buffers EXEC command.
show buffers [address hex-addr |[all | assigned | failures | free | old [dump | header | packet]]
| input-interface interface-type identifier | pool pool-name]

Syntax Description

address

(Optional) Displays buffers at a specified address.

hex-addr

Address (in hexadecimal notation) of the buffer to display.

all

(Optional) Displays all buffers.

assigned

(Optional) Displays the buffers in use.

failures

(Optional) Displays buffer allocation failures.

free

(Optional) Displays the buffers available for use.

old

(Optional) Displays buffers older than one minute.

dump

(Optional) Displays the buffer header and all data in the display.

header

(Optional) Displays the buffer header only in the display.

packet

(Optional) Displays the buffer header and packet data in the display.

input-interface

(Optional) Displays interface pool information. If the specified interface-type

argument has its own buffer pool, displays information for that pool.

interface-type

Value of interface-type can be ethernet, fastethernet, loopback, serial, or null.

identifier

Identifier of the interface specified in interface-type argument.

pool

(Optional) Displays buffers in a specified buffer pool.

pool-name

Specifies the name of a buffer pool to use.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The peak field in the output of the show buffers command shows the maximum number of buffers
created (highest total) and the time when that peak occurred relative to when you issued the show
buffers command. Formats include weeks, days, hours, minutes, and seconds. Not all systems report a
peak value, which means this field may not display in output.

Examples

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

Cisco IOS Configuration Fundamentals Command Reference

FR-458

78-11740-02

Basic System Management Commands

show buffers

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)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-459

Basic System Management Commands

show buffers

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):
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

Table 49 describes significant fields shown in the display.

Table 49

show buffers Field Descriptions

Field

Description

Buffer elements

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.

free list

Total number of the currently unallocated buffer elements.

max allowed

Maximum number of buffers that are available for allocation.

hits

Count of successful attempts to allocate a buffer when needed.

misses

Count of buffer allocation attempts that resulted in growing the buffer pool to
allocate a buffer.

created

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

Buffers that are 104 bytes long.

Middle buffers

Buffers that are 600 bytes long.

Big buffers

Buffers that are 1524 bytes long.

VeryBig buffers

Buffers that are 4520 bytes long.

Large buffers

Buffers that are 5024 bytes long.

Huge buffers

Buffers that are 18024 bytes long.

total

Total number of this type of buffer.

permanent

Number of these buffers that are permanent.

peak

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.

free list

Number of available or unallocated buffers in that pool.

Cisco IOS Configuration Fundamentals Command Reference

FR-460

78-11740-02

Basic System Management Commands

show buffers

Table 49

show buffers Field Descriptions (continued)

Field

Description

min

Minimum number of free or unallocated buffers in the buffer pool.

max allowed

Maximum number of free or unallocated buffers in the buffer pool.

hits

Count of successful attempts to allocate a buffer when needed.

misses

Count of buffer allocation attempts that resulted in growing the buffer pool in
order to allocate a buffer.

trims

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.

created

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.

Interface buffer pools:

total

Total number of this type of buffer.

permanent

Number of these buffers that are permanent.

free list

Number of available or unallocated buffers in that pool.

min

Minimum number of free or unallocated buffers in the buffer pool.

max allowed

Maximum number of free or unallocated buffers in the buffer pool.

hits

Count of successful attempts to allocate a buffer when needed.

fallbacks

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.

max cache size

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.

failures

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.

no memory

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 Configuration Fundamentals Command Reference

78-11740-02

FR-461

Basic System Management Commands

show calendar

show calendar
To display the current time and date setting for the hardware clock, use the show calendar EXEC
command:
show calendar

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Some platforms have a hardware clock (calendar) which is separate from the software clock. The
hardware clock is battery operated, and runs continuously, even if the router is powered off or rebooted.
You can compare the time and date shown with this command with the time and date listed via the show
clock EXEC command to verify that the hardware clock and software clock are synchronized with each
other. The time displayed is relative to the configured time zone.

Examples

In the following sample display, the hardware clock indicates the time stamp of 12:13:44 p.m. on Friday,
July 19, 1996:
Router> show calendar
12:13:44 PST Fri Jul 19 1996

Related Commands

Command

Description

show clock

Displays the time and date from the system software clock.

Cisco IOS Configuration Fundamentals Command Reference

FR-462

78-11740-02

Basic System Management Commands

show clock

show clock
To display the time and date from the system software clock, use the show clock EXEC command.
show clock [detail]

Syntax Description

detail

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

(Optional) Indicates the clock source (NTP, VINES, hardware clock, and so on)
and the current summer-time setting (if any).

The software clock keeps an authoritative flag that indicates whether the time is authoritative (believed
to be accurate). If the software clock has been set by a timing source (for example, via NTP), the flag is
set. If the time is not authoritative, it will be used only for display purposes. Until the clock is
authoritative and the authoritative flag is set, the flag prevents peers from synchronizing to the
software clock.
The symbol that precedes the show clock display indicates the following:

Note

Examples

Symbol

Description

Time is not authoritative.

(blank)

Time is authoritative.

Time is authoritative, but NTP is not synchronized.

In general, NTP synchronization takes approximately 15 to 20 minutes.

The following sample output shows that the current clock is authoritative and that the time source is
NTP:
Router> show clock detail
15:29:03.158 PST Mon Mar 3 1999
Time source is NTP

The following example shows the current clock is authoritative, but NTP is not yet synchronized:
Router> show clock
.16:42:35.597 UTC Wed Nov 1 1999

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-463

Basic System Management Commands

show clock

Related Commands

Command

Description

clock set

Manually sets the software clock.

show calendar

Displays the current time and date setting of the system hardware clock.

Cisco IOS Configuration Fundamentals Command Reference

FR-464

78-11740-02

Basic System Management Commands

show idb

show idb
To display information about the status of interface descriptor blocks (IDBs), use the show idb command
in privileged EXEC mode.
show idb

Syntax Description

This command has nor arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1

This command was introduced.

12.2(15)T

The output of this command was changed to show additional information.

Examples

The following is sample output from the show idb command:

Router# show idb
Maximum number of Software IDBs 8192.
HWIDBs
5
10
15
5784
86760

Active
Inactive
Total IDBs
Size each (bytes)
Total bytes
HWIDB#1
HWIDB#2
HWIDB#3
HWIDB#4
HWIDB#5

1
2
3
4
13

2
3
4
5
1

In use 17.

SWIDBs
14
3
17
2576
43792

GigabitEthernet0/0 0 5, HW
GigabitEthernet9/0 0 5, HW
GigabitEthernet9/1 6 5, HW
GigabitEthernet9/2 6 5, HW
Ethernet0 4 5, HW IFINDEX,

IFINDEX,
IFINDEX,
IFINDEX,
IFINDEX,
Ether)

Ether)
Ether)
Ether)
Ether)

Table 50 describes the significant fields shown in the display.

Table 50

show idb Field Descriptions

Field

Description

In use

Total number of software IDBs (SWIDBs) that have been allocated. This number never
decreases. SWIDBs are never deallocated.

Active

Total number of hardware IDBs (HWIDBs) and SWIDBs that are allocated and in use.

Inactive

Total number of HWIDBs and SWIDBs that are allocated but not in use.

Total

Total number of HWIDBs and SWIDBs that are allocated.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-465

Basic System Management Commands

show ntp associations

show ntp associations

To show the status of Network Time Protocol (NTP) associations, use the show ntp associations EXEC
command.
show ntp associations [detail]

Syntax Description

detail

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

(Optional) Displays detailed information about each NTP association.

Detailed descriptions of the information displayed by this command can be found in the NTP
specification (RFC 1305).
The following is sample output from the show ntp associations command:
Router> show ntp associations
address
~172.31.32.2
+~192.168.13.33
*~192.168.13.57
* master (synced),

ref clock
st when poll reach delay offset
disp
172.31.32.1
5
29 1024 377
4.2
-8.59
1.6
192.168.1.111
3
69
128 377
4.1
3.48
2.3
192.168.1.111
3
32
128 377
7.9
11.18
3.6
# master (unsynced), + selected, - candidate, ~ configured

Table 51 describes the significant fields shown in the display.

Table 51

show ntp associations Field Descriptions

Field

Description

(leading characters in display

lines)

The first characters in a display line can be one or more of the

following characters:
* Synchronized to this peer
# Almost synchronized to this peer
+ Peer selected for possible synchronization
- Peer is a candidate for selection
~ Peer is statically configured

address

Address of peer.

ref clock

Address of reference clock of peer.

st

Stratum of peer.

when

Time since last NTP packet was received from peer.

poll

Polling interval (in seconds).

Cisco IOS Configuration Fundamentals Command Reference

FR-466

78-11740-02

Basic System Management Commands

show ntp associations

Table 51

show ntp associations Field Descriptions (continued)

Field

Description

reach

Peer reachability (bit string, in octal).

delay

Round-trip delay to peer (in milliseconds).

offset

Relative time of peer clock to local clock (in milliseconds).

disp

Dispersion

The following is sample output of the show ntp associations detail command:
Router> show ntp associations detail
172.31.32.2 configured, insane, invalid, stratum 5
ref ID 172.31.32.1, time AFE252C1.6DBDDFF2 (00:12:01.428 PDT Mon Jul 5 1993)
our mode active, peer mode active, our poll intvl 1024, peer poll intvl 64
root delay 137.77 msec, root disp 142.75, reach 376, sync dist 215.363
delay 4.23 msec, offset -8.587 msec, dispersion 1.62
precision 2**19, version 3
org time AFE252E2.3AC0E887 (00:12:34.229 PDT Mon Jul 5 1993)
rcv time AFE252E2.3D7E464D (00:12:34.240 PDT Mon Jul 5 1993)
xmt time AFE25301.6F83E753 (00:13:05.435 PDT Mon Jul 5 1993)
filtdelay =
4.23
4.14
2.41
5.95
2.37
2.33
4.26
4.33
filtoffset =
-8.59
-8.82
-9.91
-8.42 -10.51 -10.77 -10.13 -10.11
filterror =
0.50
1.48
2.46
3.43
4.41
5.39
6.36
7.34
192.168.13.33 configured, selected, sane, valid, stratum 3
ref ID 192.168.1.111, time AFE24F0E.14283000 (23:56:14.078 PDT Sun Jul 4 1993)
our mode client, peer mode server, our poll intvl 128, peer poll intvl 128
root delay 83.72 msec, root disp 217.77, reach 377, sync dist 264.633
delay 4.07 msec, offset 3.483 msec, dispersion 2.33
precision 2**6, version 3
org time AFE252B9.713E9000 (00:11:53.442 PDT Mon Jul 5 1993)
rcv time AFE252B9.7124E14A (00:11:53.441 PDT Mon Jul 5 1993)
xmt time AFE252B9.6F625195 (00:11:53.435 PDT Mon Jul 5 1993)
filtdelay =
6.47
4.07
3.94
3.86
7.31
7.20
9.52
8.71
filtoffset =
3.63
3.48
3.06
2.82
4.51
4.57
4.28
4.59
filterror =
0.00
1.95
3.91
4.88
5.84
6.82
7.80
8.77
192.168.13.57 configured, our_master, sane, valid, stratum 3
ref ID 192.168.1.111, time AFE252DC.1F2B3000 (00:12:28.121 PDT Mon Jul 5 1993)
our mode client, peer mode server, our poll intvl 128, peer poll intvl 128
root delay 125.50 msec, root disp 115.80, reach 377, sync dist 186.157
delay 7.86 msec, offset 11.176 msec, dispersion 3.62
precision 2**6, version 2
org time AFE252DE.77C29000 (00:12:30.467 PDT Mon Jul 5 1993)
rcv time AFE252DE.7B2AE40B (00:12:30.481 PDT Mon Jul 5 1993)
xmt time AFE252DE.6E6D12E4 (00:12:30.431 PDT Mon Jul 5 1993)
filtdelay =
49.21
7.86
8.18
8.80
4.30
4.24
7.58
6.42
filtoffset =
11.30
11.18
11.13
11.28
8.91
9.09
9.27
9.57
filterror =
0.00
1.95
3.91
4.88
5.78
6.76
7.74
8.71

Table 52 describes the significant fields shown in the display.

Table 52

show ntp associations detail Field Descriptions

Field

Descriptions

configured

Peer was statically configured.

dynamic

Peer was dynamically discovered.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-467

Basic System Management Commands

show ntp associations

Table 52

Related Commands

show ntp associations detail Field Descriptions (continued)

Field

Descriptions

our_master

Local machine is synchronized to this peer.

selected

Peer is selected for possible synchronization.

candidate

Peer is a candidate for selection.

sane

Peer passes basic sanity checks.

insane

Peer fails basic sanity checks.

valid

Peer time is believed to be valid.

invalid

Peer time is believed to be invalid.

leap_add

Peer is signalling that a leap second will be added.

leap-sub

Peer is signalling that a leap second will be subtracted.

unsynced

Peer is not synchronized to any other machine.

ref ID

Address of machine peer is synchronized to.

time

Last time stamp peer received from its master.

our mode

Our mode relative to peer (active/passive/client/server/bdcast/bdcast

client).

peer mode

Peers mode relative to us.

our poll intvl

Our poll interval to peer.

peer poll intvl

Peers poll interval to us.

root delay

Delay along path to root (ultimate stratum 1 time source).

root disp

Dispersion of path to root.

reach

Peer reachability (bit string in octal).

sync dist

Peer synchronization distance.

delay

Round-trip delay to peer.

offset

Offset of peer clock relative to our clock.

dispersion

Dispersion of peer clock.

precision

Precision of peer clock in Hertz.

version

NTP version number that peer is using.

org time

Originate time stamp.

rcv time

Receive time stamp.

xmt time

Transmit time stamp.

filtdelay

Round-trip delay (in milliseconds) of each sample.

filtoffset

Clock offset (in milliseconds) of each sample.

filterror

Approximate error of each sample.

Command

Description

show ntp status

Displays the status of the NTP.

Cisco IOS Configuration Fundamentals Command Reference

FR-468

78-11740-02

Basic System Management Commands

show ntp status

show ntp status

To show the status of the Network Time Protocol (NTP), use the show ntp status EXEC command.
show ntp status

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following is sample output from the show ntp status command:
Router> show ntp status
Clock is synchronized, stratum 4, reference is 192.168.13.57
nominal freq is 250.0000 Hz, actual freq is 249.9990 Hz, precision is 2**19
reference time is AFE2525E.70597B34 (00:10:22.438 PDT Mon Jul 5 1993)
clock offset is 7.33 msec, root delay is 133.36 msec
root dispersion is 126.28 msec, peer dispersion is 5.98 msec

Table 53 describes the significant fields shown in the display.

Table 53

show ntp status Field Descriptions

Field

Description

synchronized

System is synchronized to an NTP peer.

unsynchronized

System is not synchronized to any NTP peer.

stratum

NTP stratum of this system.

reference

Address of peer the system is synchronized to.

nominal freq

Nominal frequency of system hardware clock.

actual freq

Measured frequency of system hardware clock.

precision

Precision of the clock of this system (in Hertz).

reference time

Reference time stamp.

clock offset

Offset of the system clock to synchronized peer.

root delay

Total delay along path to root clock.

root dispersion

Dispersion of root path.

peer dispersion

Dispersion of synchronized peer.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-469

Basic System Management Commands

show ntp status

Related Commands

Command

Description

show ntp associations Displays the status of the NTP associations.

Cisco IOS Configuration Fundamentals Command Reference

FR-470

78-11740-02

Basic System Management Commands

show registry

show registry
To show the function registry information, use the show registry EXEC command.
show registry [registry-name [registry-num]] [brief | statistics]

Syntax Description

registry-name

(Optional) Name of the registry to examine.

registry-num

(Optional) Number of the registry to examine.

brief

(Optional) Displays limited functions and services information.

statistics

(Optional) Displays function registry statistics.

Defaults

brief

Command Modes

EXEC

Command History

Release

Modification

11.1

This command was introduced.

Examples

The following example is sample output of the show registry command using the brief argument:
Switch> show registry atm 3/0/0 brief
Registry objects: 1799

bytes: 213412

-Registry 23: ATM Registry

Service 23/0:
Service 23/1:
Service 23/2:
Service 23/3:
Service 23/4:
Service 23/5:
Service 23/6:
Service 23/7:
Service 23/8:
Service 23/9:
Service 23/10:
Service 23/11:
Service 23/12:
Service 23/13:
Service 23/14:
-RegistrY 25: ATM routing Registry
Service 25/0:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-471

Basic System Management Commands

show sntp

show sntp
To show information about the Simple Network Time Protocol (SNTP), use the show sntp EXEC
command on a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, or Cisco 1750 router.
show sntp

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Examples

The following is sample output from the show sntp command:

Router> show sntp
SNTP server
171.69.118.9
172.21.28.34

Stratum
5
4

Version
3
3

Last Receive
00:01:02
00:00:36
Synced

Bcast

Broadcast client mode is enabled.

Table 54 describes the significant fields shown in the display.

Table 54

show sntp Field Descriptions

Field

Description

SNTP server

Address of the configured or broadcast NTP server.

Stratum

NTP stratum of the server. The stratum indicates how far away
from an authoritative time source the server is.

Version

NTP version of the server.

Last Receive

Time since the last NTP packet was received from the server.

Synced

Indicates the server chosen for synchronization.

Bcast

Indicates a broadcast server.

Cisco IOS Configuration Fundamentals Command Reference

FR-472

78-11740-02

Basic System Management Commands

show sntp

Related Commands

Command

Description

sntp broadcast client

Configures a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720,
or Cisco 1750 router to use SNTP to accept NTP traffic from any broadcast
server.

sntp server

Configures a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720,
or Cisco 1750 router to use SNTP to request and accept NTP traffic from a
time server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-473

Basic System Management Commands

sntp broadcast client

sntp broadcast client

To use the Simple Network Time Protocol (SNTP) to accept Network Time Protocol (NTP) traffic from
any broadcast server, use the sntp broadcast client global configuration command to configure a
Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, or Cisco 1750 router. To prevent the router
from accepting broadcast traffic, use the no form of this command.
sntp broadcast client
no sntp broadcast client

Syntax Description

This command has no arguments or keywords.

Defaults

The router does not accept SNTP traffic from broadcast servers.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

SNTP is a compact, client-only version of the NTP. SNMP can only receive the time from NTP servers;
it cannot be used to provide time services to other systems.
SNTP typically provides time within 100 milliseconds of the accurate time, but it does not provide the
complex filtering and statistical mechanisms of NTP. In addition, SNTP does not authenticate traffic,
although you can configure extended access lists to provide some protection.
You must configure the router with either this command or the sntp server global configuration
command to enable SNTP.

Examples

The following example enables the router to accept broadcast NTP packets and shows sample show sntp
command output:
Router(config)# sntp broadcast client
Router(config)# end
Router#
%SYS-5-CONFIG: Configured from console by console
Router# show sntp
SNTP server
172.21.28.34

Stratum
4

Version
3

Last Receive
00:00:36
Synced

Bcast

Broadcast client mode is enabled.

Cisco IOS Configuration Fundamentals Command Reference

FR-474

78-11740-02

Basic System Management Commands

sntp broadcast client

Related Commands

Command

Description

show sntp

Displays information about SNTP on a Cisco 1003, Cisco 1004, Cisco 1005,
Cisco 1600, Cisco 1720, or Cisco 1750 router.

sntp server

Configures a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720,
or Cisco 1750 router to use SNTP to request and accept NTP traffic from a
time server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-475

Basic System Management Commands

sntp server

sntp server
To configure a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, Cisco 1750, or Cisco 800
router to use the Simple Network Time Protocol (SNTP) to request and accept Network Time Protocol
(NTP) traffic from a stratum 1 time server, use the sntp server global configuration command. To
remove a server from the list of NTP servers, use the no form of this command.
sntp server {address | hostname} [version number]
no sntp server {address | hostname}

Syntax Description

address

IP address of the time server.

hostname

Host name of the time server.

version number

(Optional) Version of NTP to use. The default is 1.

Defaults

The router does not accept SNTP traffic from a time server.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

SNTP is a compact, client-only version of the NTP. SNMP can only receive the time from NTP servers;
it cannot be used to provide time services to other systems.
SNTP typically provides time within 100 milliseconds of the accurate time, but it does not provide the
complex filtering and statistical mechanisms of NTP. In addition, SNTP does not authenticate traffic,
although you can configure extended access lists to provide some protection.
Enter this command once for each NTP server.
You must configure the router with either this command or the sntp broadcast client global
configuration command in order to enable SNTP.
SNTP time servers should operate only at the root (stratum 1) of the subnet, and then only in configurations
where no other source of synchronization other than a reliable radio or modem time service is available. A
stratum 2 server cannot be used as an SNTP time server. The use of SNTP rather than NTP in primary servers
should be carefully considered.

Examples

The following example enables the router to request and accept NTP packets from the server at
172.21.118.9 and displays sample show sntp command output:
Router(config)# sntp server 172.21.118.9
Router(config)# end
Router#
%SYS-5-CONFIG: Configured from console by console

Cisco IOS Configuration Fundamentals Command Reference

FR-476

78-11740-02

Basic System Management Commands

sntp server

Router# show sntp

SNTP server
172.21.118.9

Related Commands

Stratum
5

Version
3

Last Receive
00:01:02
Synced

Command

Description

show sntp

Displays information about SNTP on a Cisco 1003, Cisco 1004, Cisco 1005,
Cisco 1600, Cisco 1720, or Cisco 1750 router.

sntp broadcast client

Configures a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720,
or Cisco 1750 router to use SNTP to accept NTP traffic from any broadcast
server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-477

Basic System Management Commands

time-range

time-range
To enable time-range configuration mode and define time ranges for functions (such as extended access
lists), use the time-range global configuration command. To remove the time limitation, use the no form
of this command.
time-range time-range-name
no time-range time-range-name

Syntax Description

time-range-name Desired name for the time range. The name cannot contain a space or quotation
mark, and must begin with a letter.

Defaults

None

Command Modes

Global configuration

Command History

Release

Modification

12.0(1)T

This command was introduced.

Usage Guidelines

Note

The time-range entries are identified by a name, which is referred to by one or more other configuration
commands. Multiple time ranges can occur in a single access list or other feature.

For Cisco IOS Release 12.2, 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, see the Release
12.2 Cisco IOS IP Configuration Guide and the Release 12.2 Cisco IOS AppleTalk and Novell IPX
Configuration Guide.
After the time-range command, use the periodic time-range configuration command, the absolute
time-range configuration command, or some combination of them to define when the feature is in effect.
Multiple periodic commands are allowed in a time range; only one absolute command is allowed.

Tip

Examples

To avoid confusion, use different names for time ranges and named access lists.

The following example denies HTTP traffic on Monday through Friday from 8:00 a.m. to 6:00 p.m. The
example allows UDP traffic on Saturday and Sunday from noon to midnight only.
time-range no-http
periodic weekdays 8:00 to 18:00
!
time-range udp-yes
periodic weekend 12:00 to 24:00

Cisco IOS Configuration Fundamentals Command Reference

FR-478

78-11740-02

Basic System Management Commands

time-range

!
ip access-list extended strict
deny tcp any any eq http time-range no-http
permit udp any any time-range udp-yes
!
interface ethernet 0
ip access-group strict in

Related Commands

Command

Description

absolute

Specifies an absolute start and end time for a time range.

ip access-list

Defines an IP access list by name.

periodic

Specifies a recurring (weekly) start and end time for a time range.

permit (IP)

Sets conditions under which a packet passes a named IP access list.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-479

Basic System Management Commands

time-range

Cisco IOS Configuration Fundamentals Command Reference

FR-480

78-11740-02

Troubleshooting and Fault Management

Commands
Cisco IOS Release 12.2

This chapter describes the commands used to troubleshoot a routing device. To troubleshoot, you need
to discover, isolate, and resolve the system problems. You can discover problems with the system
monitoring commands, isolate problems with the system test commands (including debug commands),
and resolve problems by reconfiguring your system with the suite of Cisco IOS software commands.
This chapter describes general fault management commands. For detailed troubleshooting procedures
and a variety of scenarios, see the Cisco IOS Internetwork Troubleshooting Guide publication. For
complete details on all debug commands, see the Cisco IOS Debug Command Reference.
For troubleshooting tasks and examples, refer to the Troubleshooting and Fault Management chapter
in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.
For documentation of commands in Cisco IOS Release 12.2T or 12.3 mainline, see the Cisco IOS
Configuration Fundamentals and Network Management Command Reference, Release 12.3.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-481

Troubleshooting and Fault Management Commands

attach

attach
To connect to a specific line card for the purpose of executing monitoring and maintenance commands
on that line card only, use the attach privileged EXEC command. To exit from the Cisco IOS software
image on the line card and return to the Cisco IOS image on the GRP card, use the exit command.
attach slot-number

Syntax Description

slot-number

Defaults

None

Command Modes

Privileged EXEC

CommandHistory

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series Gigabit Switch
Routers.

Usage Guidelines

Slot number of the line card you want to connect to. Slot numbers range from
0 to 11 for the Cisco 12012 router and 0 to 7 for the Cisco 12008 router. If the
slot number is omitted, you are prompted for the slot number.

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

Examples

Do not execute the config EXEC command from the Cisco IOS software image on the line card.

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!
LC-Slot9# show ?

Cisco IOS Configuration Fundamentals Command Reference

FR-482

78-11740-02

Troubleshooting and Fault Management Commands

attach

cef
clock
context
history
hosts
ipc
location
sessions
terminal
users
version

Cisco Express Forwarding

Display the system clock
Show context information about recent crash(s)
Display the session command history
IP domain-name, lookup style, nameservers, and host table
Interprocess communications commands
Display the system location
Information about Telnet connections
Display terminal configuration parameters
Display information about terminal lines
System hardware and software status

LC-Slot9# exit
Disconnecting from slot 9.
Connection Duration: 00:01:04
Router#

Note

Related
Commands

Because not all statistics are maintained on the line cards, the output from some of the show commands
might not be consistent.

Command

Description

attach shelf

Connects you to a specific (managed) shelf for the purpose of remotely

executing commands on that shelf only.

execute-on slot

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

simultaneously.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-483

Troubleshooting and Fault Management Commands

clear logging

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

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

CommandHistory

Release

Modification

11.2

This command was introduced.

Examples

In the following example, the logging buffer is cleared:

Router# clear logging
Clear logging buffer [confirm]
Router#

Related Commands

Command

Description

logging buffered

Logs messages to an internal buffer.

show logging

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

FR-484

78-11740-02

Troubleshooting and Fault Management Commands

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 privileged EXEC command. To disable field diagnostics on a line card, use the no
form of this command.
diag slot-number [halt | previous | post | verbose [wait] | wait]
no diag slot-number

Syntax Description

slot-number

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.

halt

(Optional) Stops the field diagnostic testing on the line card.

previous

(Optional) Displays previous test results (if any) for the line card.

post

(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.

verbose [wait]

(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.

wait

(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.

Defaults

No field diagnostics tests are performed on the line card.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series GSR.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-485

Troubleshooting and Fault Management Commands

diag

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 routers 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.

Examples

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

Cisco IOS Configuration Fundamentals Command Reference

FR-486

78-11740-02

Troubleshooting and Fault Management Commands

diag

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

78-11740-02

FR-487

Troubleshooting and Fault Management Commands

diag

Related Commands

Command

Description

microcode reload

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.

Cisco IOS Configuration Fundamentals Command Reference

FR-488

78-11740-02

Troubleshooting and Fault Management Commands

exception core-file

exception core-file
To specify the name of the core dump file, use the exception core-file global configuration command.
To return to the default core filename, use the no form of this command.
exception core-file file-name
no exception core-file

Syntax Description

file-name

Defaults

The core file is named hostname-core, where hostname is the name of the router.

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.2

This command was introduced.

Name of the core dump file saved on the server.

Usage Guidelines

Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core
file. If the routers memory is larger than 16 MB, the whole core file will not be copied to the server.
Therefore, use rcp or FTP to dump the core file.

Examples

In the following example, a user configures a router to use FTP to dump a core file named dumpfile to
the FTP server at 172.17.92.2 when it crashes:
ip ftp username red
ip ftp password blue
exception protocol ftp
exception dump 172.17.92.2
exception core-file dumpfile

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-489

Troubleshooting and Fault Management Commands

exception core-file

Related
Commands

Command

Description

exception dump

Causes the router to dump a core file to a particular server when the router
crashes.

exception memory

Causes the router to create a core dump and reboot when certain memory size
parameters are violated.

exception
spurious-interrupt

Causes the router to create a core dump and reload after a specified number
of spurious interrupts.

exception protocol

Configures the protocol used for core dumps.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-490

78-11740-02

Troubleshooting and Fault Management Commands

exception dump

exception dump
To configure the router to dump a core file to a particular server when the router crashes, use the
exception dump global configuration command. To disable core dumps, use the no form of this
command.
exception dump ip-address
no exception dump

Syntax Description

ip-address

Defaults

Disabled

Command Modes

Global configuration (config)

Command History

Release

Modification

10.3

This command was introduced.

IP address of the server that stores the core dump file.

Usage Guidelines
Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core
file. If the routers memory is larger than 16 MB, the whole core file will not be copied to the server.
Therefore, use rcp or FTP to dump the core file.
The core dump is written to a file named hostname-core on your server, where hostname is the name of
the router. You can change the name of the core file by configuring the exception core-file command.
This procedure can fail for certain types of system crashes. However, if successful, the core dump file
will be the size of the memory available on the processor (for example, 16 MB for a CSC/4).

Examples

In the following example, a user configures a router to use FTP to dump a core file to the FTP server at
172.17.92.2 when it crashes:
ip ftp username red
ip ftp password blue
exception protocol ftp
exception dump 172.17.92.2

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-491

Troubleshooting and Fault Management Commands

exception dump

Related Commands

Command

Description

exception core-file

Specifies the name of the core dump file.

exception memory

Causes the router to create a core dump and reboot when certain memory size
parameters are violated.

exception
spurious-interrupt

Causes the router to create a core dump and reload after a specified number
of spurious interrupts.

exception protocol

Configures the protocol used for core dumps.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

ip rcmd
remote-username

Configures the remote username to be used when requesting a remote copy

using rcp.

Cisco IOS Configuration Fundamentals Command Reference

FR-492

78-11740-02

Troubleshooting and Fault Management Commands

exception linecard

exception linecard
To enable storing of crash information for a line card and optionally specify the type and amount of
information stored, use the exception linecard global configuration command. To disable the storing of
crash information for the line card, use the no form of this command.
exception linecard {all | slot slot-number} [corefile filename | main-memory size [k | m] |
queue-ram size [k | m] | rx-buffer size [k | m] | sqe-register-rx | sqe-register-tx | tx-buffer
size [k | m]]
no exception linecard

Syntax Description

all

Stores crash information for all line cards.

slot slot- number

Stores crash information for the line card in the specified slot. Slot numbers
range from 0 to 11 for the Cisco 12012 and 0 to 7 for the Cisco 12008 router.

corefile filename

(Optional) Stores the crash information in the specified file in NVRAM. The
default filename is hostname-core-slot-number (for example, c12012-core-8).

main-memory size

(Optional) Stores the crash information for the main memory on the line card
and specifies the size of the crash information. Size of the memory to store is
0 to 268435456.

queue-ram size

(Optional) Stores the crash information for the queue RAM memory on the
line card and specifies the size of the crash information. Size of the memory
to store can be from 0 to 1048576.

rx-buffer size

(Optional) Stores the crash information for the receive and transmit buffer on
the line card and specifies the size of the crash information. Size of the
memory to store can be from 0 to 67108864.

tx-buffer size
sqe-register-rx
sqe-register-tx
k
m

Defaults

(Optional) Stores crash information for the receive or transmit silicon

queueing engine registers on the line card.
(Optional) The k option multiplies the specified size by 1K (1024), and the
m option multiplies the specified size by 1M (1024*1024).

No crash information is stored for the line card.

If enabled with no options, the default is to store 256 MB of main memory.

Command Modes

Global configuration (config)

Command History

Release

Modification

11.2 GS

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-493

Troubleshooting and Fault Management Commands

exception linecard

Usage Guidelines

This command is currently supported only on Cisco 12000 series Gigabit Switch Routers (GSRs).
Use the exception linecard global configuration command only when directed by a technical support
representative. Only enable options that the technical support representative requests you to enable.
Technical support representatives need to be able to look at the crash information from the line card to
troubleshoot serious problems on the line card. The crash information contains all the line card memory
information including the main memory and transmit and receive buffer information.

Caution

Examples

Use caution when enabling the exception linecard global configuration command. Enabling all options
could cause a large amount (150 to 250 MB) of crash information to be sent to the server.

In the following example, the user enables the storing of crash information for line card 8. By default,
256 MB of main memory is stored.
12000(config)# exception linecard slot 8

Cisco IOS Configuration Fundamentals Command Reference

FR-494

78-11740-02

Troubleshooting and Fault Management Commands

exception memory

exception memory
To cause the router to create a core dump and reboot when certain memory size parameters are violated,
use the exception memory global configuration command. To disable the rebooting and core dump, use
the no form of this command.
exception memory {fragment size | minimum size}
no exception memory {fragment | minimum}

Syntax Description

fragment size

The minimum contiguous block of memory in the free pool, in bytes.

minimum size

The minimum size of the free memory pool, in bytes.

Defaults

Disabled

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.3

This command was introduced.

Usage Guidelines
Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
This command is useful to troubleshoot memory leaks.
The size is checked every 60 seconds. If you enter a size that is greater than the free memory, a core
dump and router reload is generated after 60 seconds.
The exception dump command must be configured in order to generate a core dump file. If the
exception dump command is not configured, the router reloads without generating a core dump.

Examples

In the following example, the user configures the router to monitor the free memory. If the amount of
free memory falls below 250,000 bytes, the router will dump the core file and reload.
exception dump 131.108.92.2
exception core-file memory.overrun
exception memory minimum 250000

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-495

Troubleshooting and Fault Management Commands

exception memory

Related Commands

Command

Description

exception core-file

Specifies the name of the core dump file.

exception dump

Configures the router to dump a core file to a particular server when the
router crashes.

exception protocol

Configures the protocol used for core dumps.

exception region-size

Specifies the size of the region for the exception-time memory pool.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-496

78-11740-02

Troubleshooting and Fault Management Commands

exception protocol

exception protocol
To configure the protocol used for core dumps, use the exception protocol global configuration
command. To configure the router to use the default protocol, use the no form of this command.
exception protocol {ftp | rcp | tftp}
no exception protocol

Syntax Description

ftp

Uses File Transfer Protocol (FTP) for core dumps.

rcp

Uses remote copy protocol (rcp) for core dumps.

tftp

Uses TFTP for core dumps. This is the default.

Defaults

TFTP

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.3

This command was introduced.

Usage Guidelines
Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core
file. If the routers memory is larger than 16 MB, the whole core file will not be copied to the server.
Therefore, use rcp or FTP to dump the core file.

Examples

In the following example, the user configures a router to use FTP to dump a core file to the FTP server
at 172.17.92.2 when it crashes:
ip ftp username red
ip ftp password blue
exception protocol ftp
exception dump 172.17.92.2

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-497

Troubleshooting and Fault Management Commands

exception protocol

Related
Commands

Command

Description

exception core-file

Specifies the name of the core dump file.

exception dump

Causes the router to dump a core file to a particular server when the router
crashes.

exception memory

Causes the router to create a core dump and reboot when certain memory size
parameters are violated.

exception
spurious-interrupt

Causes the router to create a core dump and reload after a specified number
of spurious interrupts.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-498

78-11740-02

Troubleshooting and Fault Management Commands

exception region-size

exception region-size
To specify the size of the region for the exception-time memory pool, use the exception region-size global
configuration command. To use the default region size, use the no form of this command.
exception region-size size
no exception region-size

Syntax Description

size

Defaults

16,384 bytes

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.3

This command was introduced.

The size of the region for the exception-time memory pool.

Usage Guidelines
Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
The exception region-size command is used to define a small amount of memory to serve as a fallback
pool when the processor memory pool is marked corrupt. The exception memory command must be
used to allocate memory to perform a core dump.

Examples

In the following example, the region size is set at 1024:

Router# exception region-size 1024

Related
Commands

Command

Description

exception core-file

Specifies the name of the core dump file.

exception dump

Configures the router to dump a core file to a particular server when the
router crashes.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-499

Troubleshooting and Fault Management Commands

exception region-size

Command

Description

exception memory

Causes the router to create a core dump and reboot when certain memory size
parameters are violated.

exception protocol

Configures the protocol used for core dumps.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-500

78-11740-02

Troubleshooting and Fault Management Commands

exception spurious-interrupt

exception spurious-interrupt
To configure the router to create a core dump and reload after a specified number of spurious interrupts,
use the exception spurious-interrupt command global configuration command. To disable the core
dump and reload, use the no form of this command.
exception spurious-interrupt [number]
no exception spurious-interrupt

Syntax Description

number

Defaults

Disabled

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.3

This command was introduced.

(Optional) A number from 1 to 4294967295 that indicates the

maximum number of spurious interrupts to include in the core dump
before reloading.

Usage Guidelines
Caution

Use the exception commands only under the direction of a technical support representative. Creating a
core dump while the router is functioning in a network can disrupt network operation. The resulting
binary file, which is very large, must be transferred to a TFTP, File Transfer Protocol (FTP), or remote
copy protocol (rcp) server and subsequently interpreted by technical personnel that have access to source
code and detailed memory maps.
If you use TFTP to dump the core dump file to a server, the router will only dump the first 16 MB of the
file. If the routers memory is larger than 16 MB, the whole core file will not be copied to the server.
Therefore, use rcp or FTP to dump the core file.

Examples

In the following example, the user configures a router to create a core dump with a limit of two spurious
interrupts:
Router# exception spurious-interrupt 2

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-501

Troubleshooting and Fault Management Commands

exception spurious-interrupt

Related Commands

Command

Description

exception core-file

Specifies the name of the core dump file.

ip ftp password

Specifies the password to be used for FTP connections.

ip ftp username

Configures the user name for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-502

78-11740-02

Troubleshooting and Fault Management Commands

execute-on

execute-on
To execute commands on a line card, use the execute-on privileged EXEC command.
execute-on {slot slot-number | all | master} command

Syntax Description

slot slot-number

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

all

Executes the command on all line cards.

master

(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.

command

Cisco IOS command to remotely execute on the line card.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2 GS

This command was introduced to support Cisco 12000 series Gigabit Switch
Routers.

11.3(2)AA

Support for this command was added to the Cisco AS5800 universal access
server.

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-503

Troubleshooting and Fault Management Commands

execute-on

Timesaver

Though you can use the attach privileged EXEC command to execute commands on a specific line card,
using the execute-on slot command 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 all command allows you to perform the same command on all line cards
simultaneously.
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-on command 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.

Warning

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-support
command.
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.
The show tech-support command 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

Cisco IOS Configuration Fundamentals Command Reference

FR-504

78-11740-02

Troubleshooting and Fault Management Commands

execute-on

Examples

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
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#

Related Commands

Command

Description

attach

Connects you to a specific line card for the purpose of executing commands
using the Cisco IOS software image on that line card.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-505

Troubleshooting and Fault Management Commands

logging

logging
To log messages to a syslog server host, use the logging global configuration command. To delete the
syslog server with the specified address from the list of syslogs, use the no form of this command.
logging host-name
no logging host-name

Syntax Description

host-name

Defaults

No messages are logged to a syslog server host.

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.0

This command was introduced.

Name or IP address of the host to be used as a syslog server.

Usage Guidelines

This command identifies a syslog server host to receive logging messages. By issuing this command
more than once, you build a list of syslog servers that receive logging messages.

Examples

In the following example, messages are logged to a host named john:

logging john

Related
Commands

Command

Description

logging trap

Limits messages logged to the syslog servers based on severity and limits the
logging of system messages sent to syslog servers to only those messages at
the specified level.

Cisco IOS Configuration Fundamentals Command Reference

FR-506

78-11740-02

Troubleshooting and Fault Management Commands

logging buffered

logging buffered
To limit messages logged to an internal buffer based on severity, use the logging buffered global
configuration command. To cancel the use of the buffer, use the no form of this command. The default
form of this command returns the buffer size to the default size.
logging buffered [buffer-size | level]
no logging buffered
default logging buffered

Syntax Description

buffer-size

(Optional) Size of the buffer from 4096 to 4,294,967,295 bytes. The default size
varies by platform.

level

(Optional) Limits the logging of messages to the buffer to a specified level. You can
enter the level name or level number. See Table 55 for a list of the accepatable level
name or level number keywords.

Defaults

For most platforms, the Cisco IOS software logs messages to the internal buffer.

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

11.1(17)T

The command syntax was changed to include the level argument.

Usage Guidelines

This command copies logging messages to an internal buffer. The buffer is circular in nature, so newer
messages overwrite older messages after the buffer is filled.
Specifying a level causes messages at that level and numerically lower levels to be logged in an internal
buffer. See Table 55 for a list of level arguments.
Do not make the buffer size too large because the router could run out of memory for other tasks. You
can use the show memory EXEC command to view the free processor memory on the router; however,
this is the maximum available and should not be approached. The default logging buffered command
resets the buffer size to the default for the platform.
To display the messages that are logged in the buffer, use the show logging EXEC command. The first
message displayed is the oldest message in the buffer.
The show logging EXEC command displays the addresses and levels associated with the current logging
setup, and any other logging statistics.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-507

Troubleshooting and Fault Management Commands

logging buffered

Table 55

Examples

System Message Logging Priorities and Corresponding Level Names/Numbers

Level Name

Level
Number Description

Syslog Definition

emergencies

System unusable

LOG_EMERG

alerts

Immediate action needed

LOG_ALERT

critical

Critical conditions

LOG_CRIT

errors

Error conditions

LOG_ERR

warnings

Warning conditions

LOG_WARNING

notifications

Normal but significant condition

LOG_NOTICE

informational

Informational messages only

LOG_INFO

debugging

Debugging messages

LOG_DEBUG

In the following example, the user enables logging to an internal buffer:

logging buffered

Related Commands

Command

Description

clear logging

Clears messages from the logging buffer.

show logging

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

FR-508

78-11740-02

Troubleshooting and Fault Management Commands

logging console

logging console
To limit messages logged to the console based on severity, use the logging console global configuration
command. To disable logging to the console terminal, use the no form of this command.
logging console level
no logging console

Syntax Description

level

Defaults

debugging

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Limits the logging of messages displayed on the console terminal to a specified

level. You can enter the level number or level name. See Table 56 for a list of the
level arguments.

Specifying a level causes messages at that level and numerically lower levels to be displayed at the
console terminal.
The show logging EXEC command displays the addresses and levels associated with the current logging
setup, and any other logging statistics. See Table 56.
Table 56

System Message Logging Priorities and Corresponding Level Names/Numbers

Level Arguments

Level

Description

Syslog Definition

emergencies

System unusable

LOG_EMERG

alerts

Immediate action needed

LOG_ALERT

critical

Critical conditions

LOG_CRIT

errors

Error conditions

LOG_ERR

warnings

Warning conditions

LOG_WARNING

notifications

Normal but significant condition

LOG_NOTICE

informational

Informational messages only

LOG_INFO

debugging

Debugging messages

LOG_DEBUG

The effect of the log keyword with the IP access list (extended) interface configuration command
depends on the setting of the logging console command. The log keyword takes effect only if the logging
console level is set to 6 or 7. If you change the default to a level lower than 6 and specify the log keyword
with the IP access list (extended) command, no information is logged or displayed.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-509

Troubleshooting and Fault Management Commands

logging console

Examples

In the following example, the user changes the level of messages displayed to the console terminal to
alerts, which means alerts and emergencies are displayed:
logging console alerts

Related Commands

Command

Description

access-list (extended)

Defines an extended XNS access list.

logging facility

Configures the syslog facility in which system messages are sent.

Cisco IOS Configuration Fundamentals Command Reference

FR-510

78-11740-02

Troubleshooting and Fault Management Commands

logging facility

logging facility
To configure the syslog facility in which system messages are sent, use the logging facility global
configuration command. To revert to the default of local7, use the no form of this command.
logging facility facility-type
no logging facility

Syntax Description

facility-type

Defaults

local7

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Syslog facility. See the Usage Guidelines section of this command reference
entry for descriptions of acceptable keywords.

Table 57 describes the acceptable keywords for the facility-type argument.

Table 57

logging facility facility-type Argument

Facility-type keyword

Description

auth

Authorization system

cron

Cron facility

daemon

System daemon

kern

Kernel

local07

Reserved for locally defined messages

lpr

Line printer system

mail

Mail system

news

USENET news

sys9

System use

sys10

System use

sys11

System use

sys12

System use

sys13

System use

sys14

System use

syslog

System log

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-511

Troubleshooting and Fault Management Commands

logging facility

Table 57

Examples

logging facility facility-type Argument (continued)

Facility-type keyword

Description

user

User process

uucp

UNIX-to-UNIX copy system

In the following example, the user configures the syslog facility to the kernel facility type:
logging facility kern

Related Commands

Command

Description

logging console

Limits messages logged to the console based on severity.

Cisco IOS Configuration Fundamentals Command Reference

FR-512

78-11740-02

Troubleshooting and Fault Management Commands

logging history

logging history
To limit syslog messages sent to the routers history table and the Simple Network Management Protocol
(SNMP) network management station based on severity, use the logging history global configuration
command. To return the logging of syslog messages to the default level, use the no form of this command
with the previously configured severity level argument.
logging history [severity-level-name | severity-level-number]
no logging history [severity-level-name | severity-level-number]

Syntax Description

severity-level-name

Name of the severity level. Specifies the lowest severity level for system
error messag logging. See the Usage Guidelines section of this command for
available keywords.

severity-level-number

Number of the severity level. Specifies the lowest severity level for system
error messag logging. See the Usage Guidelines section of this command for
available keywords.

Defaults

Logging of system messages of severity levels 0 through 4 (emergency, alert, critical, error, and warning
levels); in other words, saving level warnings or higher

Command Modes

Global configuration (config)

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Sending syslog messages to the SNMP network management station occurs when you enable syslog
traps with the snmp-server enable traps global configuration command. Because SNMP traps are
inherently unreliable and much too important to lose, at least one syslog message, the most recent
message, is stored in a history table on the router. The history table, which contains table size, message
status, and message text data, can be viewed using the show logging history command. The number of
messages stored in the table is governed by the logging history size EXEC command.
Severity levels are numbered 0 through 7, with 0 being the highest severity level and 7 being the lowest
severity level (that is, the lower the number, the more critical the message). Specifying a level causes
messages at that severity level and numerically lower levels to be stored in the routers history table and
sent to the SNMP network management station. For example, specifying the level critical causes
messages as the critical (3), alert (2), and emergency (1) levles to be saved to the logging history table.
Table 58 provides a description of logging severity levels, listed from higest severity to lowest severity,
and the arguments used inthe logging history command syntax. Note that you can use the level name or
the level number as the level argument in this command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-513

Troubleshooting and Fault Management Commands

logging history

Table 58

Examples

System Logging Message Severity Levels

Severity Level
Name

Severity
Level
Number

Description

Syslog Definition

emergencies

System unusable

LOG_EMERG

alerts

Immediate action needed

LOG_ALERT

critical

Critical conditions

LOG_CRIT

errors

Error conditions

LOG_ERR

warnings

Warning conditions

LOG_WARNING

notifications

Normal but significant

condition

LOG_NOTICE

informational

Informational messages only

LOG_INFO

debugging

Debugging messages

LOG_DEBUG

In the following example, the system is initially configured to the default of saving severity level 4 or
higher. The logging history1 command is used to configure the system to save only level 1 (alert) and
level 0 (emergency) messages to the logging history table. The configuration is then confirmed using the
show logging history command.
Router#show logging history
Syslog History Table:10 maximum table entries,
! The following line shows that system-error-message-logging is set to the
! default level of warnings (4).
saving level warnings or higher
23 messages ignored, 0 dropped, 0 recursion drops
1 table entries flushed
SNMP notifications not enabled
entry number 2 : LINK-3-UPDOWN
Interface FastEthernet0, changed state to up
timestamp: 2766
Router#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#logging history 1
Router(config)#end
Router#
4w0d: %SYS-5-CONFIG_I: Configured from console by console
Router#show logging history
Syslog History Table:1 maximum table entries,
! The following line indicates that logging history level 1 is configured.
saving level alerts or higher
18 messages ignored, 0 dropped, 0 recursion drops
1 table entries flushed
SNMP notifications not enabled
entry number 2 : LINK-3-UPDOWN
Interface FastEthernet0, changed state to up
timestamp: 2766
Router#

Cisco IOS Configuration Fundamentals Command Reference

FR-514

78-11740-02

Troubleshooting and Fault Management Commands

logging history

Related Commands

Command

Description

logging on

Controls (enables or disables) the logging of system messages.

logging history size

Changes the number of syslog messages stored in the routers history table.

show logging

Displays the state of logging (syslog).

show logging history

Displays the state of logging history.

snmp-server host

Specifies the recipient of an SNMP notification operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-515

Troubleshooting and Fault Management Commands

logging history size

logging history size

To change the number of syslog messages stored in the routers history table, use the logging history
size global configuration command. To return the number of messages to the default value, use the no
form of this command.
logging history size number
no logging history size

Syntax Description

number

Defaults

One message

Command Modes

Global configuration (config)

Command History

Release

Modification

11.2

This command was introduced.

Number from 1 to 500 that indicates the maximum number of messages stored
in the history table.

Usage Guidelines

When the history table is full (that is, it contains the maximum number of message entries specified with
the logging history size command), the oldest message entry is deleted from the table to allow the new
message entry to be stored.

Examples

In the following example, the user sets the number of messages stored in the history table to 20:
logging history size 20

Related Commands

Command

Description

logging history

Limits syslog messages sent to the routers history table and the SNMP
network management station based on severity.

show logging

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

FR-516

78-11740-02

Troubleshooting and Fault Management Commands

logging linecard

logging linecard
To log messages to an internal buffer on a line card, use the logging linecard global configuration
command. To cancel the use of the internal buffer on the line cards, use the no form of this command.
logging linecard [size | level]
no logging linecard

Syntax Description

size

(Optional) Size of the buffer used for each line card. The range is from 4096 to
65,536 bytes. The default is 8 KB.

level

(Optional) Limits the logging of messages displayed on the console terminal

to a specified level. The message level can be one of the following:

alertsImmediate action needed

criticalCritical conditions

debuggingDebugging messages

emergenciesSystem is unusable

errorsError conditions

informationalInformational messages

notificationsNormal but significant conditions

warningsWarning conditions

Defaults

The Cisco IOS software logs messages to the internal buffer on the GRP card.

Command Modes

Global configuration (config)

Command History

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series Gigabit Switch
Routers.

Usage Guidelines

Specifying a message level causes messages at that level and numerically lower levels to be stored in the
internal buffer on the line cards.
Table 59 lists the message levels and associated numerical level. For example, if you specify a message
level of critical, all critical, alert, and emergency messages will be logged.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-517

Troubleshooting and Fault Management Commands

logging linecard

Table 59

Message Levels

Level Keyword

Level

emergencies

alerts

critical

errors

warnings

notifications

informational

debugging

To display the messages that are logged in the buffer, use the show logging slot EXEC command. The
first message displayed is the oldest message in the buffer.
Do not make the buffer size too large because the router could run out of memory for other tasks. You
can use the show memory EXEC command to view the free processor memory on the router; however,
this is the maximum available and should not be approached.

Examples

The following example enables logging to an internal buffer on the line cards using the default buffer
size and logging warning, error, critical, alert, and emergency messages:
(config)# logging linecard warnings

Related Commands

Command

Description

clear logging

Clears messages from the logging buffer.

show logging

Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

FR-518

78-11740-02

Troubleshooting and Fault Management Commands

logging monitor

logging monitor
To limit messages logged to the terminal lines (monitors) based on severity, use the logging monitor
global configuration command. This command limits the logging messages displayed on terminal lines
other than the console line to messages with a level at or above the level argument. To disable logging
to terminal lines other than the console line, use the no form of this command.
logging monitor severity-level
no logging monitor

Syntax Description

severity-level

Defaults

debugging (severity-level 7)

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Specifying a level causes messages at that level and numerically lower levels to be displayed to the
monitor.
Table 60

Examples

Limits the logging of messages logged to the terminal lines (monitors) to a

specified level. You can enter the level number or level name. See the Usage
Guidelines section for a list of acceptable severity-level keywords.

logging monitor System Message Logging Priorities

Level Name

Level
Number Description

Syslog Definition

emergencies

System unusable

LOG_EMERG

alerts

Immediate action needed

LOG_ALERT

critical

Critical conditions

LOG_CRIT

errors

Error conditions

LOG_ERR

warnings

Warning conditions

LOG_WARNING

notifications

Normal but significant conditions

LOG_NOTICE

informational

Informational messages only

LOG_INFO

debugging

Debugging messages

LOG_DEBUG

In the following example, the user specifies that only messages of the levels errors, critical, alerts, and
emergencies be displayed on terminals:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-519

Troubleshooting and Fault Management Commands

logging monitor

logging monitor 3

Related Commands

Command

Description

terminal monitor

Enables the display of system messages to the terminal connection.

Cisco IOS Configuration Fundamentals Command Reference

FR-520

78-11740-02

Troubleshooting and Fault Management Commands

logging on

logging on
To control logging of system messages (including error messages or debugging messages), use the
logging on global configuration command. This command sends system messages to a logging process,
which logs messages to designated locations asynchronously to the processes that generated the
messages. To disable the logging process, use the no form of this command.
logging on
no logging on

Syntax Description

This command has no arguments or keywords.

Defaults

The Cisco IOS software sends messages to the asynchronous logging process.

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The logging process controls the distribution of logging messages to the various destinations, such as
the logging buffer, terminal lines, or syslog server. You can turn logging on and off for these destinations
individually using the logging buffered, logging monitor, and logging global configuration commands.
However, if the logging on command is disabled, no messages will be sent to these destinations. Only
the console will receive messages.
Additionally, the logging process logs messages to the console and the various destinations after the
processes that generated them have completed. When the logging process is disabled, messages are
displayed on the console as soon as they are produced, often appearing in the middle of command output.

Caution

Disabling the logging on command will substantially slow down the router. Any process generating
system messages will wait until the messages have been displayed on the console before continuing.
The logging synchronous line configuration command also affects the displaying of messages to the
console. When the logging synchronous command is enabled, messages will appear only after the user
types a carriage return.

Examples

The following example shows command output and message output when logging is enabled. The ping
process finishes before any of the logging information is printed to the console (or any other destination).
Router(config)# logging on
Router(config)# end
Router#
%SYS-5-CONFIG_I: Configured from console by console

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-521

Troubleshooting and Fault Management Commands

logging on

Router# ping dirt

Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 172.16.1.129, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 4/5/8 ms
Router#
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1

In the following example, logging is disabled. The message output is displayed as messages are
generated, causing the debug messages to be interspersed with the message Type escape sequence to
abort.
Router(config)# no logging on
Router(config)# end
%SYS-5-CONFIG_I: Configured from console by console
Router#
Router# ping dirt
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sendingTyp
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1e
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sending esc
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sendingape
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sendingse
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1
IP: s=172.21.96.41 (local), d=172.16.1.129 (Ethernet1/0), len 100, sendingquen
IP: s=171.69.1.129 (Ethernet1/0), d=172.21.96.41, len 114, rcvd 1ce to abort.
Sending 5, 100-byte ICMP Echos to 172.16.1.129, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 152/152/156 ms
Router#

Related
Commands

Command

Description

logging

Logs messages to a syslog server host.

logging buffered

Logs messages to an internal buffer.

logging monitor

Limits messages logged to the terminal lines (monitors) based on severity.

logging synchronous

Synchronizes unsolicited messages and debug output with solicited

Cisco IOS software output and prompts for a specific console port line,
auxiliary port line, or vty.

Cisco IOS Configuration Fundamentals Command Reference

FR-522

78-11740-02

Troubleshooting and Fault Management Commands

logging rate-limit

logging rate-limit
To limit the rate of messages logged per second, use the logging rate-limit command in global
configuration mode. To disable the limit, use the no form of this command.
logging rate-limit {number | all number | console {number | all number}} [except severity]
no logging rate-limit

Syntax Description

number

Maximum number of messages logged per second. The valid values are
from 1 to 10000.

all

Sets the rate limit for all error and debug messages displayed at the console
and printer.

console

Sets the rate limit for error and debug messages displayed at the console.

except

(Optional) Excludes messages of this severity level or lower.

Severity decreases as the number increases. So, severity level 1 is a more
serious problem than severity level 3.

severity

(Optional) Sets the logging severity level. The valid levels are from 0 to 7.

Command Default

The default for this command is 10 messages logged per second and exclusion of messages of the errors
level or lower.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced.

12.2

This command was integrated in Cisco IOS Release 12.2.

Usage Guidelines

12.3

This command was integrated in Cisco IOS Release 12.3.

12.3T

This command was integrated in Cisco IOS Release 12.3T.

12.4

This command was integrated in Cisco IOS Release 12.4.

12.4T

This command was integrated in Cisco IOS Release 12.4T.

The logging rate-limit command controls the output of messages from the system. Use this command
if you want to avoid a flood of output messages. You can select the severity of the output messages and
output rate by using the logging rate-limit command. You can use the logging rate-limit command
anytime; it will not negatively impact the performance of your system and may improve the system
performance by specifying the severities and rates of output messages.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-523

Troubleshooting and Fault Management Commands

logging rate-limit

You can use this command with or without the logging synchronous line configuration command. For
example, if you want to see all severity 0, 1, and 2 messages, use the no logging synchronous command
and specify logging rate-limit 10 except 2. By using the two commands together, you cause all
messages of 0, 1, and 2 severity to print and limit the less severe ones (lower than 2) to only 10 per
second.
Table 61 compares the error message logging numeric severity level with its equivalent word
description.
Table 61

Examples

Error Message Logging Severity Level and Equivalent Word Descriptions

Numeric Severity Level

Equivalent Word

Description

emergencies

System unusable

alerts

Immediate action needed

critical

Critical conditions

errors

Error conditions

warnings

Warning conditions

notifications

Normal but significant condition

informational

Informational messages only

debugging

Debugging messages

In the following example, the logging rate-limit configuration mode command limits message output to
200 per second:
Router(config)# logging rate-limit 200

Related Commands

Command

Description

logging synchronous

Synchronizes unsolicited messages and debug output with solicited

Cisco IOS software output and prompts for a specific console port line,
auxiliary port line, or vty.

Cisco IOS Configuration Fundamentals Command Reference

FR-524

78-11740-02

Troubleshooting and Fault Management Commands

logging source-interface

logging source-interface
To specify the source IP address of syslog packets, use the logging source-interface global
configuration command. To remove the source designation, use the no form of this command.
logging source-interface interface-type interface-number
no logging source-interface

Syntax Description

interface-type

Interface type.

interface-number

Interface number.

Defaults

No interface is specified.

Command Modes

Global configuration (config)

Command History

Release

Modification

11.2

This command was introduced.

Normally, a syslog message contains the IP address of the interface it uses to leave the router. The
logging source-interface command specifies that syslog packets contain the IP address of a particular
interface, regardless of which interface the packet uses to exit the router.

Examples

In the following example, the user specifies that the IP address for Ethernet interface 0 is the source IP
address for all syslog messages:
logging source-interface ethernet 0

The following example specifies that the IP address for Ethernet interface 2/1 on a Cisco 7000 series
router is the source IP address for all syslog messages:
logging source-interface ethernet 2/1

Related
Commands

Command

Description

logging

Logs messages to a syslog server host.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-525

Troubleshooting and Fault Management Commands

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 line
configuration command. 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-buffers]
no logging synchronous [level severity-level | all] [limit number-of-buffers]

Syntax Description

Defaults

level severity-level

(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.

all

(Optional) Specifies that all messages are printed asynchronously,

regardless of the severity level.

limit number-of-buffers

(Optional) Specifies the number of buffers to be queued for the

terminal after which new messages are dropped. The default value is
20.

This feature is turned off by default.

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

Modification

10.0

This command was introduced.

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. Unsolicited messages and debug output is displayed on the console after
the prompt for user input is returned. To keep unsolicited messages and debug output from being
interspersed with solicited software output and prompts. After the unsolicited messages are displayed,
the console displays the user prompt again.
When specifying a severity level number, consider that for the logging system, low numbers indicate
greater severity and high numbers indicate lesser severity.

Cisco IOS Configuration Fundamentals Command Reference

FR-526

78-11740-02

Troubleshooting and Fault Management Commands

logging synchronous

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

Examples

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 would unlikely consume all available RAM.
You should guard against this type of attack through proper configuration.

In the following example, line 4 is identified and synchronous logging for line 4 is enabled with a
severity level of 6. Then another line, line 2, is identified and the synchronous logging for line 2 is
enabled with a severity level of 7 and is specified with a maximum number of buffers to be 70,000.
line 4
logging synchronous level 6
line 2
logging synchronous level 7 limit 70000

Related
Commands

Command

Description

line

Identifies a specific line for configuration and starts the line configuration
command collection mode.

logging on

Controls logging of system 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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-527

Troubleshooting and Fault Management Commands

logging trap

logging trap
To limit messages logged to the syslog servers based on severity, use the logging trap global
configuration command. The command limits the logging of system messages sent to syslog servers to
only those messages at the specified level. To disable logging to syslog servers, use the no form of this
command.
logging trap level
no logging trap

Syntax Description

level

Defaults

informational (level 6)

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Limits the logging of messages to the syslog servers to a specified level. You can
enter the level number or level name. See the Usage Guidelines section for a list
of acceptable level keywords.

The show logging EXEC command displays the addresses and levels associated with the current logging
setup. The command output also includes ancillary statistics.
Table 1 lists the syslog definitions that correspond to the debugging message levels. Additionally, four
categories of messages are generated by the software, as follows:

Error messages about software or hardware malfunctions at the LOG_ERR level.

Output for the debug commands at the LOG_WARNING level.

Interface up/down transitions and system restarts at the LOG_NOTICE level.

Reload requests and low process stacks at the LOG_INFO level.

Use the logging and logging trap commands to send messages to a UNIX syslog server.
Table 62

logging trap System Message Logging Priorities

Level Arguments

Level

Description

Syslog Definition

emergencies

System unusable

LOG_EMERG

alerts

Immediate action needed

LOG_ALERT

critical

Critical conditions

LOG_CRIT

errors

Error conditions

LOG_ERR

warnings

Warning conditions

LOG_WARNING

Cisco IOS Configuration Fundamentals Command Reference

FR-528

78-11740-02

Troubleshooting and Fault Management Commands

logging trap

Table 62

Examples

logging trap System Message Logging Priorities (continued)

Level Arguments

Level

Description

Syslog Definition

notifications

Normal but significant condition

LOG_NOTICE

informational

Informational messages only

LOG_INFO

debugging

Debugging messages

LOG_DEBUG

In the following example, the messages to a host named john is logged:

logging john
logging trap notifications

Related
Commands

Command

Description

logging

Logs messages to a syslog server host.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-529

Troubleshooting and Fault Management Commands

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 ping privileged EXEC command.
ping [protocol | tag] {host-name | system-address} [data [hex-data-pattern] | df-bit | repeat
[repeat-count] | size [datagram-size] | source [source-address | async | bvi | ctunnel | dialer |
ethernet | fastEthernet | lex | loopback | multilink | null | port-channel | tunnel | vif |
virtual-template | virtual-tokenring | xtagatm] | timeout [seconds] | validate]

Syntax Description

protocol

(Optional) Protocol keyword, one of apollo, appletalk, clns, decnet, ip, ipx, srb,
vines, or xns.

tag

(Optional) Specifies a tag encapsulated IP ping.

host-name

Host name of the system to ping.

system-address

Address of the system to ping.

data

(Optional) Specifies the data pattern.

hex-data-pattern

(Optional) Range is from 0 to FFFF.

df-bit

(Optional) Enables the do-not-fragment bit in the IP header.

repeat

(Optional) Specifies the number of pings sent. The default is 5.

repeat-count

(Optional) Range is from 1 to 2147483647.

size

(Optional) Specifies the datagram size. Datagram size is the number of bytes in
each ping.

datagram-size

(Optional) Range is from 40 to 18024.

source

(Optional) Specifies the source address or name.

source-address

(Optional)Source address or name.

async

(Optional) Asynchronous interface.

bvi

(Optional) Bridge-Group Virtual Interface.

ctunnel

(Optional) CTunnel interface.

dialer

(Optional) Dialer interface.

ethernet

(Optional) Ethernet IEEE 802.3.

fastEthernet

(Optional) FastEthernet IEEE 802.3.

lex

(Optional) Lex interface.

loopback

(Optional) Loopback interface.

multilink

(Optional) Multilink-group interface.

null

(Optional) Null interface.

port-channel

(Optional) Ethernet channel of interfaces.

tunnel

(Optional) Tunnel interface.

vif

(Optional) PGM Multicast Host interface.

virtual-template

(Optional) Virtual Template interface.

virtual-tokenring (Optional) Virtual TokenRing.

xtagatm

(Optional) Extended Tag ATM interface.

timeout

(Optional) Specifies the timeout interval in seconds. The default is 2 seconds.

Cisco IOS Configuration Fundamentals Command Reference

FR-530

78-11740-02

Troubleshooting and Fault Management Commands

ping (privileged)

seconds

(Optional) Range is from 0 to 3600.

validate

(Optional) Validates the reply data.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

12.0

The data, df-bit, repeat, size, source, timeout, and validate keywords were
added.

Usage Guidelines

The ping (packet internet groper) command sends ISO CLNS echo packets to test the reachability of a
remote router over a connectionless Open System Interconnection (OSI) network.
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 sequenceby default, Ctrl-^ X. You type the
default by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing the X key.
Table 63 describes the test characters that the ping facility sends.
Table 63

ping Test Characters

Character Description

Note

Examples

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 congestion experienced packet was received.

User interrupted test.

Unknown packet type.

&

Packet lifetime exceeded.

Not all protocols require hosts to support pings. For some protocols, the pings are Cisco-defined and are
only answered by another Cisco router.

After you enter the ping command in privileged mode, the system prompts for one of the following
keywords: apollo, appletalk, clns, decnet, ip, novell, vines, or xns. 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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-531

Troubleshooting and Fault Management Commands

ping (privileged)

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

Table 64 describes the default ping fields shown in the display.

Table 64

ping Field Descriptions

Field

Description

Protocol [ip]:

Prompts for a supported protocol. Enter appletalk, clns, ip, novell,

apollo, vines, decnet, or xns. The default is IP.

Target IP address:

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.

Repeat count [5]:

Prompts for the number of ping packets that will be sent to the
destination address. The default is 5 packets.

Datagram size [100]:

Prompts for the size of the ping packet (in bytes). The default is 100
bytes.

Timeout in seconds [2]:

Prompts for the timeout interval. The default is 2 seconds.

Extended commands [n]:

Specifies whether a series of additional commands appears.

Sweep range of sizes [n]:

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.

!!!!!

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.

Success rate is 100 percent

Indicates the percentage of packets successfully echoed back to the

router. Anything less than 80 percent is usually considered
problematic.

round-trip min/avg/max =
1/2/4 ms

Indicates the round-trip travel time intervals for the protocol echo
packets, including minimum/average/maximum (in milliseconds).

Cisco IOS Configuration Fundamentals Command Reference

FR-532

78-11740-02

Troubleshooting and Fault Management Commands

ping (privileged)

Related Commands

Command

Description

ping (user)

Tests the connection to a remote host on the network.

ping vrf

Tests the connection to a remote device in a VPN.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-533

Troubleshooting and Fault Management Commands

ping (user)

ping (user)
To diagnose basic network connectivity on AppleTalk, Connection Network Service (CLNS), IP, Novell,
Apollo, VINES, DECnet, or XNS networks, use the ping (packet internet groper) user EXEC command.
ping [protocol] {host-name | system-address}

Syntax Description

protocol

(Optional) Protocol keyword, one of apollo, appletalk, clns, decnet, ip, ipx,
vines, or xns.

host-name

Host name of the system to ping.

system-address

Address of the system to ping.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The user-level ping feature provides a basic ping facility for users that do not have system privileges.
This feature allows the Cisco IOS software to perform the simple default ping functionality for a number
of protocols. Only the terse form of the ping command is supported for user-level pings.
If the system cannot map an address for a host name, it returns an %Unrecognized host or address error
message.
To abnormally terminate a ping session, type the escape sequenceby default, Ctrl-^ X. You type the
default by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing the X key.
Table 65 describes the test characters that the ping facility sends.
Table 65

ping Test Characters

Character Description

Examples

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 congestion experienced packet was received.

User interrupted test.

Unknown packet type.

&

Packet lifetime exceeded.

The following display shows sample ping output when you ping the IP host named donald:
Router> ping donald
Type escape sequence to abort.

Cisco IOS Configuration Fundamentals Command Reference

FR-534

78-11740-02

Troubleshooting and Fault Management Commands

ping (user)

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/3/4 ms

Related
Commands

Command

Description

ping (privileged)

Checks host reachability and network connectivity.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-535

Troubleshooting and Fault Management Commands

service slave-log

service slave-log
To allow slave Versatile Interface Processor (VIP) cards to log important system messages to the console,
use the service slave-log global configuration command. 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.

Defaults

This command is enabled by default.

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

11.1

This command was introduced.

Usage Guidelines

This command allows slave slots to log system messages of level 2 or higher (critical, alerts, and
emergencies).

Examples

In the following example, important messages from the slave cards to the console are logged:
service slave-log

In the following example sample output is illustrated 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 system message.

Cisco IOS Configuration Fundamentals Command Reference

FR-536

78-11740-02

Troubleshooting and Fault Management Commands

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 global configuration command. To disable the keepalives, use the no form
of this command.
service tcp-keepalives-in
no service tcp-keepalives-in

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.0

This command was introduced.

Examples

In the following example, keepalives on incoming TCP connections are generated:

service tcp-keepalives-in

Related
Commands

Command

Description

service
tcp-keepalives-out

Generates keepalive packets on idle outgoing network connections (initiated

by a user).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-537

Troubleshooting and Fault Management Commands

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 global configuration command. To disable the keepalives, use the no form
of this command.
service tcp-keepalives-out
no service tcp-keepalives-out

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration (config)

CommandHistory

Release

Modification

10.0

This command was introduced.

Examples

In the following example, keepalives on outgoing TCP connections are generated:

service tcp-keepalives-out

Related
Commands

Command

Description

service
tcp-keepalives-in

Generates keepalive packets on idle incoming network connections (initiated

by the remote host).

Cisco IOS Configuration Fundamentals Command Reference

FR-538

78-11740-02

Troubleshooting and Fault Management Commands

service timestamps

service timestamps
To configure the system to time-stamp debugging or logging messages, use one of the service
timestamps global configuration commands. To disable this service, use the no form of this command.
service timestamps [debug | log] [ uptime | datetime [msec] [localtime] [show-timezone] ]
no service timestamps [debug | log]

Syntax Description

debug

Indicates timestamping for debugging messages.

log

Indicates timestamping for system logging messages.

uptime

(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 timestamp 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
DdHHh (D days HH hours) after the first day
WwDd (W weeks D days) after the first week

datetime

(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, or show-timezone keywords.

If the service timestamps datetime command is used without addtional

keywords, timestamps will be shown using UTC, without the year, without
milliseconds, and without a time zone name.

msec

(Optional) Includes milliseconds in the time stamp, in the format

HH:DD:MM:SS.mmm, where .mmm is milliseconds

localtime

(Optional) Time stamp relative to the local time zone.

show-timezone

(Optional) Include the time zone name in the time stamp.

Note

Defaults

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 Universal Coordinated Time (UTC).

No time-stamping.
If the service timestamps command is specified with no arguments or keywords, the default is service
timestamps debug uptime.
The default for the service timestamps type datetime command is to format the time in Coordinated
Universal Time (UTC), with no milliseconds and no time zone name.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-539

Troubleshooting and Fault Management Commands

service timestamps

The no service timestamps command by itself disables time stamps for both debug and log messages.

Command Modes

Global configuration (config)

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Time stamps can be added to either debugging or logging messages independently. The uptime form of
the command adds time stamps in the format HHHH:MM:SS, indicating the time since the system was
rebooted. The datetime form of the command adds time stamps in the format MMM DD HH:MM:SS,
indicating the date and time according to the system clock. If the system clock has not been set, the date
and time are preceded by an asterisk (*) to indicate that the date and time are probably not correct.

Examples

In the following example, the user enables time stamps on debugging messages, showing the time since
reboot:
service timestamps debug uptime

In the following example, the user enables time stamps on logging messages, showing the current time
and date relative to the local time zone, with the time zone name included:
service timestamps log datetime localtime show-timezone

Related Commands

Command

Description

clock set

Manually sets the system clock.

ntp

Controls access to the systems NTP services.

Cisco IOS Configuration Fundamentals Command Reference

FR-540

78-11740-02

Troubleshooting and Fault Management Commands

show c2600 (2600)

show c2600 (2600)

To display information for troubleshooting the Cisco 2600 series router, use the show c2600 EXEC
command.
show c2600

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

CommandHistory

Release

Modification

11.3 XA

This command was introduced.

Usage Guidelines

The show c2600 command provides complex troubleshooting information that pertains to the platforms
shared references rather than to a specific interface.

Examples

In the following example, sample output is shown for the show c2600 EXEC command. See Table 66
for a description of the output display fields.
router# show c2600
C2600 Platform Information:
Interrupts:
Assigned Handlers...
Vect Handler
# of Ints
00 801F224C
00000000
01 801DE768
0D3EE155
02 801E94E0
0000119E
04 801F0D94
00000000
05 801E6C34
00000000
06 801F0DE4
00002C1A
07 801F0EA0
0000015D
14 801F224C
00000000
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

Name
Xilinx bridge error interrupt
MPC860 TIMER INTERRUPT
16552 Con/Aux Interrupt
PA Network Management Int Handler
Timebase Reference Interrupt
PA Network IO Int Handler
MPC860 CPM INTERRUPT
Xilinx bridge error interrupt

]
]
]
]
]
]
]
]

SIU_IRQ_MASK = FFFFFFFF
Spurious IRQs = 00000000

SIEN
= EF02xxxx
SIPEND = 0000xxxx

Current Level = 00

Interrupt Throttling:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-541

Troubleshooting and Fault Management Commands

show c2600 (2600)

Throttle Count
Netint usec
Active
Longest IRQ

= 00000000
= 00000000
=
0
= 00000000

Timer Count
= 00000000
Netint Mask usec = 000003E8
Configured
=
0

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

Table 66

show c2600 Field Descriptions

Field

Description

Interrupts

Denotes that the next section describes the status of the

interrupt services.

Assigned Handlers

Denotes a subsection of the Interrupt section that displays data

about the interrupt handlers.

Vect

The processor vector number.

Handler

The execution address of the handler assigned to this vector.

# of Ints

The number of times this handler has been called.

Name

The name of the handler assigned to this vector.

IOS Priority Masks

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.

SIU_IRQ_MASK

For engineering level debug only.

Spurious IRQs

For engineering level debug only.

Interrupt Throttling:

This subsection describes the behavior of the Interrupt

Throttling mechanism on the platform.

Throttle Count

Number of times throttle has become active.

Timer Count

Number of times throttle has deactivated because the maximum

masked out time for network interrupt level has been reached.

Netint usec

Maximum time network level is allowed to run (in

microseconds).

Netint Mask usec

Maximum time network level interrupt is masked out to allow

process level code to run (in microseconds).

Active

Indicates that the network level interrupt is masked or that the

router is in interrupt throttle state.

Configured

Indicates that throttling is enabled or configured when set to 1.

Longest IRQ

Duration of longest network level interrupt (in microseconds).

Cisco IOS Configuration Fundamentals Command Reference

FR-542

78-11740-02

Troubleshooting and Fault Management Commands

show c2600 (2600)

Table 66

Related Commands

show c2600 Field Descriptions (continued)

Field

Description

IDMA Status

Monitors the activity of the Internal Direct Memory Access

(IDMA) hardware and software. Used to coalesce packets (turn
particalized packets into non particalized packets) for transfer
to the process level switching mechanism.

Requests

Number of times the IDMA engine is asked to coalesce a

packet.

Drops

Number of times the coalescing operation was aborted.

Complete

Number of times the operation was successful.

Post Coalesce Frames

Number of Frames completed post coalesce processing.

Giant

Number of packets too large to coalesce.

Available Blocks

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.

ISP Status

Provides status of In-System-Programmable (ISP) hardware.

Version string burned in chip

Current version of ISP hardware.

New version after next program

operation

Version of ISP hardware after next ISP programming operation.

ISP family type

Device family number of ISP hardware.

ISP chip ID

Internal ID of ISP hardware as designated by the chip

manufacturer.

Device is programmable

Yes or No. Indicates if an ISP operation is possible on this

board.

Command

Description

show context

Displays information stored in NVRAM when the router crashes.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-543

Troubleshooting and Fault Management Commands

show c7200 (7200)

show c7200 (7200)

To display information about the CPU and midplane for Cisco 7200 series routers, use the show c7200
EXEC command.
show c7200

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Examples

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.

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
Serial number
2863311530
Part number
Test history
0xAA
RMA number
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
0x30: EE 00 04 00 AA AA AA AA AA AA AA 50 AA
C7200 CPU EEPROM:
Hardware revision 2.0
Serial number
3509953
Test history
0x0
EEPROM format version 1
EEPROM contents (hex):
0x20: 01 15 02 00 00 35 8E C1
0x30: 50 00 00 00 FF FF FF FF

A0
170-43690-170
170-170-170

60 3E 28
AA AA AA

Board revision A0
Part number
73-1536-02
RMA number
00-00-00

49 06 00 02 00 00 00 00
FF FF FF FF FF FF FF FF

Cisco IOS Configuration Fundamentals Command Reference

FR-544

78-11740-02

Troubleshooting and Fault Management Commands

show cls

show cls
To display the current status of all Cisco link services (CLS) sessions on the router, use the show cls
EXEC command.
show cls [brief]

Syntax Description

brief

Defaults

Without the brief argument, displays complete output.

Command Modes

EXEC

Command History

Release

Modification

11.0

This command was introduced in a release prior to Cisco IOS Release11.0.

Usage Guidelines

(Optional) Displays a brief version of the output.

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.

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
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-545

Troubleshooting and Fault Management Commands

show cls

DLU user:DLSWDLUPEER
DLU user:DLSWDLU
Bridging VDLC VDLC1000
Bridging VDLC VDLC650

The examples show two DLUsSNASw and DLSwactive 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.

Cisco IOS Configuration Fundamentals Command Reference

FR-546

78-11740-02

Troubleshooting and Fault Management Commands

show context (2600)

show context (2600)

To display information stored in NVRAM when an exception occurs, use the show context EXEC
command.
show context

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Context information is specific to processors and architectures, whereas software version and uptime
information is not specific to architectures. 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 display from
the show context command includes the following information:

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

This information is useful only to your technical support representative for analyzing crashes in the field.
Use this information when you read the displayed statistics to an engineer over the phone.

Examples

The following is sample output from the show context command following a system failure on a
Cisco 2600 series router. See Table 67 for a description of the fields in this output.
router# show context
S/W Version: Cisco Internetwork Operating System Software
IOS (tm) c2600 Software (c2600-JS-M), Released Version 11.3(19980115:184921]
Copyright (c) 1986-1998 by cisco Systems, Inc.
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

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-547

Troubleshooting and Fault Management Commands

show context (2600)

R16 =
R20 =
R24 =
R28 =
Stack
Frame
Frame
Frame
Frame
Frame
Frame

0x00000000 R17 = 0x00000000 R18 = 0x00000000

0x00000000 R21 = 0x00000001 R22 = 0x00000010
0x00000000 R25 = 0x80E91348 R26 = 0x01936010
0x00000001 R29 = 0x019BA920 R30 = 0x00000000
trace:
00: SP = 0x80E80BD0
PC = 0x80109958
01: SP = 0x80E80C28
PC = 0x8010A720
02: SP = 0x80E80C40
PC = 0x80271010
03: SP = 0x80E80C50
PC = 0x8025EE64
04: SP = 0x80DEE548
PC = 0x8026702C
05: SP = 0x80DEE558
PC = 0x8026702C

Table 67

Related Commands

R19
R23
R27
R31

=
=
=
=

0x00000000
0x00000000
0x80E92A80
0x00000018

show context Field Descriptions

Field

Description

S/W Version

Standard Cisco IOS version string as displayed.

Exception occurred at

Router real time when exception occurred. The router must have
the clock time properly configured for this to be accurate.

Exception type

Technical reason for exception. For engineering analysis.

CPU Register Context

Technical processor state information. For engineering analysis.

Stack trace

Technical processor state information. For engineering analysis.

Command

Description

show processes

Displays information about the active processes.

show stacks

Monitors the stack usage of processes and interrupt routines.

Cisco IOS Configuration Fundamentals Command Reference

FR-548

78-11740-02

Troubleshooting and Fault Management Commands

show context

show context
To display information stored in NVRAM when the router crashes, use the show context EXEC
command.
show context summary
show context {all | slot slot-number [crash-index] [all] [debug]}

Syntax Description

summary

Displays a summary of all the crashes recorded.

all

Displays all crashes for all the slots. When optionally used with the slot
keyword, displays crash information for the specified slot.

slot slot-number
[crash-index]

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.

debug

(Optional) Displays crash information as a hex record dump in addition to one

of the options listed.

Command Modes

EXEC

Command History

Release

Modification

11.2 GS

This command was modified to add the all, debug, slot, and summary
keywords.

Usage Guidelines

Note

Examples

The display from the show context command includes the following information:

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

This information is of use only to technical support representatives in analyzing crashes in the field. It
is included here in case you need to read the displayed statistics to an engineer over the phone.

The following is sample output from the show context command following a system failure:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-549

Troubleshooting and Fault Management Commands

show context

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.
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
Slot 11: 0 crashes
Router#

Related
Commands

Command

Description

show processes

Displays information about the active processes.

show stacks

Monitors the stack usage of processes and interrupt routines.

Cisco IOS Configuration Fundamentals Command Reference

FR-550

78-11740-02

Troubleshooting and Fault Management Commands

show controllers (GRP image)

show controllers (GRP image)

To display information that is specific to the hardware, use the show controllers privileged EXEC
command.
show controllers [atm slot-number | clock | csar [register] | csc-fpga | dp83800 | fab-clk | fia
[register] | pos [slot-number] [details] | queues [slot-number] | sca | xbar]

Syntax Description

Command Modes

atm slot-number

(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.

clock

(Optional) Displays the clock card configuration.

csar [register]

(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.

csc-fpga

(Optional) Displays the clock and scheduler card register information in

the field programmable gate array (FPGA).

dp83800

(Optional) Displays the Ethernet information on the GRP card.

fab-clk

(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.

fia [register]

(Optional) Displays the fabric interface ASIC information and optionally

displays the register information.

pos [slot-number]
[details]

(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.

queues [slot-number]

(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.

sca

(Optional) Displays the SCA register information. The SCA is an ASIC

that arbitrates among the line cards requests to use the switch fabric.

xbar

(Optional) Displays the crossbar register information. The XBAR is an

ASIC that switches the data as it passes through the switch fabric.

Privileged EXEC

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-551

Troubleshooting and Fault Management Commands

show controllers (GRP image)

Command History

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series Internet Routers.

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
Active Alarms: None
LINE
AIS = 2
RDI = 2
FEBE = 146
Active Alarms: None
PATH
AIS = 2
RDI = 4
FEBE = 63
LOP = 0
PSE = 8
NSE = 3
Active Alarms: None
APS
COAPS = 3
PSBF = 2
State: PSBF_state = False
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

Description

clear controllers

Resets the T1 or E1 controller.

BIP(B1) = 5889

BIP(B2) = 2106453

BIP(B3) = 3216
NEWPTR = 2

show controllers (line Displays information that is specific to the hardware on a line card.
card image)

Cisco IOS Configuration Fundamentals Command Reference

FR-552

78-11740-02

Troubleshooting and Fault Management Commands

show controllers (line card image)

show controllers (line card image)

To display information that is specific to the hardware on a line card, use the attach privileged EXEC
command to connect to the line card and then use the show controllers privileged EXEC command or
the execute-on privileged EXEC command.
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-number [end-queue-number] |
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]}

Syntax Description

atm

Displays the ATM controller information.

port-number

(Optional) Displays request for the physical interface on the

ATM card. The range of choices is from 0 to 3.

all

(Optional) Lists all details.

sar

(Optional) Lists SAR interactive command.

summary

(Optional) Lists SAR status summary.

fia

Displays the fabric interface ASIC information.

register

(Optional) Displays the register information.

frfab

(Optional) Displays the "from" (transmit) fabric information.

tofab

(Optional) Displays the "to" (receive) fabric information.

bma

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).

microcode

Displays SQE information for the microcode bundled in the

line card and currently running version.

mis-inst

Displays SQE information for the micro sequencer instruction.

register

Displays silicon queuing engine (SQE) information for the

register.

qelem

For the frfab or tofab keywords, displays the SDRAM buffer

pool queue element summary information.

start-queue-element

Specifies the start queue element number from 0 to 65535.

end-queue-element

(Optional) Specifies the end queue element number from

0 to 65535).

qnum

For the frfab or tofab keywords, displays the SDRAM buffer

pool queue detail information.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-553

Troubleshooting and Fault Management Commands

show controllers (line card image)

start-queue-number

Specifies the start free queue number (from 0 to 127).

end-queue-number

(Optional) Specifies the end free queue number (from 0 to

127).

queues

For the frfab or tofab keywords, displays the SDRAM buffer

pool information.

statistics

For the frfab or tofab keywords, displays the BMA counters.

io

Displays input/output registers.

l3

Displays Layer 3 ASIC information.

pos

Displays packet-over-sonic (POS) information for framer

registers, framer queues, and ASIC registers.

framers

Displays the POS framer registers.

queues

Displays the POS framer queue information.

registers

Displays the ASIC registers.

rxsram

Displays the receive queue SRAM.

port-number

Specifies a port number (valid range is from 0 to 3).

queue-start-address

Specifies the queue SRAM logical starting address.

queue-length

(Optional) Specifies the queue SRAM length.

txsram

Displays the transmit queue SRAM.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series Gigabit Switch
Routers.

Usage Guidelines

Note

Examples

This command is intended for use by Cisco technical support.

This information provided by this command is of use only to technical support representatives in
analyzing crashes in the field.

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:

Cisco IOS Configuration Fundamentals Command Reference

FR-554

78-11740-02

Troubleshooting and Fault Management Commands

show controllers (line card image)

STS-12c
Active Maker Channels: total # 6
VCID ChnnlID Type OutputInfo
1
0888
UBR
0C010010
2
0988
VBR
04010020
3
8BC8
UBR
0C010030
4
0E08
UBR
0C010040
10
1288
VBR
040100A0
11
8BE8
VBR
0C0100B0

InPkts
0
0
0
0
0
0

InOAMs
0
0
0
0
0
0

MacString
08882000AAAA030000000800
09882000
8BC82000AAAA030000000800
0E082000AAAA030000000800
12882000
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#

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
RX POS ASIC addr space

603142E0
12000000

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-555

Troubleshooting and Fault Management Commands

show controllers (line card image)

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
master control
00
clock rcv cntrl
D0
RACP control
84
RACP gfc control
0F
TACP control status
04
RACP intr enable
04
RSOP cntrl intr enable 00
RSOP intr status
00
TPOP path sig lbl (c2) 13
SPTB control
04
SPTB status
00
Framer 1, addr=0x12000600:
master reset
C0
master config
1F
master control
00
clock rcv cntrl
D0
RACP control
84
RACP gfc control
0F
TACP control status
04
RACP intr enable
04
RSOP cntrl intr enable 00
RSOP intr status
00
TPOP path sig lbl (c2) 13
SPTB control
04
SPTB status
00
Framer 2, addr=0x12000800:
master reset
C0
master config
1F
master control
00
clock rcv cntrl
D0
RACP control
84
RACP gfc control
0F
TACP control status
04
RACP intr enable
04
RSOP cntrl intr enable 00
RSOP intr status
00
TPOP path sig lbl (c2) 13
SPTB control
04
SPTB status
00
.
.
.
Router#

rrate sts3c trate sts3c fixptr

hcsadd

tnull

rrate sts3c trate sts3c fixptr

hcsadd

tnull

rrate sts3c trate sts3c fixptr

hcsadd

tnull

The following is partial sample output from the show controllers fia command:

Cisco IOS Configuration Fundamentals Command Reference

FR-556

78-11740-02

Troubleshooting and Fault Management Commands

show controllers (line card image)

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
crc32 lkup parity 0
0
1
--------------los
0
0
crc16 0
0
To Fabric FIA Errors
----------------------sca not pres 0
grant parity 0
cntrl parity 0
multi fifo
0

Related Commands

redund overflow 0
cell parity
0
2
3
--------------0
0
0
0

req error
multi req
uni req
empty dst req

0
0
0
0

Command

Description

clear controllers

Resets the T1 or E1 controller.

cell drops 0
crc32
0
4
-------0
0

uni fifo overflow

uni fifo undrflow
crc32 lkup parity
handshake error

0
0
0
0

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-557

Troubleshooting and Fault Management Commands

show controllers logging

show controllers logging

To display logging information about a Versatile Interface Processor (VIP) card, use the show
controllers logging privileged EXEC command.
show controllers vip slot-number logging

Syntax Description

vip slot-number

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2

This command was introduced.

VIP slot number.

Usage Guidelines

This command displays the state of syslog error and event logging, including host addresses, and
whether console logging is enabled.

Examples

The following is sample output from the show controllers logging command:
Router# show controllers vip 4 logging
Syslog logging: enabled
Console logging: disabled
Monitor logging: level debugging, 266 messages logged.
Trap logging: level informational, 266 messages logged.
Logging to 192.180.2.238

Table 68 describes the significant fields shown in the display.

Table 68

Related Commands

show controllers logging Field Descriptions

Field

Description

Syslog logging

When enabled, system logging messages are sent to a UNIX host that acts as a
syslog server; that is, it captures and saves the messages.

Console logging

If enabled, states the level; otherwise, this field displays disabled.

Monitor logging

Minimum level of severity required for a log message to be sent to a monitor

terminal (not the console).

Trap logging

Minimum level of severity required for a log message to be sent to a syslog

server.

Command

Description

show logging

Displays the state of system logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

FR-558

78-11740-02

Troubleshooting and Fault Management Commands

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 privileged EXEC command.
show controllers vip slot-number tech-support

Syntax Description

vip slot-number

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

VIP slot number.

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

Description

more
system:running-config

Displays the running configuration.

show buffers

Displays statistics for the buffer pools on the network server.

show controllers

Displays information that is specific to the hardware.

show interfaces

Uses the show interfaces EXEC command to display ALC information.

show processes

Displays information about the active processes.

show processes
memory

Displays memory used.

show stacks

Monitors the stack usage of processes and interrupt routines.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-559

Troubleshooting and Fault Management Commands

show controllers tech-support

Command

Description

show tech-support

Displays general information about the router when reporting a problem.

show version

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

FR-560

78-11740-02

Troubleshooting and Fault Management Commands

show debugging

show debugging
To display information about the types of debugging that are enabled for your router, use the show
debugging privileged EXEC command.
show debugging

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1

This command was introduced.

Examples

The following is sample output from the show debugging command. In this example, three types of CDP
debugging are enabled.
Router# show debugging
CDP:
CDP packet info debugging is on
CDP events debugging is on
CDP neighbor info debugging is on

Related Commands

Command

Description

debug <feature>

Begin message logging for the specified debug command

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-561

Troubleshooting and Fault Management Commands

show diag

show diag
To display hardware information including DRAM and static RAM (SRAM) on line cards, use the show
diag command in privileged EXEC mode.
show diag [slot-number] [details] [summary]

Syntax Description

slot-number

(Optional) Slot number of the interface.

details

(Optional) Displays more details than the normal show diag output.

summary

(Optional) Displays a summary (one line per slot) of the chassis.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1 CA

This command was introduced.

11.2

This command was introduced.

11.2 P

This command was modified to show information for PA-12E/2FE, PA-E3,

and PA-T3 port adapters.

11.2 GS

This command was made available on Cisco 12000 series Gigabit Switch
Routers (GSRs).

11.3 XA

This command was integrated in Cisco IOS Release 11.3 XA.

12.0(5)XQ

This command was enhanced and made available on Cisco 1750 routers.

12.0(7)T

This command was integrated in Cisco IOS Release 12.0T.

Usage Guidelines

Note

Use this command to determine the type of hardware installed in your router. This command applies line
cards in Cisco Universal Access Servers; Cisco 1750, 7200, and 7500 series routers; and Cisco 12000
series GSRs.

The enhancement to display the field replaceable unit (FRU) number in show diag command output is
not available in all Cisco IOS releases and not all Cisco devices and Cisco network modules will display
their FRU numbers.
Examples of output showing the FRU number are included in the Examples section.
Cisco 7304 Router Usage Guidelines

For the Cisco 7304 router, this command applies to NSEs, line cards, MSCs, and SPAs.

To display hardware information for an NSE, line card, or MSC in the specified slot, use the
slot-number argument. For MSCs, information about the MSC and each of its installed SPAs is
displayed.

To display hardware information about the backplane, power supplies, and fan modules, use the
chassis keyword.

Cisco IOS Configuration Fundamentals Command Reference

FR-562

78-11740-02

Troubleshooting and Fault Management Commands

show diag

Shared Port Adapter Usage Guidelines

Examples

To display hardware information for an MSC or SIP only in a specified slot, use the slot-number
argument.

To display hardware information for a SPA only, use the show diag subslot slot/subslot version of
this command.

Example for a 1-Port T3 Serial Port Adapter on the Cisco 7200 Series Router

The following is sample output from the show diag command for a 1-port T3 serial port adapter in
chassis slot 1 on a Cisco 7200 series router:
Router# show diag 1
Slot 1:
Physical slot 1, ~physical slot 0xE, logical slot 1, CBus 0
Microcode Status 0x4
Master Enable, LED, WCS Loaded
Board is analyzed
Pending I/O Status: None
EEPROM format version 1
VIP2 controller, HW rev 2.4, board revision D0
Serial number: 04372053 Part number: 73-1684-03
Test history: 0x00
RMA number: 00-00-00
Flags: cisco 7000 board; 7500 compatible
EEPROM contents (hex):
0x20: 01 15 02 04 00 42 B6 55 49 06 94 03 00 00 00 00
0x30: 68 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Slot database information:
Flags: 0x4
Insertion time: 0x14A8 (5d02h ago)
Controller Memory Size: 16 MBytes DRAM, 1024 KBytes SRAM
PA Bay 0 Information:
T3 Serial PA, 1 ports
EEPROM format version 1
HW rev FF.FF, Board revision UNKNOWN
Serial number: 4294967295 Part number: 255-65535-255

Example Output from a Cisco 7200 Showing the FRU Number

The following is sample output from the show diag command on a Cisco 7200 series router showing the
FRU number:
Router# show diag
Slot 0:
Dual FastEthernet (RJ-45) I/O Card Port adapter, 2 ports
Port adapter is analyzed
Port adapter insertion time 6d02h ago
EEPROM contents at hardware discovery:
Hardware Revision
: 2.1
Top Assy. Part Number
: 800-07114-06
Part Number
: 73-5003-06
Board Revision
: B0
PCB Serial Number
: 31558694
RMA History
: 00
Fab Version
: 03
Fab Part Number
: 28-3455-03
Product (FRU) Number
: C7200-I/O-2FE/E
Deviation Number
: 0-0

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-563

Troubleshooting and Fault Management Commands

show diag

EEPROM format version 4

EEPROM contents (hex):
0x00: 04 FF 40 02 15 41
0x10: 82 49 13 8B 06 42
0x20: 39 34 00 00 00 04
0x30: 43 37 32 30 30 2D
0x40: 00 00 00 00 FF FF
0x50: FF FF FF FF FF FF
0x60: FF FF FF FF FF FF
0x70: FF FF FF FF FF FF

02
42
00
49
FF
FF
FF
FF

01
30
02
2F
FF
FF
FF
FF

C0
C1
03
4F
FF
FF
FF
FF

46
8B
85
2D
FF
FF
FF
FF

03
33
1C
32
FF
FF
FF
FF

20
31
0D
46
FF
FF
FF
FF

00
35
7F
45
FF
FF
FF
FF

1B
35
03
2F
FF
FF
FF
FF

CA
38
CB
45
FF
FF
FF
FF

06
36
8F
80
FF
FF
FF
FF

Router#

Examples for a Cisco 12000 Series Internet Router

The following is sample output from the show diag command on a Cisco 12000 series Internet router:
Router# show diag 3
SLOT 3 (RP/LC 3 ): 4 Port Packet Over SONET OC-3c/STM-1 Multi Mode
MAIN: type 33, 00-0000-00 rev 70 dev 0
HW config: 0x01
SW key: 00-00-00
PCA: 73-2147-02 rev 94 ver 2
HW version 1.0 S/N 04499695
MBUS: MBUS Agent (1) 73-2146-05 rev 73 dev 0
HW version 1.1 S/N 04494882
Test hist: 0x00
RMA#: 00-00-00
RMA hist: 0x00
DIAG: Test count: 0x05000001
Test results: 0x00000000
MBUS Agent Software version 01.27 (RAM) using CAN Bus A
ROM Monitor version 00.0D
Fabric Downloader version used 00.0D (ROM version is 00.0D)
Board is analyzed
Board State is Line Card Enabled (IOS RUN )
Insertion time: 00:00:10 (00:04:51 ago)
DRAM size: 33554432 bytes
FrFab SDRAM size: 67108864 bytes
ToFab SDRAM size: 16777216 bytes

The following is sample output from the show diag command with the summary keyword:
Router# show diag summary
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT
SLOT

0
2
4
7
9
11
16
17
18
19
20
24
26
28
29

(RP/LC 0 ):
(RP/LC 2 ):
(RP/LC 4 ):
(RP/LC 7 ):
(RP/LC 9 ):
(RP/LC 11):
(CSC 0
):
(CSC 1
):
(SFC 0
):
(SFC 1
):
(SFC 2
):
(PS A1
):
(PS B1
):
(TOP FAN ):
(BOT FAN ):

Route Processor
4 Port Packet Over SONET
4 Port Packet Over SONET
4 Port Packet Over SONET
4 Port Packet Over SONET
4 Port Packet Over SONET
Clock Scheduler Card
Clock Scheduler Card
Switch Fabric Card
Switch Fabric Card
Switch Fabric Card
AC Power Supply
AC Power Supply
Blower Module
Blower Module

OC-3c/STM-1
OC-3c/STM-1
OC-3c/STM-1
OC-3c/STM-1
OC-3c/STM-1

Single
Single
Single
Single
Single

Mode
Mode
Mode
Mode
Mode

The following is sample output from the show diag command with the details keyword:
Router# show diag 4 details
SLOT 4 (RP/LC 4): 4 Port Packet Over SONET OC-3c/STM-1 Single Mode
MAIN: type 33, 800-2389-01 rev 71 dev 16777215
HW config: 0x00
SW key: FF-FF-FF
PCA: 73-2275-03 rev 75 ver 3

Cisco IOS Configuration Fundamentals Command Reference

FR-564

78-11740-02

Troubleshooting and Fault Management Commands

show diag

HW version 1.1 S/N 04529465

MBUS: MBUS Agent (1) 73-2146-06 rev 73 dev 0
HW version 1.1 S/N 04541395
Test hist: 0xFF
RMA#: FF-FF-FF
RMA hist: 0xFF
DIAG: Test count: 0x05000001
Test results: 0x00000000
EEPROM contents (hex):
00: 01 00 01 00 49 00 08 62 06 03 00 00 00 FF FF FF
10: 30 34 35 34 31 33 39 35 FF FF FF FF FF FF FF FF
20: 01 01 00 00 00 00 00 FF FF FF FF FF FF FF FF FF
30: A5 FF A5 A5 A5 A5 FF A5 A5 A5 A5 A5 A5 A5 A5 A5
40: 00 21 01 01 00 49 00 08 E3 03 05 03 00 01 FF FF
50: 03 20 00 09 55 01 01 FF FF FF 00 FF FF FF FF FF
60: 30 34 35 32 39 34 36 35 FF FF FF FF FF FF FF FF
70: FF FF FF FF FF FF FF FF 05 00 00 01 00 00 00 00
MBUS Agent Software version 01.24 (RAM)
Fabric Downloader version 00.0D
Board is analyzed
Flags: 0x4
Board State is Line Card Enabled (IOS RUN)
Insertion time: 00:00:10 (00:04:51 ago)
DRAM size: 33554432 bytes
FrFab SDRAM size: 67108864 bytes
ToFab SDRAM size: 16777216 bytes

Example for an ATM SAR AIM in a Cisco 3660

The following is sample output from the show diag command for one ATM Segmentation and
Reassembly (SAR) AIM in a Cisco 3660 router:
Router# show diag 0
3660 Chassis type: ENTERPRISE
c3600 Backplane EEPROM:
Hardware Revision
: 1.0
Top Assy. Part Number
: 800-04740-02
.
.
.
ATM AIM: 1
ATM AIM module with SAR only (no DSPs)
Hardware Revision
: 1.0
Top Assy. Part Number
: 800-03700-01
Board Revision
: A0
Deviation Number
: 0-0
Fab Version
: 02
PCB Serial Number
: JAB9801ABCD

Example Output from a Cisco 3660 Showing the FRU Number

The following is sample output from the show diag command on a Cisco 3660 router that shows the FRU
numbers for slots 0 and 1:
Router# show diag
3660 Chassis type: ENTERPRISE
3660 Backplane EEPROM:
Hardware Revision
Top Assy. Part Number
Board Revision
Deviation Number
Fab Version
PCB Serial Number
RMA Test History
RMA Number

:
:
:
:
:
:
:
:

1.0
800-04740-02
C0
0-0
02
HAD04471U36
00
0-0-0-0

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-565

Troubleshooting and Fault Management Commands

show diag

RMA History
: 00
Chassis Serial Number
: JAB055180FF
Chassis MAC Address
: 0007.ebea.4460
MAC Address block size
: 112
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Fab Part Number
: 28-2651-02
Number of Slots
: 6
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 00 C8 41 01 00 C0 46 03 20 00 12 84
0x10: 42 43 30 80 00 00 00 00 02 02 C1 8B 48 41 44
0x20: 34 34 37 31 55 33 36 03 00 81 00 00 00 00 04
0x30: C2 8B 4A 41 42 30 35 35 31 38 30 46 46 C3 06
0x40: 07 EB EA 44 60 43 00 70 C4 08 00 00 00 00 00
0x50: 00 00 85 1C 0A 5B 02 01 06 FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF

02
30
00
00
00
FF
FF
FF

C3600 Mother board 2FE(TX) Port adapter, 2 ports

Port adapter is analyzed
Port adapter insertion time unknown
EEPROM contents at hardware discovery:
PCB Serial Number
: JAB05460CSV
Processor type
: 34
Top Assy. Part Number
: 800-04737-04
Board Revision
: C0
Fab Part Number
: 28-3234-02
Deviation Number
: 65535-65535
Manufacturing Test Data : FF FF FF FF FF FF FF FF
RMA Number
: 255-255-255-255
RMA Test History
: FF
RMA History
: FF
Field Diagnostics Data
: FF FF FF FF FF FF FF FF
Product (FRU) Number
: Leopard-2FE
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF C1 8B 4A 41 42 30 35 34 36 30 43 53 56
0x10: 34 40 00 B3 C0 46 03 20 00 12 81 04 42 43 30
0x20: 1C 0C A2 02 80 FF FF FF FF C4 08 FF FF FF FF
0x30: FF FF FF 81 FF FF FF FF 03 FF 04 FF C5 08 FF
0x40: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x50: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF

09
85
FF
FF
FF
FF
FF
00

Slot 0:

Slot 1:
Mueslix-4T Port adapter, 4 ports
Port adapter is analyzed
Port adapter insertion time unknown
EEPROM contents at hardware discovery:
Hardware revision 1.1
Board revision D0
Serial number
17202570
Part number
800-02314-02
FRU Part Number: NM-4T=
Test history
0x0
RMA number
00-00-00
EEPROM format version 1
EEPROM contents (hex):
0x00: 01 54 01 01 01 06 7D 8A 50 09 0A 02 00 00 00 00
0x10: 68 00 00 00 99 11 21 00 00 05 FF FF FF FF FF FF
Router#

Cisco IOS Configuration Fundamentals Command Reference

FR-566

78-11740-02

Troubleshooting and Fault Management Commands

show diag

Example for an NM-AIC-64 Installed in a Cisco 2611

The following is sample output from the show diag command for a Cisco 2611 router with the
NM-AIC-64 installed.
Router# show diag
Slot 0:
C2611 2E Mainboard Port adapter, 2 ports
Port adapter is analyzed
Port adapter insertion time unknown
EEPROM contents at hardware discovery:
Hardware Revision : 2.3
PCB Serial Number : JAD044808SG (1090473337)
Part Number : 73-2840-13
RMA History : 00
RMA Number : 0-0-0-0
Board Revision : C0
Deviation Number : 0-0
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 00 92 41 02 03 C1 18 4A 41 44
0x10: 38 30 38 53 47 20 28 31 30 39 30 34 37
0x20: 37 29 82 49 0B 18 0D 04 00 81 00 00 00
0x30: 30 80 00 00 00 00 FF FF FF FF FF FF FF
0x40: FF FF FF FF FF FF FF FF FF FF FF FF FF
0x50: FF FF FF FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF FF FF

30
33
00
FF
FF
FF
FF
FF

34
33
42
FF
FF
FF
FF
FF

34
33
43
FF
FF
FF
FF
FF

Slot 1:
NM_AIC_64 Port adapter, 3 ports
Port adapter is analyzed
Port adapter insertion time unknown
EEPROM contents at hardware discovery:
Hardware Revision : 1.0
Part Number : 74-1923-01
Board Revision : 02
PCB Serial Number : DAN05060012
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 02 55 41 01 00 82 4A 07
0x10: C1 8B 44 41 4E 30 35 30 36 30 30
0x20: FF FF FF FF FF FF FF FF FF FF FF
0x30: FF FF FF FF FF FF FF FF FF FF FF
0x40: FF FF FF FF FF FF FF FF FF FF FF
0x50: FF FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF

42
FF
FF
FF
FF
FF
FF
FF

30
FF
FF
FF
FF
FF
FF
FF

32
FF
FF
FF
FF
FF
FF
FF

83
31
FF
FF
FF
FF
FF
FF

01
32
FF
FF
FF
FF
FF
FF

Table 69 describes significant fields shown in the display.

Table 69

show diag (AIC) Field Descriptions

Field

Description

C2611 2E Mainboard Port

adapter, 2 ports

Line card type; number of ports available.

Port adapter is analyzed

The system has identified the port adapter.

Port adapter insertion time

Elapsed time since insertion.

Hardware Revision

Version number of the port adapter.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-567

Troubleshooting and Fault Management Commands

show diag

Table 69

show diag (AIC) Field Descriptions

Field

Description

PCB Serial Number

Serial number of the printed circuit board.

Part Number

Part number of the port adapter.

RMA History

Counter that indicates how many times the port adapter has been
returned and repaired.

RMA Number

Return material authorization number, which is an administrative

number assigned if the port adapter needs to be returned for repair.

Board Revision

Revision number (signifying a minor revision) of the port adapter.

Deviation Number

Revision number (signifying a minor deviation) of the port adapter.

EEPROM format version

Version number of the EEPROM format.

EEPROM contents (hex)

Dumps of EEPROM programmed data.

Example for an AIM-VPN in a Cisco 2611XM

The following example shows how to obtain hardware information about an installed AIM-VPN on the
Cisco 2611XM router.
Router# show diag 0
Encryption AIM 1:
Hardware Revision
Top Assy. Part Number
Board Revision
Deviation Number
Fab Version
PCB Serial Number
RMA Test History
RMA Number
RMA History
EEPROM format version 4
EEPROM contents (hex):
0x00:04 FF 40 03 0B 41
0x10:42 41 30 80 00 00
0x20:38 30 31 41 42 43
0x30:FF FF FF FF FF FF
0x40:FF FF FF FF FF FF
0x50:FF FF FF FF FF FF
0x60:FF FF FF FF FF FF
0x70:FF FF FF FF FF FF

:1.0
:800-03700-01
:A0
:0-0
:02
:JAB9801ABCD
:00
:0-0-0-0
:00

01
00
44
FF
FF
FF
FF
FF

00
00
03
FF
FF
FF
FF
FF

C0
02
00
FF
FF
FF
FF
FF

46
02
81
FF
FF
FF
FF
FF

03
C1
00
FF
FF
FF
FF
FF

20
8B
00
FF
FF
FF
FF
FF

00
4A
00
FF
FF
FF
FF
FF

0E
41
00
FF
FF
FF
FF
FF

74
42
04
FF
FF
FF
FF
FF

01
39
00
FF
FF
FF
FF
FF

Cisco IOS Configuration Fundamentals Command Reference

FR-568

78-11740-02

Troubleshooting and Fault Management Commands

show diag

Table 70 describes significant fields shown in the display.

Table 70

show diag (AIM-VPN) Field Descriptions

Field

Description

Hardware Revision

Version number of the port adapter.

Top Assy. Part Number

Part number of the port adapter.

Board Revision

Revision number (signifying a minor revision) of the port adapter.

Deviation Number

Revision number (signifying a minor deviation) of the port adapter.

PCB Serial Number

Serial number of the printed circuit board.

RMA Number

Return material authorization number, which is an administrative

number assigned if the port adapter needs to be returned for repair.

RMA History

Counter that indicates how many times the port adapter has been
returned and repaired.

EEPROM format version

Version number of the EEPROM format.

EEPROM contents (hex)

Dumps of EEPROM programmed data.

Example for an MSC-100 on the Cisco 7304 Router

The following is sample output from the show diag slot-number version of the command for an
MSC-100 located in slot number 4 on a Cisco 7304 router. Information about the MSC is followed by
information for its associated SPAs:
Router# show diag 4
Slot 4:
7304-MSC-100 SPA Carrier Card Line Card
Line Card state: Active
Insertion time: 00:08:49 ago
Bandwidth points: 4000000
EEPROM contents at hardware discovery:
Hardware Revision
: 0.18
Boot Time out
: 0000
PCB Serial Number
: CSJ07288905
Part Number
: 73-8789-01
Board Revision
: A0
Fab Version
: 02
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Deviation Number
: 0-0
Product Number
: 7304-MSC-100
Top Assy. Part Number
: 68-1163-04
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
Calibration Data
: Minimum: 0 dBmV, Maximum:
Calibration values :
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 50 41 00 12 46 00 00 C1 8B 43 53
0x10: 30 37 32 38 38 39 30 35 82 49 22 55 01 42 41
0x20: 02 02 03 00 81 00 00 00 00 04 00 80 00 00 00
0x30: CB 94 37 33 30 34 2D 4D 53 43 2D 31 30 30 20
0x40: 20 20 20 20 20 20 87 44 04 8B 04 C4 08 00 00
0x50: 00 00 00 00 00 C5 08 00 00 00 00 00 00 00 00
0x60: 09 00 00 00 00 00 00 00 00 00 C7 7C F6 44 3F
0x70: 00 00 00 00 00 00 00 00 00 00 00 00 02 EE FF

0 dBmV

4A
30
00
20
00
C8
30
C8

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-569

Troubleshooting and Fault Management Commands

show diag

0x80: C8 37 26 05 DC 64 28 1E 37 26 09 C4 64 32 28 32
0x90: DD 0C E4 64 32 28 43 24 2E E0 AA 82 64 F4 24 00
0xA0: 00 00 00 00 00 00 F0 2E FF FF FF FF FF FF FF FF
0xB0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0xC0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0xD0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0xE0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0xF0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x100: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x110: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x120: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x130: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x140: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x150: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x160: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x170: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x180: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x190: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1A0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1B0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1C0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1D0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1E0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x1F0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
FPGA information:
Current FPGA version
: 00.23
IOS bundled FPGA version : 00.23
CPLD version
: 01.02
Subslot 4/1:
Shared port adapter: SPA-4FE-7304, 4 ports
State: ok
Insertion time: 00:15:13 ago
Bandwidth: 400000 kbps
EEPROM contents:

Examples for Shared Port Adapters on the Cisco 7304 Router

The following is sample output from the show diag subslot command for a 4-Port 10/100 Fast Ethernet
SPA located in the bottom subslot (1) of the MSC that is installed in slot 4 on a Cisco 7304 router:
Router# show diag subslot 4/1
Subslot 4/1:
Shared port adapter: SPA-4FE-7304, 4 ports
Info: hw-ver=0x100, sw-ver=0x0 fpga-ver=0x0
State: ok
Insertion time: 23:20:42 ago
Bandwidth: 400000 kbps
EEPROM contents:
Hardware Revision
: 1.0
Boot Time out
: 0190
PCB Serial Number
: JAB073204G5
Part Number
: 73-8717-03
73/68 Level Revision
: 01
Fab Version
: 02
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Deviation Number
: 0
Product Number
: SPA-4FE-7304
Product Version Id
: V01
Top Assy. Part Number
: 68-2181-01
73/68 Level Revision
: A0
CLEI Code
: CNS9420AAA

Cisco IOS Configuration Fundamentals Command Reference

FR-570

78-11740-02

Troubleshooting and Fault Management Commands

show diag

Base MAC Address

MAC Address block size
Manufacturing Test Data
Field Diagnostics Data
Field Diagnostics Data

:
:
:
:
:

0000.0000.0000
1024
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00
: Minimum: 0 dBmV, Maximum: 0 dBmV
:
: 160000mW max
: 0mW
: 0mW
: 0mW

Calibration Data
Calibration values
Power Consumption
Mode 1
Mode 2
Mode 3
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 35 41 01 00 46 01 90 C1 8B 4A 41 42
0x10: 30 37 33 32 30 34 47 35 82 49 22 0D 03 8A 30 31
0x20: 20 20 02 02 03 00 81 00 00 00 00 04 00 88 00 00
0x30: 00 00 CB 94 53 50 41 2D 34 46 45 2D 37 33 30 34
0x40: 20 20 20 20 20 20 20 20 89 56 30 31 20 87 44 08
0x50: 85 01 8A 41 30 20 20 C6 8A 43 4E 53 39 34 32 30
0x60: 41 41 41 CF 06 00 00 00 00 00 00 43 04 00 C4 08
0x70: 00 00 00 00 00 00 00 00 C5 08 00 00 00 00 00 00
0x80: 00 00 F4 00 64 00 00 00 00 00 00 00 00 00 00 00
0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xA0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xB0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xC0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xD0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xE0: 00 00 00 00 00 00 00 00 00 C8 09 00 00 00 00 00
0xF0: 00 00 00 00 D7 08 3E 80 00 00 00 00 00 00 F3 00
0x100: 41 01 08 F6 48 43 34 F6 49 44 35 02 31 04 B0 B4
0x110: A0 8C 00 00 05 DC 64 46 32 00 00 07 08 64 46 32
0x120: 00 00 09 C4 64 46 32 00 00 0C E4 64 46 32 00 00
0x130: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 FE 02
0x140: F2 A6 FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x150: CC A0 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x160: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x170: 00 00 D4 A0 00 00 00 00 00 00 00 00 00 00 00 00
0x180: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x190: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
FPGA version:
Software version : 04.17
Hardware version : 04.17

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-571

Troubleshooting and Fault Management Commands

show diag

The following is sample output from the show diag subslot command for a 2-Port 10/100/1000 Gigabit
Ethernet SPA located in the top subslot (0) of the MSC that is installed in slot 4 on a Cisco 7304 router:
Router# show diag subslot 4/0
Subslot 4/0:
Shared port adapter: SPA-2GE-7304, 2 ports
Info: hw-ver=0x17, sw-ver=0x0 fpga-ver=0x0
State: ok
Insertion time: 00:08:47 ago
Bandwidth: 2000000 kbps
EEPROM contents:
Hardware Revision
: 0.23
Boot Time out
: 0190
PCB Serial Number
: JAB073406YH
Part Number
: 73-8792-02
73/68 Level Revision
: 01
Fab Version
: 02
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Deviation Number
: 0
Product Number
: SPA-2GE-7304
Product Version Id
: V01
Top Assy. Part Number
: 68-2181-01
73/68 Level Revision
: A0
CLEI Code
: CNS9420AAA
Base MAC Address
: 0000.0000.0000
MAC Address block size
: 1024
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00
Calibration Data
: Minimum: 0 dBmV, Maximum:
Calibration values :
Power Consumption
: 160000mW max
Mode 1 : 0mW
Mode 2 : 0mW
Mode 3 : 0mW
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 36 41 00 17 46 01 90 C1 8B 4A 41
0x10: 30 37 33 34 30 36 59 48 82 49 22 58 02 8A 30
0x20: 20 20 02 02 03 00 81 00 00 00 00 04 00 88 00
0x30: 00 00 CB 94 53 50 41 2D 32 47 45 2D 37 33 30
0x40: 20 20 20 20 20 20 20 20 89 56 30 31 20 87 44
0x50: 85 01 8A 41 30 20 20 C6 8A 43 4E 53 39 34 32
0x60: 41 41 41 CF 06 00 00 00 00 00 00 43 04 00 C4
0x70: 00 00 00 00 00 00 00 00 C5 08 00 00 00 00 00
0x80: 00 00 F4 00 64 00 00 00 00 00 00 00 00 00 00
0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xA0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xB0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xC0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00

0 dBmV

42
31
00
34
08
30
08
00
00
00
00
00
00

Cisco IOS Configuration Fundamentals Command Reference

FR-572

78-11740-02

Troubleshooting and Fault Management Commands

show diag

0xD0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0xE0: 00 00 00 00 00 00 00 00 00 C8 09 00 00 00 00 00
0xF0: 00 00 00 00 D7 08 3E 80 00 00 00 00 00 00 F3 00
0x100: 41 01 08 F6 48 43 34 F6 49 44 35 02 31 03 E8 B4
0x110: A0 8C 37 26 05 DC 64 46 32 37 26 07 08 64 46 32
0x120: 37 26 09 C4 64 46 32 32 DD 0C E4 64 46 32 43 24
0x130: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 FE 02
0x140: EF E2 FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x150: CC A0 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x160: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x170: 00 00 D4 A0 00 00 00 00 00 00 00 00 00 00 00 00
0x180: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x190: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
0x1F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
FPGA version:
Software version : 04.17
Hardware version : 04.17

Examples for a Shared Port Adapter on a Cisco 12000 Series Router

The following is sample output from the show diag subslot command for the 1-Port OC-192c/STM-64c
POS/RPR XFP SPA in subslot 1 of the SIP located in chassis slot 1 on a Cisco 12000 series router:
Router# show diag subslot 1/1
SUBSLOT 1/1 (SPA-OC192POS-XFP): 1-port OC192/STM64 POS/RPR XFP Optics Shared Port Adapter
Product Identifier (PID) : SPA-OC192POS-XFP
Version Identifier (VID) : V01
PCB Serial Number
: PRTA1304061
Top Assy. Part Number
: 68-2190-01
Top Assy. Revision
: A0
Hardware Revision
: 2.0
CLEI Code
: UNASSIGNED
Insertion Time
: 00:00:10 (13:14:17 ago)
Operational Status
: ok

Table 71 describes the significant fields shown in the display.

Table 71

show diag subslot Field Descriptions

Field

Description

Product Identifier (PID)

Product number of the SPA.

Version Identifier (VID)

Version number of the SPA.

PCB Serial Number

Serial number of the printed circuit board.

Top Assy. Part Number

Part number of the SPA.

Top Assy. Revision

Revision number (signifying a minor revision) of the SPA.

Hardware Revision

Revision number (signifying a minor revision) of the SPA hardware.

CLEI Code

Common Language Equipment Identification number.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-573

Troubleshooting and Fault Management Commands

show diag

Table 71

show diag subslot Field Descriptions (continued)

Field

Description

Insertion Time

Time when the SPA was installed, and elapsed time between that
insertion time and the current time.

Operational Status

Current status of the SPA. For more information about the status
field descriptions, refer to the show hw-module subslot oir
command.

The following is sample output from the show diag subslot details command for the 1-Port
OC-192c/STM-64c POS/RPR XFP SPA in subslot 1 of the SIP located in chassis slot 1 on a Cisco 12000
series router:
Router# show diag subslot 1/1 details
SUBSLOT 1/1 (SPA-OC192POS-XFP): 1-port OC192/STM64 POS/RPR XFP Optics Shared Port Adapter
EEPROM version
: 4
Compatible Type
: 0xFF
Controller Type
: 1100
Hardware Revision
: 2.0
Boot Timeout
: 400 msecs
PCB Serial Number
: PRTA1304061
PCB Part Number
: 73-8546-01
PCB Revision
: A0
Fab Version
: 01
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Deviation Number
: 0
Product Identifier (PID) : SPA-OC192POS-XFP
Version Identifier (VID) : V01
Top Assy. Part Number
: 68-2190-01
Top Assy. Revision
: A0
IDPROM Format Revision
: 36
System Clock Frequency
: 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00
CLEI Code
: UNASSIGNED
Base MAC Address
: 00 00 00 00 00 00
MAC Address block size
: 0
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
Calibration Data
: Minimum: 0 dBmV, Maximum: 0 dBmV
Calibration values :
Power Consumption
: 11000 mWatts (Maximum)
Environment Monitor Data : 03 30 04 B0 46 32 07 08
46 32 09 C4 46 32 0C E4
46 32 13 88 46 32 07 08
46 32 EB B0 50 3C 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 FE 02 F6 AC
Processor Label
: 00 00 00 00 00 00 00
Platform features
: 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00
Asset ID
:
Asset Alias
:
Insertion Time
: 00:00:10 (13:14:24 ago)
Operational Status
: ok

Cisco IOS Configuration Fundamentals Command Reference

FR-574

78-11740-02

Troubleshooting and Fault Management Commands

show diag

Example for a SPA Interface Processor on a Cisco 12000 Series Router

The following is sample output from the show diag command for a SIP located in chassis slot 2 on a
Cisco 12000 series router:
Router# show diag 2
SLOT 2 (RP/LC 2 ): Modular 10G SPA Interface Card
MAIN: type 149, 800-26270-01 rev 84
Deviation: 0
HW config: 0x00
SW key: 00-00-00
PCA: 73-9607-01 rev 91 ver 1
Design Release 1.0 S/N SAD08460678
MBUS: Embedded Agent
Test hist: 0x00
RMA#: 00-00-00
RMA hist: 0x00
DIAG: Test count: 0x00000000
Test results: 0x00000000
FRU: Linecard/Module: 12000-SIP-650
FRU: Linecard/Module: 12000-SIP-650
Processor Memory: MEM-LC5-1024=(Non-Replaceable)
Packet Memory: MEM-LC5-PKT-256=(Non-Replaceable)
L3 Engine: 5 - ISE OC192 (10 Gbps)
MBUS Agent Software version 1.114 (RAM) (ROM version is 3.4)
ROM Monitor version 255.255
Fabric Downloader version used 3.7 (ROM version is 255.255)
Primary clock is CSC 1
Board is analyzed
Board State is Line Card Enabled (IOS RUN )
Insertion time: 1d00h (2d08h ago)
Processor Memory size: 1073741824 bytes
TX Packet Memory size: 268435456 bytes, Packet Memory pagesize: 32768 bytes
RX Packet Memory size: 268435456 bytes, Packet Memory pagesize: 32768 bytes
0 crashes since restart
SPA Information:
subslot 2/0:
subslot 2/1:
subslot 2/2:
subslot 2/3:

SPA-OC192POS-XFP (0x44C), status is ok

Empty
Empty
Empty

Example for ADSL HWICs

The following is sample output from the show diag command for a Cisco 2811 router with
HWIC-1ADSL installed in slot 1 and HWIC-1ADSLI installed in slot 2. Each HWIC has a daughtercard
as part of its assembly. The command results below give the output from the HWIC followed by the
output from its daughtercard.
Router# show diag 0
Slot 0:
C2811 Motherboard with 2FE and integrated VPN Port adapter, 2 ports
Port adapter is analyzed
Port adapter insertion time unknown
Onboard VPN
: v2.2.0
EEPROM contents at hardware discovery:
PCB Serial Number
: FOC09052HHA
Hardware Revision
: 2.0
Top Assy. Part Number
: 800-21849-02
Board Revision
: B0
Deviation Number
: 0
Fab Version
: 06
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Processor type
: 87

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-575

Troubleshooting and Fault Management Commands

show diag

Hardware date code

: 20050205
Chassis Serial Number
: FTX0908A0B0
Chassis MAC Address
: 0013.1ac2.2848
MAC Address block size
: 24
CLEI Code
: CNMJ7N0BRA
Product (FRU) Number
: CISCO2811
Part Number
: 73-7214-09
Version Identifier
:
NA
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF C1 8B 46 4F 43 30 39 30 35 32
0x10: 03 E7 41 02 00 C0 46 03 20 00 55 59
0x20: 88 00 00 00 00 02 06 03 00 81 00 00
0x30: 09 87 83 01 31 F1 1D C2 8B 46 54 58
0x40: 41 30 42 30 C3 06 00 13 1A C2 28 48
0x50: 8A 43 4E 4D 4A 37 4E 30 42 52 41 CB
0x60: 43 4F 32 38 31 31 20 20 20 20 20 20
0x70: 09 89 20 20 4E 41 D9 02 40 C1 FF FF
WIC Slot 1:
ADSL over POTS
Hardware Revision
: 7.0
Top Assy. Part Number
: 800-26247-01
Board Revision
: 01
Deviation Number
: 0
Fab Version
: 07
PCB Serial Number
: FHH093600D4
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Product (FRU) Number
: HWIC-1ADSL
Version Identifier
: V01
CLEI Code
:
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 C8 41 07 00 C0 46 03
0x10: 42 30 31 88 00 00 00 00 02 07 C1
0x20: 39 33 36 30 30 44 34 03 00 81 00
0x30: CB 94 48 57 49 43 2D 31 41 44 53
0x40: 20 20 20 20 20 20 89 56 30 31 20
0x50: 8A FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF

20
8B
00
4C
D9
FF
FF
FF

48
02
00
30
43
8F
82
FF

48
42
00
39
00
43
49
FF

41
42
04
30
18
49
1C
FF

40
30
00
38
C6
53
2E
FF

00
46
00
20
02
FF
FF
FF

66
48
00
20
40
FF
FF
FF

87
48
04
20
C1
FF
FF
FF

01
30
00
20
C6
FF
FF
FF

EM Slot 0:
ADSL over POTS non-removable daughtercard
Hardware Revision
: 5.0
Part Number
: 73-9307-05
Board Revision
: 03
Deviation Number
: 0
Fab Version
: 05
PCB Serial Number
: FHH0936006E
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Fab Part Number
: 28-6607-05
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
Connector Type
: 01
Version Identifier
: V01
Product (FRU) Number
:
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 7A 41 05 00 82 49 24 5B 05 42 30 33

Cisco IOS Configuration Fundamentals Command Reference

FR-576

78-11740-02

Troubleshooting and Fault Management Commands

show diag

0x10:
0x20:
0x30:
0x40:
0x50:
0x60:
0x70:

88
30
CF
00
FF
FF
FF

00
30
05
00
FF
FF
FF

00
36
C4
00
FF
FF
FF

00
45
08
00
FF
FF
FF

00
03
00
00
FF
FF
FF

02
00
00
00
FF
FF
FF

05
81
00
05
FF
FF
FF

C1
00
00
01
FF
FF
FF

8B
00
00
89
FF
FF
FF

46
00
00
56
FF
FF
FF

48
00
00
30
FF
FF
FF

48
04
00
31
FF
FF
FF

30
00
C5
20
FF
FF
FF

39
85
08
FF
FF
FF
FF

33
1C
00
FF
FF
FF
FF

36
19
00
FF
FF
FF
FF

WIC Slot 2:
ADSL over ISDN
Hardware Revision
: 7.0
Top Assy. Part Number
: 800-26248-01
Board Revision
: 01
Deviation Number
: 0
Fab Version
: 07
PCB Serial Number
: FHH093600DA
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Product (FRU) Number
: HWIC-1ADSLI
Version Identifier
: V01
CLEI Code
:
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 C9 41 07 00 C0 46 03
0x10: 42 30 31 88 00 00 00 00 02 07 C1
0x20: 39 33 36 30 30 44 41 03 00 81 00
0x30: CB 94 48 57 49 43 2D 31 41 44 53
0x40: 20 20 20 20 20 20 89 56 30 31 20
0x50: 8A FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF

20
8B
00
4C
D9
FF
FF
FF

00
46
00
49
02
FF
FF
FF

66
48
00
20
40
FF
FF
FF

88
48
04
20
C1
FF
FF
FF

01
30
00
20
C6
FF
FF
FF

EM Slot 0:
ADSL over ISDN non-removable daughtercard
Hardware Revision
: 5.0
Part Number
: 73-9308-05
Board Revision
: 03
Deviation Number
: 0
Fab Version
: 05
PCB Serial Number
: FHH0936008M
RMA Test History
: 00
RMA Number
: 0-0-0-0
RMA History
: 00
Fab Part Number
: 28-6607-05
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Field Diagnostics Data
: 00 00 00 00 00 00 00 00
Connector Type
: 01
Version Identifier
: V01
Product (FRU) Number
:
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 04 7B 41 05 00 82 49 24 5C 05 42 30
0x10: 88 00 00 00 00 02 05 C1 8B 46 48 48 30 39 33
0x20: 30 30 38 4D 03 00 81 00 00 00 00 04 00 85 1C
0x30: CF 05 C4 08 00 00 00 00 00 00 00 00 C5 08 00
0x40: 00 00 00 00 00 00 05 01 89 56 30 31 20 FF FF
0x50: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF

33
36
19
00
FF
FF
FF
FF

The following sample output from a Cisco 6500 series switch shows the FRU number:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-577

Troubleshooting and Fault Management Commands

show diag

Router# show diag

Slot 4: Logical_index 8
2 port adapter FlexWAN controller
Board is analyzed ipc ready
HW rev 1.5, board revision A0
Serial Number: SAD062404C8 Part number: 73-3869-08
Slot database information:
Flags: 0x2004
Insertion time: 0x20960 (1d04h ago)
Controller Memory Size:
112 MBytes CPU Memory
16 MBytes Packet Memory
128 MBytes Total on Board SDRAM
IOS (tm) cwlc Software (cwpa-DW-M), Version 12.2(18)SXF2, RELEASE SOFTW)
PA Bay 0 Information:
ENHANCED ATM OC3 MM PA, 1 ports, FRU: PA-A3-OC3-MM
EEPROM format version 1
HW rev 2.00, Board revision A0
Serial number: 29360940 Part number: 73-2430-04
Slot 4: Logical_index 9
2 port adapter FlexWAN controller
Board is analyzed ipc ready
HW rev 1.5, board revision A0
Serial Number: SAD062404C8 Part number: 73-3869-08
Slot database information:
Flags: 0x2004
Insertion time: 0x20D10 (1d04h ago)
Controller Memory Size:
112 MBytes CPU Memory
16 MBytes Packet Memory
128 MBytes Total on Board SDRAM
IOS (tm) cwlc Software (cwpa-DW-M), Version 12.2(18)SXF2, RELEASE SOFTW)
PA Bay 1 Information:
Mx Serial PA, 4 ports
EEPROM format version 1
HW rev 1.00, Board revision A0
Serial number: 04387628 Part number: 73-1577-04
Router#

The following sample output from a Cisco 7600 series router shows the FRU number:
Router#show diag
Slot 2: Logical_index 4
2 port adapter Enhanced FlexWAN controller
Board is analyzed ipc ready
HW rev 2.1, board revision A0
Serial Number: JAE0940MH7Z Part number: 73-9539-04
Slot database information:
Flags: 0x2004
Insertion time: 0x256BC (1d01h ago)
Controller Memory Size:
384 MBytes CPU Memory
127 MBytes Packet Memory
511 MBytes Total on Board SDRAM
IOS (tm) cwlc Software (cwpa2-DW-M), Version 12.2(18)SXF2, RELEASE SOFT)
PA Bay 0 Information:

Cisco IOS Configuration Fundamentals Command Reference

FR-578

78-11740-02

Troubleshooting and Fault Management Commands

show diag

ENHANCED ATM OC3 MM PA, 1 ports, FRU: PA-A3-OC3-MM

EEPROM format version 4
HW rev 2.00, Board revision A0
Serial number: JAE0937KUPX Part number: 73-8728-01
Slot 2: Logical_index 5
2 port adapter Enhanced FlexWAN controller
Board is analyzed ipc ready
HW rev 2.1, board revision A0
Serial Number: JAE0940MH7Z Part number: 73-9539-04
Slot database information:
Flags: 0x2004
Insertion time: 0x22C34 (1d01h ago)
Controller Memory Size:
384 MBytes CPU Memory
127 MBytes Packet Memory
511 MBytes Total on Board SDRAM
IOS (tm) cwlc Software (cwpa2-DW-M), Version 12.2(18)SXF2, RELEASE SOFT)
PA Bay 1 Information:
Mx Serial PA, 4 ports
EEPROM format version 1
HW rev 1.14, Board revision D0
Serial number: 33929508 Part number: 73-1577-07
Router#

Related Commands

Command

Description

dsl operating-mode (ADSL)

Modifies the operating mode of the digital subscriber line for an

ATM interface.

show dsl interface atm

Shows all of the ADSL-specific information for a specified ATM

interface.

show controllers fastethernet

Displays Fast Ethernet interface information, transmission statistics

and errors, and applicable MAC destination address and VLAN
filtering tables.

show controllers
gigabitethernet

Displays Gigabit Ethernet interface information, transmission

statistics and errors, and applicable MAC destination address and
VLAN filtering tables.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-579

Troubleshooting and Fault Management Commands

show disk0:

show disk0:
To display flash or file system information for a disk located in slot 0, use the show disk command in
user EXEC or privileged EXEC mode.
show disk0: [all | filesys]

Syntax Description

all

(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.

filesys

(Optional) Displays the device information block, the status information,

and the usage information.

Command Modes

User EXEC
Privileged EXEC

Command History

Release

Modification

11.3AA

This command was introduced.

12.2

This command was incorporated into Cisco IOS Release 12.2.

12.3(7)T

This command was enhanced to display information about the ATA ROM
monitor library (monlib) file.

12.2(25)S

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

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:
http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751
5.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.

Cisco IOS Configuration Fundamentals Command Reference

FR-580

78-11740-02

Troubleshooting and Fault Management Commands

show disk0:

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:
Number of Cylinders
Sectors per Cylinder
Sector Size
Total Sectors

4
984
32
512
125952

ATA CARD FORMAT

Number of FAT Sectors
Sectors Per Cluster
Number of Clusters
Number of Data Sectors
Base Root Sector
Base FAT Sector
Base Data Sector

62
8
15693
125812
232
108
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:
Number of Cylinders
Sectors per Cylinder
Sector Size
Total Sectors

4
984
32
512
125952

ATA CARD FORMAT

Number of FAT Sectors
Sectors Per Cluster
Number of Clusters
Number of Data Sectors
Base Root Sector

62
8
15693
125812
232

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-581

Troubleshooting and Fault Management Commands

show disk0:

Base FAT Sector

Base Data Sector

108
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

Related Commands

Command

Description

dir disk0:

Displays a directory listing of files on an ATA PCMCIA flash disk card

located in slot 0.

dir disk1:

Displays a directory listing of files on an ATA PCMCIA flash disk card

located in slot 1.

show disk1:

Displays flash or file system information for a disk located in slot 1.

Cisco IOS Configuration Fundamentals Command Reference

FR-582

78-11740-02

Troubleshooting and Fault Management Commands

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

(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.

filesys

(Optional) Displays the device information block, the status information,

and the usage information.

Command Modes

User EXEC
Privileged EXEC

Command History

Release

Modification

11.3AA

This command was introduced.

12.2

This command was incorporated into Cisco IOS Release 12.2.

12.3(7)T

This command was enhanced to display information about the ATA ROM
monitor library (monlib) file.

12.2(25)S

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

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:
http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751
5.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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-583

Troubleshooting and Fault Management Commands

show disk1:

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:
Number of Cylinders
Sectors per Cylinder
Sector Size
Total Sectors

4
984
32
512
125952

ATA CARD FORMAT

Number of FAT Sectors
Sectors Per Cluster
Number of Clusters
Number of Data Sectors
Base Root Sector
Base FAT Sector
Base Data Sector

62
8
15693
125812
232
108
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:
Number of Cylinders
Sectors per Cylinder
Sector Size
Total Sectors

4
984
32
512
125952

ATA CARD FORMAT

Number of FAT Sectors
Sectors Per Cluster
Number of Clusters
Number of Data Sectors
Base Root Sector

62
8
15693
125812
232

Cisco IOS Configuration Fundamentals Command Reference

FR-584

78-11740-02

Troubleshooting and Fault Management Commands

show disk1:

Base FAT Sector

Base Data Sector

108
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

Related Commands

Command

Description

dir disk0:

Displays a directory listing of files on an ATA PCMCIA flash disk card

located in slot 0.

dir disk1:

Displays a directory listing of files on an ATA PCMCIA flash disk card

located in slot 1.

show disk0:

Displays flash or file system information for a disk located in slot 0.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-585

Troubleshooting and Fault Management Commands

show environment

show environment
To display temperature, voltage, and blower information on the Cisco 7000 series, Cisco 7200 series,
Cisco 7500 series routers, Cisco AS5300 series Access Servers, and Cisco 12000 series Gigabit Switch
Routers (GSRs), use the show environment privileged EXEC command.
show environment [alarms | all | fans | hardware | last | leds | power-supply | table |
temperatures | voltages]

Note

Syntax Description

The availability of keywords will depend on your system.

alarms

(Optional) Displays the alarm contact information.

all

(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.

fans

(Optional) Displays blower and fan information.

hardware

(Optional) Displays hardware-specific information.

last

(Optional) Displays information on the last measurement made.

leds

(Optional) Displays the status of the MBus LEDs on the clock and scheduler
cards and switch fabric cards.

power-supply

(Optional) Displays power supply voltage and current information. If

applicable, displays the status of the Redundant Power Supply (RPS).

table

(Optional) Displays the temperature, voltage, and blower ranges and

thresholds.

temperature

(Optional) Displays temperature information.

voltages

(Optional) Displays voltage information.

Defaults

If no options are specified, the default is all.

Command Modes

Privileged EXEC

CommandHistory

Release

Modification

10.0

This command was introduced.

11.2 GS

The alarms, fans, hardware, leds, power-supply, table temperature, and

voltages keywords were added for Cisco 12000 series GSRs.

11.3(6)AA

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 routers.

Cisco IOS Configuration Fundamentals Command Reference

FR-586

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Usage Guidelines

Once a minute a routine is run that gets environmental measurements from sensors and stores the output
into a buffer. This buffer is displayed on the console when the show environment command is entered.
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.
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.
If the Cisco 12000 series 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

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 overtemperature
condition is detected by Cisco IOS software.
CISCO-ACCESS-ENVMON-MIB also defines an overvoltage 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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-587

Troubleshooting and Fault Management Commands

show environment

Examples

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

Table 72 describes the significant fields shown in the display.

Table 72

show environment Field Descriptions

Field

Description

Environmental status as of...

Current date and time.

Data is..., refresh in...

Environmental measurements are output into a buffer every

60 seconds, unless other higher-priority processes are running.

Status message

If environmental measurements are not within specification,

warning messages are displayed.

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
+5
-12
+24

volts
volts
volts
volts

measured
measured
measured
measured

at 12.05(V)
at
4.96(V)
at -12.05(V)
at 23.80(V)

Airflow temperature measured at 38(C)

Inlet temperature measured at 25(C)

Cisco IOS Configuration Fundamentals Command Reference

FR-588

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Table 73 describes the significant fields shown in the display.

Table 73

show environment all Field Descriptions for the Cisco 7000

Field

Description

Environmental status as of...

Date and time of last query.

Data is..., refresh in...

Environmental measurements are output into a buffer every 60

seconds, unless other higher-priority processes are running.

WARNING:

If environmental measurements are not within specification,

warning messages are displayed.

Lower Power Supply

Type of power supply installed and its status (On or Off).

Upper Power Supply

Type of power supply installed and its status (On or Off).

Intermittent Powerfail(s)

Number of power hits (not resulting in shutdown) since the

system was last booted.

voltage specifications

System voltage measurements.

Airflow and inlet temperature

Temperature of air coming in and going out.

The following example is for the Cisco 7000 series router. 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
+5
-12
+24

volts
volts
volts
volts

measured
measured
measured
measured

at 12.05(V)
at
4.98(V)
at -12.00(V)
at 23.80(V)

Airflow temperature measured at 30(C)

Inlet temperature measured at 23(C)

Table 74 describes the significant fields shown in the display.

Table 74

show environment last Field Descriptions for the Cisco 7000

Field

Description

Environmental status as of...

Current date and time.

Data is..., refresh in...

Environmental measurements are output into a buffer every

60 seconds, unless other higher-priority processes are running.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-589

Troubleshooting and Fault Management Commands

show environment

Table 74

show environment last Field Descriptions for the Cisco 7000 (continued)

Field

Description

WARNING:

If environmental measurements are not within specification,

warning messages are displayed.

LAST Environmental Statistics

Displays test point values at time of the last environmental

shutdown.

Lower Power Supply:

For the Cisco 7000 router, indicates the status of the

two 700W power supplies.

Upper Power Supply:

For the Cisco 7010 router, indicates the status of the

single 600W power supply.
In 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)
+5(V)
-12(V)
+24(V)

10.20
4.74
-10.20
20.00

12.05(V)
4.98(V)
-12.05(V)
24.00(V)

13.80
5.26
-13.80
28.00

Temperature Parameters:
SENSE
WARNING
NORMAL
WARNING
CRITICAL
SHUTDOWN
-------|-------------|------------|-------------|--------------|----------Airflow
Inlet

10
10

60
39

41(C)

70
46

73(C)

88
64

Table 75 describes the significant fields shown in the display.

Table 75

show environment Field Descriptions for the Cisco 7000 Series Router

Field

Description

SENSE (Voltage Parameters)

Voltage specification for a DC line.

SENSE (Temperature
Parameters)

Air being measured. Inlet measures the air coming in, and Airflow
measures the temperature of the air inside the chassis.

WARNING

System is approaching an out-of-tolerance condition.

Cisco IOS Configuration Fundamentals Command Reference

FR-590

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Table 75

show environment Field Descriptions for the Cisco 7000 (continued)Series Router

Field

Description

NORMAL

All monitored conditions meet normal requirements.

CRITICAL

Out-of-tolerance condition exists.

SHUTDOWN

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
router when there is a voltage warning condition in the system:
7200# show environment all
Power Supplies:
Power supply 1 is unknown. Unit is off.
Power supply 2 is Zytek AC Power Supply. Unit is on.
Temperature readings:
chassis inlet
chassis outlet 1
chassis outlet 2
chassis outlet 3
Voltage readings:
+3.45 V measured
+5.15 V measured
+12.15 measured
-11.95 measured

measured
measured
measured
measured
at
at
at
at

at
at
at
at

25C/77F
29C/84F
36C/96F
44C/111F

+3.83 V:Voltage in Warning range!

+5.09 V
+12.42 V
-12.10 V

Table 76 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-591

Troubleshooting and Fault Management Commands

show environment

Table 76

show environment all Field Descriptions for the Cisco 7200 Series Router

Field

Description

Power Supplies:

Current condition of the power supplies including the type and

whether the power supply is on or off.

Temperature readings:

Current measurements of the chassis temperature at the inlet and

outlet locations.

Voltage readings:

Current measurement of the power supply test points.

The following example is for the Cisco 7200 series router. This example shows the measurements
immediately before the last shutdown and the reason for the last shutdown (if appropriate).
7200# show environment last
chassis
chassis
chassis
chassis
+3.3 V
+5.0 V
+12.0 V
-12.0 V

inlet
outlet 1
outlet 2
outlet 3

previously
previously
previously
previously
previously
previously
previously
previously

measured
measured
measured
measured
measured
measured
measured
measured

at
at
at
at
at
at
at
at

27C/80F
31C/87F
37C/98F
45C/113F
4.02
4.92
12.65
11.71

last shutdown reason - power supply shutdown

Table 77 describes the significant fields shown in the display.

Table 77

show environment last Field Descriptions for the Cisco 7200 Series Router

Field

Description

chassis inlet

Temperature measurements at the inlet area of the chassis.

chassis outlet

Temperature measurements at the outlet areas of the chassis.

voltages

Power supply test point measurements.

last shutdown reason

Possible shutdown reasons are power supply shutdown, critical

temperature, and critical voltage.

The following example is for the Cisco 7200 series router. This information lists the temperature and
voltage shutdown thresholds for each sensor.
7200# show environment table
Sample Point
LowCritical
chassis inlet
chassis outlet 1
chassis outlet 2
chassis outlet 3
+3.45 V
+2.76
+5.15 V
+4.10
+12.15 V
+9.72
-11.95 V
-8.37
Shutdown system at 70C/158F

LowWarning

+3.10
+4.61
+10.91
-9.57

HighWarning
40C/104F
43C/109F
75C/167F
55C/131F
+3.80
+5.67
+13.37
-14.34

HighCritical
50C/122F
53C/127F
75C/167F
65C/149F
+4.14
+6.17
+14.60
-15.53

Table 78 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

FR-592

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Table 78

show environment table Field Descriptions for the Cisco 7200 Series Router

Field

Description

Sample Point

Area for which measurements are taken.

LowCritical

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.

LowWarning

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.

HighWarning

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.

HighCritical

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.

Shutdown system at

The system is shut down if the specified temperature is met.

Cisco 7500 Series Router

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 router:
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
15 of 15 soft shutdowns remaining before hard shutdown

Dbus slots:
card
RSP(6)
RSP(7)

1
0123456789012
X
XX
X
inlet
35C/95F
35C/95F

hotpoint
47C/116F
43C/109F

exhaust
40C/104F
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
PS1
PS1
PS1

+5V Current
+12V Current
-12V Current
output is 378 W

measured at 59.61 A (capacity 200 A)

measured at 5.08 A (capacity 35 A)
measured at 0.42 A (capacity 3 A)

Table 79 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-593

Troubleshooting and Fault Management Commands

show environment

Table 79

show environment all Field Descriptions for the Cisco 7500

Field

Description

Arbiter type 1

Numbers indicating the arbiter type and backplane type.

Power supply

Number and type of power supply installed in the chassis.

Active fault conditions:

Lists any fault conditions that exist (such as power supply

failure, fan failure, and temperature too high).

Fan transfer point:

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.

Active trip points:

Compares temperature sensor against the values displayed at the

bottom of the show environment table command output.

15 of 15 soft shutdowns remaining 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.
Dbus slots:

Indicates which chassis slots are occupied.

card, inlet, hotpoint, exhaust

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.

Shutdown temperature source

Indicates which of the three temperature sources is selected for

comparison against the shutdown levels listed with the
show environment table command.

Voltages (+12V, +5V, -12V, +24V,

+2.5)

Voltages measured on the backplane.

PS1

Current measured on the power supply.

The following example is for the Cisco 7500 series router. This example shows the measurements
immediately before the last shutdown.
7500# show environment last
RSP(4) Inlet
RSP(4) Hotpoint
RSP(4) Exhaust
+12 Voltage
+5 Voltage
-12 Voltage
+24 Voltage

previously
previously
previously
previously
previously
previously
previously

measured
measured
measured
measured
measured
measured
measured

at
at
at
at
at
at
at

37C/98F
46C/114F
52C/125F
12.26
5.17
-12.03
23.78

Table 80 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

FR-594

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Table 80

show environment last Field Descriptions for the Cisco 7500 Series Router

Field

Description

RSP(4) Inlet, Hotpoint, Exhaust

Temperature measurements at the inlet, hotpoint, and exhaust

areas of the card.

Voltages

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 system messages occur. There are
two level of messages: warning and critical.
7500# show environment table
Sample Point
LowCritical
LowWarning
RSP(4) Inlet
RSP(4) Hotpoint
RSP(4) Exhaust
+12 Voltage
10.90
11.61
+5 Voltage
4.61
4.94
-12 Voltage
-10.15
-10.76
+24 Voltage
20.38
21.51
2.5 Reference
2.43
Shutdown boards at
70C/158F
Shutdown power supplies at
76C/168F
Restart after shutdown below 40C/104F

HighWarning
44C/111F
54C/129F

HighCritical
50C/122F
60C/140F

12.82
5.46
-13.25
26.42
2.51

13.38
5.70
-13.86
27.65

Table 81 describes the significant fields shown in the display.

Table 81

show environment table Field Descriptions for the Cisco 7500 Series Router

Field

Description

Sample Point

Area for which measurements are taken.

LowCritical

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.

LowWarning

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.

HighWarning

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.

HighCritical

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.

Shutdown boards at

The card is shut down if the specified temperature is met.

Shutdown power supplies at

The system is shut down if the specified temperature is met.

Restart after shutdown

The system will restart when the specified temperature is met.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-595

Troubleshooting and Fault Management Commands

show environment

Cisco AS5300 Series Access Servers

In the following example, how keywords and options are limited according to the physical
characteristics of the system is shown:
as5300# show environment ?
all
last
table
|
<cr>

All environmental monitor parameters

Last environmental monitor parameters
Temperature and voltage ranges
Output modifiers

as5300# show environment table

%This option not available on this platform

Cisco 12000 Series GSR

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 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 #
0
2
4
7
9
11
16
17
18
19
20
24
26
28
29
Slot #
24
26
Slot #
28
29
Router#

3V
(mv)
3300
3296
3280
3280
3292
3288
3308
3292
3304
3300
3304
NA
NA
NA
NA

5V
(mv)
4992
4976
4992
4984
4968
4992
NA
NA
NA
NA
NA
5536
5544
NA
NA

48V
(Volt)
46
46

AMP_48
(Amp)
12
19

Fan 0
(RPM)
2160
2130

Fan 1
(RPM)
2190
2190

MBUS 5V Hot Sensor

(mv)
(deg C)
5040
42.0
5136
40.0
5120
38.5
5136
42.0
5160
39.5
5152
40.0
5056
42.5
5056
40.5
5176
36.5
5184
37.5
5168
36.5
5120
NA
5128
NA
5128
NA
5104
NA

Inlet Sensor
(deg C)
37.0
33.0
31.5
32.0
31.5
30.5
38.0
36.5
35.0
33.5
34.0
31.5
31.5
NA
NA

Fan 2
(RPM)
2160
2070

Table 82 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 again.

Cisco IOS Configuration Fundamentals Command Reference

FR-596

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Table 82

show environment Field Descriptions for the Cisco 12000 Series Routers

Field

Description

Slot #

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.

3V (mv)

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.

5V (mv)

Measures the 5v power supply on the card. The 5v power supply is on the line
cards, GRP card, and power supplies.

MBUS 5V (mv)

Measures the 5v MBus on the card. The 5v MBus is on all equipment.

Hot Sensor (deg C)

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.

Inlet Sensor (deg C) 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.
48V (Volt)

Measures the DC power supplies.

AMP_48 (Amp)

Measures the AC power supplies.

Fan 0, Fan 1, Fan 2

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 #
2
5
16
18
19
24
26
Slot #
2
5
16
18
19

Slot #

Hot Sensor
(deg C)
31.0
33.5
25.5
22.0
22.5
NA
NA

Inlet Sensor
(deg C)
22.0
26.5
21.5
21.0
21.0
29.5
24.5

3V
(mv)
3292
3292
3272
3300
3316

5V
(mv)
5008
5000
NA
NA
NA

MBUS 5V
(mv)
5136
5128
5128
5128
5128

5V
(mv)

MBUS 5V 48V
(mv)
(Volt)

AMP_48
(Amp)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-597

Troubleshooting and Fault Management Commands

show environment

24
26

0
5544

5096
5144

3
47

0
3

Slot #
16

Fan Information
Voltage 16V Speed slow: Main Fans Ok Power Supply fans Ok

Alarm Indicators
No alarms
Slot #
16
18
19
24
26

Card Specific Leds

Mbus OK SFCs Failed
Mbus OK
Mbus OK
Input Failed
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
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):

GRP/GLC (Slots 0-15)

CSC
(Slots 16-17)
SFC
(Slots 18-20)

Warning
Below
Above
3200
3400
3200
3400
3200
3400

Critical
Below Above
3100
3500
3100
3500
3100
3500

Shutdown
Below Above
3050
3550
3050
3550
3050
3550

Warning
Below
Above
4850
5150

Critical
Below Above
4750
5250

Shutdown
Below Above
4680
5320

Warning
Below
Above
5000
5250
4820
5150
5000
5250

Critical
Below Above
4900
5350
4720
5250
4900
5350

Shutdown
Below Above
4750
5450
4750
5450
4750
5450

5V Ranges (mv):

GRP/GLC (Slots 0-15)

MBUS_5V Ranges (mv):

GRP/GLC (Slots 0-15)

CSC
(Slots 16-17)
SFC
(Slots 17-20)

Blower Operational Range (RPM):

Top Blower:

Fan 0
Fan 1
Fan 2

Warning
Below
1000
1000
1000

Critical
Below
750
750
750

Cisco IOS Configuration Fundamentals Command Reference

FR-598

78-11740-02

Troubleshooting and Fault Management Commands

show environment

Bottom Blower:
Warning
Below
1000
1000
1000

Fan 0
Fan 1
Fan 2

Critical
Below
750
750
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
18
19
20

Related Commands

leds
leds
leds
leds

Mbus
Mbus
Mbus
Mbus

OK
OK
OK
OK

Command

Description

snmp-server enable traps envmon Controls (enables or disables) environmental monitoring

SNMP notifications.
snmp-server host

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.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-599

Troubleshooting and Fault Management Commands

show gsr

show gsr
To display hardware information on the Cisco 12000 series Gigabit Switch Routers (GSRs), use the
show gsr EXEC command.
show gsr [chassis-info [details]]

Syntax Description

chassis-info

(Optional) Displays backplane NVRAM information.

details

(Optional) In addition to the information displayed, this option includes

hexadecimal output of the backplane NVRAM information.

Command Modes

EXEC

CommandHistory

Release

Modification

11.2 GS

This command was added to support the Cisco 12000 series GSRs.

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
state
Slot 7 type
state
Slot 16 type
state

=
=
=
=
=
=

Route Processor
IOS Running MASTER
1 Port Packet Over SONET OC-12c/STM-4c
Card Powered
Clock Scheduler Card
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
Backplane S/N: A109EXPR75FUNYJK
MAC Addr: base 0000.EAB2.34FF block size: 1024
RMA Number: 0x5F-0x2D-0x44 code: 0x01 hist: 0x1A

Cisco IOS Configuration Fundamentals Command Reference

FR-600

78-11740-02

Troubleshooting and Fault Management Commands

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 EXEC command.
show gt64010

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

CommandHistory

Release

Modification

11.2

This command was introduced.

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
:
addr_decode_err
:
Processor Address Space
ras10_low
:
ras10_high
:
ras32_low
:
ras32_high
:
cs20_low
:
cs20_high
:
cs3_boot_low
:
cs3_boot_high
:
pci_io_low
:
pci_io_high
:
pci_mem_low
:
pci_mem_high
:

0x80030000
0xFFFFFFFF
:
0x00000000
0x07000000
0x08000000
0x0F000000
0xD0000000
0x74000000
0xF8000000
0x7E000000
0x00080000
0x00000000
0x00020000
0x7F000000

(b/s 0x00000380)
(b/s 0xFFFFFFFF)
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s
(b/s

0x00000000)
0x00000007)
0x00000008)
0x0000000F)
0x000000D0)
0x00000074)
0x000000F8)
0x0000007E)
0x00000800)
0x00000000)
0x00000200)
0x0000007F)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-601

Troubleshooting and Fault Management Commands

show gt64010 (7200)

internal_spc_decode

: 0xA0000000 (b/s 0x000000A0)

bus_err_low
bus_err_high

: 0x00000000 (b/s 0x00000000)

: 0x00000000 (b/s 0x00000000)

.
.
.

Cisco IOS Configuration Fundamentals Command Reference

FR-602

78-11740-02

Troubleshooting and Fault Management Commands

show logging

show logging
To display the state of system logging (syslog) and the contents of the standard system logging message
buffer,, use the show logging privileged EXEC command.
show logging [slot slot-number | summary]

Syntax Description

slot slot-number

(Optional) Displays information in the syslog history table for a specific line
card. Slot numbers range from 0 to 11 for the Cisco 12012 router and 0 to 7
for the Cisco 12008 router.

summary

(Optional) Displays counts of messages by type for each line card.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

11.2 GS

The slot and summary keywords were added for the Cisco 12000 family.

Usage Guidelines

Note

Examples

This command displays the state of syslog error and event logging, including host addresses, and
whether console logging is enabled. This command also displays Simple Network Management Protocol
(SNMP) configuration parameters and protocol activity.

Within the context of the CLI, syslog is an abbreviation for the system message logging process in
Cisco IOS software. Syslog is alsp used to identify the messages generated, as in "syslog messages."
Technically, the term "syslog" refers only to the process of logging messages to a remote host or hosts,
but is commonly used to refer to all Cisco IOS system logging processes.

The following is sample output from the show logging command:

Router# show logging
Syslog logging: enabled
Console logging: disabled
Monitor logging: level debugging, 266 messages logged.
Trap logging: level informational, 266 messages logged.
Logging to 192.180.2.238
SNMP logging: disabled, retransmission after 30 seconds
0 messages logged
Router#

Table 83 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-603

Troubleshooting and Fault Management Commands

show logging

Table 83

show logging in Field Descriptions

Field

Description

Syslog logging

When enabled, system logging messages are sent to a UNIX host that acts as a
syslog server; that is, syslog messages are saved to the specified server.

Console logging

Minimum level of severity required for a log message to be sent to the console.
If disabled, the word disabled is displayed.

Monitor logging

Minimum level of severity required for a log message to be sent to a monitor

terminal (not the console).

Trap logging

Minimum level of severity required for a log message to be sent to a syslog

server.

SNMP logging

Displays whether SNMP logging is enabled, the number of messages logged,

and the retransmission interval.

The following is sample output from the show logging summary command for the Cisco 12012 router.
A number in the column indicates that the syslog contains that many messages for the line card. For
example, line card in slot 9 has 1 system message, 4 warning messages, and 47 notification messages.
Router# show logging summary
+-----+-------+-------+-------+-------+-------+-------+-------+-------+
SLOT | EMERG | ALERT | CRIT | ERROR |WARNING| NOTICE| INFO | DEBUG |
+-----+-------+-------+-------+-------+-------+-------+-------+-------+
|* 0* |
. |
. |
. |
. |
. |
. |
. |
. |
| 1 |
|
|
|
|
|
|
|
|
| 2 |
|
|
|
1 |
4 |
45 |
|
|
| 3 |
|
|
|
|
|
|
|
|
| 4 |
|
|
|
5 |
4 |
54 |
|
|
| 5 |
|
|
|
|
|
|
|
|
| 6 |
|
|
|
|
|
|
|
|
| 7 |
|
|
|
17 |
4 |
48 |
|
|
| 8 |
|
|
|
|
|
|
|
|
| 9 |
|
|
|
1 |
4 |
47 |
|
|
| 10 |
|
|
|
|
|
|
|
|
| 11 |
|
|
|
12 |
4 |
65 |
|
|
+-----+-------+-------+-------+-------+-------+-------+-------+-------+
Router#

Table 84 describes the logging level fields shown in the display.

Table 84

show logging summary Field Descriptions

Field

Description

SLOT

Indicates the slot number of the line card. An asterisk next to the slot number indicates
the GRP card whose error message counts are not displayed. For information on the
GRP card, use the show logging command.

EMERG

Indicates that the system is unusable.

ALERT

Indicates that immediate action is needed.

CRIT

Indicates a critical condition.

ERROR

Indicates an error condition.

WARNING

Indicates a warning condition.

Cisco IOS Configuration Fundamentals Command Reference

FR-604

78-11740-02

Troubleshooting and Fault Management Commands

show logging

Table 84

Related Commands

show logging summary Field Descriptions (continued) (continued)

Field

Description

NOTIFICE

Indicates a normal but significant condition.

INFO

Indicates an informational message only.

DEBUG

Indicates a debugging message.

Command

Description

clear logging

Clears messages from the logging buffer.

logging history size

Changes the number of syslog messages stored in the history table of the
router.

logging linecard

Logs messages to an internal buffer on a line card and limits the logging
messages displayed on terminal lines other than the console line to messages
with a level at or above level.

show logging history

Displays information about the configuration of the syslog history table.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-605

Troubleshooting and Fault Management Commands

show logging history

show logging history

To display information about the state of the syslog history table, use the show logging history
privileged EXEC command.
show logging history

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

CommandHistory

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command displays information about the syslog history table, such as the table size, the status of
messages, and text of messages stored in the table. Messages stored in the table are governed by the
logging history global configuration command.

Examples

The following example shows sample output from the show logging history command. In this example,
notifications of severity level 5 (notifications) through severity level 0 (emergencies) are configured to
be written to the logging history table.
Router# show logging history
Syslog History Table: 1 maximum table entries,
saving level notifications or higher
0 messages ignored, 0 dropped, 15 table entries flushed,
SNMP notifications not enabled
entry number 16: SYS-5-CONFIG_I
Configured from console by console
timestamp: 1110
Router#

Table 85 describes the significant fields shown in the output.

Table 85

show logging history Field Descriptions

Field

Description

maximum table entry

Number of messages that can be stored in the history table.

Set with the logging history size command.

saving level notifications <x> or Level of messages that are stored in the history table and sent
higher
to the SNMP server (if SNMP notification is enabled). The
severity level can be configured with the logging history
command.

Cisco IOS Configuration Fundamentals Command Reference

FR-606

78-11740-02

Troubleshooting and Fault Management Commands

show logging history

Table 85

Related
Commands

show logging history Field Descriptions (continued)

Field

Description

messages ignored

Number of messages not stored in the history table because

the severity level is greater than that specified with the
logging history command.

dropped

Number of messages that could not be processed due to lack

of system resources. Dropped messages do not appear in the
history table and are not sent to the SNMP server.

table entries flushed

Number of messages that have been removed from the history

table to make room for newer messages.

SNMP notifications

Whether syslog traps of the appropriate level are sent to the

SNMP server. The sending of syslog traps are enabled or
disabled through the snmp-server enable traps syslog
command.

entry number:

Number of the message entry in the history table. In the

example above, the message "SYS-5-CONFIG_I
Configured from console by console" indicates a syslog
message consisting of the facility name (SYS), which
indicates where the message came from, the severity level (5)
of the message, the message name (CONFIG_I), and the
message text.

timestamp

Time, based on the up time of the router, that the message was
generated.

Command

Description

clear logging

Clears messages from the logging buffer.

logging history

Limits syslog messages sent to the router's history table to a specified

severity level.

logging history size

Changes the number of syslog messages that can be stored in the history
table.

logging linecard

Logs messages to an internal buffer on a line card. This command limits

the logging messages displayed on terminal lines other than the console
line to messages with a level at or above level.

snmp-server enable traps The [no] snmp-server enable traps syslog form of this command
controls (enables or disables) the sending of system-logging messages
to a network management station.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-607

Troubleshooting and Fault Management Commands

show memory

show memory
To display memory utilization statistics, use the show memory command in User or Privileged EXEC
mode.
show memory [ start-address [end-address] | [ processor | io | multibus] [free] | summary ]

Syntax Description

Defaults

start-address
[end-address]

(Optional) Display memory utilization statistics starting at the specified

memory block address and, optionally, ending at the specified memory block
address.

processor

(Optional) Displays only processor (fast) memory.

io

(Optional) Displays only Input/Output memory.

multibus

(Optional) Displays only multibus memory. (Limited platform support.

Originally supported on the Cisco 7000 series.)

free

(Optional) Displays only free memory statistics for the specified memory type.

summary

(Optional) Summarizes the statistics by grouping them together by Allocating

Process Call (Alloc PC).

If a memory address is not specified, statistics for all memory addresses are displayed.
If a memory type (processor | io | multibus) is not specified, statistics for all memory types present are
displayed.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced, using the following syntax:

show memory { <start_address> [end_address] | {[ processor | io |
sram | multibus ] [free]} }

Usage Guidelines

Tip

This command prints detailed memory information to the screen. This information is intended for use
by Cisco technical support personnel.

This command can generate a large amount of output. Use the Break key sequence (often Crtl+z) at the
--More-- prompt to return to the CLI prompt.
This command first displays how much memory is being used on the router by memory pool (processor,
shared I/O memory, and, potentially, SRAM). Then this command displays, for each memory pool, a
complete list of all blocks.

Examples

The following is sample output from the show memory command:

Cisco IOS Configuration Fundamentals Command Reference

FR-608

78-11740-02

Troubleshooting and Fault Management Commands

show memory

Router# show memory

Processor

Head
B0EE38

Total(b)
5181896

Processor memory
Bytes Prev.
Next
1056 0
B0F280
2656 B0EE38
B0FD08
2520 B0F280
B10708
2000 B0FD08
B10F00
512 B10708
B11128
2000 B10F00
B11920
44 B11128
B11974
1056 B11920
B11DBC
84 B11974
B11E38
84 B11DBC
B11EB4
84 B11E38
B11F30
84 B11EB4
B11FAC

Address
B0EE38
B0F280
B0FD08
B10708
B10F00
B11128
B11920
B11974
B11DBC
B11E38
B11EB4
B11F30
Router#

Used(b)
2210036

Ref
1
1
1
1
1
1
1
1
1
1
1
1

Free(b)
2971860

PrevF

NextF

Lowest(b) Largest(b)
2692456
2845368

Alloc PC
18F132
18F132
141384
14353C
14356C
1A110E
970DE8
18F132
19ABCE
19ABCE
19ABCE
19ABCE

What
List Elements
List Headers
TTY data
TTY Input Buf
TTY Output Buf
Interrupt Stack
*Init*
messages
Watched Boolean
Watched Boolean
Watched Boolean
Watched Boolean

The following is sample output from the show memory free command:
Router# show memory free

Processor

Address
CEB844

D35ED4
D27AE8

D0A8F4
B59EF0

Head
B0EE38

Total(b)
5181896

Processor memory
Bytes Prev.
Next
24
Free list 1
32 CEB7A4
CEB88C
52
Free list 2
72
Free list 3
76
Free list 4
80
Free list 5
80 D35E30
D35F4C
80 D27A48
D27B60
88
Free list 6
100
Free list 7
100 D0A8B0
D0A980
104
Free list 8
108 B59E8C
B59F84

Used(b)
2210076

Ref

Free(b)
2971820

PrevF

NextF

Lowest(b) Largest(b)
2692456
2845368

Alloc PC

What

96B894

SSE Manager

0
0

0
D35ED4

D27AE8
0

96B894
22585E

SSE Manager
SSE Manager

2258DA

SSE Manager

2258DA

(fragment)

The display of show memory free contains the same types of information as the show memory display,
except that only free memory is displayed, and the information is displayed in order for each free list.
The first section of the display includes summary statistics about the activities of the system memory
allocator. Table 86 describes the significant fields shown in the first section of the display.
Table 86

show memory Field DescriptionsFirst Section

Field

Description

Head

Hexadecimal address of the head of the memory allocation chain.

Total(b)

Sum of used bytes plus free bytes.

Used(b)

Amount of memory in use.

Free(b)

Amount of memory not in use.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-609

Troubleshooting and Fault Management Commands

show memory

Table 86

show memory Field DescriptionsFirst Section (continued)

Field

Description

Lowest(b)

Smallest amount of free memory since last boot.

Largest(b)

Size of largest available free block.

The second section of the display is a block-by-block listing of memory use. Table 87 describes the
significant fields shown in the second section of the display.
Table 87

Characteristics of Each Block of MemorySecond Section

Field

Description

Address

Hexadecimal address of block.

Bytes

Size of block (in bytes).

Prev.

Address of previous block (should match Address on previous line).

Next

Address of next block (should match address on next line).

Ref

Reference count for that memory block, indicating how many different processes are
using that block of memory.

PrevF

Address of previous free block (if free).

NextF

Address of next free block (if free).

Alloc PC

Allocating Process Call Address of the system call that allocated the block.

What

Name of process that owns the block, or (fragment) if the block is a fragment, or
(coalesced) if the block was coalesced from adjacent free blocks.

The show memory io command displays the free I/O memory blocks.
The following is sample output from the show memory io command:
Router# show memory io
Address
Bytes
6132DA0
59264
600DDEC
500
600FE68
376
6011D54
652
614FCA0
832
6177640 2657056
Total: 2723244

Prev.
6132664
600DA4C
600FAC8
60119B4
614F564
6172E90

Next
6141520
600DFE0
600FFE0
6011FEO
614FFE0
0

Ref
0
0
0
0
0
0

PrevF
0
6132DA0
600DDEC
600FE68
601FD54
614FCA0

NextF
600DDEC
600FE68
6011D54
6013D54
6177640
0

Alloc PC
3FCF0
0
0
0
0
0

What
*Packet Buffer*

The show memory summary command displays a summary of all memory pools and memory usage per
Alloc PC (address of the system call that allocated the block).
The following is partial sample output from the show memory summary command.
Size is the number of bytes in each block. Bytes is the total size for all blocks (Bytes equals the
Size value multiplied by the Blocks value). For a description of the other fields, see Table 20 and
Table 21.
Router# show memory summary

Processor
I/O

Head
8404A580
7C53000

Total(b)
64102816
3854336

Used(b)
10509276
2138224

Free(b)
53593540
1716112

Lowest(b)
52101448
1708432

Largest(b)
51007568
1716064

Cisco IOS Configuration Fundamentals Command Reference

FR-610

78-11740-02

Troubleshooting and Fault Management Commands

show memory

Processor memory
Alloc PC
Size
Blocks
0x2AB2
192
1
0x70EC
92
2
0xC916
128
50
0x76ADE
4500
1
0x76E84
4464
1
0x76EAC
692
1
0x77764
408
1
0x77776
116
1
0x777A2
408
1
0x777B2
116
1
0xA4600
24
3
0xD9B5C
52
1
.......................
0x0
0
3413
0x0
0
28
0x0
40
3441
0x0
0
3413
0x0
0
28

Related Commands

Bytes
192
184
6400
4500
4464
692
408
116
408
116
72
52
2072576
2971680
137640
2072576
2971680

What
IDB: Serial Info
Init
RIF Cache
XDI data
XDI data
XDI data
Init
Init
Init
Init
List
SSE Manager
Pool Summary
Pool Summary (Free Blocks)
Pool Summary(All Block Headers)
Memory Summary
Memory Summary (Free Blocks)

Command

Description

show processes memory

Displays a summary of how much memory is being allocated and freed

by each process on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-611

Troubleshooting and Fault Management Commands

show memory ecc

show memory ecc

To display single-bit Error Code Correction (ECC) error logset data, use the show memory ecc command
in privileged EXEC mode.
show memory ecc

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1(30)CC

This command was introduced in Cisco IOS Release 11.1(30)CC.

12.0(4)XE

This command was integrated into Cisco IOS Release 12.0(4)XE.

12.0(6)S

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

12.1(13)

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

Usage Guidelines

Use this command to determine if the router has experienced single-bit parity errors.

Examples

The following is sample output from the show memory ecc command from a 12000-series router
running Cisco IOS Release 12.0(23)S:
Router# show memory ecc
ECC Single Bit error log
-----------------------Single Bit error detected and corrected at 0x574F3640
- Occured 1 time(s)
- Whether a scrub was attempted at this address: Yes
- Syndrome of the last error at this address: 0xE9
- Error detected on a read-modify-write cycle ? No
- Address region classification: Unknown
- Address media classification : Read/Write Single Bit error detected and corrected at
0x56AB3760
- Occured 1 time(s)
- Whether a scrub was attempted at this address: Yes
- Syndrome of the last error at this address: 0x68
- Error detected on a read-modify-write cycle ? No
- Address region classification: Unknown
- Address media classification : Read/Write
Total Single Bit error(s) thus far: 2

Cisco IOS Configuration Fundamentals Command Reference

FR-612

78-11740-02

Troubleshooting and Fault Management Commands

show memory ecc

Table 86 describes the significant fields shown in the first section of the display.
Table 88

show memory ecc Field Descriptions

Field

Description

Occured n time(s)

Number of single-bit errors that has occurred.

Whether a scrub was attempted at this address: Indicates whether a scrub has been performed.

Related Commands

Syndrome of the last error at this address:

Describes the syndrome of last error.

Error detected on a read-modify-write cycle ?

Indicates whether an error has occurred.

Address region classification:

Describes the region of the error.

Address media classification :

Describes the media of the error and correction.

Command

Description

show memory

Displays statistics about memory, including memory-free

pool statistics.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-613

Troubleshooting and Fault Management Commands

show memory fast

show memory fast

To display fast memory details for the router, use the show memory fast command.
show memory fast [ allocating-process [totals] | dead [totals] | free [totals] ]

Syntax Description

allocating-process

(Optional) Include allocating process names with the standard output.

dead

(Optional) Display only memory owned by dead processes.

free

(Optional) Display only memory not allocated to a process.

totals

(Optional) Summarizes the statistics for allocating processes, dead memory, or

free memory.

Command Modes

Exec

Command History

Release

Modification

12.1

This command was introduced in a release prior to 12.1.

Usage Guidelines

The show memory fast command displays the statistics for the fast memory. Fast memory is another
name for processor memory, and is also known as cache memory. Cache memory is called fast
memory because the processor can generally access the local cache (traditionally stored on SRAM
positioned close to the processor) much more quickly than main (primary) memory.
Cache = fast memory closest to processor = processor memory
Primary Memory = the main memory below cache.

Note

Examples

The show memory fast command is a command alias for the show memory processor command. These
commands will generate the same output on most platforms.

The following example shows sample output from the show memory fast and the show memory
processor commands:
Router>show memory fast
Processor memory
Address
8404A580
841B6ECC
Elements
841BBD18
841BC320
841BD6D4
841BD72C
841BDD34
841BE33C

Bytes
Prev
Next Ref
PrevF
NextF Alloc PC what
0001493284 00000000 841B6ECC 000 0
84BADF88 815219D8 (coalesced)
0000020004 8404A580 841BBD18 001 -------- -------- 815DB094 Managed Chunk Queue
0000001504
0000005004
0000000048
0000001504
0000001504
0000001504

841B6ECC
841BBD18
841BC320
841BD6D4
841BD72C
841BDD34

841BC320
841BD6D4
841BD72C
841BDD34
841BE33C
841BE944

001
001
001
001
001
001

-------------------------------------------

-------------------------------------------

8159EAC4
8159EB04
81F2A614
815A9514
815A9540
815A95E4

List Elements
List Headers
*Init*
messages
Watched messages
Watched Semaphore

Cisco IOS Configuration Fundamentals Command Reference

FR-614

78-11740-02

Troubleshooting and Fault Management Commands

show memory fast

841BE944 0000000504 841BE33C 841BEB64 001

Queue
841BEB64 0000001504 841BE944 841BF16C 001
Queue
841BF16C 0000001036 841BEB64 841BF5A0 001
-- More -<Ctrl+z>

-------- -------- 815A9630

Watched Message

-------- -------- 815A9658

Watcher Message

-------- -------- 815A2B24

Process Array

Router>show memory processor

Processor memory
Address
Bytes
8404A580 0001493284
841B6ECC 0000020004
Elements
841BBD18 0000001504
841BC320 0000005004
841BD6D4 0000000048
841BD72C 0000001504
841BDD34 0000001504
841BE33C 0000001504
841BE944 0000000504
Queue
841BEB64 0000001504
Queue
841BF16C 0000001036
-- More -<Ctrl+z>

Prev
Next Ref
PrevF
NextF Alloc PC what
00000000 841B6ECC 000 0
84BADF88 815219D8 (coalesced)
8404A580 841BBD18 001 -------- -------- 815DB094 Managed Chunk Queue
841B6ECC
841BBD18
841BC320
841BD6D4
841BD72C
841BDD34
841BE33C

841BC320
841BD6D4
841BD72C
841BDD34
841BE33C
841BE944
841BEB64

001
001
001
001
001
001
001

--------------------------------------------------

--------------------------------------------------

8159EAC4
8159EB04
81F2A614
815A9514
815A9540
815A95E4
815A9630

List Elements
List Headers
*Init*
messages
Watched messages
Watched Semaphore
Watched Message

841BE944 841BF16C 001

-------- -------- 815A9658

Watcher Message

841BEB64 841BF5A0 001

-------- -------- 815A2B24

Process Array

Router>

The following example shows sample output from the show memory fast allocating-process command,
followed by sample output from the show memory fast allocating-process totals command:

Router#show memory fast allocating-process

Processor memory
Address
Bytes
8404A580 0001493284
841B6ECC 0000020004
Elements
841BBD18 0000001504
841BC320 0000005004
841BD6D4 0000000048
841BD72C 0000001504
841BDD34 0000001504
841BE33C 0000001504
841BE944 0000000504
841BEB64 0000001504
841BF16C 0000001036
--More-<Ctrl+z>

Prev
Next Ref
00000000 841B6ECC 000
8404A580 841BBD18 001
841B6ECC
841BBD18
841BC320
841BD6D4
841BD72C
841BDD34
841BE33C
841BE944
841BEB64

841BC320
841BD6D4
841BD72C
841BDD34
841BE33C
841BE944
841BEB64
841BF16C
841BF5A0

001
001
001
001
001
001
001
001
001

Alloc Proc
*Init*

Alloc PC
815219D8
815DB094

What
(coalesced)
Managed Chunk Queue

*Init*
*Init*
*Init*
*Init*
*Init*
*Init*
*Init*
*Init*
*Init*

8159EAC4
8159EB04
81F2A614
815A9514
815A9540
815A95E4
815A9630
815A9658
815A2B24

List Elements
List Headers
*Init*
messages
Watched messages
Watched Semaphore
Watched Message Queue
Watcher Message Queue
Process Array

c2600-1#show memory fast allocating-process totals

Allocator PC Summary for: Processor
PC
0x815C085C
0x815B6C28

Total
1194600
948680

Count
150
5

Name
Process Stack
pak subblock chunk

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-615

Troubleshooting and Fault Management Commands

show memory fast

0x819F1DE4
0x815C4FD4
0x815B5FDC
0x819F14DC
0x81A1E838
0x8153DFB8
0x82142438
0x82151E0C
0x819F1C8C
0x815A4858
0x8083DA44

524640
393480
351528
327900
327900
248136
133192
131116
118480
100048
97248

8
6
30
5
5
294
4
1
4
148
17

BGP (0) update

MallocLite
TW Buckets
connected
IPv4 Unicast net-chunk(8)
*Packet Header*
CEF: 16 path chunk pool
Init
BGP (0) attr
Process

--More-<Ctrl+z>

The following example shows sample output from the show memory fast dead command:
Router#show memory fast dead
Processor memory
Address
Bytes
Prev
Next Ref
8498FC20 0000000028 8498FB90 8498FC64 001
------68
Router#show memory fast dead totals

PrevF
NextF Alloc PC
-------- -------- 81472B24

what
AAA MI SG NAME

Dead Proc Summary for: Processor

PC
0x81472B24

Total
68

Count
1

Name
AAA MI SG NAME

Router#

Cisco IOS Configuration Fundamentals Command Reference

FR-616

78-11740-02

Troubleshooting and Fault Management Commands

show memory scan

show memory scan

To monitor the number and type of parity (memory) errors on your system, use the show memory scan
command in Exec mode.
show memory scan

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

12.0(4)XE

This command was introduced for the Cisco 7500 series.

12.0(7)T

This command was implemented in Cisco IOS Release 12.0T for the
Cisco 7500 series.

12.0(6)S

This command was implemented in Cisco IOS Release 12.0S for the
Cisco 7500 series.

12.1(1)E

This command was implemented in Cisco IOS Release 12.1E for the
Cisco 7500 series.

Usage Guidelines

For the show memory scan command to function, the memory scan feature must be enabled on the RSP
using the memory scan global configuraiton mode command.

Examples

The following example shows a result with no memory errors:

Router# show memory scan
Memory scan is on.
No parity error has been detected.

If errors are detected in the system, the show memory scan command generates an error report. In the
following example, memory scan detected a parity error:
Router# show memory scan
Memory scan is on.
Total Parity Errors 1.
Address
BlockPtr
BlckSize
6115ABCD 60D5D090
9517A4

Disposit
Scrubed

Region Timestamp
Local 16:57:09 UTC Thu

Mar 18

Table 89 describes the fields contained in the error report.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-617

Troubleshooting and Fault Management Commands

show memory scan

Table 89

show memory scan Field Descriptions

Field

Description

Address

The byte address where the error occurred.

BlockPtr

The pointer to the block that contains the error.

BlckSize

The size of the memory block

Disposit

The action taken in response to the error:

Region

Timestamp

Related Commands

BlockInUseAn error was detected in a busy block.

InFieldPrevAn error was detected in the previous field of

a block header.

InHeaderAn error was detected in a block header.

LinkedA block was linked to a bad list.

MScrubedThe same address was scrubbed more than

once, and the block was linked to a bad list.

MultiErrorMultiple errors have been found in one block.

NoBlkHdrNo block header was found.

NotYetAn error was found; no action has been taken at

this time.

ScrubedAn error was scrubbed.

SplitLinkedA block was split, and only a small portion

was linked to a bad list.

The memory region in which the error was found:

IBSSimage BSS

IDataimagedata

ITextimagetext

localheap

The time the error occurred.

Command

Description

memory scan

Controls (enables or disables) the memory scan feature.

Cisco IOS Configuration Fundamentals Command Reference

FR-618

78-11740-02

Troubleshooting and Fault Management Commands

show pci

show pci
To display information about the peripheral component interconnect (PCI) hardware registers or bridge
registers for the Cisco 7200 series routers, use the show pci EXEC command.
show pci {hardware | bridge [register]}

Syntax Description

hardware

Displays PCI hardware registers.

bridge

Displays PCI bridge registers.

register

(Optional) Number of a specific bridge register in the range from 0 to 7. If not

specified, this command displays information about all registers.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Note

Examples

The output of this command is generally useful for diagnostic tasks performed by technical support only.

The show pci hardware EXEC command displays a substantial amount of information.

The following is sample output for the PCI bridge register 1 on a Cisco 7200 series router:
Router# show pci bridge 1
Bridge 4, Port Adaptor 1, Handle=1
DEC21050 bridge chip, config=0x0
(0x00): cfid
= 0x00011011
(0x04): cfcs
= 0x02800147
(0x08): cfccid = 0x06040002
(0x0C): cfpmlt = 0x00010010
(0x18):
(0x1C):
(0x20):
(0x24):

cfsmlt
cfsis
cfmla
cfpmla

=
=
=
=

0x18050504
0x22805050
0x48F04880
0x00004880

(0x3C): cfbc
= 0x00000000
(0x40): cfseed = 0x00100000
(0x44): cfstwt = 0x00008020

The following is partial sample output for the PCI hardware register, which also includes information on
all the PCI bridge registers on a Cisco 7200 series router:
Router# show pci hardware

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-619

Troubleshooting and Fault Management Commands

show pci

GT64010 External PCI Configuration registers:

Vendor / Device ID
: 0xAB114601 (b/s 0x014611AB)
Status / Command
: 0x17018002 (b/s 0x02800117)
Class / Revision
: 0x00000006 (b/s 0x06000000)
Latency
: 0x0F000000 (b/s 0x0000000F)
RAS[1:0] Base
: 0x00000000 (b/s 0x00000000)
RAS[3:2] Base
: 0x00000001 (b/s 0x01000000)
CS[2:0] Base
: 0x00000000 (b/s 0x00000000)
CS[3] Base
: 0x00000000 (b/s 0x00000000)
Mem Map Base
: 0x00000014 (b/s 0x14000000)
IO Map Base
: 0x01000014 (b/s 0x14000001)
Int Pin / Line
: 0x00010000 (b/s 0x00000100)
Bridge 0, Downstream MB0 to MB1, Handle=0
DEC21050 bridge chip, config=0x0
(0x00): cfid
= 0x00011011
(0x04): cfcs
= 0x02800143
(0x08): cfccid = 0x06040002
(0x0C): cfpmlt = 0x00011810
(0x18):
(0x1C):
(0x20):
(0x24):

cfsmlt
cfsis
cfmla
cfpmla

=
=
=
=

0x18000100
0x02809050
0x4AF04880
0x4BF04B00

(0x3C): cfbc
= 0x00000000
(0x40): cfseed = 0x00100000
(0x44): cfstwt = 0x00008020
.
.
.

Cisco IOS Configuration Fundamentals Command Reference

FR-620

78-11740-02

Troubleshooting and Fault Management Commands

show pci hardware

show pci hardware

To display information about the Host-PCI bridge, use the show pci hardware EXEC command.
show pci hardware

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

CommandHistory

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The output of this command is generally useful for diagnostic tasks performed by technical support only:
router# show pci hardware
hardware PCI hardware registers
Each device on the PCI bus is assigned a PCI device number.
C2600, device numbers are as follows:
Device
0
1
2
3
4
5
6
7
8-14
15

Examples

For the

Device number
First LAN device
Second LAN device
AIM device (if present)
Not presently used
Port module - first PCI device
Port module - second PCI device
Port module - third PCI device
Port module - fourth PCI device
Not presently used
Xilinx PCI bridge

The following is partial sample output for the PCI hardware register, which also includes information on
all the PCI bridge registers. Table 90 describes the significant fields shown in the display.
router# show pci hardware
XILINX Host-PCI Bridge Registers:
Vendor / Device ID: 0x401310EE
Status / Command: 0x040001C6
PCI Slave Base Reg 0: 0x00000000
PCI Slave Base Reg 1: 0x04000000

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-621

Troubleshooting and Fault Management Commands

show pci hardware

Table 90

show pci hardware Field Descriptions

Field

Description

Device/Vendor ID

Identifies the PCI vendor and device. The value 0x401310EE

identifies the device as the Xilinx-based Host-PCI bridge for the
Cisco 2600 router.

Status/Command

Provides status of the Host-PCI bridge. Refer to the PCI

Specification for more information.

PCI Slave Base Reg 0

The base address of PCI Target Region 0 for the Host-PCI bridge.
This region is used for Big-Endian transfers between PCI devices
and memory.

PCI Slave Base Reg 1

The base address of PCI Target Region 1 for the Host-PCI bridge.
This region is used for Little-Endian transfers between PCI devices
and memory.

Cisco IOS Configuration Fundamentals Command Reference

FR-622

78-11740-02

Troubleshooting and Fault Management Commands

show processes

show processes
To display information about the active processes, use the show processes command in EXEC mode.
show processes [history]

Syntax Description

history

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

12.2(2)T

The history keyword was added.

Examples

(Optional) Displays the process history in an ordered format.

The following is sample output from the show processes command:

Router# show processes
CPU utilization for five seconds: 21%/0%; one minute: 2%; five minutes: 2%
PID QTy
PC Runtime (ms) Invoked
uSecs
Stacks
TTY Process
1 Mwe 2FEA4E
1808
464
3896
1796/3000
0 IP-EIGRP Router
2 Lst 11682
10236
109
93908
1828/2000
0 Check heaps
3 Mst 3AE9C
0
280
0
1768/2000
0 Timers
4 Lwe 74AD2
0
12
0
1492/2000
0 ARP Input
5.ME
912E4
0
2
0
1892/2000
0 IPC Zone Manager
6.ME
91264
0
1
0
1936/2000
0 IPC Realm Manager
7.ME
91066
0
30
0
1784/2000
0 IPC Seat Manager
8.ME 133368
0
1
0
1928/2000
0 CXBus hot stall
9.ME 1462EE
0
1
0
1940/2000
0 Microcode load
10 Msi 127538
4
76
52
1608/2000
0 Env Mon
11.ME 160CF4
0
1
0
1932/2000
0 MIP Mailbox
12 Mwe 125D7C
4
280
14
1588/2000
0 SMT input
13 Lwe AFD0E
0
1
0
1772/2000
0 Probe Input
14 Mwe AF662
0
1
0
1784/2000
0 RARP Input
15 Hwe A1F9A
228
549
415
3240/4000
0 IP Input
16 Msa C86A0
0
114
0
1864/2000
0 TCP Timer
17 Lwe CA700
0
1
0
1756/2000
0 TCP Protocols
18.ME CCE7C
0
1
0
1940/2000
0 TCP Listener
19 Mwe AC49E
0
1
0
1592/2000
0 BOOTP Server
20 Mwe 10CD84
24
77
311
1652/2000
0 CDP Protocol
21 Mwe 27BF82
0
2
0
1776/2000
0 ATMSIG Input

The following is sample output from the show processes history command:
Router# show process history
PID Exectime(ms) Caller PC Process Name
3
12 0x0
Exec
16
0 0x603F4DEC GraphIt
21
0 0x603CFEF4 TTY Background
22
0 0x6042FD7C Per-Second Jobs
67
0 0x6015CD38 SMT input
39
0 0x60178804 FBM Timer

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-623

Troubleshooting and Fault Management Commands

show processes

16
0
21
0
22
0
16
0
21
0
22
0
67
0
39
0
24
0
11
0
69
0
69
0
51
0
69
0
36
0
69
0
--More-PID Exectime(ms)
16
0
21
0
22
0
34
0
19
0
36
0
12
0
69
0
44
0
65
4
25
8
16
0
21
0
22
0
67
0
39
0
2
0
16
0
21
0
22
0
16
0
21
0
22
0
--More-. . .

0x603F4DEC
0x603CFEF4
0x6042FD7C
0x603F4DEC
0x603CFEF4
0x6042FD7C
0x6015CD38
0x60178804
0x60425070
0x605210A8
0x605FDAF4
0x605FD568
0x60670B3C
0x605FD568
0x606E96DC
0x605FD568

GraphIt
TTY Background
Per-Second Jobs
GraphIt
TTY Background
Per-Second Jobs
SMT input
FBM Timer
Compute load avgs
ARP Input
DHCPD Database
DHCPD Database
IP Cache Ager
DHCPD Database
SSS Test Client
DHCPD Database

Caller PC Process Name

0x603F4DEC GraphIt
0x603CFEF4 TTY Background
0x6042FD7C Per-Second Jobs
0x60679D74 CDP Protocol
0x6041FBA4 Net Background
0x606E97AC SSS Test Client
0x60722A40 HC Counter Timers
0x605FD568 DHCPD Database
0x6031AD14 Adj Manager
0x60BC5BE0 SAA Event Processor
0x6042FDDC Per-minute Jobs
0x603F4DEC GraphIt
0x603CFEF4 TTY Background
0x6042FD7C Per-Second Jobs
0x6015CD38 SMT input
0x60178804 FBM Timer
0x60496768 Load Meter
0x603F4DEC GraphIt
0x603CFEF4 TTY Background
0x6042FD7C Per-Second Jobs
0x603F4DEC GraphIt
0x603CFEF4 TTY Background
0x6042FD7C Per-Second Jobs

Table 91 describes the significant fields shown in the displays.

Table 91

show processes Field Descriptions

Field

Description

CPU utilization
for five seconds

CPU utilization for the last 5 seconds. The second number indicates the percent of
CPU time spent at the interrupt level.

one minute

CPU utilization for the last minute.

five minutes

CPU utilization for the last 5 minutes.

PID

Process ID.

Process queue priority. Possible values: C (critical), H (high), M (medium), L

(low).

Cisco IOS Configuration Fundamentals Command Reference

FR-624

78-11740-02

Troubleshooting and Fault Management Commands

show processes

Table 91

Note

show processes Field Descriptions (continued)

Field

Description

Ty

Scheduler test. Possible values: * (currently running), E (waiting for an event), S

(ready to run, voluntarily relinquished processor), rd (ready to run, wakeup
conditions have occurred), we (waiting for an event), sa (sleeping until an absolute
time), si (sleeping for a time interval), sp (sleeping for a time interval (alternate
call), st (sleeping until a timer expires), hg (hung; the process will never execute
again), xx (dead: the process has terminated, but has not yet been deleted.).

PC

Current program counter.

Runtime (ms)

CPU time the process has used (in milliseconds).

Invoked

Number of times the process has been invoked.

uSecs

Microseconds of CPU time for each process invocation.

Stacks

Low water mark/Total stack space available (in bytes).

TTY

Terminal that controls the process.

Process

Name of the process.

5Sec

CPU utilization by task in the last 5 seconds.

1Min

CPU utilization by task in the last minute.

5Min

CPU utilization by task in the last 5 minutes.

Because the network server has a 4-millisecond clock resolution, run times are considered reliable only
after a large number of invocations or a reasonable, measured run time.
For a list of process descriptions, see http://www.cisco.com/warp/public/63/showproc_cpu.html .

Related Commands

Command

Description

show processes memory

Displays amount of system memory used per system process.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-625

Troubleshooting and Fault Management Commands

show processes cpu

show processes cpu

To display CPU utilization information about the active processes in a device, use the show processes
cpu command in privileged EXEC mode.
show processes cpu [history | sorted]

Syntax Description

history

(Optional) Displays CPU history in a graph format.

sorted

(Optional) Displays CPU utilization sorted by percentage.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.0

This command was introduced.

12.2(2)T

The history keyword was added.

12.3(8)T

This command was enhanced to display Address Resolution Protocol (ARP)

output.

Usage Guidelines

When you use the optional history keyword, output shows (in ASCII graphical form) the total CPU
usage on the device over a period of time. Time periods are one minute, one hour, and 72 hours, displayed
in increments of one second, one minute, and one hour, respectively. Maximum usage is measured and
recorded every second; average usage is calculated on periods of more than one second.
Consistently high CPU utilization over an extended period of time indicates a problem and using the
show processes cpu command is useful for troubleshooting. Also, you can use the output of this
command in the Cisco Output Interpreter tool to display potential issues and fixes. Output Interpreter is
available to registered users of Cisco.com who are logged in and have Java Script enabled.
For a list of system processes, go to http://www.cisco.com/warp/public/63/showproc_cpu.html.

Examples

The following is sample output from the show processes cpu command without keywords:
Router# show processes cpu
CPU utilization for five seconds: 5%/2%; one minute: 3%; five minutes: 2%
PID Runtime (ms)
Invoked
uSecs
5Sec 1Min 5Min TTY Process
1
1736
58
29931
0%
0%
0% 0
Check heaps
2
68
585
116 1.00% 1.00%
0% 0
IP Input
3
0
744
0
0%
0%
0% 0
TCP Timer
4
0
2
0
0%
0%
0% 0
TCP Protocols
5
0
1
0
0%
0%
0% 0
BOOTP Server
6
16
130
123
0%
0%
0% 0
ARP Input
7
0
1
0
0%
0%
0% 0
Probe Input
8
0
7
0
0%
0%
0% 0
MOP Protocols
9
0
2
0
0%
0%
0% 0
Timers
10
692
64
10812
0%
0%
0% 0
Net Background
11
0
5
0
0%
0%
0% 0
Logger
12
0
38
0
0%
0%
0% 0
BGP Open

Cisco IOS Configuration Fundamentals Command Reference

FR-626

78-11740-02

Troubleshooting and Fault Management Commands

show processes cpu

13
14
15
16
17
18
19

0
540
0
5100
88
152
224

1
3466
1
1367
4232
14650
99

0
155
0
3730
20
10
2262

0%
0%
0%
0%
0%
0%
0%
0%
0%
0%
0%
0%
0.20% 1.00%
0%
0%
0%
0%
0%
0% 1.00%

0
0
0
0
0
0
0

Net Input
TTY Background
BGP I/O
IGRP Router
BGP Router
BGP Scanner
Exec

The following is sample output of the one-hour portion of the output. The Y-axis of the graph is the CPU
utilization. The X-axis of the graph is the increment within the time period displayed in the graph. This
example shows the individual minutes during the previous hour. The most recent measurement is on the
left of the X-axis.
router# show processes cpu history
!--- One minute output omitted
6665776865756676676666667667677676766666766767767666566667
6378016198993513709771991443732358689932740858269643922613
100
90
80
* *
* *
* * * *
70 * * ***** * ** ***** *** **** ****** * *******
* *
60 #***##*##*#***#####*#*###*****#*###*#*#*##*#*##*#*##*****#
50 ##########################################################
40 ##########################################################
30 ##########################################################
20 ##########################################################
10 ##########################################################
0....5....1....1....2....2....3....3....4....4....5....5....
0
5
0
5
0
5
0
5
0
5
CPU% per minute (last 60 minutes)
* = maximum CPU% # = average CPU%
!--- 72-hour output omitted

The top two rows, read vertically, display the highest percentage of CPU utilization recorded during the
time increment. In this example, the CPU utilization for the last minute recorded is 66 percent. The
device may have reached 66 percent only once during that minute, or it may have reached 66 percent
multiple times. The device records only the peak reached during the time increment and the average over
the course of that increment.
The following is sample output from the show processes cpu command that shows an ARP probe
process:
Router# show processes cpu | include ARP
17
36
40
80
114

38140
0
0
0
0

389690
1
1
1
1

97
0
0
0
0

0.00%
0.00%
0.00%
0.00%
0.00%

0.00%
0.00%
0.00%
0.00%
0.00%

0.00%
0.00%
0.00%
0.00%
0.00%

0
0
0
0
0

ARP Input
IP ARP Probe
ATM ARP INPUT
RARP Input
FR ARP

Table 92 describes the fields shown in the output.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-627

Troubleshooting and Fault Management Commands

show processes cpu

Table 92

Note

Related Commands

show processes cpu Field Descriptions

Field

Description

CPU utilization
for five seconds

CPU utilization for the last 5 seconds and the percent of CPU time spent at the
interrupt level.

one minute

CPU utilization for the last minute and the percent of CPU time spent at the
interrupt level.

five minutes

CPU utilization for the last 5 minutes and the percent of CPU time spent at the
interrupt level.

PID

Process ID.

Runtime (ms)

CPU time the process has used (in milliseconds).

Invoked

Number of times the process has been invoked.

uSecs

Microseconds of CPU time for each process invocation.

5Sec

CPU utilization by task in the last 5 seconds.

1Min

CPU utilization by task in the last minute.

5Min

CPU utilization by task in the last 5 minutes.

TTY

Terminal that controls the process.

Process

Name of the process.

Because platforms have a 4- to 8-millisecond clock resolution, run times are considered reliable only
after several invocations or a reasonable, measured run time.

Command

Description

show processes memory

Displays the amount of system memory used per system process.

Cisco IOS Configuration Fundamentals Command Reference

FR-628

78-11740-02

Troubleshooting and Fault Management Commands

show processes memory

show processes memory

To show memory used, use the show processes memory command in EXEC mode.
show processes memory [pid | sorted]

Syntax Description

pid

(Optional) Process ID number of a specific process. This keyword shows detail for
only the specified process.

sorted

(Optional) Displays CPU history sorted by percentage of utilization.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following is sample output from the show processes memory command:
Router# show processes memory
Total: 5611448, Used: 2307548, Free: 3303900
PID TTY Allocated
Freed
Holding
Getbufs
0
0
199592
1236
1907220
0
0
0
400
76928
400
0
0
0
5431176
3340052
140760
349780
1
0
256
256
1724
0
2
0
264
0
5032
0
3
0
0
0
2724
0
4
0
97932
0
2852
32760
5
0
256
256
2724
0
6
0
92
0
2816
0
7
0
0
0
2724
0
8
0
0
0
2724
0
9
0
0
0
2724
0
10
0
892
476
3256
0
11
0
92
0
2816
0
12
0
216
0
2940
0
13
0
0
0
2724
0
14
0
15659136
15658584
3276
0
.
.
.
77
0
116
0
2844
0
2307224 Total

Retbufs
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

Process
*Init*
*Sched*
*Dead*
Load Meter
Exec
Check heaps
Pool Manager
Timers
CXBus hot stall
IPC Zone Manager
IPC Realm Manager
IPC Seat Manager
ARP Input
SERIAL A'detect
Microcode Loader
RFSS watchdog
Env Mon

0 IPX-EIGRP Hello

Table 93 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-629

Troubleshooting and Fault Management Commands

show processes memory

Table 93

show processes memory Field Descriptions

Field

Description

Total:

Total amount of memory held.

Used:

Total amount of used memory.

Free:

Total amount of free memory.

PID

Process ID.

TTY

Terminal that controls the process.

Allocated

Bytes of memory allocated by the process.

Freed

Bytes of memory freed by the process, regardless of who originally allocated it.

Holding

Amount of memory currently allocated to the process.

Getbufs

Number of times the process has requested a packet buffer.

Retbufs

Number of times the process has relinquished a packet buffer.

Process

Process name.

*Init*

System initialization.

*Sched*

The scheduler.

*Dead*

Processes as a group that are now dead.

Total

Total amount of memory held by all processes.

The following is sample output from the show process memory command when a PID is specified:
Router# show process memory 1
Proc Memory Summary for pid = 1
Holding = 6844
pc = 0x6049B900, size = 000006044, count = 0001
pc = 0x60480650, size = 000000612, count = 0001
pc = 0x6048254C, size = 000000188, count = 0001
Router#

Related Commands

Command

Description

show memory

Displays statistics about memory, including memory-free pool statistics.

show processes

Displays information about the active processes.

Cisco IOS Configuration Fundamentals Command Reference

FR-630

78-11740-02

Troubleshooting and Fault Management Commands

show protocols

show protocols
To display the configured protocols, use the show protocols EXEC command.
This command shows the global and interface-specific status of any configured Level 3 protocol; for
example, IP, DECnet, IPX, AppleTalk, and so on.
show protocols

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following is sample output from the show protocols command:

Router# show protocols
Global values:
Internet Protocol routing is enabled
DECNET routing is enabled
XNS routing is enabled
Appletalk routing is enabled
X.25 routing is enabled
Ethernet 0 is up, line protocol is up
Internet address is 192.168.1.1, subnet mask is 255.255.255.0
Decnet cost is 5
XNS address is 2001.AA00.0400.06CC
AppleTalk address is 4.129, zone Twilight
Serial 0 is up, line protocol is up
Internet address is 192.168.7.49, subnet mask is 255.255.255.240
Ethernet 1 is up, line protocol is up
Internet address is 192.168.2.1, subnet mask is 255.255.255.0
Decnet cost is 5
XNS address is 2002.AA00.0400.06CC
AppleTalk address is 254.132, zone Twilight
Serial 1 is down, line protocol is down
Internet address is 192.168.7.177, subnet mask is 255.255.255.240
AppleTalk address is 999.1, zone Magnolia Estates

For more information on the parameters or protocols shown in this sample output, see the Cisco IOS
Network Protocols Configuration Guide, Part 1, Network Protocols Configuration Guide, Part 2, and
Network Protocols Configuration Guide, Part 3.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-631

Troubleshooting and Fault Management Commands

show slot

show slot
To display information about the PCMCIA flash memory cards file system, use the show slot command
in user EXEC or privileged EXEC mode.
show slot [all | chips | filesys]

Syntax Description

all

(Optional) Displays all possible flash system information for all PCMCIA
flash cards in the system.

chips

(Optional) Displays flash chip information.

filesys

(Optional) Displays file system information.

Command Modes

User EXEC
Privileged EXEC

Command History

Release

Modification

12.0

This command was introduced.

Usage Guidelines

Note

Use the show slot command to display details about the files in a particular linear PCMCIA flash
memory card of less than 20 MB and some 32 MB linear PCMCIA cards.

Use the show disk command for ATA PCMCIA cards. Other forms of this commands are show disk0:
and show disk1:.
For more information regarding file systems and flash cards, access the PCMCIA Filesystem
Compatibility Matrix and Filesystem Information document at the following URL:
http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751
5.shtml
To see which flash cards are used in your router, use the show version command and look at the bottom
portion of the output.
The following display indicates an ATA PCMCIA flash disk.
Router# show version
.
.
.
46976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes).

The following display indicates a linear PCMCIA flash card with 20480K bytes of flash memory in card
at slot 1 with a sector size of 128K.
Router# show version
.
.
.
20480K bytes of Flash PCMCIA card at slot 1 (Sector size 128K).

Cisco IOS Configuration Fundamentals Command Reference

FR-632

78-11740-02

Troubleshooting and Fault Management Commands

show slot

Note

Examples

In some cases the show slot command will not display the file systems, use show slot0: or show slot1:.

The following example displays information about slot 0. The output is self-explanatory.
Router# show slot
PCMCIA Slot0 flash directory:
File Length
Name/status
1
11081464 c3660-bin-mz.123-9.3.PI5b
[11081528 bytes used, 9627844 available, 20709372 total]
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)

The following example shows all possible flash system information for all PCMCIA flash cards in the
system.
Router# show slot all
Partition
Size
Used
1
20223K 10821K

Free
9402K

Bank-Size
4096K

State
Read/Write

Copy Mode
Direct

PCMCIA Slot0 flash directory:

File Length
Name/status
addr
fcksum ccksum
1
11081464 c3660-bin-mz.123-9.3.PI5b
0x40
0x5EA3 0x5EA3
[11081528 bytes used, 9627844 available, 20709372 total]
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

The following example shows flash chip information

Router# show slot chips
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-633

Troubleshooting and Fault Management Commands

show slot

Related Commands

Command

Description

dir slot0:

Directory listing of files on a PCMCIA Flash card located in slot0.

dir slot1:

Directory listing of files on a PCMCIA Flash card located in slot1.

show slot0:

Displays information about the PCMCIA flash memory cards file system
located in slot 0.

show slot1:

Displays information about the PCMCIA flash memory cards file system
located in slot 1.

Cisco IOS Configuration Fundamentals Command Reference

FR-634

78-11740-02

Troubleshooting and Fault Management Commands

show slot0:

show slot0:
To display information about the PCMCIA flash memory cards file system located in slot 0, use the
show slot0: command in user EXEC or privileged EXEC mode.
show slot0: [all | chips | filesys]

Syntax Description

all

(Optional) Displays all possible flash system information for all PCMCIA
flash cards in the system.

chips

(Optional) Displays flash chip information.

filesys

(Optional) Displays file system information.

Command Modes

User EXEC
Privileged EXEC

Command History

Release

Modification

12.0

This command was introduced.

Usage Guidelines

Note

Use the show slot0: command to display details about the files in a particular linear PCMCIA flash
memory card of less than 20 MB and some 32 MB linear PCMCIA cards.

Use the show disk command for ATA PCMCIA cards. Other forms of this commands are show disk0:
and show disk1:.
For more information regarding file systems and flash cards, access the PCMCIA Filesystem
Compatibility Matrix and Filesystem Information document at the following URL:
http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751
5.shtml
To see which flash cards are used in your router, use the show version command and look at the bottom
portion of the output.
The following display indicates an ATA PCMCIA flash disk.
Router# show version
.
.
.
46976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes).

The following display indicates a linear PCMCIA flash card with 20480K bytes of flash memory in card
at slot 1 with a sector size of 128K.
Router# show version
.
.
.
20480K bytes of Flash PCMCIA card at slot 1 (Sector size 128K).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-635

Troubleshooting and Fault Management Commands

show slot0:

Examples

The following example displays information about slot 0. The output is self-explanatory.
Router# show slot0:
PCMCIA Slot0 flash directory:
File Length
Name/status
1
11081464 c3660-bin-mz.123-9.3.PI5b
[11081528 bytes used, 9627844 available, 20709372 total]
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Router# show slot0: all
Partition
Size
Used
1
20223K 10821K

Free
9402K

Bank-Size
4096K

State
Read/Write

Copy Mode
Direct

PCMCIA Slot0 flash directory:

File Length
Name/status
addr
fcksum ccksum
1
11081464 c3660-bin-mz.123-9.3.PI5b
0x40
0x5EA3 0x5EA3
[11081528 bytes used, 9627844 available, 20709372 total]
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

The following example shows flash chip information.

Router# show slot0: chips
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Related Commands

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

Command

Description

dir slot0:

Directory listing of files on a PCMCIA Flash card located in slot0.

dir slot1:

Directory listing of files on a PCMCIA Flash card located in slot1.

show slot1:

Displays information about the PCMCIA flash memory cards file system
located in slot 1.

show slot

Displays information about the PCMCIA flash memory cards.

Cisco IOS Configuration Fundamentals Command Reference

FR-636

78-11740-02

Troubleshooting and Fault Management Commands

show slot1:

show slot1:
To display information about the PCMCIA flash memory cards file system located in slot 1, use the
show slot1: command in user EXEC or privileged EXEC mode.
show slot1: [all | chips | filesys]

Syntax Description

all

(Optional) Shows all possible flash system information for all PCMCIA
flash cards in the system.

chips

(Optional) Shows flash chip information.

filesys

(Optional) Shows file system information.

Command Modes

User EXEC
Privileged EXEC

Command History

Release

Modification

12.0

This command was introduced.

Usage Guidelines

Note

Use the show slot1: command to display details about the files in a particular linear PCMCIA flash
memory card of less than 20 MB and some 32 MB linear PCMCIA cards located in slot 1.

Use the show disk command for ATA PCMCIA cards. Other forms of this commands are show disk0:
and show disk1:.
For more information regarding file systems and flash cards, access the PCMCIA Filesystem
Compatibility Matrix and Filesystem Information document at the following URL:
http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751
5.shtml
To see which flash cards are used in your router, use the show version command and look at the bottom
portion of the output.
The following display indicates an ATA PCMCIA flash disk.
Router# show version
.
.
.
46976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes).

The following display indicates a linear PCMCIA flash card with 20480K bytes of flash memory in card
at slot 1 with a sector size of 128K.
Router# show version
.
.
.
20480K bytes of Flash PCMCIA card at slot 1 (Sector size 128K).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-637

Troubleshooting and Fault Management Commands

show slot1:

Examples

The following example displays information about slot 0 using the slot0: command form. The output
is self-explanatory.
Router# show slot1:
PCMCIA Slot1 flash directory:
File Length
Name/status
1
10907068 c3660-bin-mz.123-7.9.PI4
[10907132 bytes used, 5739008 available, 16646140 total]
16384K bytes of processor board PCMCIA Slot1 flash (Read/Write)
Router# show slot1: all
Partition
Size
Used
1
20223K 10821K

Free
9402K

Bank-Size
4096K

State
Read/Write

Copy Mode
Direct

PCMCIA Slot0 flash directory:

File Length
Name/status
addr
fcksum ccksum
1
11081464 c3660-bin-mz.123-9.3.PI5b
0x40
0x5EA3 0x5EA3
[11081528 bytes used, 9627844 available, 20709372 total]
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

The following example shows flash chip information.

Router# show slot1: chips
20480K bytes of processor board PCMCIA Slot0 flash (Read/Write)
Chip
1
2
1
2
1
2
1
2
1
2

Bank
1
1
2
2
3
3
4
4
5
5

Code
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0
89A0

Size
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB
2048KB

Name
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL
INTEL

28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA
28F016SA

Cisco IOS Configuration Fundamentals Command Reference

FR-638

78-11740-02

Troubleshooting and Fault Management Commands

show slot1:

Related Commands

Command

Description

dir slot0:

Directory listing of files on a PCMCIA Flash card located in slot0.

dir slot1:

Directory listing of files on a PCMCIA Flash card located in slot1.

show slot0:

Displays information about the PCMCIA flash memory cards file system
located in slot 0.

show slot

Displays information about the PCMCIA flash memory cards.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-639

Troubleshooting and Fault Management Commands

show stacks

show stacks
To monitor the stack usage of processes and interrupt routines, use the show stacks EXEC command.
show stacks

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

The display from this command includes the reason for the last system reboot. If the system was reloaded
because of a system failure, a saved system stack trace is displayed. This information is of use only to
your technical support representative in analyzing crashes in the field. It is included here in case you
need to read the displayed statistics to an engineer over the phone.

The following is sample output from the show stacks command following a system failure:
Router# show stacks
Minimum process stacks:
Free/Size Name
652/1000 Router Init
726/1000 Init
744/1000 BGP Open
686/1200 Virtual Exec
Interrupt level stacks:
Level
Called Free/Size Name
1
0 1000/1000 env-flash
3
738 900/1000 Multiport Communications Interfaces
5
178 970/1000 Console UART
System was restarted by bus error at PC 0xAD1F4, address 0xD0D0D1A
GS Software (GS3), Version 9.1(0.16), BETA TEST SOFTWARE
Compiled Tue 11-Aug-92 13:27 by jthomas
Stack trace from system failure:
FP: 0x29C158, RA: 0xACFD4
FP: 0x29C184, RA: 0xAD20C
FP: 0x29C1B0, RA: 0xACFD4
FP: 0x29C1DC, RA: 0xAD304
FP: 0x29C1F8, RA: 0xAF774
FP: 0x29C214, RA: 0xAF83E
FP: 0x29C228, RA: 0x3E0CA
FP: 0x29C244, RA: 0x3BD3C

Cisco IOS Configuration Fundamentals Command Reference

FR-640

78-11740-02

Troubleshooting and Fault Management Commands

show stacks

Related Commands

Command

Description

show processes

Displays information about the active processes.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-641

Troubleshooting and Fault Management Commands

show subsys

show subsys
To display the subsystem information, use the show subsys privileged EXEC command.
show subsys [class class | name name]

Syntax Description

class class

(Optional) Displays the subsystems of the specified class. Valid

classes are driver, kernel, library, management, protocol, and
registry.

name name

(Optional) Displays the specified subsystem. Use the asterisk

character (*) as a wildcard at the end of the name to list all
subsystems, starting with the specified characters.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Use the show subsys command to confirm that all required features are in the running image.

Examples

In the following example, partial sample output is shown from the show subsys command:
Router# show subsys

static_map
arp
ether
compress
alignment
monvar
slot
oir
atm
ip_addrpool_sys
chat
dialer
flash_services
ip_localpool_sys
nvram_common
ASP
sonict
oc3suni
oc12suni
ds3suni
.
.
.

Class
Kernel
Kernel
Kernel
Kernel
Kernel
Kernel
Kernel
Kernel
Kernel
Library
Library
Library
Library
Library
Driver
Driver
Driver
Driver
Driver
Driver

Version
1.000.001
1.000.001
1.000.001
1.000.001
1.000.002
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001
1.000.001

Cisco IOS Configuration Fundamentals Command Reference

FR-642

78-11740-02

Troubleshooting and Fault Management Commands

show subsys

Table 94 describes the significant fields shown in the display.

Table 94

show subsys Field Descriptions

Field

Description

static_map

Name of the subsystem.

Class

Class of the subsystem. Possible classes include Kernel, Library, Driver,

Protocol, Management, Registry, and SystemInit.

Version

Version of the subsystem.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-643

Troubleshooting and Fault Management Commands

show tcp

show tcp
To display the status of TCP connections, use the show tcp EXEC command.
show tcp [line-number]

Syntax Description

line-number

Command Modes

EXEC

CommandHistory

Release

Modification

10.0

This command was introduced.

Examples

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

The following is sample output from the show tcp command:

Router# show tcp
tty0, connection 1 to host cider
Connection state is ESTAB, I/O status: 1, unread input bytes: 0
Local host: 172.31.232.17, Local port: 11184
Foreign host: 172.31.1.137, Foreign port: 23
Enqueued packets for retransmit: 0, input: 0, saved: 0
Event Timers (current time is 67341276):
Timer:
Retrans
TimeWait
AckHold
Starts:
30
0
32
Wakeups:
1
0
14
Next:
0
0
0
iss:
67317172
irs: 1064896000

snduna:
67317228
rcvnxt: 1064897597

sndnxt:
rcvwnd:

SendWnd
0
0
0

KeepAlive
0
0
0

67317228
2144

sndwnd:
delrcvwnd:

GiveUp
0
0
0

PmtuAger
0
0
0

4096
0

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

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

show tcp Field DescriptionsFirst Section of Output

Field

Description

tty0

Identifying number of the line.

connection 1

Number identifying the TCP connection.

Cisco IOS Configuration Fundamentals Command Reference

FR-644

78-11740-02

Troubleshooting and Fault Management Commands

show tcp

Table 95

show tcp Field DescriptionsFirst Section of Output (continued)

Field

Description

to host xxx

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

Connection state is ESTAB

A connection progresses through a series of states during its lifetime.

These states follow in the order in which a connection progresses
through them.

LISTENWaiting for a connection request from any remote

TCP and port.

SYNSENTWaiting for a matching connection request after

having sent a connection request.

SYNRCVDWaiting for a confirming connection request

acknowledgment after having both received and sent a
connection request.

ESTABIndicates an open connection; data received can be

delivered to the user. This is the normal state for the data transfer
phase of the connection.

FINWAIT1Waiting for a connection termination request from

the remote TCP or an acknowledgment of the connection
termination request previously sent.

FINWAIT2Waiting for a connection termination request from

the remote TCP host.

CLOSEWAITWaiting for a connection termination request

from the local user.

CLOSINGWaiting for a connection termination request

acknowledgment from the remote TCP host.

LASTACKWaiting for an acknowledgment of the connection

termination request previously sent to the remote TCP host.

TIMEWAITWaiting for enough time to pass to be sure the

remote TCP host has received the acknowledgment of its
connection termination request.

CLOSEDIndicates no connection state at all.

For more information, see RFC 793, Transmission Control Protocol

Functional Specification.
I/O status:

Number describing the current internal status of the connection.

unread input bytes:

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

Local host:

IP address of the network server.

Local port:

Local port number, as derived from the following equation:

line-number + (512 * random-number). (The line number uses the
lower nine bits; the other bits are random.)

Foreign host:

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

Foreign port:

Destination port for the remote host.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-645

Troubleshooting and Fault Management Commands

show tcp

Table 95

show tcp Field DescriptionsFirst Section of Output (continued)

Field

Description

Enqueued packets for

retransmit:

Number of packets waiting on the retransmit queue. These are

packets on this TCP connection that have been sent but have not yet
been acknowledged by the remote TCP host.

input:

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

the user.

saved:

Number of received out-of-order packets that are waiting for all

packets comprising the message to be received before they enter the
input queue. For example, if packets 1, 2, 4, 5, and 6 have been
received, packets 1 and 2 would enter the input queue, and packets 4,
5, and 6 would enter the saved queue.

The following line of output shows the current time according to the system clock of the local host:
Event Timers (current time is 67341276):

The time shown is the number of milliseconds since the system started.
The following lines of output display the number of times that various local TCP timeout values were
reached during this connection. In this example, the local host re-sent data 30 times because it received
no response from the remote host, and it sent an acknowledgment many more times because there was
no data on which to piggyback.
Timer:
Starts:
Wakeups:
Next:

Retrans
30
1
0

TimeWait
0
0
0

AckHold
32
14
0

SendWnd
0
0
0

KeepAlive
0
0
0

GiveUp
0
0
0

PmtuAger
0
0
0

Table 96 describes the fields in the preceding lines of output.

Table 96

show tcp Field DescriptionsSecond Section of Output

Field

Description

Timer:

The names of the timers in the display.

Starts:

The number of times the timer has been started during this connection.

Wakeups:

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

Next:

The system clock setting that will trigger the next time this timer will go off.

Retrans

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

TimeWait

The TimeWait timer is used to ensure that the remote system receives a request to
disconnect a session.

AckHold

The Acknowledgment timer is used to delay the sending of acknowledgments to

the remote TCP in an attempt to reduce network use.

SendWnd

The Send Window is used to ensure that there is no closed window due to a lost
TCP acknowledgment.

KeepAlive

The KeepAlive timer is used to control the transmission of test messages to the
remote TCP to ensure that the link has not been broken without the local TCPs
knowledge.

Cisco IOS Configuration Fundamentals Command Reference

FR-646

78-11740-02

Troubleshooting and Fault Management Commands

show tcp

Table 96

show tcp Field DescriptionsSecond Section of Output (continued)

Field

Description

GiveUp

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

PmtuAger

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

The following lines of output display the sequence numbers that TCP uses to ensure sequenced, reliable
transport of data. The local host and remote host each use these sequence numbers for flow control and
to acknowledge receipt of datagrams. Table 97 describes the significant fields shown in the display.
iss:
67317172
irs: 1064896000

Table 97

snduna:
67317228
rcvnxt: 1064897597

sndnxt:
rcvwnd:

67317228
2144

sndwnd:
delrcvwnd:

4096
0

show tcp Field DescriptionsSequence Number

Field

Description

iss:

Initial send sequence number.

snduna:

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

sndnxt:

Sequence number the local host will send next.

sndwnd:

TCP window size of the remote host.

irs:

Initial receive sequence number.

rcvnxt:

Last receive sequence number that the local host has acknowledged.

rcvwnd:

TCP window size of the local host.

delrcvwnd:

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

The following lines of output display values that the local host uses to keep track of transmission times
so that TCP can adjust to the network it is using.
Table 98 describes the significant fields shown in the display.
SRTT: 317 ms, RTTO: 900 ms, RTV: 133 ms, KRTT: 0 ms
minRTT: 4 ms, maxRTT: 300 ms, ACK hold: 300 ms
Flags: higher precedence, idle user, retransmission timeout

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-647

Troubleshooting and Fault Management Commands

show tcp

Table 98

show tcp Field DescriptionsLine Beginning with SRTT

Field

Description

SRTT:

A calculated smoothed round-trip timeout.

RTTO:

Round-trip timeout.

RTV:

Variance of the round-trip time.

KRTT:

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

minRTT:

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

maxRTT:

Largest recorded round-trip timeout.

ACK hold:

Time the local host will delay an acknowledgment in order to piggyback data on it.

Flags:

Properties of the connection.

For more information on these fields, refer to Round Trip Time Estimation, P. Karn & C. Partridge, ACM
SIGCOMM-87, August 1987.
Table 99 describes the significant fields shown in the display.
Datagrams (max data segment is 536 bytes):
Rcvd: 41 (out of order: 0), with data: 34, total data bytes: 1596
Sent: 57 (retransmit: 1), with data: 35, total data bytes: 55

Table 99

Related Commands

show tcp Field DescriptionsLast Section of Output

Field

Description

Rcvd:

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

with data:

Number of these datagrams that contained data.

total data bytes:

Total number of bytes of data in these datagrams.

Sent:

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

with data:

Number of these datagrams that contained data.

total data bytes:

Total number of bytes of data in these datagrams.

Command

Description

show tcp brief

Displays a concise description of TCP connection endpoints.

Cisco IOS Configuration Fundamentals Command Reference

FR-648

78-11740-02

Troubleshooting and Fault Management Commands

show tcp brief

show tcp brief

To display a concise description of TCP connection endpoints, use the show tcp brief EXEC command.
show tcp brief [all]

Syntax Description

all

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Examples

(Optional) Displays status for all endpoints. Without this keyword, endpoints
in the LISTEN state are not shown.

The following is sample output from the show tcp brief command while a user has connected into the
system via Telnet:
Router> show tcp brief
TCB
609789AC

Local Address
Router.cisco.com.23

Foreign Address
cider.cisco.com.3733

(state)
ESTAB

Table 100 describes the significant fields shown in the display.

Table 100

Related Commands

show tcp brief Field Descriptions

Field

Description

TCB

An internal identifier for the endpoint.

Local Address

The local IP address and port.

Foreign Address

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

(state)

The state of the connection. States are described in the syntax description of the
show tcp command.

Command

Description

show tcp

Displays the status of TCP connections.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-649

Troubleshooting and Fault Management Commands

show tdm connections

show tdm connections

To display a snapshot of the time-division multiplexing (TDM) bus connection memory in a
Cisco AS5200 access server, use the show tdm connections EXEC command.
show tdm connections [motherboard | slot slot-number]

Syntax Description

motherboard

(Optional) Motherboard in the Cisco AS5200 access server.

slot slot-number

(Optional) Slot number.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The show tdm connections command shows the connection memory for all TDM bus connections in the
access server if you do not limit the display to the motherboard or a slot.

Examples

In the following example, source stream 3 (ST3) channel 2 switched out of stream 6 (ST6) channel 2 is
shown:
AS5200# show tdm connections motherboard
MT8980 motherboard unit 0, Control Register = 0x1F, ODE Register = 0x06
Connection Memory for ST6:
Ch0: 0x62, Ch1: 0x00, Ch2: 0x00, Ch3: 0x00
Ch4: 0x00, Ch5: 0x00, Ch6: 0x00, Ch7: 0x00
Ch8: 0x00, Ch9: 0x00, Ch10: 0x00, Ch11: 0x00
Ch12: 0x00, Ch13: 0x00, Ch14: 0x00, Ch15: 0x00
Ch16: 0x00, Ch17: 0x00, Ch18: 0x00, Ch19: 0x00
Ch20: 0x00, Ch21: 0x00, Ch22: 0x00, Ch23: 0x00
Ch24: 0x00, Ch25: 0x00, Ch26: 0x00, Ch27: 0x00
Ch28: 0x00, Ch29: 0x00, Ch30: 0x00, Ch31: 0x00

To interpret the hexadecimal number 0x62 into meaningful information, you must translate it into binary
code. These two hexadecimal numbers represent a connection from any stream and a channel on any
stream. The number 6 translates into the binary code 0110, which represents the third-source stream. The
number 2 translates into the binary code 0010, which represents the second-source channel.
Stream 6 (ST6) channel 0 is the destination for ST3 channel 2 in this example.

Related Commands

Command

Description

show tcp

Displays the status of TCP connections.

Cisco IOS Configuration Fundamentals Command Reference

FR-650

78-11740-02

Troubleshooting and Fault Management Commands

show tdm data

show tdm data

To display a snapshot of the time-division multiplexing (TDM) bus data memory in a Cisco AS5200
access server, use the show tdm data EXEC command.
show tdm data [motherboard | slot slot-number]

Syntax Description

motherboard

(Optional) Motherboard in the Cisco AS5200 access server.

slot slot-number

(Optional) Slot number.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The data memory for all TDM bus connections in the access server is displayed if you do not specify a
motherboard or slot.

Examples

In the following example, a snapshot of TDM memory is shown where the normal ISDN idle pattern
(0x7E) is present on all channels of the TDM device resident on the motherboard:
AS5200# show tdm data motherboard
MT8980 motherboard unit
Data Memory for ST0:
Ch0: 0x7E, Ch1: 0x7E,
Ch4: 0x7E, Ch5: 0x7E,
Ch8: 0x7E, Ch9: 0x7E,
Ch12: 0x7E, Ch13: 0x7E,
Ch16: 0x7E, Ch17: 0x7E,
Ch20: 0x7E, Ch21: 0x7E,
Ch24: 0x7E, Ch25: 0x7E,
Ch28: 0x7E, Ch29: 0x7E,
Data Memory for ST1:
Ch0: 0x7E, Ch1: 0x7E,
Ch4: 0x7E, Ch5: 0x7E,
Ch8: 0x7E, Ch9: 0x7E,
Ch12: 0x7E, Ch13: 0x7E,
Ch16: 0x7E, Ch17: 0x7E,
Ch20: 0x7E, Ch21: 0x7E,
Ch24: 0x7E, Ch25: 0x7E,
Ch28: 0x7E, Ch29: 0x7E,

Related Commands

Command

0, Control Register = 0x1F, ODE Register = 0x06

Ch2:
Ch6:
Ch10:
Ch14:
Ch18:
Ch22:
Ch26:
Ch30:

0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,

Ch3:
Ch7:
Ch11:
Ch15:
Ch19:
Ch23:
Ch27:
Ch31:

0x7E
0x7E
0x7E
0x7E
0x7E
0x7E
0x7E
0x7E

Ch2:
Ch6:
Ch10:
Ch14:
Ch18:
Ch22:
Ch26:
Ch30:

0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,
0x7E,

Ch3:
Ch7:
Ch11:
Ch15:
Ch19:
Ch23:
Ch27:
Ch31:

0x7E
0x7E
0x7E
0x7E
0x7E
0x7E
0x7E
0x7E

Description

show tdm connections Displays data about the TDM bus connection memory in a Cisco AS5200
access server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-651

Troubleshooting and Fault Management Commands

show tech-support

show tech-support
To display general information about the router when reporting a problem, use the show tech-support
privileged EXEC command.
show tech-support [page] [password] [cef | ipmulticast | isis | mpls | ospf [process-ID | detail] |
rsvp]

Syntax Description

page

(Optional) Causes the output to display a page of information at a time. Use

the return key to display the next line of output or use the space bar to display
the next page of information. If not used, the output scrolls (that is, does not
stop for page breaks).

password

(Optional) Leaves passwords and other security information in the output. If

not used, passwords and other security-sensitive information in the output are
replaced with the label <removed> (this is the default).

cef

(Optional) Displays show command output specific to Cisco Express

Forwarding (CEF).

ipc

(Optional) Displays show command output specific to Inter-Process

Communications (IPC).

ipmulticast

(Optional) Displays show command output related to the IP Multicast

configuration, including Protocol Independent Multicast (PIM) information,
Internet Group Management Protocol (IGMP) information, and Distance
Vector Multicast Routing Protocol (DVMRP) information.

isis

(Optional) Displays show command output specific to Connectionless

Network Service (CLNS) and Intermediate System-to-Intermediate System
Protocol (ISIS).

mpls

(Optional) Displays show command output specific to Multilayer Switching

Protocol (MPLS) forwarding and applications.

ospf [ process-ID |
detail]

(Optional) Displays show command output specific to Open Shortest Path

First Protocol (OSPF) networking.

rsvp

(Optional) Displays show command output specific to Resource Reservation

Protocol (RSVP) networking.

Defaults

The output scrolls without page breaks.

Passwords and other security information are removed from the output.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.2

This command was introduced.

11.3(7), 11.2(16)

The output for this command was expanded to show additional information
for boot, bootflash, context, and traffic for all enabled protocols.
(CSCdj06229)

Cisco IOS Configuration Fundamentals Command Reference

FR-652

78-11740-02

Troubleshooting and Fault Management Commands

show tech-support

Usage Guidelines

Release

Modification

11.3(7)T

This command was integrated into Cisco IOS Release 11.3(7)T.

12.0

The following keyword extensions were added:

cef

ipmulticast

isis

mpls

ospf

The show tech-support command is useful for collecting a large amount of information about your
routing device for troubleshooting purposes. The output of this command can be provided to technical
support representatives when reporting a problem.
The show tech-support command displays the output of a number of show commands at once. The
output from this command will vary depending on your platform and configuration. For example, Access
Servers will display voice-related show output. Additionally, the show protocol traffic commands will
be displayed for only the protocols enabled on your device. The output of the show tech-support
command can include the output of the following commands:

show apollo traffic

show appletalk traffic

show bootflash

show bootvar

show buffers

show cdp neighbors

show cef

show clns traffic

show context

show controllers

show decnet traffic

show interfaces

show ip cef

show ip interface

show ip traffic

show isis

show mpls

show novell traffic

show processes cpu

show processes memory

show running-config

show stacks

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-653

Troubleshooting and Fault Management Commands

show tech-support

show version

show vines traffic

show xns traffic

show file systems

dir nvram:

show disk0: all

show process cpu

show pci controller

Use of the optional cef, ipmulticast, ipc, isis, mpls , ospf, or rsvp keywords provides a way to display
a number of show commands specific to a particular protocol or process in addition to the show
commands listed previously.
For example, if your TAC support representative suspects that you may have a problem in your Cisco
Express Forwarding (CEF) configuration, you may be asked to provide the output of the show
tech-support cef command. The show tech-support [page] [password] cef command will display the
output from the following commands in addition to the output for the standard show tech-support
command:

show ip cef summary

show adjacency summary

show ip cef events summary

show ip cef inconsistency records detail

show cef interface

show cef events

show cef timers

show interfaces stats

show cef drop

show cef not-cef-switched

Examples

For a sample display of the output from the show tech-support command, refer to the documentation
for the show commands listed in the Usage Guidelines section.

Related Commands

Command

Description

show apollo traffic

Displays information about the number and type of Apollo Domain packets
transmitted and received by the Cisco IOS software.

show appletalk traffic Displays statistics about AppleTalk traffic, including MacIP traffic.
show bootflash

Displays the contents of boot Flash memory.

show bootvar

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.

show buffers

Displays statistics for the buffer pools on the network server.

Cisco IOS Configuration Fundamentals Command Reference

FR-654

78-11740-02

Troubleshooting and Fault Management Commands

show tech-support

Command

Description

show clns traffic

Displays a list of the CLNS packets this router has seen.

show context

Displays context data.

show controllers

Displays information that is specific to the hardware.

show controllers
tech-support

Displays general information about a VIP card when reporting a problem.

show decnet traffic

Displays the DECnet traffic statistics (including datagrams sent, received,

and forwarded).

show interfaces

Displays ALC information.

show ip traffic

Displays statistics about IP traffic.

show novell traffic

Displays information about the number and type of IPX packets transmitted
and received.

show processes cpu

Displays information about the active processes.

show processes
memory

Shows the amount of memory used.

show running-config

Displays the current configuration of your routing device.

show stacks

Displays the stack usage of processes and interrupt routines.

show version

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

show vines traffic

Displays the statistics maintained about VINES protocol traffic.

show xns traffic

Displays information about the number and type of XNS packets transmitted
and received by the Cisco IOS software.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-655

Troubleshooting and Fault Management Commands

test flash

test flash
To test Flash memory on MCI and envm Flash EPROM interfaces, use the test flash EXEC command.
test flash

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Examples

In the following example, the Flash memory is tested:

test flash

Related Commands

Command

Description

test interfaces

Tests the system interfaces on the modular router.

test memory

Performs a test of Multibus memory (including nonvolatile memory) on the

modular router.

Cisco IOS Configuration Fundamentals Command Reference

FR-656

78-11740-02

Troubleshooting and Fault Management Commands

test interfaces

test interfaces
To test the system interfaces on the modular router, use the test interfaces EXEC command.
test interfaces

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The test interfaces EXEC command is intended for the factory checkout of network interfaces. It is not
intended for diagnosing problems with an operational router. The test interfaces output does not report
correct results if the router is attached to a live network. For each network interface that has an IP
address that can be tested in loopback (MCI and ciscoBus Ethernet and all serial interfaces), the test
interfaces command sends a series of ICMP echoes. Error counters are examined to determine the
operational status of the interface.

Examples

In the following example, the system interfaces are tested:

test interfaces

Related Commands

Command

Description

test flash

Tests Flash memory on MCI and envm Flash EPROM interfaces.

test memory

Performs a test of Multibus memory (including nonvolatile memory) on the

modular router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-657

Troubleshooting and Fault Management Commands

test memory

test memory
To perform a test of Multibus memory (including nonvolatile memory) on the modular router, use the
test memory EXEC command. The memory test overwrites memory.
test memory

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

The memory test overwrites memory. If you use the test memory command, you will need to rewrite
nonvolatile memory. For example, if you test Multibus memory, which is the memory used by the CSC-R
4-Mbps Token Ring interfaces, you will need to reload the system before the network interfaces will
operate properly. The test memory command is intended primarily for use by Cisco personnel.

In the following example, the memory is tested:

test memory

Related Commands

Command

Description

test flash

Tests Flash memory on MCI and envm Flash EPROM interfaces.

test interfaces

Tests the system interfaces on the modular router.

Cisco IOS Configuration Fundamentals Command Reference

FR-658

78-11740-02

Troubleshooting and Fault Management Commands

trace (privileged)

trace (privileged)
To discover the routes that packets will actually take when traveling to their destination, use the trace
privileged EXEC command.
trace [protocol] [destination]

Syntax Description

protocol

(Optional) Protocols that can be used are appletalk, clns, ip and vines.

destination

(Optional) Destination address or host name on the command line. The default
parameters for the appropriate protocol are assumed and the tracing action
begins.

Defaults

The protocol argument is based on the Cisco IOS software examination of the format of the destination
argument. For example, if the software finds a destination argument in IP format, the protocol value
defaults to ip.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The trace command works by taking advantage of the error messages generated by routers when a
datagram exceeds its time-to-live (TTL) value.
The trace command starts by sending probe datagrams with a TTL value of one. This causes the first
router to discard the probe datagram and send back an error message. The trace command sends several
probes at each TTL level and displays the round-trip time for each.
The trace command sends out one probe at a time. Each outgoing packet may result in one or two error
messages. A time exceeded error message indicates that an intermediate router has seen and discarded
the probe. A destination unreachable error message indicates that the destination node has received
the probe and discarded it because it could not deliver the packet. If the timer goes off before a response
comes in, the trace command prints an asterisk (*).
The trace command terminates when the destination responds, when the maximum TTL is exceeded, or
when the user interrupts the trace with the escape sequence. By default, to invoke the escape sequence,
type Ctrl-^ X by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing
the X key.
To use nondefault parameters and invoke an extended trace test, enter the command without a
destination argument. You will be stepped through a dialog to select the desired parameters.
Common Trace Problems

Due to bugs in the IP implementation of various hosts and routers, the IP trace command may behave
in unexpected ways.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-659

Troubleshooting and Fault Management Commands

trace (privileged)

Not all destinations will respond correctly to a probe message by sending back an ICMP port
unreachable message. A long sequence of TTL levels with only asterisks, terminating only when the
maximum TTL has been reached, may indicate this problem.
There is a known problem with the way some hosts handle an ICMP TTL exceeded message. Some
hosts generate an ICMP message but they reuse the TTL of the incoming packet. Because this is zero,
the ICMP packets do not make it back. When you trace the path to such a host, you may see a set of TTL
values with asterisks (*). Eventually the TTL gets high enough that the ICMP message can get back. For
example, if the host is six hops away, the trace command will time out on responses 6 through 11.
Trace IP Routes

The following display shows sample IP trace output when a destination host name has been specified:
Router# trace ABA.NYC.mil
Type escape sequence to abort.
Tracing the route to ABA.NYC.mil (26.0.0.73)
1 DEBRIS.CISCO.COM (192.180.1.6) 1000 msec 8 msec 4 msec
2 BARRNET-GW.CISCO.COM (192.180.16.2) 8 msec 8 msec 8 msec
3 EXTERNAL-A-GATEWAY.STANFORD.EDU (192.42.110.225) 8 msec 4 msec 4 msec
4 BB2.SU.BARRNET.NET (192.200.254.6) 8 msec 8 msec 8 msec
5 SU.ARC.BARRNET.NET (192.200.3.8) 12 msec 12 msec 8 msec
6 MOFFETT-FLD-MB.in.MIL (192.52.195.1) 216 msec 120 msec 132 msec
7 ABA.NYC.mil (26.0.0.73) 412 msec 628 msec 664 msec

Table 101 describes the significant fields shown in the display.

Table 101

trace Field Descriptions

Field

Description

Indicates the sequence number of the router in the path to the host.

DEBRIS.CISCO.COM

Host name of this router.

192.180.1.6

Internet address of this router.

1000 msec 8 msec 4 msec

Round-trip time for each of the three probes that are sent.

Extended IP Trace Dialog

The following display shows a sample trace session involving the extended dialog of the trace
command:
Router# trace
Protocol [ip]:
Target IP address: mit.edu
Source address:
Numeric display [n]:
Timeout in seconds [3]:
Probe count [3]:
Minimum Time to Live [1]:
Maximum Time to Live [30]:
Port Number [33434]:
Loose, Strict, Record, Timestamp, Verbose[none]:
Type escape sequence to abort.
Tracing the route to MIT.EDU (18.72.2.1)
1 ICM-DC-2-V1.ICP.NET (192.108.209.17) 72 msec 72 msec 88 msec
2 ICM-FIX-E-H0-T3.ICP.NET (192.157.65.122) 80 msec 128 msec 80 msec
3 192.203.229.246 540 msec 88 msec 84 msec
4 T3-2.WASHINGTON-DC-CNSS58.T3.ANS.NET (140.222.58.3) 84 msec 116 msec 88 msec

Cisco IOS Configuration Fundamentals Command Reference

FR-660

78-11740-02

Troubleshooting and Fault Management Commands

trace (privileged)

5
6
7
8
9
10
11
12

T3-3.WASHINGTON-DC-CNSS56.T3.ANS.NET (140.222.56.4) 80 msec 132 msec 88 msec

T3-0.NEW-YORK-CNSS32.T3.ANS.NET (140.222.32.1) 92 msec 132 msec 88 msec
T3-0.HARTFORD-CNSS48.T3.ANS.NET (140.222.48.1) 88 msec 88 msec 88 msec
T3-0.HARTFORD-CNSS49.T3.ANS.NET (140.222.49.1) 96 msec 104 msec 96 msec
T3-0.ENSS134.T3.ANS.NET (140.222.134.1) 92 msec 128 msec 92 msec
W91-CISCO-EXTERNAL-FDDI.MIT.EDU (192.233.33.1) 92 msec 92 msec 112 msec
E40-RTR-FDDI.MIT.EDU (18.168.0.2) 92 msec 120 msec 96 msec
MIT.EDU (18.72.2.1) 96 msec 92 msec 96 msec

Table 102 describes the fields that are unique to the extended trace sequence, as shown in the display.
Table 102

trace Field Descriptions

Field

Description

Target IP address

You must enter a host name or an IP address. There is no default.

Source address

One of the interface addresses of the router to use as a source address

for the probes. The router will normally pick what it feels is the best
source address to use.

Numeric display

The default is to have both a symbolic and numeric display; however,

you can suppress the symbolic display.

Timeout in seconds

The number of seconds to wait for a response to a probe packet. The

default is 3 seconds.

Probe count

The number of probes to be sent at each TTL level. The default count
is 3.

Minimum Time to Live [1]

The TTL value for the first probes. The default is 1, but it can be set to
a higher value to suppress the display of known hops.

Maximum Time to Live [30] The largest TTL value that can be used. The default is 30. The trace
command terminates when the destination is reached or when this
value is reached.
Port Number

The destination port used by the User Datagram Protocol (UDP) probe
messages. The default is 33434.

Loose, Strict, Record,

Timestamp, Verbose

IP header options. You can specify any combination. The trace

command issues prompts for the required fields. Note that the trace
command will place the requested options in each probe; however,
there is no guarantee that all routers (or end nodes) will process the
options.

Loose

Allows you to specify a list of nodes that must be traversed when going
to the destination.

Strict

Allows you to specify a list of nodes that must be the only nodes
traversed when going to the destination.

Record

Allows you to specify the number of hops to leave room for.

Timestamp

Allows you to specify the number of time stamps to leave room for.

Verbose

If you select any option, the verbose mode is automatically selected

and the trace command prints the contents of the option field in any
incoming packets. You can prevent verbose mode by selecting it again,
toggling its current setting.

Table 103describes the characters that can appear in trace command output.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-661

Troubleshooting and Fault Management Commands

trace (privileged)

Table 103

Related Commands

ip trace Text Characters

Char

Description

nn msec

For each node, the round-trip time (in milliseconds) for the specified number of
probes.

The probe timed out.

Unknown packet type.

Administratively unreachable. Usually, this output indicates that an access list

is blocking traffic.

Host unreachable.

Network unreachable.

Protocol unreachable.

Source quench.

Port unreachable.

Command

Description

trace (user)

Discovers the CLNS routes that packets will actually take when traveling to
their destination.

Cisco IOS Configuration Fundamentals Command Reference

FR-662

78-11740-02

Troubleshooting and Fault Management Commands

trace (user)

trace (user)
To discover the IP routes that packets will actually take when traveling to their destination, use the trace
EXEC command.
trace [protocol] [destination]

Syntax Description

protocol

(Optional) Protocols that can be used are appletalk, clns, ip and vines.

destination

(Optional) Destination address or host name on the command line. The default
parameters for the appropriate protocol are assumed and the tracing action
begins.

Defaults

The protocol argument is based on the Cisco IOS software examination of the format of the destination
argument. For example, if the software finds a destination argument in IP format, the protocol defaults
to ip.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The trace command works by taking advantage of the error messages generated by routers when a
datagram exceeds its time-to-live (TTL) value.
The trace command starts by sending probe datagrams with a TTL value of one. This causes the first
router to discard the probe datagram and send back a system message. The trace command sends several
probes at each TTL level and displays the round-trip time for each.
The trace command sends out one probe at a time. Each outgoing packet may result in one or two system
messages. A time exceeded system message indicates that an intermediate router has seen and
discarded the probe. A destination unreachable system message indicates that the destination node has
received the probe and discarded it because it could not deliver the packet. If the timer goes off before a
response comes in, trace prints an asterisk (*).
The trace command terminates when the destination responds, when the maximum TTL is exceeded, or
when the user interrupts the trace with the escape sequence. By default, to invoke the escape sequence,
type Ctrl-^ X by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing
the X key.
Common Trace Problems

Due to bugs in the IP implementation of various hosts and routers, the IP trace command may behave
in unexpected ways.
Not all destinations will respond correctly to a probe message by sending back an ICMP port
unreachable message. A long sequence of TTL levels with only asterisks, terminating only when the
maximum TTL has been reached, may indicate this problem.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-663

Troubleshooting and Fault Management Commands

trace (user)

There is a known problem with the way some hosts handle an ICMP TTL exceeded message. Some
hosts generate an ICMP message but they reuse the TTL of the incoming packet. Since this is zero, the
ICMP packets do not make it back. When you trace the path to such a host, you may see a set of TTL
values with asterisks (*). Eventually the TTL gets high enough that the ICMP message can get back.
For example, if the host is six hops away, trace will time out on responses 6 through 11.
Trace IP Routes

The following display shows sample IP trace output when a destination host name has been specified:
Router# trace ip ABA.NYC.mil
Type escape sequence to abort.
Tracing the route to ABA.NYC.mil (26.0.0.73)
1 DEBRIS.CISCO.COM (192.180.1.6) 1000 msec 8 msec 4 msec
2 BARRNET-GW.CISCO.COM (192.180.16.2) 8 msec 8 msec 8 msec
3 EXTERNAL-A-GATEWAY.STANFORD.EDU (192.42.110.225) 8 msec 4 msec 4 msec
4 BB2.SU.BARRNET.NET (192.200.254.6) 8 msec 8 msec 8 msec
5 SU.ARC.BARRNET.NET (192.200.3.8) 12 msec 12 msec 8 msec
6 MOFFETT-FLD-MB.in.MIL (192.52.195.1) 216 msec 120 msec 132 msec
7 ABA.NYC.mil (26.0.0.73) 412 msec 628 msec 664 msec

Table 104 describes the significant fields shown in the display.

Table 104

trace Field Descriptions

Field

Description

Indicates the sequence number of the router in the path to the host.

DEBRIS.CISCO.COM

Host name of this router.

192.180.1.61

Internet address of this router.

1000 msec 8 msec 4 msec

Round-trip time for each of the three probes that are sent.

Table 105 describes the characters that can appear in trace output.
Table 105

ip trace Text Characters

Char

Description

nn msec

For each node, the round-trip time (in milliseconds) for the specified number of
probes.

The probe timed out.

Unknown packet type.

Administratively unreachable. Usually, this output indicates that an access list

is blocking traffic.

Host unreachable.

Network unreachable.

Protocol unreachable.

Source quench.

Port unreachable.

Cisco IOS Configuration Fundamentals Command Reference

FR-664

78-11740-02

Troubleshooting and Fault Management Commands

trace (user)

Related Commands

Command

Description

trace (privileged)

Probes the routes that packets follow when traveling to their destination from
the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-665

Troubleshooting and Fault Management Commands

trace (user)

Cisco IOS Configuration Fundamentals Command Reference

FR-666

78-11740-02

SNMP Commands
This chapter describes Cisco IOS Release 12.2 commands used to configure Simple Network
Management Protocol (SNMP) on your routers for the purposes of network monitoring and management.
For SNMP configuration tasks and examples, refer to the Configuring SNMP Support chapter in the
Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-667

SNMP Commands
no snmp-server

no snmp-server
To disable Simple Network Management Protocol (SNMP) agent operation, use the no snmp-server
global configuration command.
no snmp-server

Syntax Description

This command has no arguments or keywords.

Defaults

None

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

This command disables all running versions of SNMP (SNMPv1, SNMPv2C, and SNMPv3) on the
device.

Examples

The following example disables the current running version of SNMP:

Router(config)# no snmp-server

Cisco IOS Configuration Fundamentals Command Reference

FR-668

78-11740-02

SNMP Commands
show management event

show management event

To display the Simple Network Management Protocol (SNMP) Event values that have been configured
on your routing device through the use of the Event MIB, use the show management event command
in privileged EXEC mode.
show management event

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release

Modification

12.1(3)T

This command was introduced.

Usage Guidelines

The Event MIB allows you to configure your own traps, informs, or set operations through the use of an
external network management application. The show management event command is used to display
the values for the Events configured on your system. There are no Cisco IOS CLI commands for
configuring Event MIB values. For information on Event MIB functionality, see RFC 2981, available at
http://www.ietf.org.

Examples

The following example shows sample output of the show management event command:
Router# show management event
Mgmt Triggers:
(1): Owner: aseem
(1): 01, Comment: TestEvent, Sample: Abs, Freq: 120
Test: Existence Threshold Boolean
ObjectOwner: aseem, Object: sethi
OID: ifEntry.10.3, Enabled 1, Row Status 1
Existence Entry: , Absent, Changed
StartUp: Present, Absent
ObjOwn: , Obj: , EveOwn: aseem, Eve: 09
Boolean Entry:
Value: 10, Cmp: 1, Start: 1
ObjOwn: , Obj: , EveOwn: aseem, Eve: 09
Threshold Entry:
Rising: 50000, Falling: 20000
ObjOwn: ase, Obj: 01 RisEveOwn: ase, RisEve: 09 , FallEveOwn: ase, FallEve: 09
Delta Value Table:
(0): Thresh: Rising, Exis: 1, Read: 0, OID: ifEntry.10.3 , val: 69356097

Mgmt Events:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-669

SNMP Commands
show management event

(1): Owner: aseem

(1)Name: 09 , Comment: , Action: Set, Notify, Enabled: 1 Status: 1
Notification Entry:
ObjOwn: , Obj: , OID: ifEntry.10.1
Set:
OID: ciscoSyslogMIB.1.2.1.0, SetValue: 199, Wildcard: 2 TAG: , ContextName:
Object Table:
(1): Owner: aseem
(1)Name: sethi, Index: 1, OID: ifEntry.10.1, Wild: 1, Status: 1

Related Commands

Command

Description

debug management event Allows real-time monitoring of Event MIB activities for the purposes of
debugging.

Cisco IOS Configuration Fundamentals Command Reference

FR-670

78-11740-02

SNMP Commands
show snmp

show snmp
To check the status of Simple Network Management Protocol (SNMP) communications, use the
show snmp EXEC command.
show snmp

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Examples

This command provides counter information for SNMP operations. It also displays the chassis ID string
defined with the snmp-server chassis-id global configuration command.

The following is sample output from the show snmp command:

Router# show snmp
Chassis: 01506199
37 SNMP packets input
0 Bad SNMP version errors
4 Unknown community name
0 Illegal operation for community name supplied
0 Encoding errors
24 Number of requested variables
0 Number of altered variables
0 Get-request PDUs
28 Get-next PDUs
0 Set-request PDUs
78 SNMP packets output
0 Too big errors (Maximum packet size 1500)
0 No such name errors
0 Bad values errors
0 General errors
24 Response PDUs
13 Trap PDUs
SNMP logging: enabled
Logging to 171.69.58.33.162, 0/10, 13 sent, 0 dropped.

SNMP Manager-role output packets

4 Get-request PDUs
4 Get-next PDUs
6 Get-bulk PDUs
4 Set-request PDUs
23 Inform-request PDUs
30 Timeouts

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-671

SNMP Commands
show snmp

0 Drops
SNMP Manager-role input packets
0 Inform response PDUs
2 Trap PDUs
7 Response PDUs
1 Responses with errors
SNMP informs: enabled
Informs in flight 0/25 (current/max)
Logging to 171.69.217.141.162
4 sent, 0 in-flight, 1 retries, 0 failed, 0 dropped
Logging to 171.69.58.33.162
0 sent, 0 in-flight, 0 retries, 0 failed, 0 dropped

Table 106 describes the fields shown in the display.

Table 106

show snmp Field Descriptions

Field

Description

Chassis

Chassis ID string.

SNMP packets input

Total number of SNMP packets input.

Bad SNMP version errors

Number of packets with an invalid SNMP version.

Unknown community name

Number of SNMP packets with an unknown community name.

Illegal operation for

community name supplied

Number of packets requesting an operation not allowed for that

community.

Encoding errors

Number of SNMP packets that were improperly encoded.

Number of requested
variables

Number of variables requested by SNMP managers.

Number of altered variables

Number of variables altered by SNMP managers.

Get-request PDUs

Number of get requests received.

Get-next PDUs

Number of get-next requests received.

Set-request PDUs

Number of set requests received.

SNMP packets output

Total number of SNMP packets sent by the router.

Too big errors

Number of SNMP packets which were larger than the maximum

packet size.

Maximum packet size

Maximum size of SNMP packets.

No such name errors

Number of SNMP requests that specified a MIB object that does not
exist.

Bad values errors

Number of SNMP set requests that specified an invalid value for a

MIB object.

General errors

Number of SNMP set requests that failed due to some other error. (It
was not a noSuchName error, badValue error, or any of the other
specific errors.)

Response PDUs

Number of responses sent in reply to requests.

Trap PDUs

Number of SNMP traps sent.

SNMP logging
sent

Indicates whether logging is enabled or disabled.

Number of traps sent.

Cisco IOS Configuration Fundamentals Command Reference

FR-672

78-11740-02

SNMP Commands
show snmp

Table 106

show snmp Field Descriptions (continued)

Field
dropped

SNMP Manager-role output

packets

Number of traps dropped. Traps are dropped when the trap queue for
a destination exceeds the maximum length of the queue, as set by the
snmp-server queue-length global configuration command.
Information related to packets sent by the router as an SNMP
manager.

Get-request PDUs

Number of get requests sent.

Get-next PDUs

Number of get-next requests sent.

Get-bulk PDUs

Number of get-bulk requests sent.

Set-request PDUs

Number of set requests sent.

Inform-request PDUs

Number of inform requests sent.

Timeouts

Number of request timeouts.

Drops

Number of requests dropped. Reasons for drops include no memory,

a bad destination address, or an unreasonable destination address.

SNMP Manager-role input

packets

Information related to packets received by the router as an SNMP

manager.

Inform response PDUs

Number of inform request responses received.

Trap PDUs

Number of SNMP traps received.

Response PDUs

Number of responses received.

Responses with errors

Number of responses containing errors.

SNMP informs

Related Commands

Description

Indicates whether SNMP informs are enabled.

Informs in flight

Current and maximum possible number of informs waiting to be

acknowledged.

Logging to

Destination of the following informs.

sent

Number of informs sent to this host.

in-flight

Number of informs currently waiting to be acknowledged.

retries

Number of inform retries sent.

failed

Number of informs that were never acknowledged.

dropped

Number of unacknowledged informs that were discarded to make

room for new informs.

Command

Description

show snmp pending

Displays the current set of pending SNMP requests.

show snmp sessions

Displays the current SNMP sessions.

snmp-server chassis-id

Provides a message line identifying the SNMP server serial

number.

snmp-server manager

Starts the SNMP manager process.

snmp-server manager session-timeout Sets the amount of time before a nonactive session is
destroyed.
snmp-server queue-length

Establishes the message queue length for each trap host.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-673

SNMP Commands
show snmp engineID

show snmp engineID

To display the identification of the local Simple Network Management Protocol (SNMP) engine and all
remote engines that have been configured on the router, use the show snmp engineID EXEC command.
show snmp engineID

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

An SNMP engine is a copy of SNMP that can reside on a local or remote device.

Examples

The following example specifies 00000009020000000C025808 as the local engineID and

123456789ABCDEF000000000 as the remote engine ID, 171.69.37.61 as the IP address of the remote
engine (copy of SNMP) and 162 as the port from which the remote device is connected to the local
device:
router# show snmp engineID
Local SNMP engineID: 00000009020000000C025808
Remote Engine ID
IP-addr
Port
123456789ABCDEF000000000
171.69.37.61
162

Table 107 describes the fields shown in the example.

Table 107

Related Commands

show snmp engineID Field Descriptions

Field

Definition

Local SNMP engine ID

A string that identifies the copy of SNMP on the local

device.

Remote Engine ID

A string that identifies the copy of SNMP on the remote

device.

IP-addr

The IP address of the remote device.

Port

The port number on the local device to which the remote

device is connected.

Command

Description

snmp-server engineID

Configures a name for either the local or remote SNMP engine on the
router.

Cisco IOS Configuration Fundamentals Command Reference

FR-674

78-11740-02

SNMP Commands
show snmp group

show snmp group

To display the names of groups on the router and the security model, the status of the different views,
and the storage type of each group, use the show snmp group EXEC command.
show snmp group

Syntax Description

This command has no keywords or arguments.

Command Modes

EXEC

Command History

Release

Modification

12.0(3)T

This command was introduced.

Examples

The following example specifies the group name as public, the security model as v1, the read view name
as v1default, the notify view name as *tv.FFFFFFFF, and the storage type as volatile:
router# show snmp group
groupname: public
security model:v1
readview:v1default
writeview: no writeview specified
notifyview: *tv.FFFFFFFF
storage-type: volatile

Table 108 describes the fields shown in the example.

Table 108

Related Commands

show snmp group Field Descriptions

Field

Definition

groupname

The name of the SNMP group, or collection of users that have a

common access policy.

security model

The security model used by the group, either v1, v2c, or v3.

readview

A string identifying the read view of the group.

writeview

A string identifying the write view of the group.

notifyview

A string identifying the notify view of the group.

storage-type

Indicates whether the settings have been set in volatile or

temporary memory on the device, or in nonvolatile or persistent
memory where settings will remain after the device has been
turned off and on again.

Command

Description

snmp-server group

Configures a new SNMP group or a table that maps SNMP users to SNMP
views.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-675

SNMP Commands
show snmp pending

show snmp pending

To display the current set of pending Simple Network Management Protocol (SNMP) requests, use the
show snmp pending EXEC command.
show snmp pending

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.3 T

This command was introduced.

Usage Guidelines

After the SNMP manager sends a request, the request is pending until the manager receives a response
or the request timeout expires.

Examples

The following is sample output from the show snmp pending command:
Router# show snmp pending
req
req
req
req

id:
id:
id:
id:

47,
49,
51,
53,

dest:
dest:
dest:
dest:

171.69.58.33.161,
171.69.58.33.161,
171.69.58.33.161,
171.69.58.33.161,

V2C
V2C
V2C
V2C

community:
community:
community:
community:

public,
public,
public,
public,

Expires
Expires
Expires
Expires

in
in
in
in

5
6
6
8

secs
secs
secs
secs

Table 109 describes the fields shown in the display.

Table 109

Related Commands

show snmp pending Field Descriptions

Field

Description

req id

ID number of the pending request.

dest

IP address of the intended receiver of the request.

V2C community

SNMP version 2C community string sent with the request.

Expires in

Remaining time before request timeout expires.

Command

Description

show snmp

Checks the status of SNMP communications.

show snmp sessions

Displays the current SNMP sessions.

snmp-server manager

Starts the SNMP manager process.

snmp-server manager
session-timeout

Sets the amount of time before a nonactive session is

destroyed.

Cisco IOS Configuration Fundamentals Command Reference

FR-676

78-11740-02

SNMP Commands
show snmp sessions

show snmp sessions

To display the current Simple Network Management Protocol (SNMP) sessions, use the show snmp
sessions EXEC command.
show snmp sessions [brief]

Syntax Description

brief

Command Modes

EXEC

Command History

Release

Modification

11.3 T

This command was introduced.

(Optional) Displays a list of sessions only. Does not display session

statistics.

Usage Guidelines

Sessions are created when the SNMP manager in the router sends SNMP requests, such as inform
requests, to a host or receives SNMP notifications from a host. One session is created for each
destination host. If there is no further communication between the router and host within the session
timeout period, the corresponding session will be deleted.

Examples

The following is sample output from the show snmp sessions command:
Router# show snmp sessions
Destination: 171.69.58.33.162, V2C community: public
Round-trip-times: 0/0/0 (min/max/last)
packets output
0 Gets, 0 GetNexts, 0 GetBulks, 0 Sets, 4 Informs
0 Timeouts, 0 Drops
packets input
0 Traps, 0 Informs, 0 Responses (0 errors)
Destination: 171.69.217.141.162, V2C community: public, Expires in 575 secs
Round-trip-times: 1/1/1 (min/max/last)
packets output
0 Gets, 0 GetNexts, 0 GetBulks, 0 Sets, 4 Informs
0 Timeouts, 0 Drops
packets input
0 Traps, 0 Informs, 4 Responses (0 errors)

The following is sample output from the show snmp sessions brief command:
Router# show snmp sessions brief
Destination: 171.69.58.33.161, V2C community: public, Expires in 55 secs

Table 110 describes the fields shown in these displays.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-677

SNMP Commands
show snmp sessions

Table 110

show snmp sessions Field Descriptions

Field

Description

Destination

IP address of the remote agent.

V2C community

SNMP version 2C community string used to communicate with the

remote agent.

Expires in

Remaining time before the session timeout expires.

Round-trip-times

Minimum, maximum, and the last round-trip time to the agent.

packets output

Packets sent by the router.

Gets

Number of get requests sent.

GetNexts

Number of get-next requests sent.

GetBulks

Number of get-bulk requests sent.

Sets

Number of set requests sent.

Informs

Number of inform requests sent.

Timeouts

Number of request timeouts.

Drops

Number of packets that could not be sent.

packets input

Related Commands

Packets received by the router.

Traps

Number of traps received.

Informs

Number of inform responses received.

Responses

Number of request responses received.

errors

Number of responses that contained an SNMP error code.

Command

Description

show snmp

Checks the status of SNMP communications.

show snmp pending

Displays the current set of pending SNMP requests.

snmp-server manager

Starts the SNMP manager process.

snmp-server manager
session-timeout

Sets the amount of time before a nonactive session is

destroyed.

Cisco IOS Configuration Fundamentals Command Reference

FR-678

78-11740-02

SNMP Commands
show snmp user

show snmp user

To display information on each Simple Network Management Protocol (SNMP) username in the group
username table, use the show snmp user EXEC command.
show snmp user

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

An SNMP user is a remote user for which an SNMP management operation is performed. For example,
inform operations can be sent to a user on a remote SNMP engine. The user is designated using the
snmp-server user command.

Examples

The following example specifies the username as authuser, the engine ID string as
00000009020000000C025808, and the storage-type as nonvolatile:
router# show snmp user
User name: authuser
Engine ID: 00000009020000000C025808
storage-type: nonvolatile

Table 111 describes fields shown in the example.

Table 111

Related Commands

show snmp user Field Descriptions

Field

Definition

User name

A string identifying the name of the SNMP user.

Engine ID

A string identifying the name of the copy of SNMP on the

device.

storage-type

Indicates whether the settings have been set in volatile or

temporary memory on the device, or in nonvolatile or persistent
memory where settings will remain after the device has been
turned off and on again.

Command

Description

snmp-server user

Configures a new user to an SNMP group.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-679

SNMP Commands
snmp-server access-policy

snmp-server access-policy
This command is no longer valid. The functionality provided by this command has been removed from
the Cisco IOS software.

Cisco IOS Configuration Fundamentals Command Reference

FR-680

78-11740-02

SNMP Commands
snmp-server chassis-id

snmp-server chassis-id
To provide a message line identifying the Simple Network Management Protocol (SNMP) server serial
number, use the snmp-server chassis-id global configuration command. To restore the default value, if
any, use the no form of this command.
snmp-server chassis-id text
no snmp-server chassis-id

Syntax Description

text

Defaults

On hardware platforms where the serial number can be machine read, the default is the serial number.
For example, a Cisco 7000 router has a default chassis-id value of its serial number.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Message you want to enter to identify the chassis serial number.

The Cisco MIB provides a chassis MIB variable that enables the SNMP manager to gather data on system
card descriptions, chassis type, chassis hardware version, chassis ID string, software version of ROM
monitor, software version of system image in ROM, bytes of processor RAM installed, bytes of NVRAM
installed, bytes of NVRAM in use, current configuration register setting, and the value of the
configuration register at the next reload. The following installed card information is provided: type of
card, serial number, hardware version, software version, and chassis slot number.
The chassis ID message can be seen with the show snmp command.

Examples

In the following example, the chassis serial number specified is 1234456:

Router(config)# snmp-server chassis-id 1234456

Related Commands

Command

Description

show snmp

Checks the status of SNMP communications.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-681

SNMP Commands
snmp-server community

snmp-server community
To set up the community access string to permit access to the Simple Network Management Protocol
(SNMP), use the snmp-server community global configuration command. To remove the specified
community string, use the no form of this command.
snmp-server community string [view view-name] [ro | rw] [number]
no snmp-server community string

Syntax Description

Defaults

string

Community string that acts like a password and permits access to the SNMP
protocol.

view view-name

(Optional) Name of a previously defined view. The view defines the objects
available to the community.

ro

(Optional) Specifies read-only access. Authorized management stations are only

able to retrieve MIB objects.

rw

(Optional) Specifies read-write access. Authorized management stations are able

to both retrieve and modify MIB objects.

number

(Optional) Integer from 1 to 99 that specifies an access list of IP addresses that are
allowed to use the community string to gain access to the SNMP agent.

By default, an SNMP community string permits read-only access to all objects.

Note

If the snmp-server community command is not used during the SNMP configuration session, it will
automatically be added to the configuration after the snmp host command is used. In this case, the
default password (string) for the snmp-server community will be taken from the snmp host
command.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

The no snmp-server command disables all versions of SNMP (SNMPv1, SNMPv2C, SNMPv3).
The first snmp-server command that you enter enables all versions of SNMP.

Examples

The following example assigns the string comaccess to SNMP allowing read-only access and specifies
that IP access list 4 can use the community string:
Router(config)# snmp-server community comaccess ro 4

Cisco IOS Configuration Fundamentals Command Reference

FR-682

78-11740-02

SNMP Commands
snmp-server community

The following example assigns the string mgr to SNMP allowing read-write access to the objects in the
restricted view:
Router(config)# snmp-server community mgr view restricted rw

The following example removes the community comaccess:

Router(config)# no snmp-server community comaccess

The following example disables all versions of SNMP:

Router(config)# no snmp-server

Related Commands

Command

Description

access-list

Configures the access list mechanism for filtering frames by protocol type or
vendor code.

snmp-server view

Creates or updates a view entry.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-683

SNMP Commands
snmp-server contact

snmp-server contact
To set the system contact (sysContact) string, use the snmp-server contact global configuration
command. To remove the system contact information, use the no form of this command.
snmp-server contact text
no snmp-server contact

Syntax Description

text

Defaults

No system contact string is set.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

String that describes the system contact information.

The following is an example of a system contact string:

Router(config)# snmp-server contact Dial System Operator at beeper # 27345

Related Commands

Command

Description

snmp-server location

Sets the system location string.

Cisco IOS Configuration Fundamentals Command Reference

FR-684

78-11740-02

SNMP Commands
snmp-server context

snmp-server context
This command is no longer valid. The functionality provided by this command has been removed from
the Cisco IOS software.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-685

SNMP Commands
snmp-server enable informs

snmp-server enable informs

This command has no functionality. To enable the sending of Simple Network Management Protocol
(SNMP) inform notifications, use one of the snmp-server enable traps notification-type global
configuration commands combined with the snmp-server host host-addr informs global configuration
command.

Cisco IOS Configuration Fundamentals Command Reference

FR-686

78-11740-02

SNMP Commands
snmp-server enable traps

snmp-server enable traps

To enable all Simple Network Management Protocol (SNMP) notifications (traps or informs) available
on your system, use the snmp-server enable traps global configuration command. To disable all
available SNMP notifications, use the no form of this command.
snmp-server enable traps [notification-type]
no snmp-server enable traps [notification-type]

Syntax Description

notification-type

(Optional) Type of notification (trap or inform) to enable or disable. If no type

is specified, all notifications available on your device are enabled or disabled.
The notification type can be one of the following keywords:

configControls configuration notifications, as defined in the

CISCO-CONFIG-MAN-MIB (enterprise 1.3.6.1.4.1.9.9.43.2). The
notification type is: (1) ciscoConfigManEvent.

dlsw [circuit | tconn]Controls DLSw notifications, as defined in the

CISCO-DLSW-MIB (enterprise 1.3.6.1.4.1.9.10.9.1.7). When the dlsw
keyword is used, you can specify the specific notification types you wish
to enable or disable. If no keyword is used, all DLSw notification types are
enabled. The option can be one of the following keywords:
circuitEnables DLSw circuit traps:

(5) ciscoDlswTrapCircuitUp
(6) ciscoDlswTrapCircuitDown
tconnEnables DLSw peer transport connection traps:

(1) ciscoDlswTrapTConnPartnerReject
(2) ciscoDlswTrapTConnProtViolation
(3) ciscoDlswTrapTConnUp
(4) ciscoDlswTrapTConnDown

ds0-busyoutSends notification whenever the busyout of a DS0

interface changes state (Cisco AS5300 platform only). This is from the
CISCO-POP-MGMT-MIB (enterprise 1.3.6.1.4.1.9.10.19.2) and the
notification type is:(1) cpmDS0BusyoutNotification

ds1-loopbackSends notification whenever the DS1 interface goes into

loopback mode (Cisco AS5300 platform only). This notification type is
defined in the CISCO-POP-MGMT-MIB (enterprise 1.3.6.1.4.1.9.10.19.2)
as: (2) cpmDS1LoopbackNotification.

entityControls Entity MIB modification notifications. This notification

type is defined in the ENTITY-MIB (enterprise 1.3.6.1.2.1.47.2) as:
(1) entConfigChange.

hsrpControls Hot Standby Routing Protocol (HSRP) notifications, as

defined in the CISCO-HSRP-MIB (enterprise 1.3.6.1.4.1.9.9.106.2). The
notification type is: (1) cHsrpStateChange.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-687

SNMP Commands
snmp-server enable traps

Defaults

ipmulticastControls IP Multicast notifications.

modem-healthControls modem-health notifications.

rsvpControls Resource Reservation Protocol (RSVP) notifications.

rtrControls Service Assurance Agent / Response Time Reporter (RTR)

notifications.

syslogControls error message notifications (Cisco Syslog MIB).

Specify the level of messages to be sent with the logging history level
command.

xgcpSends External Media Gateway Control Protocol (XGCP)

notifications. This notification is from the XGCP-MIB-V1SMI.my and the
notifications are: enterprise 1.3.6.1.3.90.2 (1) xgcpUpDownNotification

This command is disabled by default. Most notification types are disabled. However, some notification
types cannot be controlled with this command.
If you enter this command with no notification-type keywords, the default is to enable all notification
types controlled by this command.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced with the frame-relay, isdn, and envmon trap
types.

12.0(2)T

The rsvp keyword was added.

12.0(3)T

The hsrp keyword was added.

Usage Guidelines

For additional notification types, see the Related Commands table for this command.
SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests for the specified notification types. To specify whether the notifications should be sent as traps
or informs, use the snmp-server host [traps | informs] command.
If you do not enter an snmp-server enable traps command, no notifications controlled by this command
are sent. In order to configure the router to send these SNMP notifications, you must enter at least one
snmp-server enable traps command. If you enter the command with no keywords, all notification types
are enabled. If you enter the command with a keyword, only the notification type related to that keyword
is enabled. In order to enable multiple types of notifications, you must issue a separate
snmp-server enable traps command for each notification type and notification option.
The snmp-server enable traps command is used in conjunction with the snmp-server host command.
Use the snmp-server host command to specify which host or hosts receive SNMP notifications. In order
to send notifications, you must configure at least one snmp-server host command.

Cisco IOS Configuration Fundamentals Command Reference

FR-688

78-11740-02

SNMP Commands
snmp-server enable traps

Examples

The following example enables the router to send all traps to the host specified by the name
myhost.cisco.com, using the community string defined as public:
Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com public

The following example enables the router to send Frame Relay and environmental monitor traps to the
host myhost.cisco.com using the community string public:
Router(config)# snmp-server enable traps frame-relay
Router(config)# snmp-server enable traps envmon temperature
Router(config)# snmp-server host myhost.cisco.com public

The following example will not send traps to any host. The BGP traps are enabled for all hosts, but the
only traps enabled to be sent to a host are ISDN traps (which are not enabled in this example).
Router(config)# snmp-server enable traps bgp
Router(config)# snmp-server host bob public isdn

The following example enables the router to send all inform requests to the host at the address
myhost.cisco.com, using the community string defined as public:
Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com informs version 2c public

The following example sends HSRP MIB traps to the host myhost.cisco.com using the community string
public.
Router(config)# snmp-server enable traps hsrp
Router(config)# snmp-server host myhost.cisco.com traps version 2c public hsrp

Related Commands

Command

Description

snmp-server enable traps atm pvc Controls (enables or disables) ATM PVC SNMP notifications.
snmp-server enable traps bgp

Controls (enables or disables) BGP server state change SNMP

notifications.

snmp-server enable traps

calltracker

Controls (enables or disables) Call Tracker callSetup and

callTerminate SNMP notifications.

snmp-server enable traps envmon Controls (enables or disables) environmental monitor SNMP
notifications.
snmp-server enable traps
frame-relay

Controls (enables or disables) Frame Relay DLCI link staus

change SNMP notifications.

snmp-server enable traps isdn

Controls (enables or disables) ISDN SNMP notifications.

snmp-server enable traps snmp

Controls (enables or disables) RFC 1157 SNMP notifications.

snmp-server enable traps repeater Controls (enables or disables) RFC 1516 Hub notifications.
snmp-server host

Specifies whether you want the SNMP notifications sent as

traps or informs, the version of SNMP to use, the security level
of the notifications (for SNMPv3), and the recipient (host) of
the notifications.

snmp-server informs

Specifies inform request options.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-689

SNMP Commands
snmp-server enable traps

Command

Description

snmp-server trap-source

Specifies the interface (and hence the corresponding IP

address) that an SNMP trap should originate from.

snmp trap illegal-address

Issues an SNMP trap when a MAC address violation is detected

on an Ethernet hub port of a Cisco 2505, Cisco 2507, or
Cisco 2516 router.

Cisco IOS Configuration Fundamentals Command Reference

FR-690

78-11740-02

SNMP Commands
snmp-server enable traps aaa_server

snmp-server enable traps aaa_server

To enable authentication, authorization, and accounting (AAA) server state-change Simple Network
Management Protocol (SNMP) notifications, use the snmp-server enable traps aaa_server global
configuration command. To disable AAA sever state-change SNMP notifications, use the no form of this
command.
snmp-server enable traps aaa_server
no snmp-server enable traps aaa_server

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced for the Cisco AS5300 and Cisco AS5800.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) AAA Server state change (casServerStateChange)
notifications. ServerStateChange notifications, when enabled, will be sent when the server moves from
an up to dead state or when a server moves from a dead to up state.
The Cisco AAA Server State is defined by the casState object in the Cisco AAA Server MIB. The
possible values are as follows:

up(1)Server is responding to requests.

dead(2)Server failed to respond to requests.

A server is marked "dead" if it does not respond after maximum retransmissions. A server is marked "up"
again either after a waiting period or if some response is received from it. The initial value of casState
is "up(1)" at system startup. This will only transition to "dead(2)" if an attempt to communicate fails.
For a complete description of this notification and additional MIB functions, see the
CISCO-AAA-SERVER-MIB.my file, available on Cisco.com at http://www.cisco.com/public/mibs/v2/.
The snmp-server enable traps aaa_sever command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

The following example enables the router to send AAA Server up/down informs to the host at the address
myhost.cisco.com using the community string defined as public:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-691

SNMP Commands
snmp-server enable traps aaa_server

Router(config)# snmp-server enable traps aaa_server

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

Related Commands

Command

Description

aaa session-mib disconnect

Allows a remote network management system to perform Set

operations and disconnect users on the configured device using
SNMP.

show caller

Displays caller information for Async, Dialer, and Serial interfaces.

show radius statistics

Displays AAA Server MIB statistics for AAA functions.

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-692

78-11740-02

SNMP Commands
snmp-server enable traps atm pvc

snmp-server enable traps atm pvc

To enable the sending of ATM permanent virtual circuit (PVC) Simple Network Management Protocol
(SNMP) notifications, use the snmp-server enable traps atm pvc global configuration command. To
disable ATM PVC-specific SNMP notifications, use the no form of this command.
snmp-server enable traps atm pvc [interval seconds] [fail-interval seconds]
no snmp-server enable traps atm pvc

Syntax Description

interval seconds

(Optional) Minimum period between successive traps, in the range from 1 to

3600.
Generation of PVC traps is dampened by the notification interval in order to
prevent trap storms. No traps are sent until the interval lapses.

fail-interval seconds

Defaults

(Optional) Minimum period for storing the failed time stamp, in the range
from 0 to 3600.

SNMP notifications are disabled by default.

The default interval is 30.
The default fail-interval is 0.

Command Modes

Global configuration

Command History

Release

Modification

12.0(1)T

This command was introduced for those platforms that support ATM PVC
Management.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests for the specified notification types. ATM notifications are defined in the
CISCO-IETF-ATM2-PVCTRAP-MIB.my file, available from the Cisco FTP site at
ftp://www.cisco.com/public/mibs/v2/.
ATM PVC failure notification are sent when a PVC on an ATM interface fails or leaves the UP
operational state. Only one trap is generated per hardware interface, within the specified interval defined
by the interval keyword (stored as the atmIntfPvcNotificationInterval in the MIB). If other PVCs on the
same interface go DOWN during this interval, traps are generated and held until the fail-interval has
elapsed. Once the interval has elapsed, the traps are sent if the PVCs are still DOWN.
No notifications are generated when a PVC returns to the UP state after having been in the DOWN state.
If you need to detect the recovery of PVCs, you must use the SNMP management application to regularly
poll your router.
The snmp-server enable traps atm pvc command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. In order to send notifications, you must configure at least one snmp-server host command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-693

SNMP Commands
snmp-server enable traps atm pvc

Examples

The following example shows the enabling of ATM PVC traps on a router, so that if PVC 0/1 goes down,
host 172.16.61.90 will receive the notifications:
!For ATM PVC Trap Support to work on your router, you must first have SNMP support and
!an IP routing protocol configured on your router:
Router(config)# snmp-server community public ro
Router(config)# snmp-server host 172.16.61.90 public
Router(config)# ip routing
Router(config)# router igrp 109
Router(config-router)# network 172.16.0.0
!
!Enable ATM PVC Trap Support and OAM management:
Router(config)# snmp-server enable traps atm pvc interval 40 fail-interval 10
Router(config)# interface atm 1/0.1
Router(config-if)# pvc 0/1
Router(config-if-atm-vc)# oam-pvc manage

Related Commands

Command

Description

show atm pvc

Displays all ATM permanent virtual circuits (PVCs) and traffic

information.

snmp-server enable traps Enables all available SNMP notifications on your system.
snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-694

78-11740-02

SNMP Commands
snmp-server enable traps bgp

snmp-server enable traps bgp

To enable Border Gateway Protocol (BGP) state-change Simple Network Management Protocol (SNMP)
notifications, use the snmp-server enable traps bgp global configuration command. To disable BGP
state-change SNMP notifications, use the no form of this command.
snmp-server enable traps bgp
no snmp-server enable traps bgp

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced for the Cisco AS5300 and Cisco AS5800.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) Border Gateway Protocol server state change notifications,
as defined in the BGP4-MIB (enterprise 1.3.6.1.2.1.15.7). The notifications types are:
(1) bgpEstablished
(2) bgpBackwardTransition.
The BGP notifications are defined in the BGP-4 MIB as follows:
bgpTraps

OBJECT IDENTIFIER ::= { bgp 7 }

bgpEstablished NOTIFICATION-TYPE
OBJECTS { bgpPeerLastError,
bgpPeerState
}
STATUS current
DESCRIPTION
"The BGP Established event is generated when
the BGP FSM enters the ESTABLISHED state."
::= { bgpTraps 1 }
bgpBackwardTransition NOTIFICATION-TYPE
OBJECTS { bgpPeerLastError,
bgpPeerState
}
STATUS current
DESCRIPTION
"The BGPBackwardTransition Event is generated
when the BGP FSM moves from a higher numbered
state to a lower numbered state."
::= { bgpTraps 2 }

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-695

SNMP Commands
snmp-server enable traps bgp

For a complete description of these notifications and additional MIB functions, see the BGP4-MIB.my
file, available through the Cisco FTP site at ftp://www.cisco.com/public/mibs/v2/.

Note

You may notice incorrect BGP trap OID output when using the SNMP version 1 BGP4-MIB that is
available for download at ftp://ftp.cisco.com/pub/mibs/v1/BGP4-MIB-V1SMI.my. When a router
sends out BGP traps (notifications) about state changes on an SNMP version 1 monitored BGP peer,
the enterprise OID is incorrectly displayed as .1.3.6.1.2.1.15 (bgp) instead of .1.3.6.1.2.1.15.7
(bgpTraps). The problem is not due to any error with Cisco IOS software. This problem occurs
because the BGP4-MIB does not follow RFC 1908 rules regarding version 1 and version 2 trap
compliance. This MIB is controlled by IANA under the guidance of the IETF, and work is currently
in progress by the IETF to replace this MIB with a new version that represents the current state of
the BGP protocol. In the meantime, we recommend that you use the SNMP version 2 BGP4-MIB or
the CISCO-BGP4-MIB to avoid an incorrect trap OID.
The snmp-server enable traps bgp command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

The following example enables the router to send BGP state change informs to the host at the address
myhost.cisco.com using the community string defined as public:
Router(config)# snmp-server enable traps bgp
Router(config)# snmp-server host myhost.cisco.com informs version 2c public

Related Commands

Command

Description

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-696

78-11740-02

SNMP Commands
snmp-server enable traps calltracker

snmp-server enable traps calltracker

To enable Call Tracker CallSetup and Call Terminate Simple Network Management Protocol (SNMP)
notifications, use the snmp-server enable traps calltracker global configuration command. To disable
Call Tracker SNMP notifications, use the no form of this command.
snmp-server enable traps calltracker
no snmp-server enable traps calltracker

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced for the Cisco AS5300 and Cisco AS580
access servers.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) Call Tracker CallSetup and CallTerminate notifications.
CallSetup notifications are generated at the start of each call, when an entry is created in the active table
(cctActiveTable), and CallTerminate notifications are generated at the end of each call, when an entry is
created in the history table (cctHistoryTable).
For a complete description of these notifications and additional MIB functions, refer to the
CISCO-CALL-TRACKER-MIB.my file, available on Cisco.com at
http://www.cisco.com/public/mibs/v2/.
The snmp-server enable traps calltracker command is used in conjunction with the snmp-server host
global configuration command. Use the snmp-server host command to specify which host or hosts
receive SNMP notifications. To send SNMP notifications, you must configure at least one snmp-server
host command.

Examples

The following example enables the router to send call-start and call-stop informs to the host at the
address myhost.cisco.com using the community string defined as public:
Router(config)# snmp-server enable traps calltracker
Router(config)# snmp-server host myhost.cisco.com informs version 2c public calltracker

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-697

SNMP Commands
snmp-server enable traps calltracker

Related Commands

Command

Description

calltracker call-record

Enables call record SYSLOG generation for the purpose of

debugging, monitoring, or externally saving detailed call record
information.

calltracker enable

Enables the Call Tracker feature on an access server.

isdn snmp busyout b-channel

Enables PRI B channels to be busied out via SNMP.

show call calltracker

Displays Call Tracker activity and configuration information such

as the number of active calls and the history table attributes.

show modem calltracker

Displays all of the information stored within the Call Tracker Active
or History Database for the latest call assigned to specified modem.

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-698

78-11740-02

SNMP Commands
snmp-server enable traps envmon

snmp-server enable traps envmon

To enable Environmental Monitor Simple Network Management Protocol (SNMP) notifications, use the
snmp-server enable traps envmon global configuration command. To disable environmental monitor
SNMP notifications, use the no form of this command.
snmp-server enable traps envmon [shutdown] [voltage] [temperature] [fan] [supply]
no snmp-server enable traps envmon [shutdown] [voltage] [temperature] [fan] [supply]

Syntax Description

shutdown

(Optional) Controls shutdown notifications. A

ciscoEnvMonShutdownNotification (enterprise MIB OID
1.3.6.1.4.1.9.9.13.3.1) is sent if the environmental monitor detects a testpoint
reaching a critical state and is about to initiate a shutdown.

voltage

(Optional) Controls voltage notifications. A ciscoEnvMonVoltageNotification

(enterprise MIB OID 1.3.6.1.4.1.9.9.13.3.2) is sent if the voltage measured at
a given testpoint is outside the normal range for the testpoint (i.e. is at the
warning, critical, or shutdown stage).
For access servers, this notification is defined as the caemVoltageNotification
(enterprise MIB OID 1.3.6.1.4.1.9.9.61.2.2).

temperature

(Optional) Controls temperature notifications. A

ciscoEnvMonTemperatureNotification (enterprise MIB OID
1.3.6.1.4.1.9.9.13.3.3) is sent if the temperature measured at a given testpoint
is outside the normal range for the testpoint (i.e. is at the warning, critical, or
shutdown stage).
For access servers, this notification is defined as the
caemTemperatureNotification (enterprise MIB OID 1.3.6.1.4.1.9.9.61.2.1).

fan

(Optional) Controls fan failure notifications. A ciscoEnvMonFanNotification

(enterprise MIB OID 1.3.6.1.4.1.9.9.13.3.4) is sent if any one of the fans in a
fan array fails.

supply

(Optional) Controls Redundant Power Supply (RPS) failure notifications. A

ciscoEnvMonRedundantSupplyNotification (enterprise MIB OID
1.3.6.1.4.1.9.9.13.2.5) is sent if a redundant power supply fails.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

11.3(6)AA

Support for this command was introduced for the Cisco AS5300 access
server.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-699

SNMP Commands
snmp-server enable traps envmon

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) Environmental Monitor (EnvMon) status notifications for
supported systems. Cisco enterprise EnvMon notifications are triggered when an environmental
threshold is exceeded. If none of the optional keywords are specified, all available environmental
notifications are enabled.
For a complete description of these notifications and additional MIB functions, see the
CISCO-ENVMON-MIB.my and CISCO-ACCESS-ENVMON-MIB.my files, available on Cisco.com at
http://www.cisco.com/public/mibs/v2/.
Status of the Environmental Monitor can be viewed using the show environment command.
The snmp-server enable traps envmon command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

The following example enables a Cisco 12000 GSR to send environmental failure informs to the host at
the address myhost.cisco.com using the community string defined as public:
Router(config)# snmp-server enable traps envmon
Router(config)# snmp-server host myhost.cisco.com informs version 2c public envmon

Related Commands

Command

Description

show environment

Displays environmental conditions on the system.

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-700

78-11740-02

SNMP Commands
snmp-server enable traps frame-relay

snmp-server enable traps frame-relay

To enable Frame Relay DLCI link status Simple Network Management Protocol (SNMP) notifications,
use the snmp-server enable traps frame-relay global configuration command. To disable Frame Relay
link status SNMP notifications, use the no form of this command.
snmp-server enable traps frame-relay
no snmp-server enable traps frame-relay

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) Data Link Connection Identifier (DLCI) Frame Relay
notifications, as defined in the RFC1315-MIB (enterprise 1.3.6.1.2.1.10.32).
The notification type is frDLCIStatusChange (1). This trap indicates that the indicated Virtual Circuit
(VC) has changed state, meaning that the VC has either been created or invalidated, or has toggled
between the active and inactive states.

Note

For large scale configurations (systems containing hundreds of Frame Relay point-to-point
subinterfaces), note that having Frame Relay notifications enabled could potentially have a negative
impact on network performance when there are line status changes.
For a complete description of this notification and additional MIB functions, see the RFC1315-MIB.my
file and the CISCO-FRAME-RELAY-MIB.my file, available in the v1 and v2 directories,
repectively, at the Cisco.com MIB web site at
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.
The snmp-server enable traps frame-relay command is used in conjunction with the snmp-server
host command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

In the following examplethe router is configured to send Frame Relay DLCI state change informs to the
host at the address myhost.cisco.com using the community string defined as public:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-701

SNMP Commands
snmp-server enable traps frame-relay

Router(config)# snmp-server enable traps frame-relay

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

Related Commands

Command

Description

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-702

78-11740-02

SNMP Commands
snmp-server enable traps isdn

snmp-server enable traps isdn

To enable the sending of Integrated Services Digital Network (ISDN) specific Simple Network
Management Protocol (SNMP) notifications, use the snmp-server enable traps isdn global
configuration command. To disable ISDN-specific SNMP notifications, use the no form of this
command.
snmp-server enable traps isdn [call-information] [chan-not-avail] [isdnu-interface] [layer2]
no snmp-server enable traps isdn [call-information] [chan-not-avail] [isdnu-interface] [layer2]

Syntax Description

Defaults

call-information

(Optional) Controls SNMP ISDN call information notifications, as defined in

the CISCO-ISDN-MIB (enterprise 1.3.6.1.4.1.9.9.26.2). Notification types
are:

demandNbrCallInformation (1)
This notification is sent to the manager whenever a successful call clears,
or a failed call attempt is determined to have ultimately failed. In the event
that call retry is active, then this is after all retry attempts have failed.
However, only one such notification is sent in between successful call
attempts; subsequent call attempts do not generate notifications of this
type.

demandNbrCallDetails (2)
This notification is sent to the manager whenever a call connects, or
clears, or a failed call attempt is determined to have ultimately failed. In
the event that call retry is active, then this is after all retry attempts have
failed. However, only one such notification is sent in between successful
call attempts; subsequent call attempts do not generate notifications of this
type.

chan-not-avail

(Optional) Controls SNMP ISDN channel-not-available notifications. ISDN

PRI channel-not-available traps are generated when a requested DS-0 channel
is not available, or when there is no modem available to take the incoming call.
These notifications are available only for ISDN PRI interfaces.

isdnu-interface

(Optional) Controls SNMP ISDN U interface notifications.

layer2

(Optional) Controls SNMP ISDN layer2 transition notifications.

SNMP notifications are disabled by default.

If you enter this command with none of the optional keywords, all available notifications are enabled.

Command Modes

Global configuration

Command History

Release

Modification

10.3

The snmp-server enable traps isdn command was introduced.

11.3

The call-information and isdnu-interface keywords were added for the

Cisco 1600 series router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-703

SNMP Commands
snmp-server enable traps isdn

Usage Guidelines

Release

Modification

12.0

Support for the call-information and isdnu-interface keywords was

introduced for most voice platforms.

12.1(5)T

Support for the isdn chan-not-available option was added for the
Cisco AS5300, Cisco AS5400, and Cisco AS5800 access servers only.

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests for the specified notification types. ISDN notifications are defined in the
CISCO-ISDN-MIB.my and CISCO-ISDNU-IF-MIB.my files, available on Cisco.com at
http://www.cisco.com/public/mibs/v2/.
Availability of notifications will depend on your platform. To see what notifications are available, use
the snmp-server enable traps isdn ? command.
If you do not enter an snmp-server enable traps isdn command, no notifications controlled by this
command are sent. In order to configure the router to send these SNMP notifications, you must enter at
least one snmp-server enable traps isdn command. If you enter the command with no keywords, all
notification types are enabled. If you enter the command with a keyword, only the notification type
related to that keyword is enabled.
The snmp-server enable traps snmp command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

The following example shows the checking of what notification types are available on a Cisco AS5300,
and the enabling of channel-not-available and layer2 informs:
NAS(config)#snmp-server enable traps
call-information Enable SNMP isdn
chan-not-avail
Enable SNMP isdn
layer2
Enable SNMP isdn
<cr>

isdn ?
call information traps
channel not avail traps
layer2 transition traps

NAS(config)#snmp-server enable traps isdn chan-not-avail layer2

NAS(config)#snmp-server host myhost.cisco.com informs version 2c public isdn

Related Commands

Command

Description

snmp-server enable traps Enables all available SNMP notifications on your system.
snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server informs

Specifies inform request options.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

FR-704

78-11740-02

SNMP Commands
snmp-server enable traps snmp

snmp-server enable traps snmp

To enable the sending of RFC 1157 Simple Network Management Protocol (SNMP) notifications, use
the snmp-server enable traps snmp global configuration command. To disable RFC 1157 SNMP
notifications, use the no form of this command.
snmp-server enable traps snmp [authentication] [linkup] [linkdown] [coldstart] [warmstart]
no snmp-server enable traps snmp [authentication] [linkup] [linkdown] [coldstart]
[warmstart]

Syntax Description

Defaults

authentication

(Optional) Controls the sending of SNMP authentication failure notifications.

An authenticationFailure(4) trap signifies that the sending device is the
addressee of a protocol message that is not properly authenticated. The
authentication method depends on the version of SNMP being used. For
SNMPv1 or SNMPv2c, authentication failure occurs for packets with an
incorrect community string . For SNMPv3, authentication failure occurs for
packets with an incorrect SHA/MD5 authentication key or for a packet that is
outside of the authoritative SNMP engines window (for example, falls outside
of configured access lists or time ranges).

linkup

(Optional) Controls the sending of SNMP linkUp notifications. A linkUp(3)

trap signifies that the sending device recognizes that one of the communication
links represented in the agents configuration has come up.

linkdown

(Optional) Controls the sending of SNMP linkDown notifications. A

linkDown(2) trap signifies that the sending device recognizes a failure in one
of the communication links represented in the agents configuration.

coldstart

(Optional) Controls the sending of SNMP coldStart notifications. A

coldStart(0) trap signifies that the sending device is reinitializing itself such
that the agents configuration or the protocol entity implementation may be
altered.

warmstart

(Optional) Controls the sending of SNMP warmStart notifications. A

warmStart(1) trap signifies that the sending device is reinitializing itself such
that neither the agent configuration nor the protocol entity implementation is
altered.

SNMP notifications are disabled by default.

If you enter this command with none of the optional keywords, all RFC 1157 SNMP notifications are
enabled (or disabled, if using the no form).

Command Modes

Global configuration

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-705

SNMP Commands
snmp-server enable traps snmp

Command History

Release

Modification

11.3

The snmp-server enable traps snmp authentication command was

introduced. This command replaced the snmp-server trap-authentication
command.

12.1(3)T

The following keywords were added:

12.1(5)T

Usage Guidelines

linkup

linkdown

coldstart

The warmstart keyword was added.

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests for the specified notification types.
If you do not enter an snmp-server enable traps snmp command, no notifications controlled by this
command are sent. In order to configure the router to send these SNMP notifications, you must enter at
least one snmp-server enable traps snmp command. If you enter the command with no keywords, all
notification types are enabled. If you enter the command with a keyword, only the notification type
related to that keyword is enabled.
The snmp-server enable traps snmp command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. In order to send notifications, you must configure at least one snmp-server host command.
For a host to receive a notification controlled by this command, both the snmp-server enable traps
command and the snmp-server host command for that host must be enabled. If the notification type is
not controlled by this command, just the appropriate snmp-server host command must be enabled.
The snmp-server enable traps snmp [ linkup] [linkdown] form of this command globally enables or
disables SNMP linkUp and linkDown traps. After enabling either of these traps globally, you can disable
these traps on specific interfaces using the no snmp trap link-status command in interface
configuration mode. Note that on the interface level, linkUp and linkDown traps are enabled by default.
This means that you do not have to enable these notifications on a per-interface basis. However, linkUp
and linkDown notifications will not be sent unless you enable them globally using the snmp-server
enable traps snmp command.

Examples

The following example enables the router to send all traps to the host myhost.cisco.com, using the
community string defined as public:
Router(config)# snmp-server enable traps snmp
Router(config)# snmp-server host myhost.cisco.com public snmp

The following example enables the router to send all inform notifications to the host myhost.cisco.com
using the community string defined as public:
Router(config)# snmp-server enable traps snmp
Router(config)# snmp-server host myhost.cisco.com informs version 2c public snmp

The following example shows the enabling all SNMP trap types, then the disabling of only the linkUp
and linkDown traps.
Router> enable
Password:
Router# configure terminal

Cisco IOS Configuration Fundamentals Command Reference

FR-706

78-11740-02

SNMP Commands
snmp-server enable traps snmp

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

Router(config)# snmp-server enable traps snmp
Router(config)# end
Router# more system:running-config | include traps snmp
snmp-server enable traps snmp authentication linkup linkdown coldstart warmstart
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# no snmp-server enable traps snmp linkup linkdown
Router(config)# end
Router# more system:running-config | include traps snmp
snmp-server enable traps snmp authentication coldstart warmstart

Related Commands

Command

Description

snmp-server enable traps Enables all available SNMP notifications on your system.
snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server informs

Specifies inform request options.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-707

SNMP Commands
snmp-server enable traps repeater

snmp-server enable traps repeater

To enable or disable standard repeater (hub) Simple Network Management Protocol (SNMP)
notifications, use the snmp-server enable traps repeater global configuration command. To disable
repeater notifications, use the no form of this command.
snmp-server enable traps repeater [health] [reset]
no snmp-server enable traps repeater [health] [reset]

Syntax Description

health

(Optional) The rptrHealth trap conveys information related to the operational

status of the repeater. This trap is sent either when the value of rptrOperStatus
changes, or upon completion of a non-disruptive test.
The rptrOperStatus object indicates the operational state of the repeater. Status
values are as follows:

reset

Defaults

other(1)undefined or unknown status

ok(2)no known failures

rptrFailure(3)repeater-related failure

groupFailure(4)group-related failure

portFailure(5)port-related failure

generalFailure(6)failure, unspecified type

(Optional) The rptrResetEvent trap is sent on completion of a repeater reset

action (triggered by the transition to a START state by a manual command).
The rptrResetEvent trap is not sent when the agent restarts and sends an SNMP
coldStart or warmStart trap.

SNMP notifications are disabled by default.

If no keywords are specified, all repeater notifications available on your system are enabled or disabled.

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) Repeater MIB notifications, as defined in RFC 1516. RFC
1516 defines objects for managing IEEE 802.3 10 Mbps baseband repeaters, also known as hubs.

Cisco IOS Configuration Fundamentals Command Reference

FR-708

78-11740-02

SNMP Commands
snmp-server enable traps repeater

There are two sets of notifications available for this command. The following notification is defined in
the CISCO-REPEATER-MIB (enterprise 1.3.6.1.4.1.9.9.22.3):

1 ciscoRptrIllegalSrcAddrTrap (illegal source address trap )

The following notifications are defined in the CISCO-REPEATER-MIB-V1SMI (enterprise

1.3.6.1.2.1.22):

1 rptrHealth

2 rptrGroupChange

3 rptrResetEvent

For a complete description of the repeater notifications and additional MIB functions, refer to the
CISCO-REPEATER-MIB.my and CISCO-REPEATER-MIB-V1SMI.my files, available on Cisco.com at
http://www.cisco.com/public/mibs/.
The snmp-server enable traps repeater command is used in conjunction with the snmp-server host
command. Use the snmp-server host command to specify which host or hosts receive SNMP
notifications. To send SNMP notifications, you must configure at least one snmp-server host command.

Examples

The following example enables the router to send repeater inform notifications to the host at the address
myhost.cisco.com using the community string defined as public:
Router(config)# snmp-server enable traps repeater
Router(config)# snmp-server host myhost.cisco.com informs version 2c public

Related Commands

Command

Description

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-709

SNMP Commands
snmp-server enable traps voice poor-qov

snmp-server enable traps voice poor-qov

To enable poor quality of voice Simple Network Management Protocol (SNMP) notifications, use the
snmp-server enable traps voice poor-qov global configuration command. To disable poor quality of
voice SNMP notifications, use the no form of this command.
snmp-server enable traps voice poor-qov
no snmp-server enable traps voice poor-qov

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP notifications are disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced for the Cisco AS5300 and Cisco AS5800.

Usage Guidelines

SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests.
This command controls (enables or disables) poor-quality-of-voice notifications. The
poor-quality-of-voice notification is defined in CISCO-VOICE-DIAL-CONTROL-MIB as follows:
enterprise 1.3.6.1.4.1.9.9.63.2
(1) cvdcPoorQoVNotification
For a complete description of this notification and additional MIB functions, see the
CISCO-VOICE-DIAL-CONTROL-MIB.my file, available on Cisco.com at
http://www.cisco.com/public/mibs/v2/.
The snmp-server enable traps voice poor-qov command is used in conjunction with the
snmp-server host command. Use the snmp-server host command to specify which host or hosts receive
SNMP notifications. To send SNMP notifications, you must configure at least one snmp-server host
command.

Examples

The following example enables the router to poor-quality-of-voice informs to the host at the address
myhost.cisco.com using the community string defined as public:
Router(config)# snmp-server enable traps voice poor-qov
Router(config)# snmp-server host myhost.cisco.com informs version 2c public

Cisco IOS Configuration Fundamentals Command Reference

FR-710

78-11740-02

SNMP Commands
snmp-server enable traps voice poor-qov

Related Commands

Command

Description

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server trap-source

Specifies the interface that an SNMP trap should originate from.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-711

SNMP Commands
snmp-server engineID

snmp-server engineID
To configure a name for either the local or remote Simple Network Management Protocol (SNMP)
engine on the router, use the snmp-server engineID global configuration command. To remove the
configured engine ID, use the no form of this command.
snmp-server engineID {local engineid-string |
remote ip-address [udp-port port] engineid-string}
no snmp-server engineID

Syntax Description

Defaults

local

Specifies the local copy of SNMP on the router. (You must specify either
local or remote.)

engineid-string

The name of a copy of SNMP.

remote

Specifies the remote copy of SNMP on the router. (You must specify either
local or remote.)

ip-address

The IP address of the device that contains the remote copy of SNMP.

udp-port

(Optional) Specifies a UDP port of the host to use.

port

(Optional) The socket number on the remote device that contains the remote
copy of SNMP.

An SNMP engine ID is generated automatically but is not displayed or stored in the running
configuration. You can display the default or configured engine ID by using the show snmp engineID
EXEC command.
The default udp-port for remote engines is 161.

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

Note that you need not specify the entire 24-character engine ID if it contains trailing zeros. Specify only
the portion of the Engine ID up until the point where only zeros remain in the value. To configure an
engine ID of 123400000000000000000000, you can specify the value 1234, for example, snmp-server
engineID local 1234.
Changing the value of snmpEngineID has important side-effects. A user's password (entered on the
command line) is converted to an MD5 or SHA security digest. This digest is based on both the password
and the local engine ID. The command line password is then destroyed, as required by
RFC 2274.
Because of this deletion, if the local value of engineID changes, the security digests of SNMPv3 users
will be invalid, and the users will have to be reconfigured.

Cisco IOS Configuration Fundamentals Command Reference

FR-712

78-11740-02

SNMP Commands
snmp-server engineID

Similar restrictions require the reconfiguration of community strings when the engine ID changes. A
remote engine ID is required when an SNMPv3 inform is configured. The remote engine ID is used to
compute the security digest for authenticating and encrypting packets sent to a user on the remote host.
Please refer to the examples in the Configuring Informs section in the snmp-server host command
reference page.

Related Commands

Command

Description

show snmp engineID

Displays the identification of the local SNMP engine and all remote engines
that have been configured on the router.

snmp-server host

Specifies the recipient (SNMP manager) of an SNMP trap notification.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-713

SNMP Commands
snmp-server group

snmp-server group
To configure a new Simple Network Management Protocol (SNMP) group, or a table that maps SNMP
users to SNMP views, use the snmp-server group global configuration command. To remove a specified
SNMP group, use the no form of this command.
snmp-server group groupname {v1 | v2c | v3 {auth | noauth | priv}} [read readview]
[write writeview] [notify notifyview ] [access access-list]
no snmp-server group

Syntax Description

Defaults

groupname

The name of the group.

v1

The least secure of the possible security models.

v2c

The second least secure of the possible security models. It allows for the
transmission of informs and counter 64, which allows for integers twice the
width of what is normally allowed.

v3

The most secure of the possible security models.

auth

Specifies authentication of a packet without encrypting it.

noauth

Specifies no authentication of a packet.

priv

Specifies authentication of a packet with encryption.

read

(Optional) The option that allows you to specify a read view.

readview

A string (not to exceed 64 characters) that is the name of the view that
enables you only to view the contents of the agent.

write

(Optional) The option that allows you to specify a write view.

writeview

A string (not to exceed 64 characters) that is the name of the view that
enables you to enter data and configure the contents of the agent.

notify

(Optional) The option that allows you to specify a notify view

notifyview

A string (not to exceed 64 characters) that is the name of the view that
enables you to specify a notify, inform, or trap.

access

(Optional) The option that enables you to specify an access list.

access-list

A string (not to exceed 64 characters) that is the name of the access list.

Table 112 describes default values for the different views.

Table 112

snmp-server group Default Descriptions

Default

Definition

readview

Assumed to be every object belonging to the Internet (1.3.6.1) OID

space, unless the user uses the read option to override this state.

Cisco IOS Configuration Fundamentals Command Reference

FR-714

78-11740-02

SNMP Commands
snmp-server group

Table 112

snmp-server group Default Descriptions (continued)

Default

Definition

writeview

Nothing is defined for the write view (that is, the null OID). You must
configure write access.

notifyview

Nothing is defined for the notify view (that is, the null OID). If a view
is specified, any notifications in that view that are generated will be sent
to all users associated with the group (provided an SNMP server host
configuration exists for the user).

Command Modes

Global configuration

Command History

Release

Modification

11.(3)T

This command was introduced.

Usage Guidelines

When a community string is configured internally, two groups with the name public are autogenerated,
one for the v1 security model and the other for the v2c security model. Similarly, deleting a community
string will delete a v1 group with the name public and a v2c group with the name public.
Configuring Notify Views

Do not specify a notify view when configuring an SNMP group for the following reasons:

The snmp-server host command autogenerates a notify view for the user, and then adds it to the
group associated with that user.

Modifying the groups notify view will affect all users associated with that group.

The notifyview option is available for two reasons:

If a group has a notify view that is set using SNMP, you may need to change the notify view.

The snmp-server host command may have been configured before the snmp-server group
command. In this case, you must either reconfigure the snmp-server host command, or specify the
appropriate notify view.

Instead of specifying the notify view for a group as part of the snmp-server group command, use the
following commands in global configuration mode:
Step

Command

Purpose

1.

snmp-server user

Configures an SNMP user.

2.

snmp-server group

Configures an SNMP group, without adding

a notify view.

3.

snmp-server host

Autogenerates the notify view by specifying

the recipient of a trap operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-715

SNMP Commands
snmp-server group

Working with Passwords and Digests

No default values exist for authentication or privacy algorithms when you configure the command. Also,
no default passwords exist. The minimum length for a password is one character, although Cisco
recommends using eight characters for security. If you forget a password, you cannot recover it and will
need to reconfigure the user. You can specify either a plain-text password or a localized MD5 digest.
The following example shows how to enter a plain-text password for the string arizona2 for user John in
group Johngroup, type the following command line:
snmp-server user John Johngroup v3 auth md5 arizona2

When you enter a show running-config command, you will not see a line for this user. To see if this user
has been added to the configuration, type the show snmp user command.
If you have the localized MD5 or SHA digest, you can specify that string instead of the plain-text
password. The digest should be formatted as aa:bb:cc:dd where aa, bb, and cc are hex values. Also, the
digest should be exactly 16 octets long.
The following example shows how to specify the command with a digest name of
00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:
Router(config)# snmp-server user John Johngroup v3 encrypted auth md5
00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF

Related Commands

Command

Description

show snmp group

Displays the names of groups on the router and the security model, the status
of the different views, and the storage type of each group.

Cisco IOS Configuration Fundamentals Command Reference

FR-716

78-11740-02

SNMP Commands
snmp-server host

snmp-server host
To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use
the snmp-server host global configuration command. To remove the specified host, use the no form of
this command.
snmp-server host host-addr [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}]
community-string [udp-port port] [notification-type]
no snmp-server host host [traps | informs]

Syntax Description

host-addr

Name or Internet address of the host (the targeted recipient).

traps

(Optional) Sends SNMP traps to this host. This is the default.

informs

(Optional) Sends SNMP informs to this host.

version

(Optional) Version of the SNMP used to send the traps. Version 3 is the most
secure model, because it allows packet encryption with the priv keyword. If you
use the version keyword, one of the following must be specified:

1SNMPv1. This option is not available with informs.

2cSNMPv2C.

3SNMPv3. The following three optional keywords can follow the version 3
keyword:
auth (Optional). Enables Message Digest 5 (MD5) and Secure Hash

Algorithm (SHA) packet authentication

noauth (Default). The noAuthNoPriv security level. This is the default if

the [auth | noauth | priv] keyword choice is not specified.

priv (Optional). Enables Data Encryption Standard (DES) packet

encryption (also called privacy).

community-string Password-like community string sent with the notification operation. Though you
can set this string using the snmp-server host command by itself, we recommend
you define this string using the snmp-server community command prior to using
the snmp-server host command.
udp-port port

(Optional) UDP port of the host to use. The default is 162.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-717

SNMP Commands
snmp-server host

notification-type

Defaults

(Optional) Type of notification to be sent to the host. If no type is specified, all

notifications are sent. The notification type can be one or more of the following
keywords:

bgpSends Border Gateway Protocol (BGP) state change notifications.

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

configSends configuration notifications.

dspuSends downstream physical unit (DSPU) notifications.

entitySends Entity MIB modification notifications.

envmonSends Cisco enterprise-specific environmental monitor

notifications when an environmental threshold is exceeded.

frame-relaySends Frame Relay notifications.

hsrpSends Hot Standby Routing Protocol (HSRP) notifications.

isdnSends Integrated Services Digital Network (ISDN) notifications.

llc2Sends Logical Link Control, type 2 (LLC2) notifications.

repeaterSends standard repeater (hub) notifications.

rsrbSends remote source-route bridging (RSRB) notifications.

rsvpSends Resource Reservation Protocol (RSVP) notifications.

rtrSends SA Agent (RTR) notifications.

sdlcSends Synchronous Data Link Control (SDLC) notifications.

sdllcSends SDLLC notifications.

snmpSends any enabled RFC 1157 SNMP linkUp, linkDown,

authenticationFailure, warmStart, and coldStart notifications.

stunSends serial tunnel (STUN) notifications.

syslogSends error message notifications (Cisco Syslog MIB). Specify the

level of messages to be sent with the logging history level command.

ttySends Cisco enterprise-specific notifications when a Transmission

Control Protocol (TCP) connection closes.

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

x25Sends X.25 event notifications.

This command is disabled by default. No notifications are sent.

If you enter this command with no keywords, the default is to send all trap types to the host. No informs
will be sent to this host.
If no version keyword is present, the default is version 1. The no snmp-server host command with no
keywords will disable traps, but not informs, to the host. In order to disable informs, use the
no snmp-server host informs command.

Cisco IOS Configuration Fundamentals Command Reference

FR-718

78-11740-02

SNMP Commands
snmp-server host

Note

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

Command Modes

Global configuration

Command History

Release

Usage Guidelines

Modification

10.0

This command was introduced.

12.0(3)T

The following keywords were added:

version 3 [auth | noauth | priv]

hsrp

11.3(1) MA, 12.0(3)T

The voice notification-type keyword was added.

12.1(3)T

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

SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver
does not send acknowledgments when it receives traps. The sender cannot determine if the traps were
received. However, an SNMP entity that receives an inform request acknowledges the message with an
SNMP response PDU. If the sender never receives the response, the inform request can be sent again.
Thus, informs are more likely to reach their intended destination.
However, informs consume more resources in the agent and in the network. Unlike a trap, which is
discarded as soon as it is sent, an inform request must be held in memory until a response is received or
the request times out. Also, traps are sent only once, while an inform may be retried several times. The
retries increase traffic and contribute to a higher overhead on the network.
If you do not enter an snmp-server host command, no notifications are sent. In order to configure the
router to send SNMP notifications, you must enter at least one snmp-server host command. If you enter
the command with no keywords, all trap types are enabled for the host.
In order to enable multiple hosts, you must issue a separate snmp-server host command for each host.
You can specify multiple notification types in the command for each host.
When multiple snmp-server host commands are given for the same host and kind of notification (trap
or inform), each succeeding command overwrites the previous command. Only the last snmp-server
host command will be in effect. For example, if you enter an snmp-server host inform command for a
host and then enter another snmp-server host inform command for the same host, the second command
will replace the first.
The snmp-server host command is used in conjunction with the snmp-server enable command. Use
the snmp-server enable command to specify which SNMP notifications are sent globally. For a host to
receive most notifications, at least one snmp-server enable command and the snmp-server host
command for that host must be enabled.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-719

SNMP Commands
snmp-server host

However, some notification types cannot be controlled with the snmp-server enable command. For
example, some notification types are always enabled. Other notification types are enabled by a different
command. For example, the linkUpDown notifications are controlled by the snmp trap link-status
command. These notification types do not require an snmp-server enable command.
A notification-type options availability depends on the router type and Cisco IOS software features
supported on the router. For example, the envmon notification-type is available only if the
environmental monitor is part of the system. To see what notification types are available on your system,
use the command help ? at the end of the snmp-server host command.

Examples

If you want to configure a unique snmp community string for traps, but you want to prevent snmp polling
access with this string, the configuration should include an access-list. In the following example, the
community string is named comaccess and the access list is numbered 10:
Router(config)# snmp-server community comaccess ro 10
Router(config)# snmp-server host 172.20.2.160 comaccess
Router(config)# access-list 10 deny any

The following example sends RFC 1157 SNMP traps to the host specified by the name
myhost.cisco.com. Other traps are enabled, but only SNMP traps are sent because only snmp is specified
in the snmp-server host command. The community string is defined as comaccess.
Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com comaccess snmp

The following example sends the SNMP and Cisco environmental monitor enterprise-specific traps to
address 172.30.2.160:
Router(config)# snmp-server enable traps snmp
Router(config)# snmp-server enable traps envmon
Router(config)# snmp-server host 172.30.2.160 public snmp envmon

The following example enables the router to send all traps to the host myhost.cisco.com using the
community string public:
Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com public

The following example will not send traps to any host. The BGP traps are enabled for all hosts, but only
the ISDN traps are enabled to be sent to a host.
Router(config)# snmp-server enable traps bgp
Router(config)# snmp-server host bob public isdn

The following example enables the router to send all inform requests to the host myhost.cisco.com using
the community string public:
Router(config)# snmp-server enable traps
Router(config)# snmp-server host myhost.cisco.com informs version 2c public

The following example sends HSRP MIB informs to the host specified by the name myhost.cisco.com.
The community string is defined as public.
Router(config)# snmp-server enable traps hsrp
Router(config)# snmp-server host myhost.cisco.com informs version 2c public hsrp

Cisco IOS Configuration Fundamentals Command Reference

FR-720

78-11740-02

SNMP Commands
snmp-server host

Related Commands

Command

Description

snmp-server enable peer-trap

poor qov

Enable poor quality of voice notifications for applicable calls

associated with a specific voice dial peer.

snmp-server enable traps

Enables SNMP notifications (traps and informs).

snmp-server informs

Specifies inform request options.

snmp-server trap-source

Specifies the interface (and hence the corresponding IP address)

that an SNMP trap should originate from.

snmp-server trap-timeout

Defines how often to try resending trap messages on the

retransmission queue.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-721

SNMP Commands
snmp-server informs

snmp-server informs
To specify inform request options, use the snmp-server informs global configuration command. To
return the settings to the defaults, use the no form of this command.
snmp-server informs [retries retries] [timeout seconds] [pending pending]
no snmp-server informs [retries retries] [timeout seconds] [pending pending]

Syntax Description

retries retries

(Optional) Maximum number of times to resend an inform request.

The default is 3.

timeout seconds

(Optional) Number of seconds to wait for an acknowledgment before

resending. The default is 30 seconds.

pending pending

(Optional) Maximum number of informs waiting for

acknowledgments at any one time. When the maximum is reached,
older pending informs are discarded. The default is 25.

Defaults

Inform requests are resent three times. Informs are resent after 30 seconds if no response is received.
The maximum number of informs waiting for acknowledgments at any one time is 25.

Command Modes

Global configuration

Command History

Release

Modification

11.3 T

This command was introduced.

Examples

The following example increases the pending queue size if you are seeing a large number of inform
drops:
snmp-server informs pending 50

The following example increases the default timeout if you are sending informs over slow network links.
Because informs will be sitting in the queue for a longer period of time, you may also need to increase
the pending queue size.
snmp-server informs timeout 60 pending 40

The following example decreases the default timeout if you are sending informs over very fast links:
snmp-server informs timeout 5

The following example increases the retry count if you are sending informs over unreliable links.
Because informs will be sitting in the queue for a longer period of time, you may need to increase the
pending queue size.
snmp-server informs retries 10 pending 45

Cisco IOS Configuration Fundamentals Command Reference

FR-722

78-11740-02

SNMP Commands
snmp-server informs

Related Commands

Command

Description

snmp-server enable traps

Enables a router to send SNMP traps and informs.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-723

SNMP Commands
snmp-server location

snmp-server location
To set the system location string, use the snmp-server location global configuration command. To
remove the location string, use the no form of this command.
snmp-server location text
no snmp-server location

Syntax Description

text

Defaults

No system location string is set.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

String that describes the system location information.

The following example illustrates a system location string:

snmp-server location Building 3/Room 214

Related Commands

Command

Description

snmp-server contact

Sets the system contact (sysContact) string.

Cisco IOS Configuration Fundamentals Command Reference

FR-724

78-11740-02

SNMP Commands
snmp-server manager

snmp-server manager
To start the Simple Network Management Protocol (SNMP) manager process, use the snmp-server
manager global configuration command. To stop the SNMP manager process, use the no form of this
command.
snmp-server manager
no snmp-server manager

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

11.3 T

This command was introduced.

Usage Guidelines

The SNMP manager process sends SNMP requests to agents and receives SNMP responses and
notifications from agents. When the SNMP manager process is enabled, the router can query other
SNMP agents and process incoming SNMP traps.
Most network security policies assume that routers will be accepting SNMP requests, sending SNMP
responses, and sending SNMP notifications. With the SNMP manager functionality enabled, the router
may also be sending SNMP requests, receiving SNMP responses, and receiving SNMP notifications. The
security policy implementation may need to be updated prior to enabling this functionality.
SNMP requests are typically sent to UDP port 161. SNMP responses are typically sent from UDP port
161. SNMP notifications are typically sent to UDP port 162.

Examples

The following example enables the SNMP manager process:

snmp-server manager

Related Commands

Command

Description

show snmp

Checks the status of SNMP communications.

show snmp pending

Displays the current set of pending SNMP requests.

show snmp sessions

Displays the current SNMP sessions.

snmp-server manager
session-timeout

Sets the amount of time before a nonactive session is

destroyed.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-725

SNMP Commands
snmp-server manager session-timeout

snmp-server manager session-timeout

To set the amount of time before a nonactive session is destroyed, use the snmp-server manager
session-timeout global configuration command. To return the value to its default, use the no form of this
command.
snmp-server manager session-timeout seconds
no snmp-server manager session-timeout

Syntax Description

seconds

Defaults

Idle sessions time out after 600 seconds (10 minutes).

Command Modes

Global configuration

Command History

Release

Modification

11.3 T

This command was introduced.

Usage Guidelines

Number of seconds before an idle session is timed out. The default is

600 seconds.

Sessions are created when the SNMP manager in the router sends SNMP requests, such as inform
requests, to a host or receives SNMP notifications from a host. One session is created for each
destination host. If there is no further communication between the router and host within the session
timeout period, the session will be deleted.
The router tracks statistics, such as the average round-trip time required to reach the host, for each
session. Using the statistics for a session, the SNMP manager in the router can set reasonable timeout
periods for future requests, such as informs, for that host. If the session is deleted, all statistics are lost.
If another session with the same host is later created, the request timeout value for replies will return to
the default value.
However, sessions consume memory. A reasonable session timeout value should be large enough such
that regularly used sessions are not prematurely deleted, yet small enough such that irregularly used, or
one-shot sessions, are purged expeditiously.

Examples

The following example sets the session timeout to a larger value than the default:
snmp-server manager
snmp-server manager session-timeout 1000

Cisco IOS Configuration Fundamentals Command Reference

FR-726

78-11740-02

SNMP Commands
snmp-server manager session-timeout

Related Commands

Command

Description

show snmp pending

Displays the current set of pending SNMP requests.

show snmp sessions

Displays the current SNMP sessions.

snmp-server manager Starts the SNMP manager process.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-727

SNMP Commands
snmp-server packetsize

snmp-server packetsize
To establish control over the largest Simple Network Management Protocol (SNMP) packet size
permitted when the SNMP server is receiving a request or generating a reply, use the snmp-server
packetsize global configuration command. To restore the default value, use the no form of this
command.
snmp-server packetsize byte-count
no snmp-server packetsize

Syntax Description

byte-count

Defaults

1500 bytes

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

Integer byte count from 484 to 8192. The default is 1500 bytes.

The following example establishes a packet filtering of a maximum size of 1024 bytes:
snmp-server packetsize 1024

Related Commands

Command

Description

snmp-server queue-length

Establishes the message queue length for each trap host.

Cisco IOS Configuration Fundamentals Command Reference

FR-728

78-11740-02

SNMP Commands
snmp-server queue-length

snmp-server queue-length
To establish the message queue length for each trap host, use the snmp-server queue-length global
configuration command.
snmp-server queue-length length

Syntax Description

length

Defaults

10 events

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Integer that specifies the number of trap events that can be held before the queue
must be emptied.

This command defines the length of the message queue for each trap host. Once a trap message is
successfully transmitted, software will continue to empty the queue, but never faster than at a rate of four
trap messages per second.
During device bootup, there is a possibility that some traps could be dropped because of trap queue
overflow on the device. If you suspect this is occuring, you can increase the size of the trap queue (for
example, to 100) to determine if traps are then able to be sent during bootup.

Examples

In the following example, the SNMP notification queue is increased to 50 events:

Router(config)# snmp-server queue-length 50

Related Commands

Command

Description

snmp-server packetsize

Establishes control over the largest SNMP packet size permitted when
the SNMP server is receiving a request or generating a reply.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-729

SNMP Commands
snmp-server system-shutdown

snmp-server system-shutdown
To use the Simple Network Management Protocol (SNMP) message reload feature, the router
configuration must include the snmp-server system-shutdown global configuration command. To
prevent an SNMP system-shutdown request (from an SNMP manager) from resetting the Cisco agent,
use the no form of this command.
snmp-server system-shutdown
no snmp-server system-shutdown

Syntax Description

This command has no arguments or keywords.

Defaults

This command is not included in the configuration file.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Examples

The following example enables the SNMP message reload feature:

snmp-server system-shutdown

Cisco IOS Configuration Fundamentals Command Reference

FR-730

78-11740-02

SNMP Commands
snmp-server tftp-server-list

snmp-server tftp-server-list
To limit the TFTP servers used via Simple Network Management Protocol (SNMP) controlled TFTP
operations (saving and loading configuration files) to the servers specified in an access list, use the
snmp-server tftp-server-list global configuration command. To disable this feature, use the no form of
this command.
snmp-server tftp-server-list number
no snmp-server tftp-server-list

Syntax Description

number

Defaults

Disabled

Command Modes

Global configuration

Command History

Release

Modification

10.2

This command was introduced.

Examples

Standard IP access list number from 1 to 99.

The following example limits the TFTP servers that can be used for configuration file copies via SNMP
to the servers in access list 44:
snmp-server tftp-server-list 44

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-731

SNMP Commands
snmp-server trap-authentication

snmp-server trap-authentication
The snmp-server trap-authentication command has been replaced by the snmp-server enable traps
snmp authentication command. See the description of the snmp-server enable traps snmp command
in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-732

78-11740-02

SNMP Commands
snmp-server trap link

snmp-server trap link

To enable linkUp/linkDown Simple Network Management Protocol (SNMP) traps which are compliant
with RFC2233, use the snmp-server trap link command in global configuration mode. To disable IETF
compliant functionality and revert to the default Cisco implementation of linkUp/linkDown traps, use
the no form of this command.
snmp-server trap link ietf
no snmp-server trap link ietf

Syntax Description

ietf

Defaults

This command is disabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(2)T

This command was introduced.

Usage Guidelines

This required keyword indicates to the command parser that you would like
to link functionality of SNMP linkUp/linkDown traps to the Internet
Engineering Task Force (IETF) standard (as opposed to the previous Cisco
implementation).

The snmp-server trap link ietf command is used to configure your router to use the RFC2233 IETF
standards-based implementation of linkUp/linkDown traps. This command is disabled by default to
allow you to continue using the earlier Cisco implementation of linkUp/linkDown traps if you so choose.
However, please note that when using the default Cisco object definitions, linkUp/linkDown traps are not
generated correctly for sub-interfaces. In the default implementation an arbitrary value is used for the
locIfReason object in linkUp/linkDown traps for sub-interfaces, which may give you unintended results.
This is because the locIfReason object is not defined for sub-interfaces in the current Cisco implementation,
which uses OLD-CISCO-INTERFACES-MIB.my.
If you do not enable this functionality, the link trap varbind list will consist of {ifIndex, ifDescr, ifType,
locIfReason}. After you enable this functionality with the snmp-server trap link ietf command, the
varbind list will consist of {inIndex, ifAdminStatus,ifOperStatus, if Descr, ifType}. The locIfReason
object will also be conditionally included in this list depending on whether meaningful information can
be retrieved for that object. A configured sub-interface will generate retrievable information. On
non-HWIDB interfaces, there will be no defined value for locIfReason, so it will be omitted from the
trap message.

Examples

The following example shows the enabling of the RFC 2233 linkUp/linkDown traps, starting in
privileged EXEC mode:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-733

SNMP Commands
snmp-server trap link

Router# config term

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# snmp-server trap link ietf
Router(config)# end
Router# more system:running config
.
.
.
!
snmp-server engineID local 00000009000000A1616C2056
snmp-server community public RO
snmp-server community private RW
snmp-server trap link ietf
!
.
.
.

Related Commands

Command

Description

debug snmp packets

Displays information about every SNMP packet sent or received by the

router for the purposes of troubleshooting.

Cisco IOS Configuration Fundamentals Command Reference

FR-734

78-11740-02

SNMP Commands
snmp-server trap-source

snmp-server trap-source
To specify the interface (and hence the corresponding IP address) that an Simple Network Management
Protocol (SNMP) trap should originate from, use the snmp-server trap-source global configuration
command. To remove the source designation, use the no form of the command.
snmp-server trap-source interface
no snmp-server trap-source

Syntax Description

interface

Defaults

No interface is specified.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Interface from which the SNMP trap originates. The argument includes the
interface type and number in platform-specific syntax (for example,
type/slot/port).

Usage Guidelines

When an SNMP trap or inform is sent from a Cisco SNMP server, it has a notification address of
whatever interface it happened to go out of at that time. Use this command monitor notifications from a
particular interface.

Examples

The following example specifies that the IP address for interface Ethernet 0 is the source for all SNMP
notifications:
Router(config)# snmp-server trap-source ethernet 0

The following example specifies that the IP address for the ethernet interface in slot2, port 1 is the source
for all SNMP notifications:
Router(config)# snmp-server trap-source ethernet 2/1

Related Commands

Command

Description

snmp-server enable traps

Enables a router to send SNMP traps and informs.

snmp-server host

Specifies the recipient of an SNMP notification operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-735

SNMP Commands
snmp-server trap-timeout

snmp-server trap-timeout
To define how often to try resending trap messages on the retransmission queue, use the
snmp-server trap-timeout global configuration command.
snmp-server trap-timeout seconds

Syntax Description

seconds

Defaults

30 seconds

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Integer that sets the interval (in seconds) for resending the messages.

Usage Guidelines

Before the Cisco IOS software tries to send a trap, it looks for a route to the destination address. If there
is no known route, the trap is saved in a retransmission queue. The server trap-timeout command
determines the number of seconds between retransmission attempts.

Examples

The following example sets an interval of 20 seconds to try resending trap messages on the
retransmission queue:
snmp-server trap-timeout 20

Related Commands

Command

Description

snmp-server host

Specifies the recipient of an SNMP notification operation.

snmp-server queue-length

Establishes the message queue length for each trap host.

Cisco IOS Configuration Fundamentals Command Reference

FR-736

78-11740-02

SNMP Commands
snmp-server user

snmp-server user
To configure a new user to a Simple Network Management Protocol (SNMP) group, use the
snmp-server user global configuration command. To remove a user from an SNMP group, use the no
form of the command.
snmp-server user username groupname [remote host [udp-port port]]
{v1 | v2c | v3 [encrypted] [auth {md5 | sha} auth-password]} [access access-list]
no snmp-server user

Syntax Description

Defaults

username

The name of the user on the host that connects to the agent.

groupname

The name of the group to which the user belongs.

remote host

(Optional) Specifies a remote SNMP entity to which the user belongs, and
the hostname or IP address of that entity.

udp-port port

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

v1

Specifies that SNMPv1 should be used.

v2c

Specifies that SNMPv2c should be used.

v3

Specifies that the SNMPv3 security model should be used. Allows the use
of the encrypted and/or auth keywords.

encrypted

(Optional) Specifies whether the password appears in encrypted format (a

series of digits, masking the true characters of the string).

auth

(Optional) Specifies which authentication level should be used.

md5

The HMAC-MD5-96 authentication level.

sha

The HMAC-SHA-96 authentication level.

auth-password

A string (not to exceed 64 characters) that enables the agent to receive

packets from the host.

access access-list

(Optional) Specifies an access list to be associated with this SNMP user.

The access-list argument represents a value from1 to 99 that is the identifier
of the standard IP access list.

Table 113 describes default behaviors for encryption, passwords and access lists.
Table 113

snmp-server user Default Descriptions

Characteristic

Default

encryption

Not present by default. The encrypted keyword is used to

specify that the auth and priv passwords are MD5 digests and
not text passwords.

passwords

Assumed to be text strings.

access lists

Access from all IP access lists is permitted.

remote users

All users are assumed to be local to this SNMP engine unless

you specify they are remote with the remote keyword.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-737

SNMP Commands
snmp-server user

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

To configure a remote user, specify the IP address or port number for the remote SNMP agent of the
device where the user resides. Also, before you configure remote users for a particular agent, configure
the SNMP engine ID, using the command snmp-server engineID with the remote option. The remote
agents SNMP engine ID is needed when computing the authentication/privacy digests from the
password. If the remote engine ID is not configured first, the configuration command will fail.
SNMP passwords are localized using the SNMP engine ID of the authoritative SNMP engine. For
informs, the authoritative SNMP agent is the remote agent. You need to configure the remote agents
SNMP engine ID in the SNMP database before you can send proxy requests or informs to it.

Related Commands

Command

Description

show snmp user

Displays information on each SNMP username in the group username table.

Cisco IOS Configuration Fundamentals Command Reference

FR-738

78-11740-02

SNMP Commands
snmp-server view

snmp-server view
To create or update a view entry, use the snmp-server view global configuration command. To remove
the specified Simple Network Management Protocol (SNMP) server view entry, use the no form of this
command.
snmp-server view view-name oid-tree {included | excluded}
no snmp-server view view-name

Syntax Description

view-name

Label for the view record that you are updating or creating. The name
is used to reference the record.

oid-tree

Object identifier of the ASN.1 subtree to be included or excluded from

the view. To identify the subtree, specify a text string consisting of
numbers, such as 1.3.6.2.4, or a word, such as system. Replace a single
subidentifier with the asterisk (*) wildcard to specify a subtree
family; for example 1.3.*.4.

included | excluded

Type of view. You must specify either included or excluded.

Defaults

No view entry exists.

Command Modes

Global configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

Other SNMP commands require a view as an argument. You use this command to create a view to be
used as arguments for other commands that create records including a view.
Two standard predefined views can be used when a view is required, instead of defining a view. One is
everything, which indicates that the user can see all objects. The other is restricted, which indicates that
the user can see three groups: system, snmpStats, and snmpParties. The predefined views are described
in RFC 1447.
The first snmp-server command that you enter enables both versions of SNMP.

Examples

The following example creates a view that includes all objects in the MIB-II subtree:
snmp-server view mib2 mib-2 included

The following example creates a view that includes all objects in the MIB-II system group and all objects
in the Cisco enterprise MIB:
snmp-server view phred system included
snmp-server view phred cisco included

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-739

SNMP Commands
snmp-server view

The following example creates a view that includes all objects in the MIB-II system group except for
sysServices (System 7) and all objects for interface 1 in the MIB-II interfaces group:
snmp-server view agon system included
snmp-server view agon system.7 excluded
snmp-server view agon ifEntry.*.1 included

Related Commands

Command

Description

snmp-server community

Sets up the community access string to permit access to the SNMP

protocol.

Cisco IOS Configuration Fundamentals Command Reference

FR-740

78-11740-02

SNMP Commands
snmp trap link-status

snmp trap link-status

To enable Simple Network Management Protocol (SNMP) link trap generation, use the snmp trap
link-status interface configuration command. To disable SNMP link traps, use the no form of this
command.
snmp trap link-status
no snmp trap link-status

Syntax Description

This command has no arguments or keywords.

Defaults

SNMP link traps are sent when an interface goes up or down.

Command Modes

Interface configuration

Command History

Release

Modification

10.0

This command was introduced.

Usage Guidelines

By default, SNMP link traps are sent when an interface goes up or down. For interfaces expected to go
up and down during normal usage, such as ISDN interfaces, the output generated by these traps may not
be useful. The no form of this command disables these traps.

Examples

The following example disables the sending of SNMP link traps related to the ISDN BRI 0 interface:
interface bri 0
no snmp trap link-status

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-741

SNMP Commands
snmp trap link-status

Cisco IOS Configuration Fundamentals Command Reference

FR-742

78-11740-02

CDP Commands
This chapter describes commands used to monitor the router and network using Cisco Discovery
Protocol (CDP).
For system management configuration tasks and examples, refer to the Configuring Cisco Discovery
Protocol chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-743

CDP Commands
cdp advertise-v2

cdp advertise-v2
To enable Cisco Discovery Protocol Version 2 (CDPv2) advertising functionality on a device, use the
cdp advertise-v2 global configuration command. To disable advertising CDPv2 functionality, use the
no form of the command.
cdp advertise-v2
no cdp advertise-v2

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

CDP Version 2 has three additional type-length values (TLVs): they are VTP Management Domain
Name, Native VLAN, and full/half-Duplex.

Examples

In the following example, CDP Version 2 advertisements are diabled on the router:
Router#show cdp
Global CDP information:
Sending CDP packets every 60 seconds
Sending a holdtime value of 180 seconds
Sending CDPv2 advertisements is enabled
Router#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#no cdp advertise-v2
Router(config)#end
Router#show cdp
Global CDP information:
Sending CDP packets every 60 seconds
Sending a holdtime value of 180 seconds
Sending CDPv2 advertisements is not enabled
Router#

Related Commands

Command

Description

cdp enable

Enables CDP on a supported interface.

cdp run

Reenables CDP on a Cisco device.

Cisco IOS Configuration Fundamentals Command Reference

FR-744

78-11740-02

CDP Commands
cdp enable

cdp enable
To enable Cisco Discovery Protocol (CDP) on an interface, use the cdp enable interface configuration
command. To disable CDP on an interface, use the no form of this command.
cdp enable
no cdp enable

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled at the global level and on all supported interfaces.

Command Modes

Interface configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Note

Examples

CDP is enabled by default at the global level and on each supported interface in order to send or receive
CDP information. However, some interfaces, such as ATM interfaces, do not support CDP.

The cdp enable, cdp timer, and cdp run commands affect the operation of the IP on demand routing
feature (that is, the router odr global configuration command). For more information on the router
odr command, see the On-Demand Routing Commands chapter in the Cisco IOS IP and IP
Routing Command Reference.

In the following example, CDP is disabled on the Ethernet 0 interface only:

Router#show cdp
Global CDP information:
Sending CDP packets every 60 seconds
Sending a holdtime value of 180 seconds
Sending CDPv2 advertisements is enabled
Router#config terminal
Router(config)#interface ethernet 0
Router(config-if)#no cdp enable

Related Commands

Command

Description

cdp run

Reenables CDP on a Cisco device.

cdp timer

Specifies how often the Cisco IOS software sends CDP updates.

router odr

Enables on-demand routing on a hub router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-745

CDP Commands
cdp holdtime

cdp holdtime
To specify the amount of time the receiving device should hold a Cisco Discovery Protocol (CDP) packet
from your router before discarding it, use the cdp holdtime global configuration command. To revert to
the default setting, use the no form of this command.
cdp holdtime seconds
no cdp holdtime

Syntax Description

seconds

Defaults

180 seconds

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Specifies the hold time to be sent in the CDP update packets.

CDP packets are sent with a time to live, or hold time, value. The receiving device will discard the CDP
information in the CDP packet after the hold time has elapsed.
You can set the hold time lower than the default setting of 180 seconds if you want the receiving devices
to update their CDP info more rapidly.
The CDP hold time must be set to a higher number of seconds than the time between CDP transmissions,
which is set using the cdp timer command.

Examples

In the following example, the CDP packets being sent from the router are configured with a hold time of
60 seconds.
Router(config)#cdp holdtime 60

Related Commands

Command

Description

cdp timer

Specifies how often the Cisco IOS software sends CDP updates.

show cdp

Displays global CDP information, including timer and hold-time

information.

Cisco IOS Configuration Fundamentals Command Reference

FR-746

78-11740-02

CDP Commands
cdp log mismatch duplex

cdp log mismatch duplex

To display the log of duplex mismatches generated by the Cisco Discovery Protocol (CDP) on Ethernet
interfaces on a router, use the cdp log mismatch duplex command in global configuration or interface
configuration mode. To disable the display of duplex messages on all Ethernet interfaces, use the no form
of this command.
cdp log mismatch duplex
no cdp log mismatch duplex

Syntax Description

This command has no arguments or keywords.

Defaults

The router reports duplex mismatches from all Ethernet interfaces.

Command Modes

Global configuration
Interface configuration

Command History

Release

Modification

12.0

This command was introduced.

Usage Guidelines

When you enter the cdp log mismatch duplex command in global configuration mode, duplex
mismatches are displayed on all Ethernet interfaces on the router. When you enter this command in
interface configuration mode, only duplex mismatches for the specified Ethernet interface are displayed.
If the cdp log mismatch duplex command is disabled in global configuration mode, it cannot be
configured per interface using interface configuration mode.
Duplex mismatch can occur only on Ethernet interfaces.

Examples

The following example of the cdp log mismatch duplex command in global configuration mode enables
the display of duplex messages from all Ethernet interfaces on the router:
Router(config)# cdp log mismatch duplex

The following example of the cdp log mismatch duplex command in interface configuration mode
enables only the display of duplex messages that may be generated from Ethernet interface 2/1:
Router(config-if)# interface ethernet2/1
Router(config-if)# cdp log mismatch duplex

The following is sample output from the show running-config command. The bold text shows that the
cdp log mismatch duplex command is disabled globally.
Router# show running-config
Building configuration...

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-747

CDP Commands
cdp log mismatch duplex

Current configuration : 1395 bytes

!
version 12.2
!
hostname 7200_C
!
!
interface Ethernet2/1
no ip address
duplex half
no cdp log mismatch duplex
!
!
!
!
!
no cdp log mismatch duplex
cdp timer 5
!
!
!
!
line con 0
line aux 0
line vty 0 4
password lab

Related Commands

Command

Description

show running-config

Displays the contents of the currently running configuration file.

Cisco IOS Configuration Fundamentals Command Reference

FR-748

78-11740-02

CDP Commands
cdp run

cdp run
To enable Cisco Discovery Protocol (CDP), use the cdp run global configuration command. To disable
CDP, use the no form of this command.
cdp run
no cdp run

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Note

Examples

CDP is enabled on your router by default, which means the Cisco IOS software will receive CDP
information. CDP also is enabled on supported interfaces by default. To disable CDP on an interface, use
the no cdp enable interface configuration command.

Becuase ODR (on demand routing) uses CDP, the cdp enable, cdp timer, and cdp run commands
affect the operation of the router odr global configuration command. For more information on the
router odr command, see the Release 12.2 Cisco IOS IP Command Reference, Volume 2 of 3:
Routing Protocols document.

In the following example, CDP is disabled globally, then the user attempts to enable CDP on the Ethernet
0 interface:
Router(config)#no cdp run
Router(config)#end
Router#show cdp
% CDP is not enabled
Router#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#int eth0
Router(config-if)#cdp enable
% Cannot enable CDP on this interface, since CDP is not running
Router(config-if)#

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-749

CDP Commands
cdp run

Related Commands

Command

Description

cdp enable

Enables CDP on a supported interface.

cdp timer

Specifies how often the Cisco IOS software sends CDP updates.

router odr

Enables ODR on the hub router.

Cisco IOS Configuration Fundamentals Command Reference

FR-750

78-11740-02

CDP Commands
cdp timer

cdp timer
To specify how often the Cisco IOS software sends Cisco Discovery Protocol (CDP) updates, use the
cdp timer global configuration command. To revert to the default setting, use the no form of this
command.
cdp timer seconds
no cdp timer

Syntax Description

seconds

Defaults

60 seconds

Command Modes

Global configuration

Command History

Release

Modification

10.3

This command was introduced.

Usage Guidelines

Note

Examples

Specifies how often the Cisco IOS software sends CDP updates.

The trade-off with sending more frequent transmissions is providing up-to-date information versus using
bandwidth more often.

The cdp enable, cdp timer, and cdp run commands affect the operation of the IP on demand routing
feature (that is, the router odr global configuration command). For more information on the router
odr command, see the On-Demand Routing Commands chapter in the Cisco IOS IP and IP
Routing Command Reference.

In the following example, CDP updates are sent every 80 seconds, less frequently than the default setting
of 60 seconds. You might want to make this change if you are concerned about preserving bandwidth.
cdp timer 80

Related Commands

Command

Description

cdp enable

Enables CDP on a supported interface.

cdp holdtime

Specifies the amount of time the receiving device should hold a CDP packet
from your router before discarding it.

cdp timer

Specifies how often the Cisco IOS software sends CDP updates.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-751

CDP Commands
cdp timer

Command

Description

router odr

Enables ODR on the hub router.

show cdp

Displays global CDP information, including timer and hold-time

information.

Cisco IOS Configuration Fundamentals Command Reference

FR-752

78-11740-02

CDP Commands
clear cdp counters

clear cdp counters

To reset Cisco Discovery Protocol (CDP) traffic counters to zero, use the clear cdp counters privileged
EXEC command.
clear cdp counters

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following example clears the CDP counters. The show cdp traffic output shows that all of the traffic
counters have been reset to zero.
Router# clear cdp counters
Router# show cdp traffic
CDP counters:
Packets output: 0, Input: 0
Hdr syntax: 0, Chksum error: 0, Encaps failed: 0
No memory: 0, Invalid packet: 0, Fragmented: 0

Related Commands

Command

Description

clear cdp table

Clears the table that contains CDP information about neighbors.

show cdp traffic

Displays traffic information from the CDP table.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-753

CDP Commands
clear cdp table

clear cdp table

To clear the table that contains Cisco Discovery Protocol (CDP) information about neighbors, use the
clear cdp table privileged EXEC command.
clear cdp table

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following example clears the CDP table. The output of the show cdp neighbors command shows
that all information has been deleted from the table.
Router# clear cdp table
CDP-AD: Deleted table entry for neon.cisco.com, interface Ethernet0
CDP-AD: Deleted table entry for neon.cisco.com, interface Serial0
Router# show cdp neighbors
Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
S - Switch, H - Host, I - IGMP
Device ID

Related Commands

Local Intrfce

Holdtme

Capability

Command

Description

show cdp neighbors

Displays information about neighbors.

Platform

Port ID

Cisco IOS Configuration Fundamentals Command Reference

FR-754

78-11740-02

CDP Commands
show cdp

show cdp
To display global Cisco Discovery Protocol (CDP) information, including timer and hold-time
information, use the show cdp privileged EXEC command.
show cdp

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

12.0(3)T

The output of this command was modified to include CDP Version 2

information.

Examples

The following example shows that the current router is sending CDP advertisements every 1 minute (the
default setting for the cdp timer global configuration command). Also shown is that the current router
directs its neighbors to hold its CDP advertisements for 3 minutes (the default for the cdp holdtime
global configuration command), and that the router is enabled to send CDP Version 2 advertisements:
router# show cdp
Global CDP information:
Sending CDP packets every 60 seconds
Sending a holdtime value of 180 seconds
Sending CDPv2 advertisements is enabled

Table 114 describes the significant fields shown in the display.

Table 114

show cdp Field Descriptions

Field

Definition

Sending CDP packets every XX

seconds

The interval (in seconds) between transmissions of CDP

advertisements. This field is controlled by the cdp timer
command.

Sending a holdtime value of XX

seconds

The amount of time (in seconds) the device directs the neighbor
to hold a CDP advertisement before discarding it. This field is
controlled by the cdp holdtime command.

Sending CDPv2 advertisements is

XX

The state of whether CDP Version-2 type advertisements are

enabled to be sent. Possible states are enabled or disabled. This
field is controlled by the cdp advertise v2 global configuration
command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-755

CDP Commands
show cdp

Related Commands

Command

Description

cdp advertise-v2

Enables CDP Version 2 advertising functionality on a device.

cdp holdtime

Specifies the amount of time the receiving device should hold a CDP packet
from your router before discarding it.

cdp timer

Specifies how often the Cisco IOS software sends CDP updates.

show cdp entry

Displays information about a specific neighbor device listed in the CDP

table.

show cdp interface

Displays information about the interfaces on which CDP is enabled.

show cdp neighbors

Displays detailed information about neighboring devices discovered using

CDP.

show cdp traffic

Displays information about traffic between devices gathered using CDP.

Cisco IOS Configuration Fundamentals Command Reference

FR-756

78-11740-02

CDP Commands
show cdp entry

show cdp entry

To display information about a specific neighboring device discovered using Cisco Discovery Protocol
(CDP), use the show cdp entry privileged EXEC command.
show cdp entry {* | device-name[*] [protocol | version]}

Syntax Description

Displays all of the CDP neighbors.

device-name

Name of the neighbor about which you want information.

device-name*

You can enter an asterisk (*) at the end of an entry-name as a wildcard. For
example, entering show cdp entry dev* will match all entries which begin
with dev.

protocol

(Optional) Limits the display to information about the protocols enabled on a

router.

version

(Optional) Limits the display to information about the version of software

running on the router.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following is sample output from the show cdp entry command with no limits. Information about
the neighbor device.cisco.com is displayed, including device ID, address and protocol, platform,
interface, hold time, and version.
Router# show cdp entry device.cisco.com
------------------------Device ID: device.cisco.com
Entry address(es):
IP address: 192.168.68.18
CLNS address: 490001.1111.1111.1111.00
DECnet address: 10.1
Platform: cisco 4500, Capabilities: Router
Interface: Ethernet0/1, Port ID (outgoing port): Ethernet0
Holdtime : 125 sec
Version :
Cisco IOS Software
Cisco IOS (tm) 4500 Software (C4500-J-M), Version 12.1(2)
Copyright (c) 1986-2000 by cisco Systems, Inc.
Compiled Mon 07-Apr-00 19:51 by joeuser

The following is sample output from the show cdp entry protocol command. Only information about
the protocols enabled on device.cisco.com is displayed.
Router# show cdp entry device.cisco.com protocol

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-757

CDP Commands
show cdp entry

Protocol information for device.cisco.com:

IP address: 192.168.68.18
CLNS address: 490001.1111.1111.1111.00
DECnet address: 10.1

The following is sample output from the show cdp entry version command. Only information about the
version of software running on device.cisco.com is displayed.
Router# show cdp entry device.cisco.com version
Version information for device.cisco.com:
Cisco IOS Software
Cisco IOS (tm) 4500 Software (C4500-J-M), Version 12.1(2)
Copyright (c) 1986-2000 by cisco Systems, Inc.
Compiled Mon 07-Apr-00 19:51 by joeuser

Related Commands

Command

Description

show cdp

Displays global CDP information, including timer and hold-time

information.

show cdp interface

Displays information about the interfaces on which CDP is enabled.

show cdp neighbors

Displays detailed information about neighboring devices discovered using

CDP.

show cdp traffic

Displays traffic information from the CDP table.

Cisco IOS Configuration Fundamentals Command Reference

FR-758

78-11740-02

CDP Commands
show cdp interface

show cdp interface

To display information about the interfaces on which Cisco Discovery Protocol (CDP) is enabled, use
the show cdp interface privileged EXEC command.
show cdp interface [type number]

Syntax Description

type

(Optional) Type of interface about which you want information.

number

(Optional) Number of the interface about which you want

information.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following is sample output from the show cdp interface command. Status information and
information about CDP timer and hold-time settings is displayed for all interfaces on which CDP is
enabled.
Router# show cdp interface
Serial0 is up, line protocol is up, encapsulation is SMDS
Sending CDP packets every 60 seconds
Holdtime is 180 seconds
Ethernet0 is up, line protocol is up, encapsulation is ARPA
Sending CDP packets every 60 seconds
Holdtime is 180 seconds

The following is sample output from the show cdp interface command with an interface specified.
Status information and information about CDP timer and hold-time settings is displayed for Ethernet
interface 0 only.
Router# show cdp interface ethernet 0
Ethernet0 is up, line protocol is up, encapsulation is ARPA
Sending CDP packets every 60 seconds
Holdtime is 180 seconds

Related Commands

Command

Description

show cdp

Displays global CDP information, including timer and hold-time

information.

show cdp entry

Displays information about a specific neighbor device or all neighboring

devices discovered using CDP.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-759

CDP Commands
show cdp interface

Command

Description

show cdp neighbors

Displays detailed information about neighboring devices discovered using

CDP.

show cdp traffic

Displays traffic information from the CDP table.

Cisco IOS Configuration Fundamentals Command Reference

FR-760

78-11740-02

CDP Commands
show cdp neighbors

show cdp neighbors

To display detailed information about neighboring devices discovered using Cisco Discovery Protocol
(CDP), use the show cdp neighbors privileged EXEC command.
show cdp neighbors [type number] [detail]

Syntax Description

type

(Optional) Type of the interface connected to the neighbors about which you
want information.

number

(Optional) Number of the interface connected to the neighbors about which

you want information.

detail

(Optional) Displays detailed information about a neighbor (or neighbors)

including network address, enabled protocols, hold time, and software
version.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

12.0(3)T

The output for the detail form of this command was expanded to include
CDP Version 2 information.

Examples

The following is sample output for the show cdp neighbors command:
Router#show cdp neighbors
Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
S - Switch, H - Host, I - IGMP, r - Repeater
Device ID
lab-7206
lab-as5300-1
lab-as5300-2
lab-as5300-3
lab-as5300-4
lab-3621
008024 2758E0

Local Intrfce
Eth 0
Eth 0
Eth 0
Eth 0
Eth 0
Eth 0
Eth 0

Holdtme
157
163
159
122
132
140
132

Capability
R
R
R
R
R
R S
T

Platform Port ID
7206VXR
Fas 0/0/0
AS5300
Fas 0
AS5300
Eth 0
AS5300
Eth 0
AS5300
Fas 0/0
3631-telcoFas 0/0
CAT3000
1/2

Table 115 describes the fields shown in this example.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-761

CDP Commands
show cdp neighbors

Table 115

show cdp neighbors Field Descriptions

Field

Definition

Device ID

The configured ID (name), MAC address, or serial

number of the neighbor device.

Local Intrfce

(Local Interface) The protocol being used by the

connectivity media.

Holdtme

(Holdtime) The remaining amount of time, in seconds,

the current device will hold the CDP advertisement
from a transmitting router before discarding it.

Capability

The capability code discovered on the device. This is

the type of the device listed in the CDP Neighbors
table. Possible values are:
RRouter
TTransparent bridge
BSource-routing bridge
SSwitch
HHost
IIGMP device
rRepeater

Platform

The product number of the device.

Port ID

The protocol and port number of the device.

The following is sample output for the show cdp neighbors detail command.
router#show cdp neighbors detail
------------------------Device ID: lab-7206
Entry address(es):
IP address: 172.19.169.83
Platform: cisco 7206VXR, Capabilities: Router
Interface: Ethernet0, Port ID (outgoing port): FastEthernet0/0/0
Holdtime : 123 sec
Version :
Cisco Internetwork Operating System Software
IOS (tm) 5800 Software (C5800-P4-M), Version 12.1(2)
Copyright (c) 1986-2002 by Cisco Systems, Inc.
advertisement version: 2
Duplex: half
------------------------Device ID: lab-as5300-1
Entry address(es):
IP address: 172.19.169.87
Platform: cisco AS5300, Capabilities: Router
--More-.
.
.

Cisco IOS Configuration Fundamentals Command Reference

FR-762

78-11740-02

CDP Commands
show cdp neighbors

Table 116 describes the fields displayed in the show cdp neighbors output.
Table 116

Related Commands

show cdp neighbors detail Field Descriptions

Field

Definition

Device ID

The name of the neighbor device and either the MAC

address or the serial number of this device.

Entry address(es)

A list of network addresses of neighbor devices.

[network protocol] address

The network address of the neighbor device. The

address can be in IP, IPX, AppleTalk, DECnet, or
CLNS protocol conventions.

Platform

The product name and number of the neighbor device.

Capabilities

The device type of the neighbor. This device can be a

router, a bridge, a transparent bridge, a source-routing
bridge, a switch, a host, an IGMP device, or a
repeater.

Interface

The protocol and port number of the port on the

current device.

Holdtime

The remaining amount of time, in seconds, the current

device will hold the CDP advertisement from a
transmitting router before discarding it.

Version:

The software version running on the neighbor device.

advertisement version:

The version of CDP being used for CDP

advertisements.

Duplex:

The duplex state of connection between the current

device and the neighbor device.

Native VLAN

The ID number of the VLAN on the neighbor device.

VTP Management Domain

A string that is the name of the collective group of

VLANs associated with the neighbor device.

Command

Description

show cdp

Displays global CDP information, including timer and hold-time

information.

show cdp entry

Displays information about a specific neighbor device listed in the CDP

table.

show cdp interface

Displays information about the interfaces on which CDP is enabled.

show cdp traffic

Displays information about traffic between devices gathered using CDP.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-763

CDP Commands
show cdp traffic

show cdp traffic

To display information about traffic between devices gathered using Cisco Discovery Protocol (CDP),
use the show cdp traffic privileged EXEC command.
show cdp traffic

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release

Modification

10.3

This command was introduced.

Examples

The following example specifies information associated with the show cdp traffic command:
router# show cdp traffic
Total packets output: 543, Input: 333
Hdr syntax: 0, Chksum error: 0, Encaps failed: 0
No memory: 0, Invalid: 0, Fragmented: 0
CDP version 1 advertisements output: 191, Input: 187
CDP version 2 advertisements output: 352, Input: 146

Table 117 describes the significant fields shown in the display.

Table 117

show cdp traffic Field Descriptions

Field

Definition

Total packets output

The number of CDP advertisements sent by the local device.

Note that this value is the sum of the CDP Version 1
advertisements output and CDP Version 2 advertisements output
fields.

Input

The number of CDP advertisements received by the local

device. Note that this value is the sum of the CDP Version 1
advertisements input and CDP Version 2 advertisements input
fields.

Hdr syntax

The number of CDP advertisements with bad headers, received

by the local device.

Chksum error

The number of times the checksum (verifying) operation failed

on incoming CDP advertisements.

Encaps failed

The number of times CDP failed to send advertisements on an

interface because of a failure caused by the bridge port of the
local device.

Cisco IOS Configuration Fundamentals Command Reference

FR-764

78-11740-02

CDP Commands
show cdp traffic

Table 117

show cdp traffic Field Descriptions (continued)

Field

Definition

No memory

The number of times the local device did not have enough
memory to store the CDP advertisements in the advertisement
cache table when the device was attempting to assemble
advertisement packets for transmission and parse them when
receiving them.

Invalid

The number of invalid CDP advertisements received and sent by

the local device.

Fragmented

The number of times fragments or portions of a single CDP

advertisement were received by the local device instead of the
complete advertisement.

CDP version 1 advertisements

output

The number of CDP Version 1 advertisements sent by the local

device.

Input

The number of CDP Version 1 advertisements received by the

local device.

CDP version 2 advertisements

output
Input

Related Commands

The number of CDP Version 2 advertisements sent by the local

device.
The number of CDP Version 2 advertisements received by the
local device.

Command

Description

show cdp

Displays global CDP information, including timer and hold-time

information.

show cdp entry

Displays information about a specific neighbor device listed in the CDP

table.

show cdp interface

Displays information about the interfaces on which CDP is enabled.

show cdp neighbors

Displays detailed information about neighboring devices discovered using

CDP.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-765

CDP Commands
show cdp traffic

Cisco IOS Configuration Fundamentals Command Reference

FR-766

78-11740-02

RMON Commands
This chapter describes commands used to monitor the router and network Remote Monitoring (RMON).
For system management configuration tasks and examples, refer to the Configuring RMON Support
chapter in the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-767

RMON Commands
rmon

rmon
To enable Remote Monitoring (RMON) on an Ethernet interface, use the rmon interface configuration
command. To disable RMON on the interface, use the no form of this command.
rmon {native | promiscuous}
no rmon

Syntax Description

native

Enables RMON on the Ethernet interface. In native mode, the router processes
only packets destined for this interface.

promiscuous

Enables RMON on the Ethernet interface. In promiscuous mode, the router

examines every packet.

Defaults

RMON is disabled on the interface.

Command Modes

Interface configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Note

This command enables RMON on Ethernet interfaces. A generic RMON console application is
recommended in order to use the RMON network management capabilities. SNMP must also be
configured. RMON provides visibility of individual nodal activity and allows you to monitor all nodes
and their interaction on a LAN segment. When the rmon command is issued, the router automatically
installs an Ethernet statistics study for the associated interface.

RMON can be very data and processor intensive. Users should measure usage effects to ensure that
router performance is not degraded and to minimize excessive management traffic overhead. Native
mode is less intensive than promiscuous mode.
All Cisco IOS software feature sets support RMON alarm and event groups. Additional RMON groups
are supported in certain feature sets. Refer to the Release Notes for feature set descriptions. As a security
precaution, support for the packet capture group allows capture of packet header information only; data
payloads are not captured.
The RMON MIB is described in RFC 1757.

Examples

The following example enables RMON on Ethernet interface 0 and allows the router to examine only
packets destined for the interface:
interface ethernet 0
rmon native

Cisco IOS Configuration Fundamentals Command Reference

FR-768

78-11740-02

RMON Commands
rmon

Related Commands

Command

Description

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

rmon queuesize

Changes the size of the queue that holds packets for analysis by the RMON
process.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-769

RMON Commands
rmon alarm

rmon alarm
To set an alarm on any MIB object, use the rmon alarm global configuration command. To disable the
alarm, use the no form of this command.
rmon alarm number variable interval {delta | absolute} rising-threshold value [event-number]
falling-threshold value [event-number] [owner string]
no rmon alarm number

Syntax Description

number

Alarm number, which is identical to the alarmIndex in the alarmTable in the

Remote Monitoring (RMON) MIB.

variable

MIB object to monitor, which translates into the alarmVariable used in the
alarmTable of the RMON MIB.

interval

Time in seconds the alarm monitors the MIB variable, which is identical to
the alarmInterval used in the alarmTable of the RMON MIB.

delta

Tests the change between MIB variables, which affects the alarmSampleType
in the alarmTable of the RMON MIB.

absolute

Tests each MIB variable directly, which affects the alarmSampleType in the
alarmTable of the RMON MIB.

rising-threshold
value

Value at which the alarm is triggered.

event-number

(Optional) Event number to trigger when the rising or falling threshold

exceeds its limit. This value is identical to the alarmRisingEventIndex or the
alarmFallingEventIndex in the alarmTable of the RMON MIB.

falling-threshold
value

Value at which the alarm is reset.

owner string

(Optional) Specifies an owner for the alarm, which is identical to the

alarmOwner in the alarmTable of the RMON MIB.

Defaults

No alarms configured

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The MIB object must be specified as a dotted decimal value after the entry sequence (for example,
ifEntry.10.1). You cannot specify the variable name and the instance (for example, ifInOctets.1) or the
entire dotted decimal notation. The variable must be of the form entry.integer.instance.
To disable the RMON alarms, you must use the no form of the command on each configured alarm. For
example, enter no rmon alarm 1, where the 1 identifies which alarm is to be removed.

Cisco IOS Configuration Fundamentals Command Reference

FR-770

78-11740-02

RMON Commands
rmon alarm

See RFC 1757 for more information about the RMON alarm group.

Examples

The following example configures an RMON alarm using the rmon alarm command:
rmon alarm 10 ifEntry.20.1 20 delta rising-threshold 15 1 falling-threshold 0
owner jjohnson

This example configures RMON alarm number 10. The alarm monitors the MIB variable ifEntry.20.1
once every 20 seconds until the alarm is disabled, and checks the change in the variables rise or fall. If
the ifEntry.20.1 value shows a MIB counter increase of 15 or more, such as from 100000 to 100015, the
alarm is triggered. The alarm in turn triggers event number 1, which is configured with the rmon event
command. Possible events include a log entry or a SNMP trap. If the ifEntry.20.1 value changes by 0
(falling-threshold 0), the alarm is reset and can be triggered again.

Related Commands

Command

Description

rmon

Enables Remote Network Monitoring (RMON) on an Ethernet interface

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-771

RMON Commands
rmon capture-userdata

rmon capture-userdata
To disable the packet zeroing feature that initializes the user payload portion of each Remote Monitoring
(RMON) MIB packet, use the rmon capture-userdata global configuration command. To enable packet
zeroing, use the no form of this command.
rmon capture-userdata
no rmon capture-userdata

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Global configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Use the show rmon matrix command to display RMON statistics.

Examples

The following command disables the packet zeroing feature:

rmon capture-userdata

Related Commands

Command

Description

rmon collection matrix

Enables a RMON MIB matrix group of statistics on an interface.

Cisco IOS Configuration Fundamentals Command Reference

FR-772

78-11740-02

RMON Commands
rmon collection history

rmon collection history

To enable Remote Monitoring (RMON) MIB history group of statistics on an interface, use the rmon
collection history interface configuration command. To remove a specified RMON history group of
statistics, use the no form of this command.
rmon collection history {controlEntry integer} [owner ownername] [buckets bucket-number]
[interval seconds]
no rmon collection history {controlEntry integer} [owner ownername] [buckets bucket-number]
[interval seconds]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value from 1 to 65535 that identifies the RMON group of statistics

and matches the index value returned for Simple Network
Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of

statistics.

ownername

(Optional) Records the name of the owner of the RMON group of

statistics.

buckets

(Optional) Specifies the maximum number of buckets desired for the

RMON collection history group of statistics.

bucket-number

(Optional) A value associated with the number of buckets specified

for the RMON collection history group of statistics.

interval

(Optional) Specifies the number of seconds in each polling cycle.

seconds

(Optional) The number of seconds in each polling cycle.

Defaults

No default behavior or values.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Use the show rmon capture and show rmon matrix commands to display RMON statistics.

Examples

The following command enables an RMON MIB collection history group of statistics with an ID number
of 20 and an owner of john:
rmon collection history controlEntry 20 owner john

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-773

RMON Commands
rmon collection history

Related Commands

Command

Description

show rmon capture

Displays the contents of the RMON capture table of the router.

show rmon matrix

Displays the RMON MIB matrix table.

Cisco IOS Configuration Fundamentals Command Reference

FR-774

78-11740-02

RMON Commands
rmon collection host

rmon collection host

To enable a Remote Monitoring (RMON) MIB host collection group of statistics on the interface, use
the rmon collection host interface configuration command. To remove the specified RMON host
collection, use the no form of the command.
rmon collection host {controlEntry integer} [owner ownername]
no rmon collection host {controlEntry integer} [owner ownername]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value from 1 to 65535 that identifies the RMON group of statistics

and matches the index value returned for Simple Network
Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of

statistics.

ownername

(Optional) Records the name of the owner of the RMON group of

statistics

Defaults

No default behavior or values.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Use the show rmon hosts and show rmon matrix commands to display RMON statistics.

Examples

The following command enables an RMON collection host group of statistics with an ID number of 20
and an owner of john:
rmon collection host controlEntry 20 owner john

Related Commands

Command

Description

show rmon hosts

Displays the RMON MIB hosts table.

show rmon matrix

Displays the RMON MIB matrix table.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-775

RMON Commands
rmon collection matrix

rmon collection matrix

To enable a Remote Monitoring (RMON) MIB matrix group of statistics on an interface, use the rmon
collection matrix interface configuration command. To remove a specified RMON matrix group of
statistics, use the no form of the command.
rmon collection matrix {controlEntry integer} [owner ownername]
no rmon collection matrix {controlEntry integer} [owner ownername]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value between 1 and 65535 that identifies the RMON group of

statistics and matches the index value returned for Simple Network
Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of

statistics.

ownername

(Optional) Records the name of the owner of the RMON group of

statistics.

Defaults

No default behavior or values.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Use the show rmon matrix command to display RMON statistics.

Examples

The following command enables the RMON collection matrix group of statistics with an ID number of
20 and an owner of john:
rmon collection matrix controlEntry 20 owner john

Related Commands

Command

Description

show rmon matrix

Displays the RMON MIB matrix table.

Cisco IOS Configuration Fundamentals Command Reference

FR-776

78-11740-02

RMON Commands
rmon collection rmon1

rmon collection rmon1

To enable all possible autoconfigurable Remote Monitoring (RMON) MIB statistic collections on the
interface, use the rmon collection rmon1 command in interface configuration mode. To disable these
statistic collections on the interface, use the no form of the command.
rmon collection rmon1 {controlEntry integer} [owner ownername]
no rmon collection rmon1 {controlEntry integer} [owner ownername]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value from 1 to 65535 that identifies the RMON group of statistics

and matches the index value returned for Simple Network
Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of

statistics.

ownername

(Optional) Records the name of the owner of the RMON group of

statistics.

Defaults

No default behavior or values.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Use the show rmon matrix command to display RMON statistics.

Examples

The following command enables the RMON collection rmon1 group of statistics with an ID of 20 and
an owner of john:
rmon collection rmon1 controlEntry 20 owner john

Related Commands

Command

Description

show rmon matrix

Displays the RMON MIB matrix table.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-777

RMON Commands
rmon event

rmon event
To add or remove an event in the RMON event table that is associated with an RMON event number, use
the rmon event global configuration command. To disable RMON on the interface, use the no form of
this command.
rmon event number [log] [trap community] [description string] [owner string]
no rmon event number

Syntax Description

number

Assigned event number, which is identical to the eventIndex in the eventTable in

the RMON MIB.

log

(Optional) Generates an RMON log entry when the event is triggered and sets
the eventType in the RMON MIB to log or log-and-trap.

trap community

(Optional) SNMP community string used for this trap. Configures the setting of
the eventType in the RMON MIB for this row as either snmp-trap or
log-and-trap. This value is identical to the eventCommunityValue in the
eventTable in the RMON MIB.

description string

(Optional) Specifies a description of the event, which is identical to the event

description in the eventTable of the RMON MIB.

owner string

(Optional) Owner of this event, which is identical to the eventOwner in the

eventTable of the RMON MIB.

Defaults

No events configured

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

This command applies only to the Cisco 2500 series and Cisco AS5200 series.
See RFC 1757 for more information about the RMON MIB.

Examples

The following example enables the rmon event command:

rmon event 1 log trap eventtrap description High ifOutErrors owner sdurham

This example configuration creates RMON event number 1, which is defined as High ifOutErrors, and
generates a log entry when the event is triggered by an alarm. The user sdurham owns the row that is
created in the event table by this command. This configuration also generates a Simple Network
Management Protocol (SNMP) trap when the event is triggered.

Cisco IOS Configuration Fundamentals Command Reference

FR-778

78-11740-02

RMON Commands
rmon event

Related Commands

Command

Description

rmon

Enables RMON on an Ethernet interface.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-779

RMON Commands
rmon queuesize

rmon queuesize
To change the size of the queue that holds packets for analysis by the Remote Monitoring (RMON)
process, use the rmon queuesize global configuration command. To restore the default value, use the no
form of this command.
rmon queuesize size
no rmon queuesize

Syntax Description

size

Defaults

64 packets

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Number of packets allowed in the queue awaiting RMON analysis. Default

queue size is 64 packets.

This command applies to the RMON function, which is available on Ethernet interfaces of Cisco 2500
series and Cisco AS5200 series routers only.
You might want to increase the queue size if the RMON function indicates it is dropping packets. You
can determine this from the output of the show rmon command or from the etherStatsDropEvents object
in the etherStats table. A feasible maximum queue size depends on the amount of memory available in
the router and the configuration of the buffer pool.

Examples

The following example configures the RMON queue size to be 128 packets:
rmon queuesize 128

Related Commands

Command

Description

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-780

78-11740-02

RMON Commands
show rmon

show rmon
To display the current RMON agent status on the router, use the show rmon EXEC command.
show rmon [alarms | capture | events | filter | history | hosts | matrix | statistics | task | topn]

Syntax Description

alarms

(Optional) Displays the RMON alarm table.

capture

(Optional) Displays the RMON buffer capture table. Available on

Cisco 2500 series and Cisco AS5200 series only.

events

(Optional) Displays the RMON event table.

filter

(Optional) Displays the RMON filter table. Available on

Cisco 2500 series and Cisco AS5200 series only.

history

(Optional) Displays the RMON history table. Available on

Cisco 2500 series and Cisco AS5200 series only.

hosts

(Optional) Displays the RMON hosts table. Available on

Cisco 2500 series and Cisco AS5200 series only.

matrix

(Optional) Displays the RMON matrix table. Available on

Cisco 2500 series and Cisco AS5200 series only.

statistics

(Optional) Displays the RMON statistics table. Available on

Cisco 2500 series and Cisco AS5200 series only.

task

(Optional) Displays general RMON statistics. This is the default.

topn

(Optional) Displays the RMON top-n hosts table. Available on

Cisco 2500 series and Cisco AS5200 series only.

Defaults

If no option is specified, the task option is displayed.

Command Modes

EXEC

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Refer to the specific show rmon command for an example and description of the fields.
For additional information, refer to the RMON MIB described in RFC 1757.

Examples

The following is sample output from the show rmon command. All counters are from the time the router
was initialized.
Router# show rmon
145678 packets input (34562 promiscuous), 0 drops
145678 packets processed, 0 on queue, queue utilization 15/64

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-781

RMON Commands
show rmon

Table 118 describes the fields shown in the display.

Table 118

show rmon Field Descriptions

Field

Description

x packets input

Number of packets received on RMON-enabled interfaces.

x promiscuous

Number of input packets that were seen by the router only because
RMON placed the interface in promiscuous mode.

x drops

Number of input packets that could not be processed because the RMON
queue overflowed.

x packets processed Number of input packets actually processed by the RMON task.

Related Commands

x on queue

Number of input packets that are sitting on the RMON queue, waiting to
be processed.

queue utilization
x/y

y is the maximum size of the RMON queue; x is the largest number of

packets that were ever on the queue at a particular time.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

rmon queuesize

Changes the size of the queue that holds packets for analysis by the RMON
process.

show rmon alarms

Displays the contents of the routers RMON alarm table.

show rmon capture

Displays the contents of the routers RMON capture table.

show rmon events

Displays the contents of the routers RMON event table.

show rmon filter

Displays the contents of the routers RMON filter table.

show rmon history

Displays the contents of the routers RMON history table.

show rmon hosts

Displays the contents of the routers RMON hosts table.

show rmon matrix

Displays the contents of the routers RMON matrix table.

show rmon statistics

Displays the contents of the routers RMON statistics table.

show rmon topn

Displays the contents of the routers RMON p-N host table.

Cisco IOS Configuration Fundamentals Command Reference

FR-782

78-11740-02

RMON Commands
show rmon alarms

show rmon alarms

To display the contents of the RMON alarm table of the router, use the show rmon alarms EXEC
command.
show rmon alarms

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON alarms to display alarm
information with the show rmon alarms command.

Examples

The following is sample output from the show rmon alarms command:
Router# show rmon alarms
Alarm 2 is active, owned by manager1
Monitors ifEntry.1.1 every 30 seconds
Taking delta samples, last value was 0
Rising threshold is 15, assigned to event 12
Falling threshold is 0, assigned to event 0
On startup enable rising or falling alarm

Table 119 describes the fields shown in the display.

Table 119

show rmon alarms Field Descriptions

Field

Description

Alarm 2 is active, owned by

manager1

Unique index into the alarmTable, showing the alarm

status is active, and the owner of this row, as defined in
the alarmTable of RMON.

Monitors ifEntry.1.1

Object identifier of the particular variable to be sampled.

Equivalent to alarmVariable in RMON.

every 30 seconds

Interval in seconds over which the data is sampled and

compared with the rising and falling thresholds.
Equivalent to alarmInterval in RMON.

Taking delta samples

Method of sampling the selected variable and calculating

the value to be compared against the thresholds.
Equivalent to alarmSampleType in RMON.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-783

RMON Commands
show rmon alarms

Table 119

Related Commands

show rmon alarms Field Descriptions (continued)

Field

Description

last value was

Value of the statistic during the last sampling period.

Equivalent to alarmValue in RMON.

Rising threshold is

Threshold for the sampled statistic. Equivalent to

alarmRisingThreshold in RMON.

assigned to event

Index of the eventEntry that is used when a rising

threshold is crossed. Equivalent to
alarmRisingEventIndex in RMON.

Falling threshold is

Threshold for the sampled statistic. Equivalent to

alarmFallingThreshold in RMON.

assigned to event

Index of the eventEntry that is used when a falling

threshold is crossed. Equivalent to
alarmFallingEventIndex in RMON.

On startup enable rising or

falling alarm

Alarm that may be sent when this entry is first set to valid.
Equivalent to alarmStartupAlarm in RMON.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-784

78-11740-02

RMON Commands
show rmon capture

show rmon capture

To display the contents of the routers RMON capture table, use the show rmon capture EXEC
command.
show rmon capture

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon capture command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.

Examples

The following is sample output from the show rmon capture command:
Router# show rmon capture
Buffer 4096 is active, owned by manager1
Captured data is from channel 4096
Slice size is 128, download size is 128
Download offset is 0
Full Status is spaceAvailable, full action is lockWhenFull
Granted 65536 octets out of 65536 requested
Buffer has been on since 00:01:16, and has captured 1 packets
Current capture buffer entries:
Packet 1 was captured 416 ms since buffer was turned on
Its length is 326 octets and has a status type of 0
Packet ID is 634, and contains the following data:
00 00 0c 03 12 ce 00 00 0c 08 9d 4e 08 00 45 00
01 34 01 42 00 00 1d 11 e3 01 ab 45 30 15 ac 15
31 06 05 98 00 a1 01 20 9f a8 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00

Table 120 describes the fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-785

RMON Commands
show rmon capture

Table 120

show rmon capture Field Descriptions

Field

Description

Buffer 4096 is active

Equates to bufferControlIndex in the bufferControlTable of

RMON. Uniquely identifies a valid (active) row in this
table.

owned by manager1

Denotes the owner of this row. Equates to

bufferControlOwner in the bufferControlTable of RMON.

Captured data is from channel

Equates to the bufferControlChannelIndex and identifies

which RMON channel is the source of these packets.

Slice size is

Identifies the maximum number of octets of each packet

that will be saved in this capture buffer. Equates to
bufferControlCaptureSliceSize of RMON.

download size is

Identifies the maximum number of octets of each packet in

this capture buffer that will be returned in an SNMP
retrieval of that packet. Equates to
bufferControlDownloadSliceSize in RMON.

Download offset is

Offset of the first octet of each packet in this capture buffer

that will be returned in an SNMP retrieval of that packet.
Equates to bufferControlDownloadOffset in RMON.

Full Status is spaceAvailable

Shows whether the buffer is full or has room to accept new

packets. Equates to bufferControlFullStatus in RMON.

full action is lockWhenFull

Controls the action of the buffer when it reaches full status.

Equates to bufferControlFullAction in RMON.

Granted 65536 octets

Actual maximum number of octets that can be saved in this

capture buffer. Equates to bufferControlMaxOctetsGranted
in RMON.

out of 65536 requested

Requested maximum number of octets to be saved in this

capture buffer. Equates to
bufferControlMaxOctetsRequested in RMON.

Buffer has been on since

Indicates how long the buffer has been available.

and has captured 1 packets

Number of packets captured since buffer was turned on.

Equates to bufferControlCapturedPackets in RMON.

Current capture buffer entries: Lists each packet captured.

Packet 1 was captured 416 ms
since buffer was turned on
Its length is 326 octets and has
a status type of 0

Zero indicates the error status of this packet. Equates to

captureBufferPacketStatus in RMON, where its value
options are documented.

Packet ID is

Index that describes the order of packets received on a

particular interface. Equates to captureBufferPacketID in
RMON.

and contains the following

data:

Data inside the packet, starting at the beginning of the

packet.

Cisco IOS Configuration Fundamentals Command Reference

FR-786

78-11740-02

RMON Commands
show rmon capture

Related Commands

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-787

RMON Commands
show rmon events

show rmon events

To display the contents of the routers RMON event table, use the show rmon events EXEC command.
show rmon events

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON events to display alarm
information with the show rmon events command.

Examples

The following is sample output from the show rmon events command:
Router# show rmon events
Event 12 is active, owned by manager1
Description is interface-errors
Event firing causes log and trap to community rmonTrap, last fired 00:00:00

Table 121 describes the fields shown in the display.

Table 121

show rmon events Field Descriptions

Field

Description

Event 12 is active, owned by

manager1

Unique index into the eventTable, showing the event status

is active, and the owner of this row, as defined in the
eventTable of RMON.

Description is interface-errors

Type of event, in this case an interface error.

Event firing causes log and

trap

Type of notification that the router will make about this

event. Equivalent to eventType in RMON.

community rmonTrap

If an SNMP trap is to be sent, it will be sent to the SNMP

community specified by this octet string. Equivalent to
eventCommunity in RMON.

last fired

Last time the event was generated.

Cisco IOS Configuration Fundamentals Command Reference

FR-788

78-11740-02

RMON Commands
show rmon events

Related Commands

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-789

RMON Commands
show rmon filter

show rmon filter

To display the contents of the routers RMON filter table, use the show rmon filter EXEC command.

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon filter command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.

Examples

The following is sample output from the show rmon filter command:
Router# show rmon filter
Filter 4096 is active, and owned by manager1
Data offset is 12, with
Data of 08 00 00 00 00 00 00 00 00 00 00 00 00 00 ab 45 30 15 ac 15 31 06
Data Mask is ff ff 00 00 00 00 00 00 00 00 00 00 00 00 ff ff ff ff ff ff ff ff
Data Not Mask is 0
Pkt status is 0, status mask is 0, not mask is 0
Associated channel 4096 is active, and owned by manager1
Type of channel is acceptFailed, data control is off
Generate event index 0
Event status is eventFired, # of matches is 1482
Turn on event index is 0, turn off event index is 0
Description:

Table 122 describes the fields shown in the display.

Table 122

show rmon filter Field Descriptions

Field

Description

Filter x is active, and owned by y

Unique index of the filter, its current state, and the owner,
as defined in the filterTable of RMON.

Data offset is

Offset from the beginning of each packet where a match of

packet data will be attempted. Equivalent to
filterPktDataOffset in RMON.

Data of

Data that is to be matched with the input packet. Equivalent

to filterPktData in RMON.

Cisco IOS Configuration Fundamentals Command Reference

FR-790

78-11740-02

RMON Commands
show rmon filter

Table 122

Related Commands

show rmon filter Field Descriptions (continued)

Field

Description

Data Mask is

Mask that is applied to the match process. Equivalent to

filterPktDataMask in RMON.

Data Not Mask is

Inversion mask that is applied to the match process.

Equivalent to filterPktDataNotMask in RMON.

Pkt status is

Status that is to be matched with the input packet.

Equivalent to filterPktStatus in RMON.

status mask is

Mask that is applied to the status match process. Equivalent

to filterPktStatusMask in RMON.

not mask is

Inversion mask that is applied to the status match process.

Equivalent to filterPktStatusNotMask in RMON.

Associated channel x is active, and

owned by y

Unique index of the channel, its current state, and the

owner, as defined in the channelTable of RMON.

Type of channel is {acceptMatched |

acceptFailed}

This object controls the action of the filters associated with

this channel. Equivalent to channelAcceptType of RMON.

data control is {off | on }

This object controls the flow of data through this channel.

Equivalent to channelDataControl in RMON.

Generate event index 0

Value of this object identifies the event that is configured

to be generated when the associated channelDataControl is
on and a packet is matched. Equivalent to
channelEventIndex in RMON.

Event status is eventFired

When the channel is configured to generate events when

packets are matched, this message indicates the means of
controlling the flow of those events. Equivalent to
channelEventStatus in RMON.

# of matches is

Number of times this channel has matched a packet.

Equivalent to channelMatches in RMON.

Turn on event index is

Value of this object identifies the event that is configured

to turn the associated channelDataControl from off to on
when the event is generated. Equivalent to
channelTurnOnEventIndex in RMON.

Turn off event index is

Value of this object identifies the event that is configured

to turn the associated channelDataControl from on to off
when the event is generated. Equivalent to
channelTurnOffEventIndex in RMON.

Description:

Comment describing this channel.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-791

RMON Commands
show rmon history

show rmon history

To display the contents of the routers RMON history table, use the show rmon history EXEC
command.
show rmon history

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon history command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.

Examples

The following is sample output from the show rmon history command:
Router# show rmon history
Entry 1 is active, and owned by manager1
Monitors ifEntry.1.1 every 30 seconds
Requested # of time intervals, ie buckets, is 5
Granted # of time intervals, ie buckets, is 5
Sample # 14 began measuring at 00:11:00
Received 38346 octets, 216 packets,
0 broadcast and 80 multicast packets,
0 undersized and 0 oversized packets,
0 fragments and 0 jabbers,
0 CRC alignment errors and 0 collisions.
# of dropped packet events is 0
Network utilization is estimated at 10

Table 123 describes the fields shown in the display.

Table 123

show rmon history Field Descriptions

Field

Description

Entry 1 is active, and owned by Unique index of the history entry, its current state, and the
manager1
owner as defined in the historyControlTable of RMON.
Monitors ifEntry.1.1

This object identifies the source of the data for which

historical data was collected and placed in a media-specific
table. Equivalent to historyControlDataSource in RMON.

Cisco IOS Configuration Fundamentals Command Reference

FR-792

78-11740-02

RMON Commands
show rmon history

Table 123

show rmon history Field Descriptions (continued)

Field

Description

every 30 seconds

Interval in seconds over which the data is sampled for each

bucket in the part of the media-specific table associated
with this historyControlEntry. Equivalent to
historyControlInterval in RMON.

Requested # of time intervals,

ie buckets, is

Requested number of discrete time intervals over which

data is to be saved in the part of the media-specific table
associated with this historyControlEntry. Equivalent to
historyControlBucketsRequested in RMON.

Granted # of time intervals,

ie buckets, is

Actual number of discrete time intervals over which data is

to be saved in the part of the media-specific table
associated with this historyControlEntry. Equivalent to
historyControlBucketsGranted in RMON.

Sample # 14 began measuring

at

Time at the start of the interval over which this sample was
measured.

Received 38346 octets

Total number of octets of data (including those in bad

packets) received on the network (excluding framing bits
but including FCS octets). Equivalent to
etherHistoryOctets in RMON.

x packets

Number of packets (including bad packets) received during

this sampling interval. Equivalent to etherHistoryPkts in
RMON.

x broadcast

Number of good packets received during this sampling

interval that were directed to the broadcast address.
Equivalent to etherHistoryBroadcastPkts in RMON.

x multicast packets

Number of good packets received during this sampling

interval that were directed to a multicast address.
Equivalent to etherHistoryMulticastPkts in RMON.

x undersized

Number of packets received during this sampling interval

that were fewer than 64 octets long (excluding framing bits
but including FCS octets) and were otherwise well formed.
Equivalent to etherHistoryUndersizedPkts in RMON.

x oversized packets

Number of packets received during this sampling interval

that were longer than 1518 octets (excluding framing bits
but including FCS octets) but were otherwise well formed.
Equivalent to etherHistoryOversizePkts in RMON.

x fragments

Total number of packets received during this sampling

interval that were fewer than 64 octets in length (excluding
framing bits but including FCS octets), and had either a bad
Frame Check Sequence (FCS) with an integral number of
octets (FCS Error) or a bad FCS with a nonintegral number
of octets (Alignment Error). Equivalent to
etherHistoryFragments in RMON.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-793

RMON Commands
show rmon history

Table 123

Related Commands

show rmon history Field Descriptions (continued)

Field

Description

x jabbers

Number of packets received during this sampling interval

that were longer than 1518 octets (excluding framing bits
but including FCS octets), and had either a bad Frame
Check Sequence (FCS) with an integral number of octets
(FCS Error) or a bad FCS with a nonintegral number of
octets (Alignment Error). Note that this definition of jabber
is different than the definition in IEEE-802.3 section
8.2.1.5 (10BASE5) and section 10.3.1.4 (10BASE2).
Equivalent to etherHistoryJabbers in RMON.

x CRC alignment errors

Number of packets received during this sampling interval

that had a length (excluding framing bits but including FCS
octets) from 64 to 1518 octets, inclusive, but had either a
bad Frame Check Sequence (FCS) with an integral number
of octets (FCS Error) or a bad FCS with a nonintegral
number of octets (Alignment Error). Equivalent to
etherHistoryCRCAlignErrors in RMON.

x collisions

Best estimate of the total number of collisions on this

Ethernet segment during this sampling interval. Equivalent
to etherHistoryCollisions in RMON.

# of dropped packet events is

Total number of events in which packets were dropped by

the operation because of resources during this sampling
interval. Note that this number is not necessarily the
number of packets dropped, it is just the number of times
this condition has been detected. Equivalent to
etherHistoryDropEvents in RMON.

Network utilization is
estimated at

Best estimate of the mean physical-layer network usage on

this interface during this sampling interval, in hundredths
of a percent. Equivalent to etherHistoryUtilization in
RMON.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-794

78-11740-02

RMON Commands
show rmon hosts

show rmon hosts

To display the contents of the routers RMON hosts table, use the show rmon hosts EXEC command.
show rmon hosts

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon hosts command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.
For additional information, refer to the RMON MIB described in RFC 1757.

Examples

The following is sample output from the show rmon hosts command:
Router# show rmon hosts
Host Control Entry 1 is active, and owned by manager1
Monitors host ifEntry.1.1
Table size is 51, last time an entry was deleted was 00:00:00
Creation Order number is 1
Physical address is 0000.0c02.5808
Packets: rcvd 6963, transmitted 7041
Octets: rcvd 784062, transmitted 858530
# of packets transmitted: broadcast 28, multicast 48
# of bad packets transmitted is 0

Table 124 describes the fields shown in the display.

Table 124

show rmon hosts Field Descriptions

Field

Description

Host Control Entry 1 is active, Unique index of the host entry, its current state, and the
and owned by manager1
owner as defined in the hostControlTable of RMON.
Monitors host ifEntry.1.1

This object identifies the source of the data for this instance
of the host function. Equivalent to hostControlDataSource
in RMON.

Table size is

Number of hostEntries in the hostTable and the

hostTimeTable associated with this hostControlEntry.
Equivalent to hostControlTableSize in RMON.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-795

RMON Commands
show rmon hosts

Table 124

show rmon hosts Field Descriptions (continued)

Field

Description

last time an entry was deleted

was

Time when the last entry was deleted from the hostTable.

Creation Order number is

Index that defines the relative ordering of the creation time

of hosts captured for a particular hostControlEntry.
Equivalent to hostCreationOrder in RMON.

Physical address is

Physical address of this host. Equivalent to hostAddress in

RMON.

Packets: rcvd

Number of good packets transmitted to this address.

Equivalent to hostInPkts in RMON.

transmitted

Number of packets, including bad packets transmitted by

this address. Equivalent to hostOutPkts in RMON.

Octets: rcvd

Number of octets transmitted to this address since it was

added to the hostTable (excluding framing bits but
including FCS octets), except for those octets in bad
packets. Equivalent to hostInOctets in RMON.

transmitted

Number of octets transmitted by this address since it was

added to the hostTable (excluding framing bits but
including FCS octets), including those octets in bad
packets. Equivalent to hostOutOctets in RMON.

# of packets transmitted:

Number of good packets transmitted by this address that

were broadcast or multicast.

# of bad packets transmitted is Number of bad packets transmitted by this address.

Related Commands

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-796

78-11740-02

RMON Commands
show rmon matrix

show rmon matrix

To display the contents of the routers RMON matrix table, use the show rmon matrix EXEC command.
show rmon matrix

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon matrix command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.
For additional information, refer to the RMON MIB described in RFC 1757.

Examples

The following is sample output from the show rmon matrix command:
Router# show rmon matrix
Matrix 1 is active, and owned by manager1
Monitors ifEntry.1.1
Table size is 451, last time an entry was deleted was at 00:00:00

Table 125 describes the fields shown in the display.

Table 125

Related Commands

show rmon matrix Field Descriptions

Field

Description

Matrix 1 is active, and owned

by manager1

Unique index of the matrix entry, its current state, and the
owner as defined in the matrixControlTable of RMON.

Monitors ifEntry.1.1

This object identifies the source of the data for this instance
of the matrix function. Equivalent to
matrixControlDataSource in RMON.

Table size is 451, last time an

entry was deleted was at

Size of the matrix table and the time that the last entry was
deleted.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-797

RMON Commands
show rmon matrix

Command

Description

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-798

78-11740-02

RMON Commands
show rmon statistics

show rmon statistics

To display the contents of the routers RMON statistics table, use the show rmon statistics EXEC
command.
show rmon statistics

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON alarms and events to display
alarm information with the show rmon statistics command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.

Examples

The following is sample output from the show rmon statistics command:
Router# show rmon statistics
Interface 1 is active, and owned by config
Monitors ifEntry.1.1 which has
Received 60739740 octets, 201157 packets,
1721 broadcast and 9185 multicast packets,
0 undersized and 0 oversized packets,
0 fragments and 0 jabbers,
0 CRC alignment errors and 32 collisions.
# of dropped packet events (due to lack of resources): 511
# of packets received of length (in octets):
64: 92955, 65-127: 14204, 128-255: 1116,
256-511: 4479, 512-1023: 85856, 1024-1518:2547

Table 126 describes the fields shown in the display.

Table 126

show rmon statistics Field Descriptions

Field

Description

Interface 1 is active, and

owned by config

Unique index of the statistics entry, its current state, and

the owner as defined in the etherStatsTable of RMON.

Monitors ifEntry.1.1

This object identifies the source of the data that this

etherStats entry is configured to analyze. Equivalent to
etherStatsDataSource in RMON.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-799

RMON Commands
show rmon statistics

Table 126

show rmon statistics Field Descriptions (continued)

Field

Description

Received 60739740 octets

Total number of octets of data (including those in bad

packets) received on the network (excluding framing bits
but including FCS octets). Equivalent to etherStatsOctets
in RMON.

x packets

Number of packets (including bad packets) received.

Equivalent to etherStatsPkts in RMON.

x broadcast

Number of good packets received that were directed to the

broadcast address. Equivalent to etherStatsBroadcastPkts
in RMON.

x multicast packets

Number of good packets received that were directed to a

multicast address. Equivalent to etherStatsMulticastPkts in
RMON.

x undersized

Number of packets received that were fewer than 64 octets

long (excluding framing bits but including FCS octets) and
were otherwise well formed. Equivalent to
etherStatsUndersizedPkts in RMON.

x oversized packets

Number of packets received that were longer than 1518

octets (excluding framing bits but including FCS octets)
but were otherwise well formed. Equivalent to
etherStatsOversizePkts in RMON.

x fragments

Total number of packets received that were fewer than

64 octets in length (excluding framing bits but including
FCS octets), and had either a bad Frame Check Sequence
(FCS) with an integral number of octets (FCS Error) or a
bad FCS with a nonintegral number of octets (Alignment
Error). Equivalent to etherStatsFragments in RMON.

x jabbers

Number of packets received that were longer than 1518

octets (excluding framing bits but including FCS octets),
and had either a bad Frame Check Sequence (FCS) with an
integral number of octets (FCS Error) or a bad FCS with a
nonintegral number of octets (Alignment Error). Note that
this definition of jabber is different than the definition in
IEEE-802.3 section 8.2.1.5 (10BASE5) and section
10.3.1.4 (10BASE2). Equivalent to etherStatsJabbers in
RMON.

x CRC alignment errors

Number of packets received that had a length (excluding

framing bits but including FCS octets) from 64 to 1518
octets, inclusive, but had either a bad Frame Check
Sequence (FCS) with an integral number of octets (FCS
Error) or a bad FCS with a nonintegral number of octets
(Alignment Error). Equivalent to
etherStatsCRCAlignErrors in RMON.

x collisions

Best estimate of the total number of collisions on this

Ethernet segment. Equivalent to etherHistoryCollisions in
RMON.

Cisco IOS Configuration Fundamentals Command Reference

FR-800

78-11740-02

RMON Commands
show rmon statistics

Table 126

show rmon statistics Field Descriptions (continued)

Field

Description

# of dropped packet events

(due to lack of resources):

Total number of events in which packets were dropped by

the operation because of a lack of resources. Note that this
number is not necessarily the number of packets dropped,
it is just the number of times this condition has been
detected. Equivalent to etherStatsDropEvents in RMON.

# of packets received of length Separates the received packets (good and bad) by packet
(in octets):
size in the given ranges (64, 65 to 127,128 to 255, 256 to
511, 512 to 1023, 1024 to 1516).

Related Commands

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-801

RMON Commands
show rmon topn

show rmon topn

To display the contents of the routers RMON Top-N host table, use the show rmon topn EXEC
command.
show rmon topn

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

For additional information, refer to the RMON MIB described in RFC 1757.
You must have first enabled RMON on the interface, and configured RMON events to display alarm
information with the show rmon events command.
This command is available on the Cisco 2500 series and Cisco AS5200 series only.

Examples

The following is sample output from the show rmon topn command:
Router# show rmon topn
Host Entry 1 of report 1 is active, owned by manager1
The rate of change is based on hostTopNInPkts
This report was last started at 00:00:00
Time remaining in this report is 0 out of 0
Hosts physical address is 00ad.beef.002b
Requested # of hosts: 10, # of hosts granted: 10
Report # 1 of Top N hosts entry 1 is recording
Host 0000.0c02.5808 at a rate of 12

Table 127 describes the fields shown in the display.

Table 127

show rmon topn Field Descriptions

Field

Description

Host Entry 1 of report 1 is

active, owned by manager1

Unique index of the hostTopN entry, its current state, and

the owner as defined in the hostTopNControlTable of
RMON.

The rate of change is based on Variable for each host that the hostTopNRate variable is
hostTopNInPkts
based on.
This report was last started at

Time the report was started.

Cisco IOS Configuration Fundamentals Command Reference

FR-802

78-11740-02

RMON Commands
show rmon topn

Table 127

show rmon topn Field Descriptions (continued)

Field

Description

Time remaining in this report

is

Number of seconds left in the report currently being

collected. Equivalent to hostTopNTimeRemaining in
RMON.

out of

Number of seconds that this report has collected during the

last sampling interval, or if this report is currently being
collected, the number of seconds that this report is being
collected during this sampling interval. Equivalent to
hostTopNDuration in RMON.

Hosts physical address is

Host address.

Requested # of hosts:

Maximum number of hosts requested for the Top-N table.

Equivalent to hostTopNRequestedSize in RMON.

# of hosts granted:

Maximum number of hosts granted for the Top-N

table.Eqivalent to hostTopNGrantedSiz in RMON.

Report # 1 of Top N hosts entry Report number and entry.

1 is recording
Host 0000.0c02.5808 at a rate
of

Related Commands

Physical address of the host, and the amount of change in

the selected variable during this sampling interval.
Equivalent to hostTopNAddress and hostTopNRate in
RMON.

Command

Description

rmon

Enables RMON on an Ethernet interface.

rmon alarm

Sets an alarm on any MIB object.

rmon event

Adds or removes an event in the RMON event table that is associated with
an RMON event number.

show rmon

Displays the current RMON agent status on the router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-803

RMON Commands
show rmon topn

Cisco IOS Configuration Fundamentals Command Reference

FR-804

78-11740-02

Cisco Service Assurance Agent Commands

This chapter describes the commands used to monitor network performance using Cisco
Service Assurance Agent (SAA) in Cisco IOS Release 12.2.
For SAA configuration tasks and examples, see the Network Monitoring Using Cisco Service
Assurance Agent chapter in the Cisco IOS Configuration Fundamentals Configuration Guide,
Release 12.2.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-805

Cisco Service Assurance Agent Commands

buckets-of-history-kept

buckets-of-history-kept
To set the number of history buckets that are kept during the operation lifetime of the SAA, use the
buckets-of-history-kept SAA RTR configuration command. To return to the default value, use the no
form of this command.
buckets-of-history-kept size
no buckets-of-history-kept

Syntax Description

size

Defaults

50 buckets

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Number of history buckets kept during the lifetime of the operation. The
default is 50 buckets.

History collection and statistics capturing is enabled for the following SAA operations: ICMP Echo,
SNA Echo, ICMP PathEcho, UDP Echo, TcpConnect, DNS, and DLSW. History collection is not
supported for HTTP and Jitter (UDP+) operations.
By default, history is not collected. When a problem arises where history is useful (for example, a large
number of timeouts are occurring), you can configure the lives-of-history-kept SAA RTR configuration
command to collect history. You can optionally adjust the buckets-of-history-kept, filter-for-history,
and samples-of-history-kept SAA RTR configuration commands.
When the number of buckets reaches the size specified, no further history for this life is stored.

Note

Collecting history increases the RAM usage. Only collect history when you think there is a problem
in the network. For general network response time information, use the statistics gathering feature of
SAA.
If history is collected, each bucket contains one or more history entries from the operation. When the
operation type is pathEcho, an entry is created for each hop along the path that the operation takes to
reach its destination. The type of entry stored in the history table is controlled by the filter-for-history
SAA RTR configuration command. The total number of entries stored in the history table is controlled
by the combination of samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept
SAA RTR configuration commands.

Cisco IOS Configuration Fundamentals Command Reference

FR-806

78-11740-02

Cisco Service Assurance Agent Commands

buckets-of-history-kept

Each time the SAA starts an operation, a new bucket is created until the number of history buckets
matches the specified size or the operations lifetime expires. History buckets do not wrap. The
operations lifetime is defined by the rtr schedule global configuration command. The operation starts
an SAA operation based on the seconds specified by the frequency SAA RTR configuration command.

Examples

The following example configures operation 1 to keep 25 history buckets during the lifetime of the
operation lifetime:
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

Related Commands

1
type echo protocol ipIcmpEcho 172.16.161.21
buckets-of-history-kept 25
lives-of-history-kept 1

Command

Description

filter-for-history

Defines the type of information kept in the history table for the
SA Agent operation.

lives-of-history-kept

Sets the number of lives maintained in the history table for the SA Agent
operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

rtr schedule

Configures the time parameters for an SAA operation.

samples-of-history-kept

Sets the number of entries kept in the history table per bucket for the
SA Agent operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-807

Cisco Service Assurance Agent Commands

data-pattern

data-pattern
To specify the data pattern in an SAA udpEcho operation to test for data corruption, use the data pattern
SAA RTR configuration mode command. To remove the data pattern specification, use the no form of
this command.
data-pattern hex-pattern
no data-pattern hex-pattern

Syntax Description

hex-pattern

Defaults

The default hex-pattern is ABCD.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.1(1)T

This command was introduced.

Usage Guidelines

Hexadecimal sting to use for monitoring the specified operation.

The data-pattern command allows users to specify a alphanumeric character string to verify that
operation payload does not get corrupted in either direction (source-to-destination (SD) or
destination-to-source (DS)).
For Cisco IOS Release 12.2, the data-pattern command is applicable to the udpEcho operation only.
This command also applies to the Frame Relay operation in 12.2(1)T and later T releases.

Examples

The following example specifies 1234ABCD5678 as the data pattern:

Router(config)# rtr 1
Router(config-rtr)# type udpEcho dest-ipaddr 10.0.54.205 dest-port 101
Router(config-rtr)# data-pattern 1234ABCD5678

Related Commands

Command

Description

show rtr configuration

Displays configuration values including all defaults for all SAA

operations or the specified operation.

show rtr collection-statistics Displays statistical errors for all SAA operations or the specified
operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-808

78-11740-02

Cisco Service Assurance Agent Commands

distributions-of-statistics-kept

distributions-of-statistics-kept
To set the number of statistic distributions kept per hop during the lifetime operation of the SAA, use the
distributions-of-statistics-kept SAA RTR configuration command. To return to the default value, use
the no form of this command.
distributions-of-statistics-kept size
no distributions-of-statistics-kept

Syntax Description

size

Defaults

1 distribution

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Note

Number of statistic distributions kept per hop. The default is 1 distribution.

In most situations, you do not need to change the statistic distribution size for the SAA. Only change the
size when distributions are needed (for example, when performing statistical modeling of your network).

Increasing the distributions also increases the RAM usage. The total number of statistics distributions
captured will be: the value of distributions-of-statistics-kept times the value of
hops-of-statistics-kept times the value of paths-of-statistics-kept times the value of
hours-of-statistics-kept.
When the number of distributions reaches the size specified, no further distribution information is stored.

Examples

The following example sets the distribution to 5 and the distribution interval to 10 ms. This setting means
that the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain
statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth
distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from
40 ms to infinity.
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

1
type echo protocol ipIcmpEcho 172.16.161.21
distributions-of-statistics-kept 5
statistics-distribution-interval 10

Related Commands

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-809

Cisco Service Assurance Agent Commands

distributions-of-statistics-kept

Command

Description

hops-of-statistics-kept

Sets the number of hops for which statistics are maintained per path
for the SAA operation.

hours-of-statistics-kept

Sets the number of hours for which statistics are maintained for the
SAA operation.

paths-of-statistics-kept

Sets the number of paths for which statistics are maintained per hour
for the SAA operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration

mode.

statistics-distribution-interval Sets the time interval for each statistics distribution kept for the
SA Agent.

Cisco IOS Configuration Fundamentals Command Reference

FR-810

78-11740-02

Cisco Service Assurance Agent Commands

filter-for-history

filter-for-history
To define the type of information kept in the history table for an SAA operation, use the
filter-for-history SAA RTR configuration command. To return to the default value, use the no form of
this command.
filter-for-history {none | all | overThreshold | failures}
no filter-for-history {none | all | overThreshold | failures}

Syntax Description

none

No history kept. This is the default.

all

All operation operations attempted are kept in the history table.

overThreshold

Only packets that are over the threshold are kept in the history table.

failures

Only packets that fail for any reason are kept in the history table.

Defaults

No SAA history is kept for an operation.

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Use the filter-for-history command to control what gets stored in the history table for the SAA. To
control how much history gets saved in the history table, use the lives-of-history-kept,
buckets-of-history-kept, and the samples-of-history-kept SAA RTR configuration commands.
An operation can collect history and capture statistics. By default, history is not collected. When a
problem arises where history is useful (for example, a large number of timeouts are occurring), you can
configure the lives-of-history-kept command to collect history.

Note

Examples

Collecting history increases the RAM usage. Only collect history when you think there is a problem.
For general network response time information, use statistics.

In the following example, only operation packets that fail are kept in the history table:
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

1
type echo protocol ipIcmpEcho 172.16.161.21
lives-of-history-kept 1
filter-for-history failures

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-811

Cisco Service Assurance Agent Commands

filter-for-history

Related Commands

Command

Description

buckets-of-history-kept Sets the number of history buckets that are kept during the lifetime of the
SAA.
lives-of-history-kept

Sets the number of lives maintained in the history table for the SAA
operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

samples-of-history-kept Sets the number of entries kept in the history table per bucket for the SAA
operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-812

78-11740-02

Cisco Service Assurance Agent Commands

frequency

frequency
To set the rate at which a specified SAA operation is sent into the network, use the frequency SAA RTR
configuration command. To return to the default value, use the no form of this command.
frequency seconds
no frequency

Syntax Description

seconds

Defaults

60 seconds

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Note

Number of seconds between the SAA probe operations.

If an individual SAA operational probe takes longer to execute than the specified frequency value, a
statistics counter called busy is incremented rather than sending a second probe.

We recommend that you do not set the frequency value to less than 60 seconds for the following
reasons: It is not needed when keeping statistics (the default), and it can slow down the WAN because
of the potential overhead that numerous operations can cause.
The value specified for the frequency command cannot be less than the value specified for the timeout
SAA RTR configuration command.

Examples

The following example configures SAA IP/ICMP Echo operation 1 to send a probe every 90 seconds:
Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# frequency 90

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

timeout

Sets the amount of time the SAA operation waits for a response from its
request packet.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-813

Cisco Service Assurance Agent Commands

hops-of-statistics-kept

hops-of-statistics-kept
To set the number of hops for which statistics are maintained per path for the SAA operation, use the
hops-of-statistics-kept SAA RTR configuration command. To return to the default value, use the no
form of this command.
hops-of-statistics-kept size
no hops-of-statistics-kept

Syntax Description

size

Defaults

16 hops for type pathEcho

Number of hops for which statistics are maintained per path. The default is
16 hops for type pathEcho and 1 hop for type echo.

1 hop for type echo

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

One hop is the passage of a timed packet from this router to another network device. The other network
device is assumed to be a device along the path to the destination (including the destination) when the
operation type is pathEcho, or just the destination when the type is echo.
When the number of hops reaches the size specified, no further hop information is stored.

Examples

The following example monitors the statistics of operation 2 for only 10 hops:
Router(config)# rtr 2
Router(config-rtr)# type pathecho protocol ipIcmpEcho 172.16.1.177
Router(config-rtr)# hops-of-statistics-kept 10

Related Commands

Command

Description

distributions-of-statistics-kept

Sets the number of statistic distributions kept per hop during the
lifetime of the SAA.

hours-of-statistics-kept

Sets the number of hours for which statistics are maintained for
the SAA operation.

paths-of-statistics-kept

Sets the number of paths for which statistics are maintained per
hour for the SAA operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-814

78-11740-02

Cisco Service Assurance Agent Commands

hops-of-statistics-kept

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration

mode.

statistics-distribution-interval

Sets the time interval for each statistics distribution kept for the
SAA.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-815

Cisco Service Assurance Agent Commands

http-raw-request

http-raw-request
To explicitly specify the options for a GET request for an SAA HTTP operation, use the
http-raw-request command in SAA RTR configuration mode.
http-raw-request

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Using the http-raw-request command puts you in HTTP Raw Request configuration mode, indicated
by the (config-rtr-http) router prompt.
The http-raw-request command should follow the type http operation raw command. Use the
raw-request option when you wish to explicitly specify the content of an HTTP request. Use HTTP 1.0
commands in HTTP Raw Request configuration mode.
The SAA will specify the content of an HTTP request for you if you use the type http operation get
command. SA Agent will send the HTTP request, receive the reply, and report RTT statistics (including
the size of the page returned).

Examples

In the following example, SAA operation 6 is created and configured as an HTTP operation. The HTTP
GET command is explicitly specified:
Router(config)# rtr 6
Router(config-rtr)# type http operation raw url http://www.cisco.com
Router(config-rtr)# http-raw-request
Router(config-rtr-http)# GET /index.html HTTP/1.0\r\n
Router(config-rtr-http)# \r\n
Router(config-rtr-http)# exit
Router(config)# rtr schedule 6 start-time now

Related Commands

Command

Description

type http

Configures an HTTP SAA operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-816

78-11740-02

Cisco Service Assurance Agent Commands

hours-of-statistics-kept

hours-of-statistics-kept
To set the number of hours for which statistics are maintained for the SAA operation, use the
hours-of-statistics-kept SAA RTR configuration command. To return to the default value, use the no
form of this command.
hours-of-statistics-kept hours
no hours-of-statistics-kept

Syntax Description

hours

Defaults

2 hours

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Number of hours that the router maintains statistics. The default is 2 hours.

When the number of hours exceeds the specified value, the statistics table wraps (that is, the oldest
information is replaced by newer information).
This command sets the amount of time statistics are kept for use by the show rtr collection-statistics
command and show rtr distribution command.

Examples

The following example maintains 3 hours of statistics for SAA operation 2:

Router(config)# rtr 2
Router(config-rtr)# type pathecho protocol ipIcmpEcho 172.16.1.177
Router(config-rtr)# hours-of-statistics-kept 3

Related Commands

Command

Description

distributions-of-statistics-kept

Sets the number of statistic distributions kept per hop during the
lifetime of the SAA.

hops-of-statistics-kept

Sets the number of hops for which statistics are maintained per
path for the SAA operation.

paths-of-statistics-kept

Sets the number of paths for which statistics are maintained per
hour for the SAA operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration

mode.

statistics-distribution-interval

Sets the time interval for each statistic distribution kept for the
SA Agent.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-817

Cisco Service Assurance Agent Commands

lives-of-history-kept

lives-of-history-kept
To set the number of lives maintained in the history table for the SAA operation, use the
lives-of-history-kept SAA RTR configuration command. To return to the default value, use the no form
of this command.
lives-of-history-kept lives
no lives-of-history-kept

Syntax Description

lives

Defaults

0 lives

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Number of lives maintained in the history table for the operation. If you
specify 0 lives, history is not collected for the operation.

The number of lives you can specify is dependent on the type of operation you are configuring. Use the
lives-of-history-kept ? command to determine the available options.
The default value of 0 lives means that history is not collected for the operation.
To disable history collection, use no lives-of-history-kept command rather than the filter-for-history
none SAA RTR configuration command. The no lives-of-history-kept command disables history
collection before an operation is attempted, while the filter-for-history command causes the SAA to
check for history inclusion after the operation attempt is made.
When the number of lives exceeds the specified value, the history table wraps (that is, the oldest
information is replaced by newer information).
When an operation makes a transition from pending to active, a life starts. When the life of an operation
ends, the operation makes a transition from active to pending.

Examples

The following example maintains the history for 5 lives of operation 1:

Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# lives-of-history-kept 5

Cisco IOS Configuration Fundamentals Command Reference

FR-818

78-11740-02

Cisco Service Assurance Agent Commands

lives-of-history-kept

Related Commands

Command

Description

buckets-of-history-kept Sets the number of history buckets that are kept during the lifetime of the
SAA.
filter-for-history

Defines the type of information kept in the history table for the SAA
operation.

rtr

Enters SAA RTR configuration mode.

samples-of-history-kept Sets the number of entries kept in the history table per bucket for the
SA Agent operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-819

Cisco Service Assurance Agent Commands

lsr-path

lsr-path
To define a loose source routing (LSR) path for a Cisco SAA IP echo operation, use the lsr-path SAA
RTR configuration command. To remove the definition, use the no form of this command.
lsr-path {hostname | ip-address} [{hostname | ip-address} ...]
no lsr-path

Syntax Description

{hostname | ip-address}

Hostname or IP address of the first hop in the LSR path.

[{hostname | ip-address} ...]

(Optional) Indicates that you can continue specifying host

destinations until you specify the final host target. Each hostname or
ip-address specified indicates another hop on the path. The maximum
number of hops you can specify is eight. Do not enter the dots (...).

Defaults

LSR path is disabled.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

The maximum number of hops available is eight when an LSR path is configured.

Examples

In the following example, the LSR path is defined for SAA echo operation 1. The target destination for
the operation is at 172.16.1.176. The first hop on the LSR path is 172.18.4.149. The second hop on the
LSR path is 172.18.16.155.
Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# lsr-path 172.18.4.149 172.18.26.155

Related Commands

Command

Description

rtr

Specifies an identification for an SAA operation and enters SAA RTR

configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-820

78-11740-02

Cisco Service Assurance Agent Commands

owner

owner
To configure the Simple Network Management Protocol (SNMP) owner of an SAA operation, use the
owner SAA RTR configuration command. To return to the default value, use the no form of this
command.
owner text
no owner

Syntax Description

text

Defaults

No owner is specified.

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Name of the SNMP owner from 0 to 255 ASCII characters. The default is
none.

Usage Guidelines

The owner name contains one or more of the following: ASCII form of the network management
stations transport address, network management station name (that is, the domain name), and network
management personnels name, location, or phone number. In some cases, the agent itself will be the
owner of the operation. In these cases, the name can begin with agent.

Examples

The following example sets the owner of operation 1 to 172.16.1.189 cwb.cisco.com John Doe RTP
555-1212:
Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# owner 172.16.1.189 cwb.cisco.com John Doe RTP 555-1212

Related Commands

Command

Description

rtr

Enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-821

Cisco Service Assurance Agent Commands

paths-of-statistics-kept

paths-of-statistics-kept
To set the number of paths for which statistics are maintained per hour for the SAA operation, use the
paths-of-statistics-kept SAA RTR configuration command. To return to the default value, use the no
form of this command.
paths-of-statistics-kept size
no paths-of-statistics-kept

Syntax Description

size

Defaults

5 paths for type pathEcho

Number of paths for which statistics are maintained per hour. The default is
5 paths for type pathEcho and 1 path for type echo.

1 path for type echo

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

A path is the route the request packet of the operation takes through the network to get to its destination.
The operation may take a different path to reach its destination for each SAA operation.
When the number of paths reaches the size specified, no further path information is stored.

Examples

The following example maintains statistics for only 3 paths for operation 2:
Router(config)# rtr 2
Router(config-rtr)# type pathEcho protocol ipIcmpEcho 172.16.1.177
Router(config-rtr)# paths-of-statistics-kept 3

Related Commands

Command

Description

distributions-of-statistics-kept

Sets the number of statistic distributions kept per hop during the
lifetime of the SA.

hops-of-statistics-kept

Sets the number of hops for which statistics are maintained per
path for the SAA operation.

hours-of-statistics-kept

Sets the number of hours for which statistics are maintained for
the SAA operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-822

78-11740-02

Cisco Service Assurance Agent Commands

paths-of-statistics-kept

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration

mode.

statistics-distribution-interval

Sets the time interval for each statistics distribution kept for the
SAA.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-823

Cisco Service Assurance Agent Commands

request-data-size

request-data-size
To set the protocol data size in the payload of the SAA operations request packet, use the
request-data-size SAA RTR configuration command. To return to the default value, use the no form of
this command.
request-data-size byte
no request-data-size

Syntax Description

byte

Defaults

1 byte

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Size of the protocol data in the payload of the request packet of the
operation. Range is 0 to the maximum of the protocol. The default is 1 byte.

Usage Guidelines

When the protocol name has the suffix appl, the packet uses both a request and respond data size (see
the response-data-size SAA RTR configuration command), and the data size is 12 bytes smaller than
the normal payload size (this 12 bytes is the ARR Header used to control send and data response sizes).

Examples

The following example sets the request packet size to 40 bytes for operation 3:
Router(config)# rtr 3
Router(config-rtr)# type echo protocol snalu0echoappl cwbc0a
Router(config-rtr)# request-data-size 40

Related Commands

Command

Description

response-data-size

Sets the protocol data size in the payload of the SAA operations response
packet.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-824

78-11740-02

Cisco Service Assurance Agent Commands

response-data-size

response-data-size
To set the protocol data size in the payload of an SAA operations response packet, use the
response-data-size SAA RTR configuration command. To return to the default value, use the no form
of this command.
response-data-size byte
no response-data-size

Syntax Description

byte

Defaults

0 bytes

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Size of the protocol data in the payload in the operations response packet.
For appl protocols, the default is 0 bytes. For all others, the default is the
same value as the request-data-size.

The response-data-size command is only applicable for the following operations:

type echo protocol snaLU0EchoAppl

type echo protocol snaLU2EchoAppl

type pathEcho protocol snaLU0EchoAppl

type pathEcho protocol snaLU2EchoAppl

Note that these protocols are defined with the type command that end in appl (for example,
snalu0echoappl). When the protocol ends in appl, the response data size is 12 bytes smaller than
normal payload size.

Examples

The following example configures the response packet size of snaLU0 Echo operation 3 to 1440 bytes:
Router(config)# rtr 3
Router(config-rtr)# type echo protocol snalu0echoappl cwbc0a
Router(config-rtr)# response-data-size 1440

Related Commands

Command

Description

request-data-size

Sets the protocol data size in the payload of the SAA operations request
packet.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-825

Cisco Service Assurance Agent Commands

rtr

rtr
To begin configuring an SAA operation by entering SAA RTR configuration mode, use the rtr command
in global configuration mode. To remove all configuration information for an operation, including the
schedule of the operation, reaction configuration, and reaction triggers, use the no form of this
command.
rtr op-number
no rtr op-number

Syntax Description

op-number

Defaults

None

Command Modes

Global configuration

Command History

Release

Usage Guidelines

Operation number used for the identification of the SAA operation you wish
to configure.

Modification

11.2

This command was introduced.

12.2(11)T

The maximum number of operations was increased from 500 to 2000.

The rtr command is used to configure Cisco Service Assurance Agent (SAA) operations. Use this
command to specify an identification number for the operation you are about to configure. After you
enter this command, you will enter the SAA RTR configuration mode, indicated by the (config-rtr)
router prompt. The Related Commands table lists the commands you can use in SAA RTR
configuration mode.
For detailed information on the configuration of the Cisco SAA feature, see the Network Monitoring
Using Cisco Service Assurance Agent chapter in the Cisco IOS Configuration Fundamentals
Configuration Guide, Release 12.2.
SAA allows a maximum of 500 operations.
Debugging is supported only on the first 32 operation numbers.
After you configure a operation, you must schedule the operation. For information on scheduling a
operation, refer to the rtr schedule global configuration command. You can also optionally set reaction
triggers for the operation. For information on reaction triggers, refer to the rtr reaction-configuration
and rtr reaction-trigger global configuration commands.

Note

After you schedule an operation with the rtr schedule global configuration command, you cannot
modify the configuration of the operation. To modify the configuration of the operation after it is
scheduled, use the no rtr command. You can now reenter the operations configuration with the rtr
command.

Cisco IOS Configuration Fundamentals Command Reference

FR-826

78-11740-02

Cisco Service Assurance Agent Commands

rtr

To display the current configuration settings of the operation, use the show rtr configuration EXEC
command.

Examples

In the following example, operation 1 is configured to perform end-to-end response time operations
using an SNA LU Type 0 connection with the host name cwbc0a. Only the type SAA RTR configuration
command is required; all others are optional.
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#
Router(config)#

Note

Related Commands

1
type echo protocol snalu0echoappl cwbc0a
request-data-size 40
response-data-size 1440
exit

If operation 1 already existed and it has not been scheduled, you are placed into SAA RTR
configuration command mode. If the operation already exists and has been scheduled, this command
will fail.

Command

Description

buckets-of-history-kept

Sets the number of history buckets that are kept during an SAA
operations lifetime.

distributions-of-statistics-kept

Sets the number of statistic distributions kept per hop during an

SAA operations lifetime.

filter-for-history

Defines the types of information to be kept in the history table for

SAA operations.

frequency

Sets the frequency at which the operation should execute.

hops-of-statistics-kept

Sets the number of hops for which statistics are maintained per
path for the SAA operation.

hours-of-statistics-kept

Sets the number of hours for which statistics are maintained for
SAA operations.

lives-of-history-kept

Sets the number of lives maintained in the history table for an

SAA operation.

lsr path

Specifies the path on which to measure the ICMP Echo response

time.

owner

Configures the SNMP owner of an SAA operation.

paths-of-statistics-kept

Sets the number of paths for which statistics are maintained per
hour for an SAA operation.

request-data-size

Sets the protocol data size in the payload of an operations request

packet.

response-data-size

Sets the protocol data size in the payload of an operations

response packet.

samples-of-history-kept

Sets the number of entries kept in the history table for an SAA
operation.

statistics-distribution-interval

Sets the time interval for each statistical distribution.

tag

Logically links SAA operations together in a group.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-827

Cisco Service Assurance Agent Commands

rtr

Command

Description

threshold

Sets the rising threshold (hysteresis) that generates a reaction

event and stores history information for the probe.

timeout

Sets the amount of time an SAA operation waits for a response

from its request packet.

tos

Defines the IP type of service for request packets of SAA

operations.

type dlsw

Configures an SAA DLSw operation.

type tcpConnect

Defines an SAA TCP Connect operation.

verify-data

Checks each SAA operation response for corruption.

Cisco IOS Configuration Fundamentals Command Reference

FR-828

78-11740-02

Cisco Service Assurance Agent Commands

rtr key-chain

rtr key-chain
To enable SAA control message authentication and specify an MD5 key chain, use the rtr key-chain
global configuration command. To remove control message authentication, use the no form of this
command.
rtr key-chain name
no rtr key-chain

Syntax Description

name

Defaults

None

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Name of MD5 key chain.

Usage Guidelines

The authentication configuration on the SAA collector and SAA Responder must be the same. Both sides
must configure the same key chain or both sides must not use authentication.

Examples

In the following example, the SAA control message uses MD5 authentication, and the key chain name
is CSAA:
Router(config)# rtr key-chain csaa

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-829

Cisco Service Assurance Agent Commands

rtr low-memory

rtr low-memory
To specify how much unused memory must be available to allow SAA configuration, use the
rtr low-memory global configuration command. To remove the type configuration for the operation, use
the no form of this command.
rtr low-memory value
no rtr low-memory

Syntax Description

value

Defaults

The default value is 25 percent of the memory available on the system.

Command Modes

Global configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

Specifies amount of memory, in bytes, that must be available to configure

SAA (RTR). The range is from 0 to the maximum amount of free memory
bytes available.

The rtr low-memory command allows the user to specify the amount of memory that the SAA can use.
If the amount of available free memory falls below the value specified in the rtr low-memory command,
then the SAA will not allow new operations to be configured. If this command is not used, the default
low-memory value is 25 percent. This means that if 75 percent of system memory has been utilized you
will not be able to configure any SAA characteristics.
The value of the rtr low-memory command should not exceed the amount of free memory available on
the system. To determine the amount of free memory available on the system, use the show memory
EXEC command.

Examples

In the following example, the router is configured so that no less than 2 MB of memory will be free for
RTR configuration:
Router(config)# rtr low-memory 2000000

Related Commands

Command

Description

rtr

Specifies an identification number for an operation and enters SAA RTR

configuration mode.

show memory

Displays statistics about memory, including memory-free pool statistics.

Cisco IOS Configuration Fundamentals Command Reference

FR-830

78-11740-02

Cisco Service Assurance Agent Commands

rtr reaction-configuration

rtr reaction-configuration
To configure certain actions to occur based on events under the control of the SAA, use the rtr
reaction-configuration global configuration command. To return to the default values of the operation,
use the no form of this command.
rtr reaction-configuration operation-number [verify-error-enable] [connection-loss-enable]
[timeout-enable] [threshold-falling milliseconds] [threshold-type option] [action-type
option]
no rtr reaction-configuration operation-number

Syntax Description

operation-number

Number of the SAA operation to configure.

verify-error-enable

(Optional) Enables error verification. The default is disabled.

connection-loss-enable (Optional) Enables checking for connection loss in connection-oriented

protocols. Disabled by default.
timeout-enable

(Optional) Enables checking for response time reporting operation timeouts

based on the timeout value configured for the operation with the timeout
SAA RTR configuration command. The default is disabled.

threshold-falling
milliseconds

(Optional) Sets the falling threshold (standard RMON-type hysteresis

mechanism) in milliseconds. When the falling threshold is met, generate a
resolution reaction event. The rising of the operation over threshold is set
with the threshold SAA RTR configuration command. The default value is
3000 ms.

threshold-type option

(Optional) Specify the algorithm used by the SAA to calculate over and
falling threshold violations. The value for option can be one of the
following keywords:

neverDo not calculate threshold violations (the default).

immediateWhen the response time exceeds the rising over threshold

or drops below the falling threshold, immediately perform the action
defined by action-type.

consecutive [occurrences]When the response time exceeds the rising

threshold consecutively five times or drops below the falling threshold
consecutively five times, perform the action defined by action-type.
Optionally specify the number of consecutive occurrences. The default
is 5.

xofy [x-value y-value]When the response time exceeds the rising

threshold five out of the last five times or drops below the falling
threshold five out of the last five times, perform the action defined by
action-type. Optionally specify the number of violations that must
occur and the number that must occur within a specified number. The
default is 5 for both x-value and y-value.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-831

Cisco Service Assurance Agent Commands

rtr reaction-configuration

action-type option

Defaults

average [attempts]When the average of the last five response times

exceeds the rising threshold or when the average of the last five
response times drops below the falling threshold, perform the action
defined by action-type. Optionally specify the number of operations to
average. The default is the average of the last five response time
operations. For example: if the threshold of the operation is 5000 ms
and the last three attempts results of the operation are 6000, 6000, and
5000 ms, the average would be 6000 + 6000 + 5000=17000/3 > 5000,
thus violating the 5000-ms threshold.

(Optional) Specify what action or combination of actions the operation

performs when you configure connection-loss-enable or timeout-enable,
or threshold events occur. For the action-type to occur for threshold events,
the threshold-type must be defined to anything other than never. Option
can be one of the following keywords:

noneNo action is taken.

trapOnlySend an SNMP trap on both over and falling threshold

violations.

nmvtOnlySend an SNA NMVT Alert on over threshold violation

and an SNA NMVT Resolution on falling threshold violations.

triggerOnlyHave one or more target operations operational state

make the transition from pending to active on over (and falling)
threshold violations. The target operations are defined with the rtr
reaction-trigger command. A target operation will continue until its
life expires as specified by the target operations life value configured
with the rtr schedule global configuration command. A triggered
target operation must finish its life before it can be triggered again.

trapAndNmvtSend a combination of trapOnly and nmvtOnly.

trapAndTriggerSend a combination of trapOnly and triggerOnly.

nmvtAndTriggerSend a combination of nmvtOnly and

triggerOnly.

trapNmvtAndTriggerSend a combination of trapOnly, nmvtOnly,

and triggerOnly.

No reactions are generated.

Error verification is disabled.
Connection loss is disabled.
Checking the timeout is disabled.
The falling threshold value is 3000 ms.
The algorithm threshold is never.

Command Modes

Global configuration

Cisco IOS Configuration Fundamentals Command Reference

FR-832

78-11740-02

Cisco Service Assurance Agent Commands

rtr reaction-configuration

Command History

Usage Guidelines

Release

Modification

11.2

This command was introduced.

12.1(1)T

The verify-error-enable optional keyword was added.

Triggers are used for diagnostics purposes and are not used in normal operation.
You can use triggers to assist you in determining where delays are happening in the network when
excessive delays are being seen on an end-to-end basis.
The reaction applies only to attempts to the target (that is, attempts to any hops along the path in
pathEcho do not generate reactions).

Note

Examples

Keywords are not case sensitive and are shown in mixed case for readability only.

In the following example, operation 19 sends an SNMP trap when there is an over or falling threshold
violation:
Router(config)# rtr reaction-configuration 19 threshold-type immediate action-type
trapOnly

Figure 2 shows that an alert (rising trap) would be issued immediately when the response time exceeds
the rising threshold and a resolution (falling trap) would be issued immediately when the response time
drops below the falling threshold.
Figure 2

Example of Rising and Falling Thresholds

Rising threshold

= Threshold violation

Falling threshold

= Resolution
Time

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

rtr reaction-trigger

Defines a second SAA operation to make the transition from a pending state
to an active state when one of the trigger action-type options are defined with
the rtr reaction-configuration global configuration command.

threshold

Sets the rising threshold (hysteresis) that generates a reaction event and
stores history information for the SAA operation.

timeout

Sets the amount of time the SAA operation waits for a response from its
request packet.

S4793

= Alert

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-833

Cisco Service Assurance Agent Commands

rtr reaction-trigger

rtr reaction-trigger
To define a second SAA operation to make the transition from a pending state to an active state when
one of the trigger action-type options are defined with the rtr reaction-configuration global
configuration command, use the rtr reaction-trigger global configuration command. To remove the
trigger combination, use the no form of this command.
rtr reaction-trigger operation-number target-operation
no rtr reaction-trigger operation

Syntax Description

operation-number

Number of the operation in the active state that has the action-type set with
the rtr reaction-configuration global configuration command.

target-operation

Number of the operation in the pending state that is waiting to be triggered

with the rtr global configuration command.

Defaults

No trigger combination is defined.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Triggers are usually used for diagnostics purposes and are not used in normal operation.

Examples

In the following example, the state of operation 1 is changed from pending state to active state when
action-type of operation 2 occurs:
Router(config)# rtr reaction-trigger 2 1

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

rtr reaction-configuration

Configures certain actions to occur based on events under the control

of the SAA.

rtr schedule

Configures the time parameters for an SAA operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-834

78-11740-02

Cisco Service Assurance Agent Commands

rtr reset

rtr reset
To perform a shutdown and restart of the SAA, use the rtr reset global configuration command.
rtr reset

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Global configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines
Caution

Use the rtr reset command only in extreme situations such as the incorrect configuration of a number
of operations.
The rtr reset command stops all operations, clears SAA RTR configuration information, and returns the
SAA feature to the startup condition. This command does not reread the SAA RTR configuration stored
in startup-config in NVRAM. You must retype the configuration or perform a config memory command.

Examples

The following example resets the SAA feature:

Router(config)# rtr reset

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-835

Cisco Service Assurance Agent Commands

rtr responder

rtr responder
To enable the SAA Responder feature, use the rtr responder global configuration command. To disable
the SAA Responder, use the no form of this command.
rtr responder [type {udpEcho | tcpConnect} [ipaddress ipaddr] port port]
no rtr responder [type {udpEcho | tcpConnect} [ipaddress ipaddr] port port]

Syntax Description

type udpEcho

(Optional) Specifies that the responder will accept and return udpEcho
operation packets.
Note

You should use type udpEcho keyword combination for Jitter

(UDP Echo +) operations as well.

type tcpConnect

(Optional) Specifies that the responder will accept and return tcpConnect
operation packets.

ipaddress ipaddr

(Optional) Specifies the IP address that the operation will be received at.

port port

(Optional) Specifies the port number that the operation will be received on.

Defaults

None

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

12.1(1)T

The type, ipaddr, and port keywords were added.

Usage Guidelines

This command is used on the destination device for SAA operations to enable UPD Echo, TCP Connect,
and Jitter (UDP+) operations on non-native interfaces.
The type, ipaddr, and port keywords enable the SAA Responder to respond to probe packets without
receiving Control Protocol packets. The applicable protocols are Jitter, udpEcho, and tcpConnect.
However, note that if you use these keywords, packet loss statistics will not be able to be generated for
the operation, because the Responder will not be able to determine the order of the received packets.

Examples

The following example enables the SAA Responder:

Router(config)# rtr responder

Cisco IOS Configuration Fundamentals Command Reference

FR-836

78-11740-02

Cisco Service Assurance Agent Commands

rtr responder

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-837

Cisco Service Assurance Agent Commands

rtr restart

rtr restart
To restart an SAA operation, use the rtr restart global configuration command.
rtr restart operation-number

Syntax Description

operation-number

Defaults

No default behavior or values.

Command Modes

Global configuration.

Command History

Release

Modification

12.1(1)T

This command was introduced.

Usage Guidelines

Number of the SAA operation to restart. SAA allows a maximum of 500

operations.

To restart an operation, the operation should be in an active state (as defined in the rtr
reaction-configuration command).
SAA allows a maximum of 500 operations.
This command does not have a no form.

Examples

The following example restarts operation 12:

Router(config)# rtr restart 12

Cisco IOS Configuration Fundamentals Command Reference

FR-838

78-11740-02

Cisco Service Assurance Agent Commands

rtr schedule

rtr schedule
To configure the time parameters for an SAA operation, use the rtr schedule global configuration
command. To stop the operation and place it in the default state (pending), use the no form of this
command.
rtr schedule operation-number [life {forever | seconds}] [start-time
{hh:mm[:ss] [month day | day month] | pending | now | after hh:mm::ss}] [ageout seconds]
no rtr schedule operation-number

Syntax Description

operation-number

(Required) Number of the SAA operation to schedule.

life seconds

(Optional) Number of seconds the operation actively collects information. The

default is 3600 seconds (one hour).

life forever

(Optional) Schedules the operation to run indefinitely.

start-time

(Optional) Time when the operation starts collecting information. If the

start-time is not specified, no information is collected until the start-time is
configured or a trigger occurs that performs a start-time now.

start-time
hh:mm[:ss]

(Optional) Specifies an absolute start time using hour, minute, and (optionally)
second. Use the 24-hour clock notation. For example, start-time 01:02 means
start at 1:02 a.m., and start-time 13:01:30 means start at 1:01 p.m. and 30
seconds. The current day is implied unless you specify a month and day.

month

(Optional) Name of the month to start the operation in. If month is not specified,
the current month is used. Use of this argument requires that a day be specified
as well. You can specify the month with the full english name, or using the first
three letters of the month.

day

(Optional) Number of the day (in the range 1 to 31) to start the operation on. If
a day is not specified, the current day is used. Use of this argument requires that
a month be specified as well.

start-time pending (Optional) No information is collected. This is the default value.

start-time now

(Optional) Indicates that the operation should start immediately.

start-time after
hh:mm:ss

(Optional) Indicates that the operation should start hh hours, mm minutes, and
ss seconds after this command was entered.

ageout seconds

(Optional) Number of seconds to keep the operation in memory when it is not

actively collecting information. The default is 0 seconds (never ages out).

Defaults

The operation is placed in a pending state (that is, the operation is enabled but not actively collecting
information).

Command Modes

Global configuration

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-839

Cisco Service Assurance Agent Commands

rtr schedule

Command History

Usage Guidelines

Release

Modification

11.2

This command was introduced.

12.1(1)T

The after and forever keywords were added.

After you schedule the operation with the rtr schedule command, you cannot change the configuration
of the operation. To change the configuration of the operation, use the no form of the rtr global
configuration command and reenter the configuration information.
If the operation is in a pending state, you can define the conditions under which the operation makes the
transition from pending to active with the rtr reaction-trigger and rtr reaction-configuration global
configuration commands. When the operation is in an active state, it immediately begins collecting
information.
The following time line shows the age-out process of the operation:
W----------------------X----------------------Y----------------------Z

where:

W is the time the operation was configured with the rtr global configuration command.

X is the start time or start of life of the operation (that is, when the operation became active).

Y is the end of life as configured with the rtr schedule global configuration command (life seconds
have counted down to zero).

Z is the age out of the operation.

Age out starts counting down at W and Y, is suspended between X and Y, and is reset to its configured
size at Y.
It is possible for the operation to age out before it executes (that is, Z can occur before X). To ensure that
this does not happen, the difference between the operations configuration time and start time (X and W)
must be less than the age-out seconds.

Note

Examples

The total RAM required to hold the history and statistics tables is allocated at this time. This is to
prevent router memory problems when the router gets heavily loaded and to lower the amount of
overhead the feature causes on a router when it is active.

In the following example, operation 25 begins actively collecting data at 3:00 p.m. on April 5. This
operation will age out after 12 hours of inactivity, which can be before it starts or after it has finished
with its life. When this operation ages out, all configuration information for the operation is removed
(that is, the configuration information is no longer in the running-config in RAM).
Router(config)# rtr schedule 25 life 43200 start-time 15:00 apr 5 ageout 43200

In the following example, operation 1 begins collecting data after a 5 minute delay:
Router(config)# rtr schedule 1 start after 00:05:00

In the following example, operation 3 begins collecting data immediately and is scheduled to run
indefinitely:
Router(config)# rtr schedule 3 start-time now life forever

Cisco IOS Configuration Fundamentals Command Reference

FR-840

78-11740-02

Cisco Service Assurance Agent Commands

rtr schedule

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

rtr reaction-configuration Configures certain actions to occur based on events under the control of
the SAA.
rtr reaction-trigger

Defines a second SAA operation to make the transition from a pending

state to an active state when one of the trigger action-type options is
defined with the rtr reaction-configuration global configuration
command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-841

Cisco Service Assurance Agent Commands

samples-of-history-kept

samples-of-history-kept
To set the number of entries kept in the history table per bucket for the SAA operation, use the
samples-of-history-kept SAA RTR configuration command. To return to the default value, use the no
form of this command.
samples-of-history-kept samples
no samples-of-history-kept

Syntax Description

samples

Defaults

16 entries for type pathEcho

Number of entries kept in the history table per bucket. The default is
16 entries for type pathEcho and 1 entry for type echo.

1 entry for type echo

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Use the samples-of-history-kept command to control how many entries are saved in the history table.
To control the type of information that gets saved in the history table, use the filter-for-history
command. To set how many buckets get created in the history table, use the buckets-of-history-kept
command.
An operation can collect history and capture statistics. By default, history is not collected. When a
problem arises where history is useful (for example, a large number of timeouts are occurring), you can
configure the lives-of-history-kept SAA RTR configuration command to collect history.

Note

Examples

Collecting history increases the usage of RAM. Only collect history when you think there is a
problem. For general network response time information, use statistics.

In the following example, ten entries are kept in the history table for each of the lives of operation 3:
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

1
type pathecho protocol ipIcmpEcho 172.16.1.176
lives-of-history-kept 3
samples-of-history-kept 10

Cisco IOS Configuration Fundamentals Command Reference

FR-842

78-11740-02

Cisco Service Assurance Agent Commands

samples-of-history-kept

Related Commands

Command

Description

buckets-of-history-kept Sets the number of history buckets that are kept during the lifetime of the
SAA.
filter-for-history

Defines the type of information kept in the history table for the SAA
operation.

lives-of-history-kept

Sets the number of lives maintained in the history table for the SAA
operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-843

Cisco Service Assurance Agent Commands

show rtr application

show rtr application

To display global information about the SAA feature, use the show rtr application EXEC command.
show rtr application [tabular | full]

Syntax Description

tabular

(Optional) Displays information in a column format reducing the number of

screens required to display the information.

full

(Optional) Displays all information using identifiers next to each displayed

value. This is the default.

Defaults

Full format

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Use the show rtr application command to display information such as supported operation types and
supported protocols.

Examples

The following is sample output from the show rtr application command in full format:
router#show rtr application
Response Time Reporter
Version: 2.2.0 Round Trip Time MIB
Max Packet Data Size (ARR and Data): 16384
Time of Last Change in Whole RTR: 03:34:44.000 UTC Sun Feb 11 2001
System Max Number of Entries: 500
Number of Entries configured:5
Number of active Entries:5
Number of pending Entries:0
Number of inactive Entries:0
Supported Operation Types
Type of Operation to Perform: echo
Type of Operation to Perform: pathEcho
Type of Operation to Perform: udpEcho
Type of Operation to Perform: tcpConnect
Type of Operation to Perform: http
Type of Operation to Perform: dns
Type of Operation to Perform: jitter
Type of Operation to Perform: dlsw
Type of Operation to Perform: dhcp
Type of Operation to Perform: ftp

Cisco IOS Configuration Fundamentals Command Reference

FR-844

78-11740-02

Cisco Service Assurance Agent Commands

show rtr application

Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol
Protocol

Supported Protocols
Type: ipIcmpEcho
Type: ipUdpEchoAppl
Type: snaRUEcho
Type: snaLU0EchoAppl
Type: snaLU2EchoAppl
Type: ipTcpConn
Type: httpAppl
Type: dnsAppl
Type: jitterAppl
Type: dlsw
Type: dhcp
Type: ftpAppl

Number of configurable probe is 490

Related Commands

Command

Description

show rtr configuration

Displays configuration values including all defaults for all SAA operations
or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-845

Cisco Service Assurance Agent Commands

show rtr authentication

show rtr authentication

To display SAA RTR authentication information, use the show rtr authentication EXEC command.
show rtr authentication

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

Use the show rtr authentication command to display information such as supported operation types and
supported protocols.

Examples

The following is sample output from the show rtr application command:
Router# show rtr authentication
RTR control message uses MD5 authentication, key chain name is: rtr

Related Commands

Command

Description

show rtr configuration

Displays configuration values for RTR operations (probes).

Cisco IOS Configuration Fundamentals Command Reference

FR-846

78-11740-02

Cisco Service Assurance Agent Commands

show rtr collection-statistics

show rtr collection-statistics

Note

Effective with Cisco IOS Release 12.3(14)T, the show rtr collection-statistics command is replaced by
the show ip sla monitor collection-statistics command. See the show ip sla monitor
collection-statistics command for more information.
To display statistical errors for all Cisco IOS IP Service Level Agreements (IP SLAs) operations or a
specified operation, use the show rtr collection-statistics command in EXEC mode.
show rtr collection-statistics [operation-number]

Syntax Description

operation-number

Defaults

Shows statistics for the past two hours.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

12.0(5)T

The output for this command was expanded to show information for Jitter
operations.

Usage Guidelines

(Optional) Number of the IP SLAs operation to display.

12.1

The tabular and full keywords were removed.

12.1(1)T

The output for this command was expanded to show information for the FTP
operation type and for One Way Delay Jitter operations.

12.2(8)T, 12.2(8)S

Output for NumOfJitterSamples was added (CSCdv30022).

12.2(11)T

The SAA Engine II was implemented. The maximum number of operations

was increased from 500 to 2000.

12.3(4)T

Output (MOS and ICPIF scores) for the Jitter (codec) operation type was
added.

12.3(7)T

Decimal granularity for MOS scores was added.

12.3(14)T

This command was replaced by the show ip sla monitor collection-statistics

command.

Use the show rtr collection-statistics command to display information such as the number of failed
operations and the failure reason. You can also use the show rtr distribution-statistics and
show rtr totals-statistics commands to display additional statistical information.
This command shows information collected over the past two hours, unless you specify a different
amount of time using the hours-of-statistics-kept command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-847

Cisco Service Assurance Agent Commands

show rtr collection-statistics

For One Way Delay Jitter operations, the clocks on each device must be synchronized using NTP (or
GPS systems). If the clocks are not synchronized, one way measurements are discarded. (If the sum of
the source to destination (SD) and the destination to source (DS) values is not within 10 percent of the
round trip time, the one way measurement values are assumed to be faulty, and are discarded.)

Note

Examples

This command does not support the IP SLAs ICMP path jitter operation.

The following shows sample output from the show rtr collection-statistics command in full format.
Router# show rtr collection-statistics 1
Collected Statistics
Entry Number: 1
Start Time Index: *17:15:41.000
Path Index: 1
Hop in Path Index: 1
Number of Failed Operations due
Number of Failed Operations due
Number of Failed Operations due
Number of Failed Operations due
Number of Failed Operations due
Number of Failed Operations due
Number of Failed Operations due
Target Address: 172.16.1.176

UTC Thu May 16 1996

to
to
to
to
to
to
to

a Disconnect: 0
a Timeout: 0
a Busy: 0
a No Connection: 0
an Internal Error: 0
a Sequence Error: 0
a Verify Error: 0

Output for HTTP Operations

The following example shows output from the show rtr collection-statistics command when the specified
operation is an HTTP operation:
Router# show rtr collection-statistics 2
Collected Statistics
Entry Number:2
HTTP URL:http://172.20.150.200
Start Time:*00:01:16.000 UTC Mon Nov 1 2003
Comps:1
OvrTh:0
DNSTimeOut:0
TCPTimeOut:0
TraTimeOut:0
DNSError:0
HTTPError:0
IntError:0
Busies:0

RTTMin:343
RTTMax:343
RTTSum:343
RTTSum2:117649
DNSRTT:0
TCPConRTT:13
TransRTT:330
MesgSize:1771

Output for Jitter Operations

The following is sample output from the show rtr collection-statistics command, where operation 2 is
a Jitter operation that includes One Way statistcis:
Router# show rtr collection-statistics
Collected Statistics
Entry Number: 2

Cisco IOS Configuration Fundamentals Command Reference

FR-848

78-11740-02

Cisco Service Assurance Agent Commands

show rtr collection-statistics

Target Address: 5.0.0.1, Port Number:99

Start Time: 11:12:03.000 UTC Thu Jul 1 1999
RTT Values:
NumOfRTT: 600 RTTSum: 3789 RTTSum2: 138665
Packet Loss Values:
PacketLossSD: 0 PacketLossDS: 0
PacketOutOfSequence: 0 PacketMIA: 0 PacketLateArrival: 0
InternalError: 0 Busies: 0
Jitter Values:
MinOfPositivesSD: 1
MaxOfPositivesSD: 2
NumOfPositivesSD: 26 SumOfPositivesSD: 31
Sum2PositivesSD:
MinOfNegativesSD: 1
MaxOfNegativesSD: 4
NumOfNegativesSD: 56 SumOfNegativesSD: 73
Sum2NegativesSD:
MinOfPositivesDS: 1
MaxOfPositivesDS: 338
NumOfPositivesDS: 58 SumOfPositivesDS: 409 Sum2PositivesDS:
MinOfNegativesDS: 1
MaxOfNegativesDS: 338
NumOfNegativesDS: 48 SumOfNegativesDS: 396 Sum2NegativesDS:
One Way Values:
NumOfOW: 440
OWMinSD: 2 OWMaxSD: 6
OWSumSD: 1273 OWSum2SD: 4021
OWMinDS: 2 OWMaxDS: 341 OWSumDS: 1643 OWSum2DS: 120295

41
133
114347
114332

The values shown indicate the aggregated values for the current hour. RTT stands for Round-Trip-Time.
SD stands for Source-to-Destination. DS stands for Destination-to-Source. OW stands for One Way.
Table 128 describes the significant fields shown in this output.
Output for Jitter (codec) Operations

The following is sample output from the show rtr collection-statistics command, where operation 10 is
a Jitter (codec) operation:
Router# show rtr collection-statistics 10
Entry number: 10
Start Time Index: 13:18:49.904 PST Mon Jun 24 2002
Number of successful operations: 2
Number of operations over threshold: 0
Number of failed operations due to a Disconnect: 0
Number of failed operations due to a Timeout: 0
Number of failed operations due to a Busy: 0
Number of failed operations due to a No Connection: 0
Number of failed operations due to an Internal Error: 0
Number of failed operations due to a Sequence Error: 0
Number of failed operations due to a Verify Error: 0
Voice Scores:
MinOfICPIF: 0
MaxOfICPIF: 0
MinOfMOS: 0
MaxOfMOS: 0
RTT Values:
NumOfRTT: 122
RTTAvg: 2
RTTMin: 2
RTTMax: 3
RTTSum: 247
RTTSum2: 503
Packet Loss Values:
PacketLossSD: 0 PacketLossDS: 0
PacketOutOfSequence: 0 PacketMIA: 0
PacketLateArrival: 0
InternalError: 0
Busies: 0
PacketSkipped: 78 <<<<<===========
Jitter Values:
MinOfPositivesSD: 1
MaxOfPositivesSD: 1
NumOfPositivesSD: 9
SumOfPositivesSD: 9
Sum2PositivesSD: 9
MinOfNegativesSD: 1
MaxOfNegativesSD: 1
NumOfNegativesSD: 8
SumOfNegativesSD: 8
Sum2NegativesSD: 8
MinOfPositivesDS: 1
MaxOfPositivesDS: 1
NumOfPositivesDS: 6
SumOfPositivesDS: 6
Sum2PositivesDS: 6
MinOfNegativesDS: 1
MaxOfNegativesDS: 1
NumOfNegativesDS: 7
SumOfNegativesDS: 7
Sum2NegativesDS: 7
Interarrival jitterout: 0
Interarrival jitterin: 0
One Way Values:

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-849

Cisco Service Assurance Agent Commands

show rtr collection-statistics

NumOfOW: 0
OWMinSD: 0
OWMinDS: 0

Table 128

OWMaxSD: 0
OWMaxDS: 0

OWSumSD: 0
OWSumDS: 0

OWSum2SD: 0
OWSum2DS: 0

show rtr collection-statistics Field Descriptions

Field

Description

Voice Scores:

Indicates that Voice over IP statistics appear on the following lines.

Voice score data is computed when the operation type is configured
as type jitter (codec).

ICPIF

The Calculated Planning Impairment Factor (ICPIF) value for the

operation. The ICPIF value is computed by IP SLAs using the
formula Icpif = Io + Iq + Idte + Idd + Ie A, where

the values for Io, Iq, and Idte are set to zero,

the value Idd is computed based on the measured one way delay,

the value Ie is computed based on the measured packet loss,

and the value of A is specified by the user.

ICPIF values are expressed in a typical range of 5 (very low

impairment) to 55 (very high impairment). ICPIF values numerically
less than 20 are generally considered adequate.
Note

This value is intended only for relative comparisons, and

may not match ICPIF values generated using alternate
methods.

MinOfICPIF:

The lowest (minimum) ICPIF value computed for the collected

statistics.

MaxOfICPIF:

The highest (maximum) ICPIF value computed for the collected

statistics.

Mos

The estimated Mean Opinion Score (Conversational Quality,

Estimated) for the latest iteration of the operation. The MOS-CQE is
computed by IP SLAs as a function of the ICPIF.
MOS values are expressed as a number from 1 (1.00) to 5 (5.00), with
5 being the highest level of quality, and 1 being the lowest level of
quality. A MOS value of 0 (zero) indicates that MOS data could not
be generated for the operation.

MinOfMos:

The lowest (minimum) MOS value computed for the collected

statistics.

MaxOfMos:

The highest (maximum) ICPIF value computed for the collected

statistics.

RTT Values:

Indicates that Round-Trip-Time statistics appear on the following

lines.

NumOfRTT

The number of successful round trips.

RTTSum

The sum of all successful round trip values (in milliseconds).

RTTSum2

The sum of squares of those round trip values (in milliseconds).

PacketLossSD

The number of packets lost from source to destination.

Cisco IOS Configuration Fundamentals Command Reference

FR-850

78-11740-02

Cisco Service Assurance Agent Commands

show rtr collection-statistics

Table 128

show rtr collection-statistics Field Descriptions (continued)

Field

Description

PacketLossDS

The number of packets lost from destination to source.

PacketOutOfSequence

The number of packets returned out of order.

PacketMIA

The number of packets lost where the direction (SD/DS) cannot be

determined.

PacketLateArrival

The number of packets that arrived after the timeout.

PacketSkipped

The number of packets that are not sent during the IP SLAs jitter
operation.

InternalError

The number of times an operation could not be started due to other

internal failures.

Busies

The number of times this operation could not be started because the
previously scheduled run was not finished.

Jitter Values:

Indicates that Jitter statistics appear on the following lines.

Jitter is inter-packet delay variance.

NumOfJitterSamples:

The number of jitter samples collected. This is the number of

samples that are used to calculate the following jitter statitstics.

MinOfPositivesSD
MaxOfPositivesSD

The minimum and maximum positive jitter values from source to

destination, in milliseconds.

NumOfPositivesSD

The number of jitter values from source to destination that are

positive (i.e., network latency increases for two consecutive test
packets).

SumOfPositivesSD

The sum of those positive values (in milliseconds).

Sum2PositivesSD

The sum of squares of those positive values.

MinOfNegativesSD
MaxOfNegativesSD

The minimum and maximum negative jitter values from source to

destination. The absolute value is given.

NumOfNegativesSD

The number of jitter values from source to destination that are

negative (i.e., network latency decreases for two consecutive test
packets).

SumOfNegativesSD

The sum of those values.

Sum2NegativesSD

The sum of the squares of those values.

Interarrival jitterout:

The source to destination(SD) jitter value calculation, as defined in

RFC 1889.

Interarrival jitterin:

The destination to souce (DS) jitter value calculation, as defined in

RFC 1889.

One Way Values

Indicates that one way measurement statistics appear on the

following lines.
One Way (OW) Values are the amount of time it took the packet to
travel from the source router to the target router (SD) or from the
target router to the source router (DS).

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-851

Cisco Service Assurance Agent Commands

show rtr collection-statistics

Table 128

show rtr collection-statistics Field Descriptions (continued)

Field

Description

NumOfOW

Number of successful one way time measurements.

OWMinSD

Minimum time from the source to the destination.

OWMaxSD

Maximum time from the source to the destination.

OWSumSD

Sum of the OWMinSD and OWMaxSD values.

OWSum2SD

Sum of the squares of the OWMinSD and OWMaxSD values.

The DS values show the same information as above for Destination-to-Source Jitter values.

Related Commands

Command

Description

show ntp status

Displays the status of the Network Time Protocol configuration

on your system.

show rtr configuration

Displays configuration values including all defaults for all IP

SLAs operations or the specified operation.

show rtr distributions-statistics

Displays statistic distribution information (captured response

times) for all IP SLAs operations or the specified operation.

show rtr totals-statistics

Displays the total statistical values (accumulation of error counts

and completions) for all IP SLAs operations or the specified
operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-852

78-11740-02

Cisco Service Assurance Agent Commands

show rtr configuration

show rtr configuration

To display configuration values including all defaults for all SAA operations or the specified operation,
use the show rtr configuration EXEC command.
show rtr configuration [operation] [tabular | full]

Syntax Description

operation

(Optional) Number of the SAA operation to display.

tabular

(Optional) Display information in a column format reducing the number of

screens required to display the information.

full

(Optional) Display all information using identifiers next to each displayed

value. This is the default.

Defaults

Full format for all operations

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Examples

The following is sample output from the show rtr configuration command in full format:
Router# show rtr configuration 1
Complete Configuration Table (includes defaults)
Entry Number: 1
Owner: Sample Owner
Tag: Sample Tag Group
Type of Operation to Perform: echo
Reaction and History Threshold (milliseconds): 5000
Operation Frequency (seconds): 60
Operation Timeout (milliseconds): 5000
Verify Data: FALSE
Status of Entry (SNMP RowStatus): active
Protocol Type: ipIcmpEcho
Target Address: 172.16.1.176
Request Size (ARR data portion): 1
Response Size (ARR data portion): 1
Life (seconds): 3600
Next Start Time: Start Time already passed
Entry Ageout (seconds): 3600
Connection Loss Reaction Enabled: FALSE
Timeout Reaction Enabled: FALSE
Threshold Reaction Type: never
Threshold Falling (milliseconds): 3000
Threshold Count: 5
Threshold Count2: 5
Reaction Type: none
Number of Statistic Hours kept: 2

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-853

Cisco Service Assurance Agent Commands

show rtr configuration

Number of Statistic Paths kept: 1

Number of Statistic Hops kept: 1
Number of Statistic Distribution Buckets kept: 1
Number of Statistic Distribution Intervals (milliseconds): 20
Number of History Lives kept: 0
Number of History Buckets kept: 50
Number of History Samples kept: 1
History Filter Type: none

The following example verifies the configuration of an HTTP operation:

router# show rtr configuration
Complete Configuration Table (includes defaults)
Entry Number:3
Owner:Joe
Tag:AppleTree
Type of Operation to Perform:http
Reaction and History Threshold (milliseconds):5000
Operation Frequency (seconds):60
Operation Timeout (milliseconds):5000
Verify Data:FALSE
Status of Entry (SNMP RowStatus):active
Protocol Type:httpAppl
Target Address:
Source Address:0.0.0.0
Target Port:0
Source Port:0
Request Size (ARR data portion):1
Response Size (ARR data portion):1
Control Packets:enabled
Loose Source Routing:disabled
LSR Path:
Type of Service Parameters:0x0
HTTP Operation:get
HTTP Server Version:1.0
URL:http://www.cisco.com
Cache Control:enabled
Life (seconds):3600
Next Scheduled Start Time:Start Time already passed
Entry Ageout:never
Connection Loss Reaction Enabled:FALSE
Timeout Reaction Enabled:FALSE
Threshold Reaction Type:never
Threshold Falling (milliseconds):3000
Threshold Count:5
Threshold Count2:5
Reaction Type:none
Number of Statistic Hours kept:2
Number of Statistic Paths kept:1
Number of Statistic Hops kept:1
Number of Statistic Distribution Buckets kept:1
Statistic Distribution Interval (milliseconds):20
Number of History Lives kept:0
Number of History Buckets kept:15
Number of History Samples kept:1
History Filter Type:none

Related Commands

Cisco IOS Configuration Fundamentals Command Reference

FR-854

78-11740-02

Cisco Service Assurance Agent Commands

show rtr configuration

Command

Description

show rtr application

Displays global information about the SAA feature.

show rtr collection-statistics

Displays statistical errors for all SAA operations or the specified

operation.

show rtr distributions-statistics

Displays statistic distribution information (captured response

times) for all SAA operations or the specified operation.

show rtr history

Displays history collected for all SAA operations or the specified

operation.

show rtr operational-state

Displays the operational state of all SAA operations or the

specified operation.

show rtr reaction-trigger

Displays the reaction trigger information for all SAA operations

or the specified operation.

show rtr totals-statistics

Displays the total statistical values (accumulation of error counts

and completions) for all SAA operations or the specified
operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-855

Cisco Service Assurance Agent Commands

show rtr distributions-statistics

show rtr distributions-statistics

To display statistic distribution information (captured response times) for all SAA operations or the
specified operation, use the show rtr distributions-statistics EXEC command.
show rtr distributions-statistics [operation] [tabular | full]

Syntax Description

operation

(Optional) Number of the SAA operation to display.

tabular

(Optional) Displays information in a column format reducing the number of

screens required to display the information. This is the default.

full

(Optional) Displays all information using identifiers next to each displayed

value.

Defaults

Tabular format for all operations

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The distributions statistics consist of the following:

The sum of completion times (used to calculate the mean)

The sum of the completions times squared (used to calculate standard deviation)

The maximum and minimum completion time

The number of completed attempts

You can also use the show rtr collection-statistics and show rtr totals-statistics commands to display
additional statistical information.

Examples

The following is sample output from the show rtr distributions-statistics command in tabular format:
Router# show rtr distributions-statistics
Captured Statistics
Multiple Lines per Entry
Line 1
Entry
StartT
Pth
Hop
Dst
Comps
OvrTh
SumCmp

=
=
=
=
=
=
=
=

Entry Number
Start Time of Entry (hundredths of seconds)
Path Index
Hop in Path Index
Time Distribution Index
Operations Completed
Operations Completed Over Thresholds
Sum of Completion Times (milliseconds)

Cisco IOS Configuration Fundamentals Command Reference

FR-856

78-11740-02

Cisco Service Assurance Agent Commands

show rtr distributions-statistics

Line 2
SumCmp2L = Sum of Completion Times
SumCmp2H = Sum of Completion Times
TMax
= Completion Time Maximum
TMin
= Completion Time Minimum
Entry StartT
Pth Hop Dst Comps
SumCmp2L
SumCmp2H
TMax
1
17417068
1
1
1
2
8192
0
64

Related Commands

Command

Squared Low 32 Bits (milliseconds)

Squared High 32 Bits (milliseconds)
(milliseconds)
(milliseconds)
OvrTh
SumCmp
TMin
0
128
64

Description

show rtr collection-statistics Displays statistical errors for all SAA operations or the specified
operation.
show rtr configuration

Displays configuration values including all defaults for all SAA

operations or the specified operation.

show rtr totals-statistics

Displays the total statistical values (accumulation of error counts and

completions) for all SAA operations or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-857

Cisco Service Assurance Agent Commands

show rtr history

show rtr history

To display history collected for all SAA operations or for a specified operation, use the show rtr history
EXEC command.
show rtr history [operation-number] [tabular | full]

Syntax Description

operation-number

(Optional) Displays history for only the specified operation.

tabular

(Optional) Displays information in a column format reducing the number of

screens required to display the information. This is the default.

full

(Optional) Displays all information using identifiers next to each displayed

value.

Defaults

Tabular format, history for all operations is displayed

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Table 129 lists the Response Return values used in the output of the show rtr history command. If the
default (tabular) format is used, the Response Return description is displayed as a code in the Sense
column. If the full format is used, the Response Return is displayed as indicated in the Description
column.
Table 129

Response Return (Sense Column) Codes

Code

Description

Okay.

Disconnected.

Over threshold.

Timeout.

Busy.

Not connected.

Dropped.

Sequence error.

Verify error.

10

Application
specific.

Cisco IOS Configuration Fundamentals Command Reference

FR-858

78-11740-02

Cisco Service Assurance Agent Commands

show rtr history

Examples

The following is sample output from the show rtr history command in tabular format:
Router# show rtr history
Point by point History
Multiple Lines per Entry
Line 1
Entry
= Entry Number
LifeI
= Life Index
BucketI = Bucket Index
SampleI = Sample Index
SampleT = Sample Start Time
CompT
= Completion Time (milliseconds)
Sense
= Response Return Code
Line 2 has the Target Address
Entry LifeI
BucketI
SampleI
SampleT
2
1
1
1
17436548
AB 45 A0 16
2
1
2
1
17436551
AC 12 7 29
2
1
2
2
17436551
AC 12 5 22
2
1
2
3
17436552
AB 45 A7 22
2
1
2
4
17436552
AB 45 A0 16

Related Commands

CompT
16

Sense
1

Command

Description

show rtr configuration

Displays configuration values including all defaults for all SAA operations
or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-859

Cisco Service Assurance Agent Commands

show rtr operational-state

show rtr operational-state

Note

Effective with Cisco IOS Release 12.3(14)T, the show rtr operational-state command is replaced by
the show ip sla monitor statistics command. See the show ip sla monitor statistics command for more
information.
To display the operational state of all Cisco IOS IP Service Level Agreements (IP SLAs) operations or
a specified operation, use the show rtr operational-state command in EXEC mode.
show rtr operational-state [operation-number]

Syntax Description

operation-number

Defaults

Displays output for all running IP SLAs operations.

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

12.0(5)T

Output for the Jitter operation type was added.

12.1

The tabular and full keywords were removed.

12.2(8)T

Output for NumOfJitterSamples was added (CSCdv30022).

12.2(8)S

Output for NumOfJitterSamples was added (CSCdv30022).

12.3(4)T

Output (MOS and ICPIF scores) for the Jitter (codec) operation type was added.

12.3(7)T

Decimal granularity for MOS scores was added.

12.3(14)T

This command was replaced by the show ip sla monitor statistics command.

(Optional) ID number of the IP SLAs operation to display.

Usage Guidelines

Use the show rtr operational-state command to display the current state of IP SLAs operations,
including how much life the operation has left, whether the operation is active, and the completion time.
The output will also include the monitoring data returned for the last (most recently completed)
operation.

Examples

The following example shows basic sample output from the show rtr operational-state command:
Router# show rtr operational-state
Current Operational State
Entry Number: 3
Modification Time: *22:15:43.000 UTC Sun Feb 11 2001
Diagnostics Text:
Last Time this Entry was Reset: Never
Number of Octets in use by this Entry: 1332

Cisco IOS Configuration Fundamentals Command Reference

FR-860

78-11740-02

Cisco Service Assurance Agent Commands

show rtr operational-state

Number of Operations Attempted: 2

Current Seconds Left in Life: 3511
Operational State of Entry: active
Latest Completion Time (milliseconds): 544
Latest Operation Start Time: *22:16:43.000 UTC Sun Feb 11 2001
Latest Oper Sense: ok
Latest Sense Description: 200 OK
Total RTT: 544
DNS RTT: 12
TCP Connection RTT: 28
HTTP Transaction RTT: 504
HTTP Message Size: 9707

The following example shows sample output from the show rtr operational-state command when the
specified operation is a Jitter (codec) operation:
Router# show rtr operational-state 1
Entry number: 1
Modification time: 13:18:38.012 PST Mon Jun 24 2002
Number of Octets Used by this Entry: 10392
Number of operations attempted: 2
Number of operations skipped: 0
Current seconds left in Life: Forever
Operational state of entry: Active
Last time this entry was reset: Never
Connection loss occurred: FALSE
Timeout occurred: FALSE
Over thresholds occurred: FALSE
Latest RTT (milliseconds): 2
Latest operation start time: *13:18:42.896 PST Mon Jun 24 2002
Latest operation return code: OK
Voice Scores:
ICPIF Value: 0 MOS score: 0
RTT Values:
NumOfRTT: 61
RTTAvg: 2
RTTMin: 2
RTTMax: 3
RTTSum: 123
RTTSum2: 249
Packet Loss Values:
PacketLossSD: 0 PacketLossDS: 0
PacketOutOfSequence: 0 PacketMIA: 0
PacketLateArrival: 0
InternalError: 0
Busies: 0
PacketSkipped: 39
<<<<<<==========
Jitter Values:
MinOfPositivesSD: 1
MaxOfPositivesSD: 1
NumOfPositivesSD: 1
SumOfPositivesSD: 1
Sum2PositivesSD: 1
MinOfNegativesSD: 1
MaxOfNegativesSD: 1
NumOfNegativesSD: 1
SumOfNegativesSD: 1
Sum2NegativesSD: 1
MinOfPositivesDS: 0
MaxOfPositivesDS: 0
NumOfPositivesDS: 0
SumOfPositivesDS: 0
Sum2PositivesDS: 0
MinOfNegativesDS: 0
MaxOfNegativesDS: 0
NumOfNegativesDS: 0
SumOfNegativesDS: 0
Sum2NegativesDS: 0
Interarrival jitterout: 0
Interarrival jitterin: 0
One Way Values:
NumOfOW: 0
OWMinSD: 0
OWMaxSD: 0
OWSumSD: 0
OWSum2SD: 0
OWMinDS: 0
OWMaxDS: 0
OWSumDS: 0
OWSum2DS: 0

The values shown indicate the values for the last IP SLAs operation. RTT stands for Round-Trip-Time.
SD stands for Source-to-Destination. DS stands for Destination-to-Source. OW stands for One Way. The
* symbol in front of the time stamps indicates the time is synchronized using NTP or SNTP. Table 130
describes the significant fields shown in this output.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-861

Cisco Service Assurance Agent Commands

show rtr operational-state

Table 130

show rtr operational-state Field Descriptions

Field

Description

Voice Scores:

Indicates that Voice over IP statistics appear on the following lines.

Voice score data is computed when the operation type is configured
as type jitter (codec).

ICPIF:

The Calculated Planning Impairment Factor (ICPIF) value for the

latest iteration of the operation. The ICPIF value is computed by IP
SLAs using the formula Icpif = Io + Iq + Idte + Idd + Ie A, where

the values for Io, Iq, and Idte are set to zero,

the value Idd is computed based on the measured one way

delay,

the value Ie is computed based on the measured packet loss,

and the value of A is specified by the user.

ICPIF values are expressed in a typical range of 5 (very low

impairment) to 55 (very high impairment). ICPIF values
numerically less than 20 are generally considered adequate.
Note

MOS:

This value is intended only for relative comparisons, and

may not match ICPIF values generated using alternate
methods.

The estimated Mean Opinion Score (Conversational Quality,

Estimated) for the latest iteration of the operation. The MOS-CQE
is computed by IP SLAs as a function of the ICPIF.
MOS values are expressed as a number from 1 (1.00) to 5 (5.00),
with 5 being the highest level of quality, and 1 being the lowest level
of quality. A MOS value of 0 (zero) indicates that MOS data could
not be generated for the operation.

RTT Values:

Indicates that Round-Trip-Time statistics appear on the following

lines.

NumOfRTT

The number of successful round trips.

RTTSum

The sum of those round trip values (in milliseconds).

RTTSum2

The sum of squares of those round trip values (in milliseconds).

Packet Loss Values:

Indicates that Packet Loss statistics appear on the following lines.

PacketLossSD

The number of packets lost from source to destination.

PacketLossDS

The number of packets lost from destination to source.

PacketOutOfSequence

The number of packets returned out of order.

PacketMIA

The number of packets lost where the direction (SD or DS) cannot
be determined (MIA: missing in action).

PacketLateArrival

The number of packets that arrived after the timeout.

PacketSkipped

The number of packets that are not sent during the IP SLAs jitter
operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-862

78-11740-02

Cisco Service Assurance Agent Commands

show rtr operational-state

Table 130

show rtr operational-state Field Descriptions (continued)

Field

Description

InternalError

The number of times an operation could not be started due to other

internal failures.

Busies

The number of times this operation could not be started because the
previously scheduled run was not finished.

Jitter Values:

Indicates that jitter operation statistics appear on the following

lines.
Jitter is inter-packet delay variance.

NumOfJitterSamples:

The number of jitter samples collected. This is the number of

samples that are used to calculate the following jitter statitstics.

MinOfPositivesSD
MaxOfPositivesSD

The minimum and maximum positive jitter values from source to

destination, in milliseconds.

NumOfPositivesSD

The number of jitter values from source to destination that are

positive (i.e., network latency increases for two consecutive test
packets).

SumOfPositivesSD

The sum of those positive values (in milliseconds).

Sum2PositivesSD

The sum of squares of those positive values.

MinOfNegativesSD
MaxOfNegativesSD

The minimum and maximum negative jitter values from source to

destination. The absolute value is given.

NumOfNegativesSD

The number of jitter values from source to destination that are

negative (i.e., network latency decreases for two consecutive test
packets).

SumOfNegativesSD

The sum of those values.

Sum2NegativesSD

The sum of the squares of those values.

Interarrival jitterout:

The source to destination(SD) jitter value calculation, as defined in

RFC 1889.

Interarrival jitterin:

The destination to souce (DS) jitter value calculation, as defined in

RFC 1889.

One Way Values

Indicates that One Way measurement statistics appear on the

following lines.
One Way (OW) Values are the amount of time it took the packet to
travel from the source router to the target router (SD) or from the
target router to the source router (DS).

NumOfOW

Number of successful one way time measurements.

OWMinSD

Minimum time from the source to the destination.

OWMaxSD

Maximum time from the source to the destination.

OWSumSD

Sum of the OWMinSD and OWMaxSD values.

OWSum2SD

Sum of the squares of the OWMinSD and OWMaxSD values.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-863

Cisco Service Assurance Agent Commands

show rtr operational-state

Related Commands

Command

Description

show rtr configuration

Displays configuration values including all defaults for all IP SLAs

operations or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-864

78-11740-02

Cisco Service Assurance Agent Commands

show rtr reaction-trigger

show rtr reaction-trigger

To display the reaction trigger information for all SAA operations or the specified operation, use the
show rtr reaction-trigger EXEC command.
show rtr reaction-trigger [operation-number] [tabular | full]

Syntax Description

operation-number

(Optional) Number of the SAA operation to display.

tabular

(Optional) Display information in a column format reducing the number of

screens required to display the information.

full

(Optional) Display all information using identifiers next to each displayed

value. This is the default.

Defaults

Full format for all operations

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Use the show rtr reaction-trigger command to display the configuration status and operational state of
target operations that will be triggered as defined with the rtr reaction-configuration global command.

Examples

The following is sample output from the show rtr reaction-trigger command in full format:
Router# show rtr reaction-trigger 1
Reaction Table
Entry Number: 1
Target Entry Number: 2
Status of Entry (SNMP RowStatus): active
Operational State: pending

Related Commands

Command

Description

show rtr configuration

Displays configuration values including all defaults for all SAA operations
or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-865

Cisco Service Assurance Agent Commands

show rtr responder

show rtr responder

To display SAA RTR Responder information, use the show rtr responder EXEC command.
show rtr responder

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

Use the show rtr responder command to display information about recent sources of SAA control
messages, such as who has sent recent control messages and who has sent invalid control messages.

Examples

The following is sample output from the show rtr responder command:
Router# show rtr responder
RTR Responder is: Enabled
Number of control message received: 19 Number
Recent sources:
4.0.0.1 [19:11:49.035 UTC Sat Dec
4.0.0.1 [19:10:49.023 UTC Sat Dec
4.0.0.1 [19:09:48.707 UTC Sat Dec
4.0.0.1 [19:08:48.687 UTC Sat Dec
4.0.0.1 [19:07:48.671 UTC Sat Dec

of errors: 1
2
2
2
2
2

1995]
1995]
1995]
1995]
1995]

Recent error sources:

4.0.0.1 [19:10:49.023 UTC Sat Dec 2 1995] RTT_AUTH_FAIL

Related Commands

Command

Description

show rtr configuration

Displays configuration values for SAA operations.

Cisco IOS Configuration Fundamentals Command Reference

FR-866

78-11740-02

Cisco Service Assurance Agent Commands

show rtr totals-statistics

show rtr totals-statistics

To display the total statistical values (accumulation of error counts and completions) for all SAA
operations or the specified operation, use the show rtr totals-statistics EXEC command.
show rtr totals-statistics [number] [tabular | full]

Syntax Description

number

(Optional) Number of the SAA operation to display.

tabular

(Optional) Display information in a column format reducing the number of

screens required to display the information.

full

(Optional) Display all information using identifiers next to each displayed

value. This is the default.

Defaults

Full format for all operations

Command Modes

EXEC

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

The total statistics consist of the following items:

The operation number

The start time of the current hour of statistics

The age of the current hour of statistics

The number of attempted operations

You can also use the show rtr distributions-statistics and show rtr collection-statistics commands to
display additional statistical information.

Examples

The following is sample output from the show rtr totals-statistics command in full format:
Router# show rtr totals-statistics
Statistic Totals
Entry Number: 1
Start Time Index: *17:15:41.000 UTC Thu May 16 1996
Age of Statistics Entry (hundredths of seconds): 48252
Number of Initiations: 10

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-867

Cisco Service Assurance Agent Commands

show rtr totals-statistics

Related Commands

Command

Description

show rtr collection-statistics

Displays statistical errors for all SAA operations or the specified

operation.

show rtr configuration

Displays configuration values including all defaults for all SAA

operations or the specified operation.

show rtr distributions-statistics

Displays statistic distribution information (captured response

times) for all SAA operations or the specified operation.

Cisco IOS Configuration Fundamentals Command Reference

FR-868

78-11740-02

Cisco Service Assurance Agent Commands

statistics-distribution-interval

statistics-distribution-interval
To set the time interval for each statistics distribution kept for the SAA, use the
statistics-distribution-interval SAA RTR configuration command. To return to the default value, use
the no form of this command.
statistics-distribution-interval milliseconds
no statistics-distribution-interval

Syntax Description

milliseconds

Defaults

20 ms

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Number of milliseconds (ms) used for each statistics distribution kept. The
default is 20 ms.

Usage Guidelines

In most situations, you do not need to change the statistical distribution interval or size. Only change the
interval or size when distributions are needed, for example, when performing statistical modeling of your
network. To set the statistical distributions size, use the distributions-of-statistics-kept SAA RTR
configuration command.

Examples

In the following example, the distribution is set to five and the distribution interval is set to 10 ms. This
means that the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain
statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth
distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from
40 ms to infinity.
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

Related Commands

1
type echo protocol ipIcmpEcho 172.28.161.21
distribution-of-statistics-kept 5
statistics-distribution-interval 10

Command

Description

distributions-of-statistics-kept

Sets the number of statistic distributions kept per hop during the
SAA operations lifetime.

hops-of-statistics-kept

Set the number of hops for which statistics are maintained per
path for the SAA operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-869

Cisco Service Assurance Agent Commands

statistics-distribution-interval

Command

Description

hours-of-statistics-kept

Sets the number of hours for which statistics are maintained for
the SAA operation.

paths-of-statistics-kept

Sets the number of paths for which statistics are maintained per
hour for the SAA operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration

mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-870

78-11740-02

Cisco Service Assurance Agent Commands

tag

tag
To create a user-specified identifier for an SAA operation, use the tag SAA RTR configuration
command. To remove a tag from a operation, use the no form of this command.
tag text
no tag

Syntax Description

text

Defaults

No operations are tagged.

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Name of a group that this operation belongs to. From 0 to 16 ASCII

characters.

An operation tag is normally used to logically link operations in a group

Tags can be used to support automation (for example, by using the same tag for two different operations
on two different routers echoing the same target).

Examples

In the following example, operation 1 is tagged with the label bluebell:

Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# tag bluebell

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-871

Cisco Service Assurance Agent Commands

threshold

threshold
To set the rising threshold (hysteresis) that generates a reaction event and stores history information for
the SAA operation, use the threshold SAA RTR configuration command. To return to the default value,
use the no form of this command.
threshold milliseconds
no threshold

Syntax Description

milliseconds

Defaults

5000 ms

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Number of milliseconds required for a rising threshold to be declared. The

default value is 5000 ms.

The value specified for the threshold command must not exceed the value specified for the timeout SAA
RTR configuration command.
The threshold value is used by the rtr reaction-configuration and filter-for-history commands.

Examples

In the following example, the threshold of operation 1 is set to 2500 ms:

Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# threshold 2500

Related Commands

Command

Description

filter-for-history

Defines the type of information kept in the history table for the SAA
operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

rtr reaction-configuration Configures certain actions to occur based on events under the control of
the SAA.

Cisco IOS Configuration Fundamentals Command Reference

FR-872

78-11740-02

Cisco Service Assurance Agent Commands

timeout

timeout
To set the amount of time the SAA operation waits for a response from its request packet, use the timeout
SAA RTR configuration command. To return to the default value, use the no form of this command.
timeout milliseconds
no timeout

Syntax Description

milliseconds

Defaults

The default timeout values vary by operation. Per the RTTMON-MIB, the defaults are:

Number of milliseconds (ms) the operation waits to receive a response

from its request packet.

DLSw+ (type dlsw) and FTP (type ftp) operations - 30000 ms

DNS (type dns) operations - 9 seconds
(as defined by multiplying the MAX_DNS_WAITTIME value by the MAXDNSTRIES value)
TCP Connection (type tcpConnect) and HTTP (type http) operations - 60 seconds
(as defined by multiplying the MAXALIVETRIES value by the MAXSYNTRYTICKS value)

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Use the timeout command to set how long the operation waits to receive a response, and use the
frequency SAA RTR configuration command to set the rate at which the SAA starts an operation.
The value specified for the timeout command cannot be greater than the value specified for the
frequency command.

Examples

In the following example, the timeout for the IP/ICMP Echo operation 1 is set for 2500 ms:
Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# timeout 2500

Related Commands

Command

Description

frequency

Sets the rate at which the SAA operation starts a response time operation.

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-873

Cisco Service Assurance Agent Commands

tos

tos
To define a type of service (ToS) byte in the IP header of SAA operations, use the tos SAA RTR
configuration command. To return to the default value, use the no form of this command.
tos number
no tos

Syntax Description

number

Defaults

The default type-of-service value is 0.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

Service type byte in the IP header. The range is 0 to 255. The default is 0.

The type-of-service (ToS) value is an 8-bit field in IP headers. This field contains information such as
precedence and TOS. This is useful for policy-routing as well as features like CAR (Committed Access Rate),
where routers examine for TOS values.
When the type-of-service is defined for an operation, the SAA Responder will reflect the ToS value it
recieves.

Examples

In the following example, SAA operation 1 is configured as an echo probe using the IP/ICMP Echo
protocol and the destination IP address 172.16.1.175. The ToS value is set to 0x80.
Router(config)# rtr 1
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176
Router(config-rtr)# tos 0x80

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

FR-874

78-11740-02

Cisco Service Assurance Agent Commands

type dhcp

type dhcp
To configure a Dynamic Host Configuration Protocol SAA operation, use the type dhcp SAA RTR
configuration command. To disable a DHCP SAA operation, use the no form of this command.
type dhcp [source-ipaddr source-ipaddr] [dest-ipaddr dest-ipaddr] [option decimal-option
[circuit-id circuit-id] [remote-id remote-id] [subnet-mask subnet-mask]]
no type dhcp

Syntax Description

source-ipaddr
source-ipaddr

(Optional) Source name or IP address.

dest-ipaddr
dest-ipaddr

(Optional) Destination name or IP address.

option decimal-option

(Optional) Option number. The only currently valid value is 82. DHCP
option 82 allows you to specify the circuit-id, remote-id, and/or the
subnet-mask for the destination DHCP server.

circuit-id circuit-id

(Optional) Circuit ID in hexadecimal.

remote-id remote-id

(Optional) Remote ID in hexadecimal.

subnet-mask
subnet-mask

(Optional) Subnet mask IP address. The default value is 255.255.255.0.

Defaults

The subnet-mask value is 255.255.255.0.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

12.1(1)T

The following keywords were added:

Usage Guidelines

source-ipaddr

dest-ipaddr

option 82

You must configure the type of operation before you can configure any of the other characteristics of the
operation.
If the source IP address is configured, then packets will be sent with that source address.
You may configure the ip dhcp-server command to identify the DHCP server that the DHCP operation
will measure.
If the target IP address is configured, then only that device will be measured.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-875

Cisco Service Assurance Agent Commands

type dhcp

If the ip dhcp-server command is not configured and the target IP address is not configured, then DHCP
discover packets will be sent on every available IP interface.
Option 82 is called the Relay Agent Information option and is inserted by the DHCP relay agent when
forwarding client-originated DHCP packets to a DHCP server. Servers recognizing the Relay Agent
Information option may use the information to implement IP address or other parameter assignment
policies. The DHCP Server echoes the option back verbatim to the relay agent in server-to-client replies,
and the relay agent strips the option before forwarding the reply to the client.
The Relay Agent Information option is organized as a single DHCP option that contains one or more
suboptions that convey information known by the relay agent. The initial sub-options are defined for a
relay agent that is co-located in a public circuit access unit. These suboptions are as follows: a circuit-id
for the incoming circuit, a remote-id which provides a trusted identifier for the remote high-speed
modem, and a subnet-mask designation for the logical IP subnet from which the relay agent received
the client DHCP packet.
If an odd number of characters are specified for the circuit-id, a zero will be added to the end of the
string.

Examples

In the following example, SAA operation number 4 is configured as a DHCP operation enabled for
DHCP server 172.16.20.3:
Router(config)# rtr 4
Router(config-rtr)# type dhcp option 82 circuit-id 10005A6F1234
Router(config-rtr)# exit
Router(config)# ip dhcp-server 172.16.20.3

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

ip dhcp-server

Specifies which DHCP servers to use on a network, and specifies the IP

address of one or more DHCP servers available on the network.

Cisco IOS Configuration Fundamentals Command Reference

FR-876

78-11740-02

Cisco Service Assurance Agent Commands

type dlsw

type dlsw
To configure a data-link switching (DLSw) SAA operation, use the type dlsw SAA RTR configuration
command. To remove the type configuration for the operation, use the no form of this command.
type dlsw peer-ipaddr ipaddr
no type dlsw peer-ipaddr ipaddr

Syntax Description

peer-ipaddr

Peer destination.

ipaddr

IP address.

Defaults

None.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

In order to configure a DLSw operation, the DLSw feature must be configured on the local and target
routers.
You must configure the type of operation before you can configure any of the other characteristics of the
operation.
The default for the optional characteristic request-data-size for a DLSw SAA operation is 0 bytes.
The default for the optional characteristic timeout for a DLSw SAA operation is 30 seconds.

Examples

In the following example, SAA operation number 4 is configured as a DLSw operation enabled for
remote peer IP address 172.21.27.11. The data size is 15 bytes.
Router(config)# rtr 4
Router(config-rtr)# type dlsw peer-ipaddr 172.21.27.11
Router(config-rtr)# request-data-size 15

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-877

Cisco Service Assurance Agent Commands

type dlsw

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

request-data-size

Sets the protocol data size in the payload of the SAA operations request
packet.

show dlsw peers

Displays DLSw peer information.

Cisco IOS Configuration Fundamentals Command Reference

FR-878

78-11740-02

Cisco Service Assurance Agent Commands

type dns

type dns
To configure a Domain Name System (DNS) SAA operation, use the type dns SAA RTR configuration
command. To remove the type configuration for the operation, use the no form of this command.
type dns target-addr {ip-address | hostname} name-server ip-address
no type dns target-addr {ip-address | hostname} name-server ip-address

Syntax Description

target-addr
{ip-address | hostname}

Target (destination) IP address or hostname.

name-server ip-address

IP address of the Domain Name Server.

Defaults

No default behavior or values.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Usage Guidelines

You must configure the type of operation before you can configure any of the other characteristics of the
operation.

Examples

In the following example, SAA operation 7 is created and configured as a DNS operation using the target
IP address 172.20.2.132:
Router(config)# rtr 7
Router(config-rtr)# type dns target-addr lethe name-server 172.20.2.132

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-879

Cisco Service Assurance Agent Commands

type echo

type echo
To configure an SAA end-to-end echo response time probe operation, use the type echo SAA RTR
configuration command. To remove the operation from the configuration, use the no form of this
command.
type echo protocol protocol-type target [source-ipaddr ip-address]
no type echo protocol protocol-type target [source-ipaddr ip-address]

Syntax Description

protocol protocol-type
target

source-ipaddr ipaddr

Protocol used by the operation. The protocol-type target argument

combination must take one of the following forms:

ipIcmpEcho {ip-address | hostname}IP/ICMP Echo. Requires a

destination IP address or IP host name.

snaRUEcho sna-hostnameSNAs SSCP Native Echo. Requires the

host name defined for the SNAs PU connection to VTAM.

snaLU0EchoAppl sna-hostname [sna-application] [sna-mode]

SNA LU type 0 connection to Ciscos NSPECHO host application that
requires the host name defined for the SNAs PU connection to
VTAM. Optionally, specify the host application name (the default is
NSPECHO) and SNA mode to access the application.

snaLU2EchoAppl sna-hostname [sna-application] [sna-mode]

SNA LU type 2 connection to Ciscos NSPECHO host application that
requires the host name defined for the SNAs PU connection to
VTAM. Optionally, specify the host application name (the default is
NSPECHO) and SNA mode to access the application.

(Optional) Specifies an IP address as the source for the operation.

Defaults

The default SNA host sna-application name for a SNA LU type echo is NSPEcho.
The default data size for a IP/ICMP echo operation is 28 bytes.

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

12.0(5)T

The source-ipaddr ipaddr keyword/argument combination was added to

support the specification of an IP source for the operation.

Usage Guidelines

Support of echo to a protocol and pathEcho to a protocol is dependent on the protocol type and
implementation. In general most protocols support echo and few protocols support pathEcho.

Cisco IOS Configuration Fundamentals Command Reference

FR-880

78-11740-02

Cisco Service Assurance Agent Commands

type echo

Note

Keywords are not case sensitive and are shown in mixed case for readability only.
Prior to sending a operation packet to the responder, the SAA sends a control message to the Responder
to enable the destination port.
The default for the optional characteristic request-data-size for a ipIcmpEcho operation is 28 bytes.
This is the payload portion of the Icmp packet, which makes a 64 byte IP packet.

Examples

In the following example, operation 10 is created and configured as an echo probe using the IP/ICMP
Echo protocol and the destination IP address 172.16.1.175:
Router(config)# rtr 10
Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.175

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

show rtr configuration

Displays configuration values for RTR operations.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-881

Cisco Service Assurance Agent Commands

type ftp

type ftp
To configure an FTP operation, use the type ftp SAA RTR configuration command. To remove the type
configuration for the operation, use the no form of this command.
type ftp operation get url url [source-ipaddr source-ipaddr] [mode {passive | active}]
no type ftp operation get url url [source-ipaddr source-ipaddr] [mode {passive | active}]

Syntax Description

operation get

Specifies an FTP GET operation. (Support for other FTP operation types
may be added in future releases.)

url url

Location information for the file to retrieve.

source-ipaddr
source-ipaddr

(Optional) Source address of the operation.

mode

(Optional) Specifies mode, either active or passive.

passive

FTP passive transfer mode. This mode is the default.

active

FTP active transfer mode.

Defaults

The default FTP transfer mode is passive.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.1(1)T

This command was introduced.

Usage Guidelines

GET is the only valid operation value. The URL must be in one of the following formats:

ftp://user:password@host/filename

ftp://host/filename

If the user and password keywords are not specified, the defaults are anonymous and test, respectively.

Examples

In the following example, an FTP operation is configured. Joe is the user and Young is the password. zxq
is the host and test is the file name.
Router(config)# rtr 3
Router(config-rtr)# type ftp operation get ftp://joe:young@zxq/test

Cisco IOS Configuration Fundamentals Command Reference

FR-882

78-11740-02

Cisco Service Assurance Agent Commands

type ftp

Related Commands

Command

Description

show rtr collection-statistics Displays statistical errors for all SAA operations or the specified
operation.
show rtr operational-state

Displays the operational state of all SAA operations or the specified

operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-883

Cisco Service Assurance Agent Commands

type http

type http
To configure a Hypertext Transfer Protocol (HTTP) SAA operation, use the type http SAA RTR
configuration command. To remove the type configuration for the operation, use the no form of this
command.
type http operation {get | raw} url url [name-server ipaddress] [version version number]
[source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}]
[proxy proxy-url]
no type http operation {get | raw} url url [name-server ipaddress] [version version number]
[source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}]
[proxy proxy-url]

Syntax Description

operation get

Specifies an HTTP GET operation.

operation raw

Specifies an HTTP RAW operation.

url url

Specifies the URL of destination HTTP server.

name-server

(Optional) Specifies name of destination Domain Name Server.

ipaddress

(Optional) IP address of Domain Name Server.

version

(Optional) Specifies version number.

version number

(Optional) Version number.

source-ipaddr

(Optional) Specifies source name or IP address.

name

Source name.

ipaddr

Source IP address.

source-port

(Optional) Specifies source port.

port number

(Optional) Source port number.

cache

(Optional) Enables or disables download of cached HTTP page.

enable

Enables downloads of cached HTTP page.

disable

Disables download of cached HTTP page.

proxy

(Optional) Proxy information.

proxy-url

(Optional) Proxy information or URL.

Defaults

No default behavior or values.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

FR-884

78-11740-02

Cisco Service Assurance Agent Commands

type http

Usage Guidelines

You must configure the type of operation before you can configure any of the other characteristics of the
operation.

Examples

HTTP GET operation

In this example operation 5 is created and configured as an HTTP GET operation. The destination URL
is http://www.cisco.com.
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config)# rtr

5
type http operation get url http://www.cisco.com
exit
schedule 5 start-time now

HTTP RAW operation using RAW submode

In this example operation 6 is created and configured as an HTTP RAW operation. To use the raw request
commands, HTTP-RAW submode is entered using the http-raw-request command. The RTR
HTTP-RAWsubmode is indicated by the (config-rtr-http) router prompt.
Router(config)# rtr 6
Router(config-rtr)# type http operation raw url http://www.cisco.com
Router(config-rtr)# http-raw-request
Router(config-rtr-http)# GET /index.html HTTP/1.0\r\n
Router(config-rtr-http)# \r\n
Router(config-rtr-http)# exit
Router(config)# rtr schedule 6 start-time now

HTTP RAW operation through a Proxy Server

In this example http://www.proxy.cisco.com is the proxy server and http://www.yahoo.com is the

HTTP Server:
Router(config)# rtr 6
Router(config-rtr)# type http operation raw url http://www.proxy.cisco.com
Router(config-rtr)# http-raw-request
Router(config-rtr-http)# GET http://www.example.com HTTP/1.0\r\n
Router(config-rtr-http)# \r\n
Router(config-rtr-http)# exit
Router(config)# rtr schedule 6 start-time now

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-885

Cisco Service Assurance Agent Commands

type jitter

type jitter
To configure a jitter SAA operation, use the type jitter SAA RTR configuration command. To disable a
jitter operation, use the no form of this command.
type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr}]
[source-port port-number] [control {enable | disable}] [num-packets number-of-packets]
[interval inter-packet-interval]
no type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr}] [source-port port-number] [control {enable | disable}] [num-packets
number-of-packets] [interval inter-packet-interval]

Syntax Description

dest-ipaddr

Destination for the operation.

name

Destination IP host name.

ipaddr

Destination IP address.

dest-port

Destination port.

port-number

Port number of the destination port.

source-ipaddr

(Optional) Source IP address.

name

IP host name.

ipaddr

IP address.

source-port

(Optional) Source port.

port-number

Port number of the source.

control

(Optional) Combined with the enable or disable keyword, enables or

disables sending a control message to the destination port.

enable

Enables the SAA to send a control message to the destination port prior
to sending a probe packet. This is the default value.

disable

Disables sending of control messages to the responder prior to sending

a probe packet.

num-packets
number-of-packets

(Optional) Number of packets, as specified by the number argument.

The default value is 10.

interval
inter-packet-interval

(Optional) Interpacket interval in milliseconds. The default value of the

inter-packet-interval argument is 20 ms.

Defaults

The default for the optional characteristic request-data-size for a SAA Jitter operation is 32 bytes of
UDP data.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

FR-886

78-11740-02

Cisco Service Assurance Agent Commands

type jitter

Usage Guidelines

The type jitter command configures a UDP Plus SAA operation. The UDP Plus operation is a superset
of the UDP echo operation. In addition to measuring UDP round trip time, the UDP Plus operation
measures per-direction packet-loss and Jitter. Jitter is inter-packet delay variance. Packet loss is a critical
element in SLAs, and Jitter statistics are useful for analyzing traffic in a VoIP network.
You must enable the SAA Responder on the target router before you can configure a Jitter operation.
Prior to sending a operation packet to the responder, the SAA sends a control message to the SA Agent
Responder to enable the destination port.
You must configure the type of operation before you can configure any of the other characteristics of the
operation.

Examples

In the following example, operation 6 is created and configured as a UDP+ Jitter operation using the
destination IP address 172.30.125.15, the destination port number 2000, 20 packets, and an interval of
20:
Router(config)# rtr 6
Router(config-rtr)# type jitter dest-ip 172.30.125.15 dest-port 2000 num-packets 20
interval 20

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

request-data-size

Sets the payload size for SAA operation requests.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-887

Cisco Service Assurance Agent Commands

type pathEcho

type pathEcho
To configure an IP/ICMP Path Echo SAA operation, use the type pathEcho SAA RTR configuration
command. To remove the operation from the configuration, use the no form of this command.
type pathEcho protocol ipIcmpEcho {ip-address | ip-hostname}
no type pathEcho protocol ipIcmpEcho {ip-address | ip-hostname}

Syntax Description

protocol ipIcmpEcho

Specifies an IP/ICMP Echo operation. This is currently the only

protocol type supported for the SAA Path Echo operation.

ip-address

Specifies the IP address of the target device.

ip-hostname

Specifies the designated IP name of the target device.

Defaults

None

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Keywords are not case sensitive and are shown in mixed case for readability only.

Examples

In the following example, SAA operation 10 is created and configured as pathEcho probe using the
IP/ICMP Echo protocol and the destination IP address 172.16.1.175:
Router(config)# rtr 10
Router(config-rtr)# type pathEcho protocol ipIcmpEcho 172.16.1.175

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

show rtr configuration

Displays configuration values for RTR operations (probes).

Cisco IOS Configuration Fundamentals Command Reference

FR-888

78-11740-02

Cisco Service Assurance Agent Commands

type tcpConnect

type tcpConnect
To define a tcpConnect probe, use the type tcpConnect SAA RTR configuration command. To remove
the type configuration for the probe, use the no form of this command.
type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr} source-port port-number] [control {enable | disable}]
no type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number

Syntax Description

dest-ipaddr name | ipaddr

Destination of tcpConnect probe. name indicates IP host name.

ipaddr indicates IP address.

dest-port port-number

Destination port number.

source-ipaddr name | ipaddr (Optional) Source IP host name or IP address.

source-port port-number

(Optional) Port number of the source. When a port number is not

specified, SAA picks the best IP address (nearest to the target) and
available UDP port.

control

(Optional) Specifies that the SAA control protocol should be used

when running this probe. The control protocol is required when the
probes target is a Cisco router that does not natively provide the
service (TCP service in this case). Combined with the enable or
disable keyword, enables or disables sending a control message to the
destination port. The default is that the control protocol is enabled.
When enabled, the SAA sends a control message to the SAA
Responder (if available) to enable the destination port prior to sending
a probe packet.

enable

Enables the SAA collector to send a control message to the destination

port prior to sending a probe packet.

disable

Disables the SAA from sending a control message to the target prior
to sending a probe packet.

Defaults

The control protocol is enabled.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

You must configure an SAA operation type before you can configure any of the other characteristics of
the operation.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-889

Cisco Service Assurance Agent Commands

type tcpConnect

The Transmission Control Protocol (TCP) Connection operation is used to discover the time it takes to
connect to the target device. This operation can be used to test virtual circuit availability or application
availability. If the target is a Cisco router, then SA Agent makes a TCP connection to any port number
specified by the user. If the destination is a non-Cisco IP host, then the user must specify a known target
port number (for example, 21 for FTP, 23 for Telnet, or 80 for HTTP Server). This operation is useful in
testing Telnet or HTTP connection times.

Examples

In the following example, SAA operation 11 is created and configured as a tcpConnect probe using the
destination IP address 172.16.1.175, and the destination port 2400:
Router(config)# rtr 11
Router(config-rtr)# type tcpConnect dest-ipaddr 172.16.1.175 dest-port 2400

Related Commands

Command

Description

rtr

Specifies an SAA operation begins configuration for that operation.

show rtr configuration

Displays configuration values for SAA operations.

Cisco IOS Configuration Fundamentals Command Reference

FR-890

78-11740-02

Cisco Service Assurance Agent Commands

type udpEcho

type udpEcho
To define a udpEcho probe, use the type udpEcho SAA RTR configuration command. To remove the
type configuration for the probe, use the no form of this command.
type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr} source-port port-number] [control {enable | disable}]
no type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number

Syntax Description

dest-ipaddr name | ipaddr

Destination of the udpEcho probe. Use an IP host name or IP address.

dest-port port-number

Destination port number. The range of port numbers is from 1 to

65,535.

source-ipaddr name | ipaddr (Optional) Source IP host name or IP address.

source-port port-number

(Optional) Port number of the source. When a port number is not

specified, SAA picks the best IP address (nearest to the target) and
available UDP port

control

(Optional) Specifies that the SAA RTR control protocol should be

used when running this probe. The control protocol is required when
the probes target is a Cisco router that does not natively provide the
service (UDP service in this case). Combined with the enable or
disable keyword, enables or disables sending of a control message to
the destination port. The default is that the control protocol is enabled.

enable

Enable the SAA collector to send a control message to the destination

port prior to sending a probe packet.

disable

Disable the SAA from sending a control message to the responder

prior to sending a probe packet.

Defaults

The control protocol is enabled. Prior to sending a probe packet to the Responder, the SAA collector
sends a control message to the Responder to enable the destination port.

Command Modes

SAA RTR configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

You must configure an operation type before you can configure any of the other characteristics of the
operation.
The source IP address and port number are optional. If they are not specified, SAA selects the IP address
nearest to the target and an available UDP port.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-891

Cisco Service Assurance Agent Commands

type udpEcho

Examples

In the following example, SAA operation 12 is created and configured as udpEcho probe using the
destination IP address 172.16.1.175 and destination port 2400:
Router# configure terminal
Router(config)# rtr 12
Router(config-rtr)# type udpEcho dest-ipaddr 172.16.1.175 dest-port 2400

Related Commands

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

show rtr configuration

Displays configuration values for SAA operations.

Cisco IOS Configuration Fundamentals Command Reference

FR-892

78-11740-02

Cisco Service Assurance Agent Commands

verify-data

verify-data
To cause the SAA operation to check each response for corruption, use the verify-data SAA RTR
configuration command. To return to the default value, use the no form of this command.
verify-data
no verify-data

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

SAA RTR configuration

Command History

Release

Modification

11.2

This command was introduced.

Usage Guidelines

Caution

Examples

Only use the verify-data command when corruption may be an issue.

Do not enable this feature during normal operation because it causes unnecessary overhead.

In the following example, operation 5 is configured to verify the data for each response:
Router(config)# rtr
Router(config-rtr)#
Router(config-rtr)#
Router(config-rtr)#

Related Commands

5
type echo protocol ipIcmpEcho 172.16.1.174
response-data-size 2
verify-data

Command

Description

rtr

Specifies an SAA operation and enters SAA RTR configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-893

Cisco Service Assurance Agent Commands

verify-data

Cisco IOS Configuration Fundamentals Command Reference

FR-894

78-11740-02

WCCP Commands
This chapter provides detailed descriptions of the commands used to configure Web Cache
Communication Protocol Version 1 (WCCPv1) and Version 2 (WCCPv2) on your routing device.
For configuration tasks and examples, refer to the Network Management Using WCCP chapter in the
Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.
Table 131 lists those commands that have been replaced since Cisco IOS Release 12.0.
Table 131

Replaced WCCP Commands

Command in Cisco IOS

Release 12.0:

Replaced by or Integrated into:

ip wccp enable

ip wccp

ip wccp redirect-list

ip wccp

ip web-cache redirect

ip wccp web-cache redirect out

(see the ip wccp <service> redirect command)

show ip wccp web-caches

show ip wccp web-cache detail

(see the show ip wccp command)

Note

Cisco IOS Release 12.2 allows you to enable either WCCPv1 functionality or WCCPv2 functionality
on your router using the ip wccp version command. However, you must use the commands
introduced with WCCPv2 to configure WCCPv1. The original WCCPv1 configuration commands
that have been replaced (see Table 131) will no longer function.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-895

WCCP Commands
clear ip wccp

clear ip wccp
To remove Web Cache Communication Protocol (WCCP) statistics (counts) maintained on the router for
a particular service, use the clear ip wccp EXEC command.
clear ip wccp {web-cache | service-number}

Syntax Description

web-cache

Directs the router to remove statistics for the web cache service.

service-number

Directs the router to remove statistics for a specified cache service.

The number can be from 0 to 99.

Defaults

No default behavior or values.

Command Modes

EXEC

Command History

Release

Modification

11.1 CA

This command was introduced for Cisco 7200 and 7500 platforms.

11.2 P

Support for this command was added to a variety of Cisco platforms.

12.0(3)T

This command was expanded to be explicit about service using the

web-cache keyword and the service-number argument.

Usage Guidelines

Use the show ip wccp and show ip wccp detail commands to display WCCP statistics. If Cisco
Cache Engines are used in your service group, the reverse proxy service is indicated by a value of 99.

Examples

In the following example, all statistics associated with the web cache service are removed:
Router# clear ip wccp web-cache

Related Commands

Command

Description

ip wccp

Directs a router to enable or disable the support for a cache engine service group.

show ip wccp

Displays global statistics related to the WCCP.

Cisco IOS Configuration Fundamentals Command Reference

FR-896

78-11740-02

WCCP Commands
ip wccp

ip wccp
To direct a router to enable or disable the support for a cache engine service group, use the ip wccp
global configuration command. To remove the ability of a router to control support for a service group,
use the no form of this command.
ip wccp {web-cache | service-number} [group-address multicast-address] [redirect-list
access-list] [group-list access-list] [password password [0 | 7]]
no ip wccp {web-cache | service-number} [group-address multicast-address] [redirect-list
access-list] [group-list access-list] [password password [0 | 7]]

Syntax Description

web-cache

Enables the web cache service.

service-number

Enables the specified Web Cache Communication Protocol (WCCP)

service. Services are identified using a number from 0 to 99. If Cisco
Cache Engines are being used in your service group, the reverse-proxy
service is indicated by a value of 99.

group-address
multicast-address

(Optional) Directs the router to use a specified multicast IP address for

communication with the WCCP service group. The multicast-address
argument requires a multicast address, which is used by the router to
determine which cache engine should receive redirected messages.

redirect-list access-list

(Optional) Directs the router to use an access list to control traffic

redirected to this service group. The access-list argument should consist
of a string of no more than 64 characters (name or number) that specifies
the access list.

group-list access-list

(Optional) Directs the router to use an access list to determine which cache
engines are allowed to participate in the service group. The access-list
argument should consist of a string of no more than 64 characters (name
or number) that specifies the access list.

password password

(Optional) Directs the router to apply Message Digest 5 (MD5)

authentication to messages received from the service group. Messages that
are not accepted by the authentication are discarded. The password can be
up to seven characters in length.

0|7

(Optional) Indicates the HMAC MD5 algorithm that is used to encrypt the
password. The value is generated when an encrypted password is created
for a cache engine.

Defaults

WCCP services are not enabled on the router.

Command Modes

Global configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-897

WCCP Commands
ip wccp

Usage Guidelines

This configuration command instructs a router to enable or disable the support for the Service Group
specified by the service name given. A service name may be either one of the provided standard keyword
definitions or a number representing a cache engine dynamically defined definition. Once the service is
enabled, the router can participate in the establishment of a Service Group.
Currently the only provided keyword definition to be used as a service name is web-cache. This keyword
is used to describe the existing WCCP version 1 functionality.
When the ip wccp global configuration command is issued, it instructs the router to allocate space and
enable support of the specified WCCP service for participation in a Service Group.
When the no ip wccp global configuration command is issued, it instructs the router to terminate
participation in the Service Group, deallocate space if none of the interfaces still have the service
configured, and terminate the WCCP task if no other services are configured.

Note

The ip wccp command has replaced the ip wccp enable, ip wccp redirect-list, and ip wccp
group-list commands from the version 1 implementation of WCCP.
The keywords following the service name are optional and may be specified in any order, but only may
be specified once. The following sections outline the specific usage of each of the optional forms of this
command.
ip wccp {web-cache | service-number} group-address multicast-address

A WCCP group address can be configured to set up a multicast address that cooperating routers and web
caches can use to exchange WCCP protocol messages. If such an address is used, ip multicast routing
must be enabled so that the messages using the configured group (multicast) addresses are received
correctly. To enable ip multicast routing, use the ip multicast-routing command.
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. The response is sent to
the group address as well. The default is for no group address to be configured, in which case all Here I
Am messages are responded to with a unicast reply.
ip wccp {web-cache | service-number} redirect-list access-list

The option instructs the router to use an access list to control the traffic that is redirected to the cache
engines of the Service Group specified by the service name given. The access-list-name 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 which traffic is
permitted to be redirected. The default is for no redirect list to be configured (all traffic is redirected).
WCCP requires that the following protocol and ports are not filtered by any access lists:

User Datagram Protocol (UDP) (protocol type 17) port 2048. This port is used for control signalling.
Blocking this type of traffic will prevent WCCP from establishing a connection between the router
and cache engines.

Generic routing encapsulation (GRE) encapsulated (protocol type 47) frames. Blocking this type of
traffic will prevent the cache engines from ever seeing the packets intercepted.

ip wccp {web-cache | service-number} group-list access-list

The option instructs the router to use an access list to control the cache engines allowed to participate in
the specified Service Group. The access-list parameter 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 itself specifies which cache engines are permitted to participate in the Service Group. The default is
for no group list to be configured, in which case all cache engines may participate in the Service Group.

Cisco IOS Configuration Fundamentals Command Reference

FR-898

78-11740-02

WCCP Commands
ip wccp

Note

The ip wccp {web-cache | service-number} group-list command syntax resembles the ip wccp
{web-cache | service-number} group-listen command, but these are entirely different commands.
Note that the ip wccp group-listen command is an interface configuration command, used to
configure an interface to listen for multicast notifications from a cache cluster. See the description of
the ip wccp <service> group-listen command in this chapter for more information.
ip wccp {web-cache | service-number} password password

The option instructs the router to use MD5 authentication on the messages received from the Service
Group specified by the service name given. Use this form of the command to set the password on the
router. You must also configure the same password separately on each cache engine. The password can
be up to a maximum of seven characters. Messages that do not authenticate when authentication is
enabled on the Router are discarded. The default is for no authentication password to be configured and
authentication to be disabled.

Examples

In the following example, a user configures a router to run WCCP reverse proxy service, using the
multicast address of 224.1.1.1:
Router# configure terminal
Router(config)# ip wccp 99 group-address 224.1.1.1
Router(config)# interface ethernet 0
Router(config-if)# ip wccp web-cache group-list

In the following example, a user configures a router to redirect web-related packets without a destination
of 192.168.196.51 to the cache engine:
Router# configure terminal
Router(config)# access-list 100 deny ip any host 192.168.196.51
Router(config)# access-list 100 permit ip any any
Router(config)# ip wccp redirect-list 100
Router(config)# interface Ethernet 0
Router(config-if)# ip web-cache redirect-list
Router(config-if)# end
Router#

Related Commands

Command

Description

ip wccp version

Specifies which version of WCCP you wish to use on your router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-899

WCCP Commands
ip wccp enable

ip wccp enable
The ip wccp enable has been replaced by the ip wccp command. See the description of the ip wccp
command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-900

78-11740-02

WCCP Commands
ip wccp <service> group-listen

ip wccp <service> group-listen

To configure an interface on a router to enable or disable the reception of IP multicast packets for the
Web Cache Communication Protocol (WCCP) feature, use the ip wccp group-listen interface
configuration command. To remove control of the reception of IP multicast packets for the WCCP
feature, use the no form of this command.
ip wccp {web-cache | service-number} group-listen
no ip wccp {web-cache | service-number} group-listen

Syntax Description

web-cache

Directs the router to send packets to the web cache service.

service-number

The identification number of the cache engine service group being

controlled by a router. The number can be from 0 to 99.

Defaults

This command is disabled by default.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

Examples

On routers that are to be members of a Service Group when IP multicast is used, the following
configuration is required:

The IP multicast address for use by the WCCP Service Group must be configured.

The interfaces on which the router wishes to receive the IP multicast address to be configured with
the ip wccp {web-cache | service-number} group-listen interface configuration command.

In the following example, a user enables the multicast packets for a web cache with a multicast address
of 224.1.1.100.
router# configure terminal
router(config)# ip wccp web-cache group-address 244.1.1.100
router(config)# interface ethernet 0
router(config-if)# ip wccp web-cache group listen

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-901

WCCP Commands
ip wccp <service> group-listen

Related Commands

Command

Description

ip wccp

Directs a router to enable or disable the support for a WCCP cache engine
service group.

ip wccp <service>
redirect

Enables WCCP redirection on an interface.

Cisco IOS Configuration Fundamentals Command Reference

FR-902

78-11740-02

WCCP Commands
ip wccp redirect exclude in

ip wccp redirect exclude in

To configure an interface to exclude packets received on an interface from being checked for redirection,
use the ip wccp redirect exclude in interface configuration command. To disable the ability of a router
to exclude packets from redirection checks, use the no form of this command.
ip wccp redirect exclude in
no ip wccp redirect exclude in

Syntax Description

This command has no arguments or keywords.

Defaults

Redirection exclusion is disabled.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(3)T

This command was introduced.

Usage Guidelines

This configuration command instructs the interface to exclude inbound packets from any redirection
check that may occur at the outbound interface. Note that the command is global to all the services and
should be applied to any inbound interface that you wish to exclude from redirection.
This command is intended to be used to accelerate the flow of packets from a cache engine to the internet as
well as allow for the use of the WCCPv2 Packet Return feature.

Examples

In the following example, packets arriving on Ethernet interface 0 are excluded from all WCCP
redirection checks:
Router(config)# interface ethernet 0
Router(config-if)# ip wccp redirect exclude in

Related Commands

Command

Description

ip wccp

Directs a router to enable or disable the support for a cache engine service
group.

ip wccp redirect out

Configures an interface to enable a the ability of a router to verify that

appropriate packets are being redirected to a cache engine.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-903

WCCP Commands
ip wccp redirect-list

ip wccp redirect-list
This command is now documented as part of the ip wccp {web-cache | service-number} command. See
the description of the ip wccp command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

FR-904

78-11740-02

WCCP Commands
ip wccp <service> redirect

ip wccp <service> redirect

To enable packet redirection on an outbound or inbound interface using Web Cache Communication
Protocol (WCCP), use the ip wccp service redirect interface configuration command. To disable WCCP
redirection, use the no form of this command.
ip wccp service redirect {out | in}
no ip wccp service redirect {out | in}

Syntax Description

service

Specifies the service group. You can specify the web-cache keyword, or
you can specify the identification number(from 0 to 99) of the service.

redirect

Enables packet redirection checking on an outbound or inbound interface.

out

Specifies packet redirection on an outbound interface.

in

Specifies packet redirection on an inbound interface.

Defaults

Redirection checking on the interface is disabled.

Command Modes

Interface configuration

Command History

Release

Modification

12.0(3) T

This command was introduced.

12.0(11)S

The in keyword was added to the 12.0 S release train.

12.1(3)T

The in keyword was added to the 12.1 T release train.

Usage Guidelines

The ip wccp service redirect in command allows you to configure WCCP redirection on an interface
receiving inbound network traffic. When the command is applied to an interface, all packets arriving at
that interface will be compared against the criteria defined by the specified WCCP service. If the packets
match the criteria, they will be redirected.
Likewise, the ip wccp service redirect out command allows you to configure the WCCP redirection
check at an outbound interface.

Tips

Be careful not to confuse the ip wccp service redirect {out | in} interface configuration command
with the ip wccp redirect exclude in interface configuration command.

Note

This command has the potential to effect the ip wccp redirect exclude in command. (These
commands have opposite functions.) If you have ip wccp redirect exclude in set on an interface and
you subsequently configure the ip wccp service redirect in command, the exclude in command
will be overridden. The opposite is also true: configuring the exclude in command will override the
redirect in command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-905

WCCP Commands
ip wccp <service> redirect

Examples

In the following example, the user configures a session in which reverse proxy packets on Ethernet
interface 0 are being checked for redirection and redirected to a Cisco Cache Engine:
Router# configure terminal
Router(config)# ip wccp 99
Router(config)# interface ethernet 0
Router(config-if)# ip wccp 99 redirect ?
in
Redirect to a Cache Engine appropriate inbound packets
out Redirect to a Cache Engine appropriate outbound packets
Router(config-if)# ip wccp 99 redirect out

In the following example, the user configures a session in which HTTP traffic arriving on Ethernet
interface 0/1 will be redirected to a Cisco Cache Engine:
Router# configure terminal
Router(config)# ip wccp web-cache
Router(config)# interface ethernet 0/1
Router(config-if)# ip wccp web-cache redirect in

Related Commands

Command

Description

ip wccp redirect exclude in

Enables redirection exclusion on an interface.

Cisco IOS Configuration Fundamentals Command Reference

FR-906

78-11740-02

WCCP Commands
ip wccp version

ip wccp version
To specify which version of Web Cache Communication Protocol (WCCP) you wish to configure on
your router, use the ip wccp version global configuration command.
ip wccp version {1 | 2}

Syntax Description

Web Cache Communication Protocol Version 1 (WCCPv1).

Web Cache Communication Protocol Version 2 (WCCPv2).

Defaults

WCCPv2

Command Modes

Global configuration

Command History

Release

Modification

12.0(5)T

This command was introduced.

Examples

In the following example, the user changes the WCCP version from the default of WCCPv2 to WCCPv1,
starting in privileged EXEC mode:
router# show ip wccp
% WCCP version 2 is not enabled
router# configure terminal
router(config)# ip wccp version 1
router(config)# end
router# show ip wccp
% WCCP version 1 is not enabled

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-907

WCCP Commands
ip web-cache redirect

ip web-cache redirect
The ip web-cache redirect interface configuration command has been replaced by the ip wccp
<service> redirect interface configuration command. The ip web-cache redirect command is no longer
supported. See the description of the ip wccp <service> redirect command in this chapter for more
information.

Cisco IOS Configuration Fundamentals Command Reference

FR-908

78-11740-02

WCCP Commands
show ip wccp

show ip wccp
To display global statistics related to Web Cache Communication Protocol (WCCP), use the show ip
wccp command in privileged EXEC mode.
show ip wccp [service-number | web-cache] [detail | view]

Syntax Description

service-number

(Optional) Identification number of the web-cache service group being controlled

by the cache. The number can be from 0 to 256. For web caches using Cisco Cache
Engines, the reverse proxy service is indicated by a value of 99.

web-cache

(Optional) Statistics for the web-cache service.

detail

(Optional) Information about the router and all web caches.

view

(Optional) Other members of a particular service group have or have not been
detected.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1CA

This command was introduced for Cisco 7200 and 7500 platforms.

11.2P

Support for this command was added to a variety of Cisco platforms.

Usage Guidelines

12.0(3)T

The detail and view keywords were added.

12.3(7)T

The output was enhanced to display the bypass counters (process, fast, and
Cisco Express Forwarding) when WCCP is enabled.

12.2(14)SX

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

12.2(17d)SXB

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

12.2(25)S

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

12.3(14)T

The output was enhanced to display the maximum number of service groups.

12.2(27)SBC

This command was integrated into Cisco IOS Release 12.2(27)SBC.

12.2(33)SRA

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

Use the clear ip wccp command to reset the counter for the Packets Redirected information.
Use the show ip wccp service-number command to provide the Total Packets Redirected count. The
Total Packets Redirected count is the number of flows, or sessions, that are redirected.
Use the show ip wccp service-number detail command to provide the Packets Redirected count. The
Packets Redirected count is the number of flows, or sessions, that are redirected.
Use the show ip wccp web-cache detail command to provide an indication of how many flows, rather
than packets, are using Layer 2 redirection.
For cache-engine clusters using Cisco cache engines, the reverse proxy service-number is indicated by
a value of 99.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-909

WCCP Commands
show ip wccp

For additional information on the IP WCCP commands, refer to the Configuring Web Cache Services
Using WCCP section in the Cisco IOS Configuration Fundamentals Configuration Guide.

Examples

This section contains examples and field descriptions for the following forms of this command:

show ip wccp web-cache

show ip wccp service-number view

show ip wccp service-number detail

show ip wccp web-cache detail

show ip wccp web-cache detail (bypass counters displayed)

show ip wccp web-cache

The following is sample output from the show ip wccp web-cache command:
Router# show ip wccp web-cache
Global WCCP Information:
Service Name: web-cache:
Number of Cache Engines:
1
Number of Routers:
1
Total Packets Redirected:
213
Redirect access-list:
no_linux
Total Packets Denied Redirect:
88
Total Packets Unassigned:
-noneGroup access-list:
0
Total Messages Denied to Group:
0
Total Authentication failures:
0

Table 132 describes the significant fields shown in the display.

Table 132

show ip wccp web-cache Field Descriptions

Field

Description

Service Name

Indicates which service is detailed.

Number of Cache Engines

Number of Cisco cache engines using the router as their home

router.

Number of Routers

The number of routers in the service group.

Total Packets Redirected

Total number of packets redirected by the router.

Redirect access-list

The name or number of the access list that determines which

packets will be redirected.

Total Packets Denied Redirect

Total number of packets that were not redirected because they did
not match the access list.

Total Packets Unassigned

Number of packets that were not redirected because they were not
assigned to any cache engine. Packets may not be assigned during
initial discovery of cache engines or when a cache is dropped
from a cluster.

Group access-list

Indicates which cache engine is allowed to connect to the router.

Cisco IOS Configuration Fundamentals Command Reference

FR-910

78-11740-02

WCCP Commands
show ip wccp

Table 132

show ip wccp web-cache Field Descriptions (continued)

Field

Description

Total Messages Denied to Group

Indicates the number of packets denied by the group-list access

list.

Total Authentication failures

The number of instances where a password did not match.

show ip wccp service-number view

The following is sample output from the show ip wccp 1 view command:
Router# show ip wccp 1 view
WCCP Router Informed of:
10.168.88.10
10.168.88.20
WCCP Cache Engines Visible
10.168.88.11
10.168.88.12
WCCP Cache Engines Not Visible:
-none-

Note

The number of maximum service groups that can be configured is 256.

If any web cache is displayed under the WCCP Cache Engines Not Visible field, the router needs to be
reconfigured to map the web cache that is not visible to it.
Table 133 describes the significant fields shown in the display.
Table 133

show ip wccp service-number view Field Descriptions

Field

Description

WCCP Router Informed of

A list of routers detected by the current router.

WCCP Clients Visible

A list of clients that are visible to the router and other clients in
the service group.

WCCP Clients Not Visible

A list of clients in the service group that are not visible to the
router and other clients in the service group.

show ip wccp service-number detail

The following example displays WCCP client information and WCCP router statistics that include the
type of services:
Router# show ip wccp 91 detail
WCCP Client information:
WCCP Client ID: 10.1.1.14
Protocol Version: 2.0
State: Usable
Redirection: GRE
Packet Return: GRE
Assignment: HASH
Initial Hash Info: 0000000000000000000000000000000000000000000000000000000000000000
Assigned Hash Info: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
Hash Allotment: 256 (100.00%)

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-911

WCCP Commands
show ip wccp

Packets Redirected: 0
Connect Time: 00:01:56
Bypassed Packets
Process: 0
CEF: 0

show ip wccp web-cache detail

The following example displays web-cache engine information and WCCP router statistics for a
particular service group:
Router# show ip wccp web-cache detail
WCCP Router information:
IP Address
Protocol Version:
WCCP Client Information
IP Address:
Protocol Version:
State:
Initial Hash Info:
Assigned Hash Info:
Hash Allotment:
Packets Redirected:
Connect Time:

10.168.88.10
2.0

10.168.88.11
2.0
Usable
AAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAA
FFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFF
256 (100.00%)
21345
00:13:46

Table 134 describes the significant fields shown in the display.

Table 134

show ip wccp web-cache detail Field Descriptions

Field

Description

WCCP Router information

The header for the area that contains fields for the IP address and
version of WCCP associated with the router connected to the
cache engine in the service group.

IP Address

The IP address of the router connected to the cache engine in the

service group.

Protocol Version

The version of WCCP being used by the router in the service

group.

WCCP Client Information

The header for the area that contains fields for information on
clients.

IP Address

The IP address of the cache engine in the service group.

Protocol Version

The version of WCCP being used by the cache engine in the

service group.

State

Indicates whether the cache engine is operating properly and can

be contacted by a router and other cache engines in the service
group.

Initial Hash Info

The initial state of the hash bucket assignment. The values show
the state of each of the 256 hash buckets. Hexadecimal digits are
used as shorthand for binary numbers with F representing 1111,
four bits set to one. If a set of four bits is F, then that hash bucket
is allocated to the client with the displayed ID. If a set of bits is 0,
then it is not allocated to the client with the displayed ID.

Cisco IOS Configuration Fundamentals Command Reference

FR-912

78-11740-02

WCCP Commands
show ip wccp

Table 134

show ip wccp web-cache detail Field Descriptions (continued)

Field

Description

Assigned Hash Info

The current state of the hash bucket assignment. The values show
the state of each of the 256 hash buckets. If F is displayed, then
that hash bucket is allocated to the client with the displayed ID. If
a bit is 0 then it is not allocated to the client with the displayed
ID. In this output all the bits in the assigned field are F, indicating
that all traffic goes to that client. All 1s in the assigned field
indicates there is only one client in the service group. If there
were two clients in the group, half of the bits would have a value
of F and the other half would have a value of 0 for each client,
indicating that redirected traffic is divided equally between the
two clients.

Hash Allotment

The percent of buckets assigned to the current cache engine. Both

a value and a percent figure are displayed.

Packets Redirected

The number of packets that have been redirected to the cache

engine.

Connect Time

The amount of time the cache engine has been connected to the
router.

show ip wccp web-cache detail (Bypass Counters)

The following example displays web-cache engine information and WCCP router statistics that include
the bypass counters:
Router# show ip wccp web-cache detail
WCCP Router information:
IP Address:10.168.88.10
Protocol Version:2.0
WCCP Client Information
IP Address:10.168.88.11
Protocol Version:2.0
State:Usable
Initial Hash Info:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
Assigned Hash Info:FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
Hash Allotment:256 (100.00%)
Packets Redirected:21345
Connect Time:00:13:46
Bypassed Packets
Process:
0
Fast:
0
CEF:
250

Table 135 describes the significant fields shown in the display.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-913

WCCP Commands
show ip wccp

Table 135

Related Commands

show ip wccp web-cache detail Field Descriptions

Field

Description

WCCP Router information

The header for the area that contains fields for the IP address and
the version of WCCP associated with the router connected to the
cache engine in the service group.

IP Address

The IP address of the router connected to the cache engine in the

service group.

Protocol Version

The version of WCCP that is being used by the router in the

service group.

WCCP Client Information

The header for the area that contains fields for information on
clients.

IP Address

The IP address of the cache engine in the service group.

Protocol Version

The version of WCCP that is being used by the cache engine in

the service group.

State

Indicates whether the cache engine is operating properly and can

be contacted by a router and other cache engines in the service
group.

Initial Hash Info

The initial state of the hash bucket assignment.

Assigned Hash Info

The current state of the hash bucket assignment.

Hash Allotment

The percent of buckets assigned to the current cache engine. Both

a value and a percent figure are displayed.

Packets Redirected

The number of packets that have been redirected to the cache

engine.

Connect Time

The amount of time the cache engine has been connected to the
router.

Bypassed Packets

The number of packets that have been bypassed. Process, fast, and
Cisco Express Forwarding (CEF) are switching paths within
Cisco IOS software.

Command

Description

clear ip wccp

Clears the counter for packets redirected using WCCP.

ip wccp

Enables WCCP on a router and specifies the type of services to be used.

ip wccp redirect

Enables packet redirection on an outbound or inbound interface using

WCCP.

ip wccp web-cache
accelerated

Enables the hardware acceleration for WCCP version 1.

show ip interface

Lists a summary of the IP information and status of an interface.

Cisco IOS Configuration Fundamentals Command Reference

FR-914

78-11740-02

WCCP Commands
show ip wccp web-caches

show ip wccp web-caches

The show ip wccp web-caches command has been replaced by the show ip wccp web-cache detail
command. See the description of the show ip wccp command in this chapter for more information.

Command History

Release

Modification

11.2P, 11.1CA,
12.0

This command was introduced.

12.1

This command was replaced by the show ip wccp command.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-915

WCCP Commands
show ip wccp web-caches

Cisco IOS Configuration Fundamentals Command Reference

FR-916

78-11740-02

Appendixes

ASCII Character Set and Hex Values

Some commands described in the Cisco IOS documentation set, such as the escape-character line
configuration command, require that you enter the decimal representation of an ASCII character. Other
commands, such as the snmp-server group command, make use of hexadecimal representations.
Table 136 provides code translations from the decimal numbers to their hexadecimal and ASCII
equivalents. It also provides the keyword entry for each ASCII character. For example, the ASCII
carriage return (CR) is decimal 13. Entering Ctrl-M at your terminal generates decimal 13, which is
interpreted as a CR.
Table 136

ASCII Translation Table

Numeric Values
Decimal
Hex

ASCII
Character

Meaning

Keyboard Entry

00

NUL

Null

Ctrl-@

01

SOH

Start of heading

Ctrl-A

02

STX

Start of text

Ctrl-B

03

ETX

Break/end of text

Ctrl-C

04

EOT

End of transmission

Ctrl-D

05

ENQ

Enquiry

Ctrl-E

06

ACK

Positive acknowledgment

Ctrl-F

07

BEL

Bell

Ctrl-G

08

BS

Backspace

Ctrl-H

09

HT

Horizontal tab

Ctrl-I

10

0A

LF

Line feed

Ctrl-J

11

0B

VT

Vertical tab

Ctrl-K

12

0C

FF

Form feed

Ctrl-L

13

0D

CR

Ctrl-M
Carriage return
(Equivilant to the Enter or
Return key)

14

0E

SO

Shift out

Ctrl-N

15

0F

SI

Shift in/XON (resume

output)

Ctrl-O

16

10

DLE

Data link escape

Ctrl-P

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-919

ASCII Character Set and Hex Values

Table 136

ASCII Translation Table (continued)

Numeric Values
Decimal
Hex

ASCII
Character

Meaning

17

11

DC1

Device control character 1 Ctrl-Q

18

12

DC2

Device control character 2 Ctrl-R

19

13

DC3

Device control character 3 Ctrl-S

20

14

DC4

Device control character 4 Ctrl-T

21

15

NAK

Negative acknowledgment Ctrl-U

22

16

SYN

Synchronous idle

23

17

ETB

End of transmission block Ctrl-W

24

18

CAN

Cancel

Ctrl-X

25

19

EM

End of medium

Ctrl-Y

26

1A

SUB

Substitute/end of file

Ctrl-Z

27

1B

ESC

Escape

Ctrl-[

28

1C

FS

File separator

Ctrl-\

29

1D

GS

Group separator

Ctrl-]

30

1E

RS

Record separator

Ctrl-^

31

1F

US

Unit separator

Ctrl-_

32

20

SP

Space

Space

33

21

34

22

"

"

"

35

23

36

24

37

25

38

26

&

&

&

39

27

40

28

41

29

42

2A

43

2B

44

2C

45

2D

46

2E

47

2F

48

30

Zero

49

31

One

50

32

Two

51

33

Three

Keyboard Entry

Ctrl-V

Cisco IOS Configuration Fundamentals Command Reference

FR-920

78-11740-02

ASCII Character Set and Hex Values

Table 136

ASCII Translation Table (continued)

Numeric Values
Decimal
Hex

ASCII
Character

Meaning

Keyboard Entry

52

34

Four

53

35

Five

54

36

Six

55

37

Seven

56

38

Eight

57

39

Nine

58

3A

59

3B

60

3C

<

<

<

61

3D

62

3E

>

>

>

63

3F

64

40

65

41

66

42

67

43

68

44

69

45

70

46

71

47

72

48

73

49

74

4A

75

4B

76

4C

77

4D

78

4E

79

4F

80

50

81

51

82

52

83

53

84

54

85

55

86

56

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-921

ASCII Character Set and Hex Values

Table 136

ASCII Translation Table (continued)

Numeric Values
Decimal
Hex

ASCII
Character

Meaning

Keyboard Entry

87

57

88

58

89

59

90

5A

91

5B

92

5C

93

5D

94

5E

95

5F

96

60

97

61

98

62

99

63

100

64

101

65

102

66

103

67

104

68

105

69

106

6A

107

6B

108

6C

109

6D

110

6E

111

6F

112

70

113

71

114

72

115

73

116

74

117

75

118

76

119

77

120

78

121

79

Cisco IOS Configuration Fundamentals Command Reference

FR-922

78-11740-02

ASCII Character Set and Hex Values

Table 136

ASCII Translation Table (continued)

Numeric Values
Decimal
Hex

ASCII
Character

Meaning

Keyboard Entry

122

7A

123

7B

124

7C

125

7D

126

7E

Tilde

127

7F

DEL

Delete

Del

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-923

ASCII Character Set and Hex Values

Cisco IOS Configuration Fundamentals Command Reference

FR-924

78-11740-02

Cisco 7500 Series Line Card Configuration

Commands
This chapter contains Cisco IOS software commands used to configure characteristics for Cisco 7500
series line cards. Line cards are any I/O card that can be inserted in a modular chassis (including the
Cisco 7500 RSP cards).
For more information on Cisco 7000 series hardware configuration, see the Core/High-End Routers
documentation section of Cisco.com at
http://www.cisco.com/univercd/cc/td/doc/product/core/index.htm or on the Documentum CD-ROM.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-925

Cisco 7500 Series Line Card Configuration Commands

service single-slot-reload-enable

service single-slot-reload-enable
To enable single line card reloading for all line cards in a Cisco 7500 series router, use the service
single-slot-reload-enable global configuration command. To disable single line card reloading for the
line cards, use the no form of this command.
service single-slot-reload-enable
no service single-slot-reload-enable

Syntax Description

This command has no arguments or keywords.

Defaults

Single line card reloading is disabled by default.

Command Modes

Global configuration mode

Command History

Release

Modification

12.0(13)S

This command was introduced.

12.1(5)T

This command was integrated in Cisco IOS Release 12.1 T.

Usage Guidelines

Before the introduction of this command, the only method of correcting a line card hardware failure or
a severe software error for one line card on a Cisco 7500 series router required the execution of a Cbus
Complex, a process that reloaded every line card on the network backplane. The time taken to complete
the Cbus Complex was often inconvenient, and no network traffic could be routed or switched during the
Cbus Complex process.
The service single-slot-reload-enable command allows users to correct a line card failure on a
Cisco 7500 series router by reloading the failed line card without reloading any other line cards on the
network backplane. During the single line card reload process, all physical lines and routing protocols
on the other line cards of the network backplane remain active. A single line card reload is also
substantially faster than the Cbus Complex process

Examples

In the following example, single line card reloading is enabled for all lines cards on a Cisco 7513 router:
c7513(config)# service single-slot-reload-enable

Related Commands

Command

Description

show diag

Displays hardware information on line cards.

show running-config

Displays configuration information.

Cisco IOS Configuration Fundamentals Command Reference

FR-926

78-11740-02

Cisco 7500 Series Line Card Configuration Commands

slave auto-sync config

slave auto-sync config

To turn on automatic synchronization of configuration files for a Cisco 7507 or Cisco 7513 router that
is configured for High System Availability (HSA) using Dual RSP Cards, use the slave auto-sync config
global configuration command. To turn off automatic synchronization, use the no form of the command.
slave auto-sync config
no slave auto-sync config

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

11.1

The command was introduced.

Usage Guidelines

Use this command for a Cisco 7507 or Cisco 7513 router that is configured for dual RSP cards. On the
Cisco 7507 and Cisco 7513 router, you can install two RSP cards in a single router to improve system
availability. Dual RSP Cards is a High System Availability (HSA) feature.
In automatic synchronization mode, when you issue a copy EXEC command that specifies the masters
startup configuration (nvram:startup-config) as the target, the master also copies the same file to the
slaves startup configuration (slavenvram:startup-config). Use this command when implementing
HSA for simple hardware backup or for software error protection to ensure that the master and slave RSP
contain the same configuration files.

Examples

The following example turns on automatic configuration file synchronization. When the copy
system:running-config nvram:startup-config command is entered, the running configuration is saved
to the startup configurations of both the master RSP and the slave RSP.
Router(config)# slave auto-sync config
Router(config)# end
Router# copy system:running-config nvram:startup-config

Related Commands

Command

Description

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-927

Cisco 7500 Series Line Card Configuration Commands

slave auto-sync config

Command

Description

show version

Displays the software version running on the master and slave RSP cards.

slave sync config

Manually synchronizes configuration files on the master and slave RSP cards
of a Cisco 7507 or Cisco 7513 router.

Cisco IOS Configuration Fundamentals Command Reference

FR-928

78-11740-02

Cisco 7500 Series Line Card Configuration Commands

slave default-slot

slave default-slot
To specify the default slave Route Switch Processor (RSP) card on a Cisco 7507 or Cisco 7513 router,
use the slave default-slot global configuration command.
slave default-slot processor-slot-number

Syntax Description

processor-slot-number

Defaults

The default slave is the RSP card located in the higher number processor slot. On the Cisco 7507 router,
processor slot 3 contains the default slave RSP. On the Cisco 7513 router, processor slot 7 contains the
default slave RSP.

Command Modes

Global configuration

Command History

Release

Modification

11.1

The command was introduced.

Usage Guidelines

Number of a processor slot that contains the default slave RSP. On the
Cisco 7507 router, valid values are 2 or 3. On the Cisco 7513 router,
valid values are 6 or 7. The default is the higher number processor
slot.

Use this command for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Cards. On the
Cisco 7507 and Cisco 7513 router, you can install two RSP cards in a single router to improve system
availability. Dual RSP Cards is a High System Availability (HSA) feature.
The router uses the default slave information when booting as follows:

Examples

If a system boot is due to powering up the router or using the reload EXEC command, then the
specified default slave will be the slave RSP.

If a system boot is due to a system crash or hardware failure, then the system ignores the default
slave designation, and makes the crashed or faulty RSP card the slave RSP.

In the following example, the user sets the default slave RSP to processor slot 2 on a Cisco 7507 router:
c7507(config)# slave default-slot 2

Related Commands

Command

Description

reload

Reloads the operating system.

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

show version

Displays the software version running on the master and slave RSP cards.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-929

Cisco 7500 Series Line Card Configuration Commands

slave image

slave image
To specify the image that the slave Route Switch Processor (RSP) runs on a Cisco 7507 or Cisco 7513
router, use the slave image global configuration command.
slave image {system | file-url}

Syntax Description

system

Loads the slave image that is bundled with the master system image.
This is the default.

file-url

Loads the slave image from the specified file in a Flash file system.
If you do not specify a filename, the first file on the specified Flash
file system is the default file.

Defaults

The default is to load the image from the system bundle.

Command Modes

Global configuration

Command History

Release

Modification

11.1

This command was introduced.

Usage Guidelines

Use this command for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Cards. On the
Cisco 7507 and Cisco 7513 router, you can install two RSP cards in a single router to improve system
availability. Dual RSP Cards is a High System Availability (HSA) feature.
Use the slave image command to override the slave image that is bundled with the master image.
When using HSA for simple hardware backup, ensure that the slave image is in the same location on the
master and the slave RSP card. Thus, if the slave RSP card becomes the master, it will be able to find the
slave image and download it to the new slave.

Examples

In the following example, the slave RSP is specified to run the rsp-dw-mz.ucode.111-3.2 image from slot
0:
c7507(config)# slave image slot0:rsp-dw-mz.ucode.111-3.2

Related Commands

Command

Description

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

show version

Displays the software version running on the master and slave RSP cards.

slave reload

Forces a reload of the image that the slave RSP card is running on a
Cisco 7507 or Cisco 7513 router.

Cisco IOS Configuration Fundamentals Command Reference

FR-930

78-11740-02

Cisco 7500 Series Line Card Configuration Commands

slave reload

slave reload
To force a reload of the image that the slave Route Switch Processor (RSP) card is running on a Cisco
7507 or Cisco 7513 router, use the slave reload global configuration command.
slave reload

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

Global configuration

Command History

Release

Modification

11.1

The command was introduced.

Usage Guidelines

Use this command for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Cards. On the
Cisco 7507 and Cisco 7513 router, you can install two RSP cards in a single router to improve system
availability. Dual RSP Cards is a High System Availability (HSA) feature.
After using the slave image global configuration command to specify the image that the slave RSP runs
on a Cisco 7507 or Cisco 7513 router, use the slave reload command to reload the slave with the new
image. The slave reload command can also be used to force the slave to reboot its existing image.

Examples

In the following example, an inactive slave RSP card is reloaded. If the slave reloads, it will return to
an active slave state. If the master RSP fails, the slave RSP will become the master.
c7507(config)# slave reload

Related Commands

Command

Description

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

show version

Displays the software version running on the master and slave RSP cards.

slave image

Specifies the image that the slave RSP runs on a Cisco 7507 or Cisco 7513
router.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-931

Cisco 7500 Series Line Card Configuration Commands

slave sync config

slave sync config

To manually synchronize configuration files on the master and slave Route Switch Processor (RSP) cards
of a Cisco 7507 or Cisco 7513 router, use the slave sync config privileged EXEC command.
slave sync config

Syntax Description

This command has no arguments or keywords.

Defaults

Automatic synchronization is turned on.

Command Modes

Privileged EXEC

Command History

Release

Modification

11.1

The command was introduced.

Usage Guidelines

Use this command for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Cards. On the
Cisco 7507 and Cisco 7513 router, you can install two RSP cards in a single router to improve system
availability. Dual RSP Cards is a High System Availability (HSA) feature.
This command allows you to synchronize the configuration files of the master and slave RSP cards on a
case-by-case basis when you do not have automatic synchronization turned on. This command copies
the masters configuration file to the slave RSP card.

Note

Examples

You must use this command when you insert a new slave RSP card into a Cisco 7507 or Cisco 7513
router for the first time to ensure that the new slave is configured consistently with the master.

In the following example, the configuration files on the master and slave RSP card are synchronized:
c7507(config)# slave sync config

Related Commands

Command

Description

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

show version

Displays the software version running on the master and slave RSP cards.

slave auto-sync config Turns on automatic synchronization of configuration files for a Cisco 7507
or Cisco 7513 router that is configured for HSA.

Cisco IOS Configuration Fundamentals Command Reference

FR-932

78-11740-02

Cisco 7500 Series Line Card Configuration Commands

slave terminal

slave terminal
To enable access to the slave Route Switch Processor (RSP) console, use the slave terminal global
configuration command. To disable access to the slave RSP console, use the no form of this command.
slave terminal
no slave terminal

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release

Modification

11.1

The command was introduced.

Usage Guidelines

The slave console does not have enable password protection. Thus, an individual connected to the slave
console port can enter privileged EXEC mode and view or erase the configuration of the router. Use the
no slave terminal command to disable slave console access and prevent security problems. When the
slave console is disabled, users cannot enter commands.
If slave console access is disabled, the following message appears periodically on the slave console:
%%Slave terminal access is disabled. Use "slave terminal" command in master RSP
configuration mode to enable it.

Examples

In the following example, the user disables console access to the slave RSP:
c7507(config)# no slave terminal

Related Commands

Command

Description

show controller cbus

Displays detailed information on the cards connected to the CBus controller.

show stacks

Displays the stack trace and version information of the master and slave RSP
cards.

show version

Displays the software version running on the master and slave RSP cards.

slave auto-sync config Turns on automatic synchronization of configuration files for a Cisco 7507
or Cisco 7513 router that is configured for Dual RSP Cards.

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

FR-933

Cisco 7500 Series Line Card Configuration Commands

slave terminal

Cisco IOS Configuration Fundamentals Command Reference

FR-934

78-11740-02

Index

Index

I N D E X

Symbols

! character

absolute command

ping command output

absolute-timeout command

FR-532

# character (privileged EXEC mode prompt)

. character

use with logout-warning

FR-9

IP, time-based

FR-532

/etc/printcap file
FR-80

FR-478

activation character, setting

FR-54, FR-545

activation-character command

xv

? command

FR-376, FR-440

IPX, time ranges

modifying for printing

> prompt

FR-76

access lists

ping command output

<cr>

FR-376

alias command

FR-313

FR-378

aliases

xiv

commands, creating for

displaying

Numerics

FR-378

FR-457

ASCII
character set (table)

7-bit character set

session, changing for a

FR-919

character widths, changing

FR-106

standard U.S. characters

disconnect character

FR-106

dispatch character

8-bit character set

escape character

EXEC and configuration commands

default value, setting

FR-59

hold character

line, configuring on a

FR-69

padding

session, changing for a

FR-94

hardware databits
line, configuring for a

FR-57

session, changing for a

FR-88

FR-84, FR-106

FR-61
FR-62, FR-90

FR-67, FR-93
FR-71

FR-78, FR-102

start character

FR-109

stop character

FR-111

async-bootp command
attach command

FR-344

FR-482

autobaud command

software character bits

line, setting for a

FR-54, FR-545

FR-55

FR-58

session, changing for a

FR-89

special character width

default value, setting

FR-60

banner exec command

line, configuring on a

FR-84

banner incoming command

session, changing for a

FR-106

banner login command

FR-124
FR-126

FR-128

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-937

Index

banner motd command

secondary

FR-130

banners

FR-318

boot system command

FR-320

EXEC, displaying

FR-124

Break key

incoming message

FR-126

buckets-of-history-kept command

line

buffer-length command

disabling on a

FR-124, FR-128, FR-156

enabling on a

FR-124, FR-128, FR-156

line number
login

FR-323

command history
line, configuring for a

FR-162

FR-130

reverse Telnet lines

FR-40, FR-42

interface buffer pool tuning

FR-383

size, setting

baud rates

buffers command

FR-105

See also line speed

FR-382

FR-318

FR-234

FR-312

boot config command

calendar set command

FR-235

carriage return (<cr>)

order of entries, rearranging

FR-323

ASCII value

FR-320, FR-323

cd command
FR-325, FR-327

FR-697

xv

FR-919

cautions, usage in text

boot fields
default values, changing

FR-385

Call Tracker, MIB notifications

BOOT environment variable

boot flash command

FR-384

FR-316

boot buffersize command

boot host command

FR-458

buffers huge size command

boot bootstrap command

specifying

FR-383

FR-382, FR-384

statistics, displaying

boot bootldr command

FR-382, FR-384

public buffer pool tuning

FR-130

See also messages

receive, changing for session

FR-17, FR-19

session, changing for a

management parameters

FR-126

system shutdown, using to announce

boot command

FR-56

buffers

FR-128

MOTD

FR-806

FR-181

CDP (Cisco Discovery Protocol)

FR-312

global information, displaying

FR-237

FR-755

interface status information, displaying

booting

FR-759

neighbor

from Flash

FR-320

device, displaying information

from Flash manually

FR-312

information, displaying

from network server

FR-312

table, clearing

(example)

FR-314
FR-325, FR-327

BOOTLDR environment variable, specifying

boot registers

FR-316

FR-240

FR-325, FR-327

bootstrap image
backing up on a server

FR-761

FR-754

routing device

system software, configuration register

boot network command

FR-757

disabling

FR-749

enabling

FR-749

traffic counters, clearing

FR-753

traffic information, displaying

FR-764

transmission hold time, configuring

FR-188

transmission timer, setting

FR-746

FR-751

Cisco IOS Configuration Fundamentals Command Reference

IN-938

78-11740-02

Index

Version-2, enabling

CLI prompts

FR-744

cdp advertise-v2 command

cdp enable command

customizing

FR-744

clock calendar-valid command

FR-745

cdp holdtime command

cdp timer command

clock set command

FR-747

clock timezone command

FR-751

FR-389

FR-391

clock update-calendar command

FR-395

command alias

FR-58

session, changing for a

See aliases

FR-89

command history

character padding
line, configuring for a

buffer size

FR-78

session, changing for a

line, configuring for a

FR-102

character set

FR-17, FR-19

session, changing for a

7-bit

FR-40, FR-42

commands

See 7-bit character set

displaying previous

8-bit

recalling

See 8-bit character set

exiting

EXEC process

FR-33

FR-11, FR-12

global configuration

default, defining the

FR-33

command modes

character width

privileged EXEC

FR-59

line, configuring for a

FR-244

FR-8

command modes, understanding

FR-69

session, changing for a

xiii to xiv

commands

FR-94

context-sensitive help for abbreviating

special characters
default, defining the

default form, using

FR-60

line, configuring for a

xvii

See command history

FR-106

mapping old to new (table)

checksums
system images, verifying

no form, using

FR-188

Cisco AAA Server MIB, notifications

clear cdp counters command

clear cdp table command

conventions

xviii

help

clear logging command

FR-484

clear parser cache command

xv

FR-15

SNMP, setting

FR-682

compressed system images

FR-323

CONFIG_FILE environment variable, specifying

FR-243

config-register command

FR-134

CLI (command line interface), privilege levels

ix

community string

FR-754
FR-896

xvii

displaying (example)

FR-708

FR-753

clear ip wccp command

FR-232, FR-268

command syntax

FR-691

Cisco IOS configuration changes, saving

Cisco Repeater MIB notifications

xiv, FR-3

history

FR-84

session, changing for a

clear tcp command

FR-387

FR-388

clock summer-time command

FR-749

character data bits

line, setting for a

FR-386

clock read-calendar command

FR-746

cdp log mismatch duplex command

cdp run command

FR-444

FR-8

FR-235

FR-325

configuration files
Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-939

Index

active, displaying
compressing

copy

FR-261

copy bootflash rcp command

FR-249

CONFIG_FILE environment variable, storing

in FR-189
host

copy command

FR-194

FR-183

copy erase flash command

See erase flash command

default filename

FR-251

loading from a server

copy flash rcp command

FR-251

loading from a server

FR-237

load time, displaying

FR-258

FR-193

copy rcp flash command

(example)

FR-191

copy rcp running-config command

network

copy rcp startup-config command

default filename

FR-251

loading from a server

FR-251

network server, storing on

FR-189

storing in

FR-211

FR-183

copy startup-config running-config command

FR-183

FR-271

copy verify command

rcp, copying using

FR-186, FR-187, FR-238, FR-241

reloading at boot time

FR-237, FR-240

running, backing up on the server

specifying boot file
configurations, saving

See verify command

copy verify flash command

FR-189

FR-237

configuration modes, exiting

FR-10

xviii

See verify command

copy xmodem command

FR-273

copy ymodem command

FR-274

FR-10

microcode image

FR-244

loading

configure memory command

FR-245

configure network command

FR-182

configure overwrite-network command

configure terminal command

FR-272

CPA (Channel Port Adapter)

configuration sessions, ending

confreg command

FR-191

copy verify bootflash command

FR-189

configure command

FR-194

copy running-config startup-config command

(example)

displaying file

FR-194

copy tftp flash command

NVRAM

reloading

FR-278
FR-283

CSAA
FR-247

See SA Agent

FR-244

FR-327

connections
full duplex, refusing

FR-113

incoming, definition

FR-126

naming

FR-226

data bits
character, changing for a

FR-158

open, displaying

session, setting for a

FR-121

databits command

consoles

FR-89

FR-58

FR-57

data-character-bits command

debug messages, displaying

logging messages

FR-509

contact string, setting for SNMP

continue command

FR-100

data flow control, setting

data-pattern command

FR-684

FR-329

FR-58

FR-95

FR-808

debug command output, displaying

debug messages, displaying enabled

FR-100
FR-561

Cisco IOS Configuration Fundamentals Command Reference

IN-940

78-11740-02

Index

default-value exec-character-bits command

FR-59

default-value special-character-bits command

delete command
diag command
dir command

editing command

FR-198

FR-5

editors

FR-485

enhanced mode

FR-200

disabling for a line

directory
print working
remove

FR-60

disabling for session

FR-213

enabling for a line

FR-215

disable command

FR-5
FR-37
FR-5

enabling for session

FR-4

disconnect character, setting

disconnect-character command
diskless boot, configuring

enable command

FR-61

FR-8

enable password command

FR-61

end command

FR-351

dispatch-character command

FR-37

FR-8

FR-10

end-of-line characters, changing

FR-62

enhanced editing mode

dispatch characters
line, configuring for a

See editors, enhanced mode

FR-62

packet transmission using a

session, changing for a

FR-62, FR-65, FR-91

FR-587

table of measurements within specification

FR-64

dispatch-timeout command

environmental conditions
at last shutdown

FR-90

dispatch-machine command

temperature and voltage

FR-65

distributions-of-statistics-kept command

FR-809

FR-587

FR-320

rcp, enabling on

FR-352

BOOTLDR, specifying

rsh, enabling on

FR-352

CONFIG_FILE, specifying

erase command

xi

online, accessing

FR-275

erase start-up config command

See erase command

xi

Documentation CD-ROM

error messages

documents and resources, supporting

logging priorities (table)

viii

downward-compatible-config command

FR-396

redirecting

FR-508, FR-519, FR-528, FR-604

FR-521

escape-character command

Dual RSPs
reload slave RSP card

line, defining the

FR-67

session, changing for a

FR-931

Event MIB, monitoring

FR-930

synchronizing configurations manually

FR-67

escape characters

FR-931

slave image
specifying

FR-202

erase flash command

v to vii

reloading

FR-235

See erase command

ix

feedback, providing

ordering

FR-316

erase bootflash command

documentation

modules

FR-590

environment variables
BOOT, specifying

DNS (Domain Name System)

conventions

FR-116

FR-932

FR-93
FR-669

exception core-file command

exception dump command

FR-489

FR-491

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-941

Index

exception linecard command

FR-493

format

exception memory command

FR-495

make directory

exception protocol command

FR-497

recover deleted file

exception region-size

FR-207
FR-210

remove directory

FR-499

exception spurious-interrupt command

FR-501

EXEC

rename file

FR-215

FR-214

verifying files

mode, default aliases

FR-224

FR-226

Flash load helper, monitoring

FR-378

process

FR-286

Flash memory

delaying startup of

FR-449

booting automatically

disabling on a line

FR-136

devices, deleting a file

displaying messages upon creation

enabling on a line
exec-banner command

FR-188, FR-226

end transmission

FR-69

FR-111

session, changing for a

exec-timeout command
exit command

FR-297

flow control

FR-136

execute-on command

FR-198

FR-206

verifying checksum

FR-139

FR-124, FR-128

exec-character-bits command

formatting
partitioning

FR-136

timeout interval, setting for the

exec command

FR-124

FR-320

FR-139
FR-501, FR-503

start character

FR-109

stop character

FR-111

format command

FR-11, FR-12

FR-95

FR-206

frequency (RTR) command

fsck command

FR-813

FR-209

full-help command

FR-13

Feature Navigator
See platforms, supported
file compression

FR-249

file prompt command

get command

FR-205

See type http command

files
contents, displaying
download mode

global configuration mode

FR-211

entering

FR-92

file systems

global configuration mode,summary of

default, setting
erase
list

FR-244

FR-181

FR-202

FR-200

filter-for-history command

FR-811

filtering output, show and more commands

Finger protocol, enabling

xviii

FR-399

Flash file system

hardware break signal

FR-112

hardware flow control

FR-95

hardware platforms
See platforms, supported

check and repair

deleting files

xiv

FR-209

help, user-level commands

FR-13

FR-221

Cisco IOS Configuration Fundamentals Command Reference

IN-942

78-11740-02

Index

help command

ip ftp source-interface command

xiv, FR-15

history command

ip ftp username command

FR-17

history size command

FR-349

ip http access-class command

FR-19

hold character

FR-348

FR-169

ip http authentication command

line, configuring for a

ip http port command

FR-71

FR-170

FR-172

session, changing for a

FR-96

ip http server command

FR-173

hold-character command

FR-71

ip rarp-server command

FR-350

hops-of-statistics-kept command

ip rcmd domain-lookup command

FR-814

host configuration files

ip rcmd rcp-enable command

copying from a server using rcp

(example)

ip rcmd rsh-enable command

FR-251

loading from a server

hostname command

FR-237, FR-251

FR-397

host names, router

FR-355

ip rcmd remote-username command

FR-194

default filename

FR-354, FR-360

ip rcmd remote-host command

FR-188

FR-352

hours-of-statistics-kept command

ip rcmd source-interface command

FR-361

ip telnet source-interface command

FR-401

ip wccp command

FR-817

HTTP Raw configuration submode

http-raw-request command

FR-360

ip tftp source-interface command

FR-397

FR-402

FR-897

ip wccp enable command

FR-885

See the ip wccp command

FR-816

ip wccp group-address command

ip wccp group-list command

incoming connections, definition

indexes, master

ip wccp redirect command

FR-126

FR-687

insecure command

FR-72

FR-897, FR-899
FR-905

ip wccp redirect-list command

xiv

ip wccp version command

FR-907

ip web-cache redirect command

FR-106

See also 8-bit character set

FR-168

invalidated system images

FR-905

ip wccp web-cache redirect command

international character sets

international command

FR-903

FR-897

ip wccp service redirect command

interface configuration mode, summary of

FR-905

FR-908

IPX (Internet Packet Exchange)

access lists, time ranges

FR-478

FR-304

IP

access lists, time-based

FR-376, FR-440

routing, interface status

FR-676

keepalive packets, generating

ip bootp server command

FR-398

keymaps, specifying for session

ip finger command

FR-901

ip wccp redirect exclude in command

viii

informs, enabling

supporting

ip wccp password command

FR-164

FR-897

FR-897

ip wccp group-listen command

idle-terminal message, enabling

FR-358

FR-537, FR-538
FR-98

FR-399

ip ftp passive command

ip ftp password command

FR-346
FR-347
Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-943

Index

LPD (line printer daemon), configuring

lsr-path command
length command

FR-820

FR-73

line cards, executing specific show commands on

FR-482

lines
messages, sending

FR-160

MAC addresses

line speeds

mapping to IP address

receive speed, changing session

FR-105

transmit and receive speed, changing session

transmit speed, changing session
link traps, disabling

FR-818

FR-21

logging buffered command

FR-507

FR-145

menu options command

FR-147

menu prompt command

FR-148

menu status-line command

logging console command

FR-509

menu text command

FR-151

logging facility command

FR-511

menu title command

FR-153

logging history command

logging linecard command

FR-511

FR-513

logging history size command

FR-516

FR-517

logging on command

FR-521
FR-516

FR-519

syslog SNMP traps

UNIX syslog server

FR-521

logging rate-limit command

logging synchronous command

logging trap command

FR-506

FR-526

logout, warning users of impending

FR-729

messages
FR-525

FR-528

buffering
busy

FR-507

FR-159

debug, displaying
FR-76

FR-20

logout-warning command

FR-513

message queue length, SNMP

FR-523

logging source-interface command

logout command

enabling
monitor

FR-519

FR-150

FR-509

history table size

See message logging

FR-149

message logging
console

logging messages
logging monitor command

FR-146

menu single-space command

FR-506

facility-type keywords (table)

FR-142

FR-144

menu line-mode command

FR-484

FR-295

FR-143

menu default command

FR-75

FR-140

logging command

FR-294

menu (EXEC) command

resume

FR-724

logging buffer, clearing

FR-312

menu command

FR-74

lockable command

from ROM

menu clear-screen command

FR-403

location string, setting

FR-312

memory-size iomem command

FR-403

load statistics interval

from Flash

memory scan command

lives-of-history-kept command

location command

FR-118

FR-733

load-interval command

FR-350

manual booting
FR-108

FR-741

linkUp/linkDown traps

lock command

FR-80

line activation, displaying

line-in-use

FR-76

FR-100
FR-124

FR-159

sending to other terminals

FR-160

Cisco IOS Configuration Fundamentals Command Reference

IN-944

78-11740-02

Index

system error, redirecting

vacant terminal

FR-521

FR-164

See also banners

MIB
Cisco Round-Trip Time Monitor
RMON

name-connection command

FR-158

network configuration files

FR-237, FR-240

copying from a server using rcp

FR-826

(example)

FR-768, FR-778

MIB, descriptions online

changing

microcode
loading Cisco IOS image

no menu command

microcode (12000) command

microcode (7200) command

notes, usage in text

FR-278

ntp broadcast client command

ntp broadcast command

modes
monitors, message logging to

MOP (Maintenance Operation Protocol)

server
booting automatically
mop device-code command

ntp master command

FR-420

FR-426

FR-430

ntp server command

FR-432

ntp source command

FR-434

ntp trusted-key command

FR-25

FR-436

ntp update-calendar command

FR-286

null bytes, end of string

FR-27

running-config command

FR-438

FR-78, FR-102

NVRAM file compression

more system

FR-424

FR-428

ntp refclock command

FR-364

FR-211

more flh:logfile command

FR-419

ntp peer command

FR-363

FR-23

more exclude command

FR-417

ntp disable command

ntp multicast command

FR-364

mop retransmit-timer command

FR-415

ntp multicast client command

FR-320

forwarding boot requests

FR-249

FR-262, FR-266

MOTD (message-of-the-day) banner, configuring

motd-banner command

FR-413

ntp clock-period command

FR-519

FR-409

FR-411

ntp broadcastdelay command

See command modes

more include command

FR-407

ntp authentication-key command

FR-283

FR-210

more begin command

FR-405

ntp authenticate command

FR-282

FR-249

FR-668

ntp access-group command

FR-284

microcode reload (7000/7500) command

microcode reload (7200) command

FR-537, FR-538

FR-155

no snmp-server command

FR-276

microcode reload (12000) command

FR-251

nonvolatile RAM file compression

FR-280

microcode (7000/7500) command

more command

FR-240

network services, tailoring use of

FR-276

FR-284

mkdir command

FR-251

loading from a server

FR-280

loading from Flash memory

reloading

FR-194

default filename

viii

FR-188

FR-156

FR-130

O
operating system, reloading

FR-330

output notifications
line, setting for a

FR-77

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-945

Index

session, configuring for a

owner command

privilege level command

FR-101

privilege levels

FR-821

FR-8

FR-8

probes
See also SA Agent operation

process-max-time command
prompt command

packet dispatch characters

line, setting

customizing

FR-90

system

packets
maximum size, establishing
SNMP, filtering

FR-444

xiv

pwd command

FR-728

FR-213

FR-728

padding
line, configuring for a
padding command

FR-78

session, changing for a

question mark (?) command

FR-102

xiv

queues

FR-78

length, SNMP trap queues

parity
line, setting for a
parity command

FR-103

FR-79

parser cache command

partition command

FR-248

RARP (Reverse Address Resolution Protocol)

FR-297

partition flash command

router, configuring as server

FR-297

paths-of-statistics-kept command
periodic command

FR-822

configuring
FR-532

FR-440

ping (user) command

FR-355, FR-359

copying files

FR-354

DNS, enabling security

ping (privileged) command

FR-350

rcp (remote copy protocol)

period (.) character, ping command output

FR-530

remote username

FR-534

FR-352

FR-323

refuse-message command

ping command

FR-159

release notes

test characters (table)

test connectivity

FR-531, FR-534

FR-530, FR-534

release notes, identify using

printer command

FR-80

private command

FR-82

FR-330

remote shell

Feature Navigator, identify using

port queue, retry interval

See platforms, supported

reload command

platforms, supported
xix

xix

FR-104

privileged EXEC command mode

FR-8

summary of

FR-729

FR-79

session, changing for a

entering

FR-440, FR-444

prompts

FR-62

session, changing

FR-443

See rsh server

remote username, rcp requests
default values

FR-323

overriding default value

rename command

FR-323

FR-214

request-data-size command
response-data-size command

FR-824
FR-825

xiv

Cisco IOS Configuration Fundamentals Command Reference

IN-946

78-11740-02

Index

resume command

rsh server

FR-144

retry interval, terminal port queue

(example)

FR-104

RFC

access, granting

full text, obtaining

RFC 868, time servers

FR-344

RFC 887, RLP servers

FR-345

See SA Agent (Service Assurance Agent)

rtr command

rtr key-chain command

FR-344

RFC 1035, domain names

RFC 1178, choosing a name for your computer

RFC 1447, predefined SNMP views
RFC 1757, RMON MIB

FR-830

rtr reaction-configuration command

FR-397

RFC 1757, RMON alarm group

FR-826

FR-829

rtr low memory command

FR-344

RFC 1084, BOOTP requests for asynchronous

interfaces FR-344
FR-739

FR-771

FR-768, FR-778

rtr reaction-trigger command

rtr reset command
FR-397

FR-831

FR-834

FR-835

rtr responder command

rtr schedule command

FR-836
FR-839

running configuration file, copying to the server

(example) FR-195

FR-215

RMON (Remote Monitoring)

agent status, displaying
alarms, enabling

FR-781

FR-770

SA (Service Assurance) Agent

FR-780

history statistics, displaying

FR-778

interface, enabling

application information, displaying

FR-770
FR-772

rmon collection history command

rmon collection host command

FR-773

FR-775

rmon collection matrix command

rmon collection rmon1

FR-776

FR-777

rotary groups, in-use message

FR-397

FR-853

history
collection

FR-806

FR-811
FR-818
FR-842

operations

FR-320

ROM monitor mode, summary of

FR-846

FR-826

samples kept

FR-780

ROM, booting automatically

FR-366

configuring

lives kept
FR-778

rmon queuesize command

router, host name

configuration information, displaying

filters

FR-768

rmon event command

FR-844

authentication information, displaying

rmon capture-userdata command

rmon command

FR-858

SA Agent (Service Assurance Agent)

FR-768

rmon alarm command

rsh command

FR-826

rtr configuration mode, entering

RFC 1034, domain name servers

event table

FR-352

RTR (Response Time Reporter)

FR-344

FR-351

RFC 950, subnet masks

rmdir command

FR-360, FR-366

DNS, enabling security

FR-399

RFC 865, Quote of the Day servers

RFC 903, RARP

FR-355

commands, executing

viii

RFC 742, Finger protocol

enabling

FR-366

xiv

FR-164

setting frequency of
operations, configuring

FR-813
FR-875 to FR-892

probe
owner

FR-821

scheduling

FR-840

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-947

Index

reaction trigger
configuring
displaying

service nagle command

resetting

service prompt config command

FR-833, FR-834

service slave-log command

FR-824

response data size

FR-866

statistics

service tcp-keepalives-out command

service telnet-zero-idle command

displaying

FR-814

setup command

paths kept

FR-822

setup command facility

statistics, setting hours kept

FR-455
FR-456

FR-46

configuration (examples)

FR-48 to FR-49

default client IP address (examples)

FR-872

configuration (example)

FR-873

verify data

FR-454

asynchronous interfaces

FR-817

FR-871

timeout

FR-538

service udp-small-servers command

FR-856, FR-869

hops kept

threshold

FR-537

service tcp-small-servers command

FR-825

FR-48 to FR-49

FR-47 to FR-52

configuration command script (example)

FR-893

samples-of-history-kept command

FR-842

scheduler allocate command

FR-446

scheduler-interval command

FR-447

FR-926

FR-536

service tcp-keepalives-in command

FR-835

responder information, displaying

tags

FR-453

service single-slot-reload-enable command

FR-865

request data size

FR-452

configuration file, saving

FR-49

FR-52

global parameters configuration

(example) FR-47 to FR-48
interface parameters configuration
(example) FR-48 to FR-52

screen
length

interface summary, viewing

line, setting for a

FR-73

session, changing for a

output, pausing

sample configuration
FR-99

FR-47

FR-47 to FR-52

System Configuration Dialog

FR-71

(example)

width

FR-47

returning to privileged EXEC prompt

line, setting for a

FR-122

session, changing for a

terminating the configuration

FR-120

show aliases command

See privilege levels

send command
serial device
FR-74

service config command

FR-249

FR-251

service decimal-tty command

service exec-wait command
service finger command

show begin command

FR-29

show boot command

FR-332

show bootflash command

service compress-config command

FR-448
FR-449

FR-450

service hide-telnet-address command

service linenumber command

FR-368

FR-300

show bootvar command

FR-333

show buffers command

FR-382

show c2600 command

FR-541

show c7200 command

FR-544

show calendar command

FR-451

show cdp command

FR-299

FR-457

show async-bootp command

FR-160

location, setting

FR-47

show (Flash file system) command

security levels

FR-47

FR-462

FR-755

FR-162

Cisco IOS Configuration Fundamentals Command Reference

IN-948

78-11740-02

Index

show cdp entry command

show cdp interface command

show cdp traffic command
show cls

show memory command

FR-759

show cdp neighbors command

show clock command

show management event command

FR-757

show memory ecc

FR-761

FR-608

FR-612

show memory fast command

FR-764

FR-289

show ntp associations command

FR-545

show configuration command

show context command

show ntp status command

FR-216, FR-253

show pci command

FR-547

show controllers (GRP image) command

FR-551

show controllers (line card image) command

show controllers logging command

FR-553

FR-558

show controllers tech-support command

show debugging command

FR-559

FR-469

show derived-config command

FR-254

show pci hardware command

show processes command

show processes cpu command

show registry command

FR-471

show disk command

FR-580, FR-583

show rmon alarms command

show rmon command

FR-217

show file information command

show file systems command
show flash command

FR-218

show idb command

FR-790

show rmon history command

show rmon topn command

FR-299
FR-306

FR-792
FR-795
FR-797
FR-799

FR-802

show rtr application command

FR-844

show rtr authentication command

FR-288

FR-846

show rtr collection-statistics command

FR-600

show history command

show rmon filter command

show rmon statistics command

show flash summary command

show gt64010 command

FR-788

show rmon matrix command

FR-299

show flash filesys command

show gsr command

FR-785

FR-781

show rmon hosts command

FR-219

FR-299

show flh-log command

FR-783

show rmon events command

FR-257

show flash chips command

FR-335

show rmon capture command

FR-31

FR-629

FR-631

show reload command

show file descriptors command

FR-626

show processes memory command

FR-562

show exclude command

FR-621

FR-623

show diag command

FR-586

FR-258

FR-619

show protocols command

FR-561

show environment command

FR-466

show parser statistics command

FR-549

show context command (2600)

show file command

FR-614

show microcode command

FR-463

FR-669

show rtr configuration command

FR-601

FR-853

show rtr distribution-statistics command

FR-33

show rtr history command

FR-465
FR-35

show rtr operational-state command

show ip wccp command

FR-909

show rtr reaction-trigger command

show ip wccp view command

FR-915

FR-507, FR-509, FR-528, FR-603

show logging history command

FR-606

show running-config command

FR-860
FR-865

FR-866

show rtr totals-statistics command

FR-909

show ip wccp web-caches command

show logging command

show rtr responder command

FR-909

FR-867

FR-261

show running-config map-class command

show slot command

FR-856

FR-858

show include command

show ip wccp detail command

FR-847

FR-264

FR-632, FR-635, FR-637

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-949

Index

show snmp command

versions, disabling all

FR-671

show snmp engineID command

show snmp group command

SNMP server

FR-674

system location, setting

FR-675

show snmp pending command

FR-676

trap operation

show snmp sessions command

FR-677

recipient

show snmp user command

show sntp command

show tcp command

FR-266

FR-642

FR-682

snmp-server contact command

FR-684

snmp-server context command

FR-685

snmp-server enable informs command

FR-649

FR-686

snmp-server enable traps aaa_server command

FR-644

show tdm connections command

FR-650

show tdm connections motherboard command

channel output, interpreting
show tdm data command

FR-680

FR-681

snmp-server community command

show startup-config command

show tcp brief command

FR-717

snmp-server chassis-id command

FR-640

show subsys command

FR-717

snmp-server access-policy command

FR-679

FR-472

show stacks command

FR-668

snmp-server enable traps atm command

FR-693

snmp-server enable traps bgp command

FR-695

snmp-server enable traps calltracker command

FR-650

snmp-server enable traps command

FR-651

show tech-support command

FR-691

FR-687

snmp-server enable traps envmon command

FR-652

FR-697

FR-699

show version command

FR-336

snmp-server enable traps frame-relay command

show whoami command

FR-83

snmp-server enable traps isdn command

shutdown

snmp-server enable traps snmp command

FR-730

slave auto-sync config command

slave default-slot command

FR-930

slave reload command

FR-931

slave sync config command

slave terminal command

snmp-server engineID command

snmp-server group command
snmp-server host command

FR-932

FR-933

SNMP (Simple Network Management Protocol)

community access string, setting

FR-682

configuration parameters, displaying

informs, enabling
packet filtering

FR-603

FR-684
FR-724

system shutdown, enabling

FR-668, FR-730

FR-717

snmp-server informs command

FR-722

snmp-server location command

FR-724

snmp-server manager command

FR-725

snmp-server manager session-timeout command

source, setting

FR-735

FR-736
FR-687

FR-729

snmp-server tftp-server-list command

FR-730

FR-731

snmp-server trap-authentication command

FR-732

FR-733

snmp-server trap-source command

snmp-server trap-timeout command
snmp-server user command

FR-726

FR-728

snmp-server system-shutdown command

snmp-server trap link command

trap message

traps, enabling

FR-714

snmp-server queue-length command

FR-728

system location, setting

FR-705

FR-712

snmp-server packet-size command

FR-687

system contact, setting

FR-708

snmp-server enable traps voice poor-qov

command FR-710

FR-927

FR-929

slave image command

timeout

FR-703

snmp-server enable traps repeater command

SNMP, enabling with

FR-701

FR-735
FR-736

FR-737

Cisco IOS Configuration Fundamentals Command Reference

IN-950

78-11740-02

Index

snmp-server view command

session, changing for a

FR-739

snmp trap link-status command

FR-741

sntp broadcast client command

FR-474

sntp server command

FR-111

strings
system contact, setting

FR-684

system location, setting

FR-476

software configuration boot register

FR-325, FR-327

software flow control

FR-717, FR-724

Symmetricom GPS device, enabling

system buffers

session, changing for a

See buffers

FR-95

start character, changing the

FR-109

System Configuration Dialog

FR-46

FR-84

system contact string, setting

FR-684

special-character-bits command
special characters

system error messages, redirecting

activation character

FR-430

FR-521

system image file

FR-54, FR-545

copying from server to Flash (example)

character width
default, defining the

checksum, verifying

FR-84

session, changing for a

disconnect character

system images

FR-60

line, configuring for a

compressing

FR-106

FR-62

escape character
line, configuring for a

FR-323

copying using Xmodem

FR-291

copying using Ymodem

FR-291

default filename

FR-67

session, changing for a

FR-226

copying from a server using rcp

FR-61

dispatch character, setting for line

invalidated

FR-93

hold character

FR-304

session, changing for a

FR-724

system shutdown, enabling using SNMP

FR-71

session, changing for a

FR-323

FR-322

system location string, setting

line, configuring for a

FR-191

FR-668, FR-730

system software

FR-96

booting

FR-90

speeds

FR-320, FR-322

displaying version of

FR-336

See line speeds

squeeze command

FR-221

start characters
flow control, changing

FR-109

Tab key, command completion

session, changing for a

FR-109

tag command

startup configuration file

FR-195

TCP

state-machine command

FR-85

statistics-distribution-interval command
stop bits
line, configuring for a
session, changing for a
stopbits command

FR-87
FR-110

FR-87

FR-134

keepalive protocol, activating

FR-538

packet dispatch state machine

FR-64

technical support information

displaying

FR-652

Telnet

stop characters
flow control, changing

FR-871

connections, clearing
FR-869

xiv

addresses, suppressing
FR-111

FR-451

end-of-line characters, changing

FR-116

Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-951

Index

Remote Echo option

locking

FR-113

Suppress Go Ahead option

packet dispatch character

FR-113

terminal databits command

FR-75

parity bit

FR-88

FR-103

terminal data-character-bits command

FR-89

pausing output to screen

terminal dispatch-character command

FR-90

port queue

terminal dispatch-timeout command

terminal download command
terminal editing command

FR-91

terminal escape-character command

FR-93

terminal exec-character-bits command

FR-94

FR-95

receive speed

FR-105

session, changing for a

line, configuring for a

FR-122

FR-96

start character

FR-109

FR-175

stop character, changing

terminal keymap-type command

FR-98

type

terminal notify command

session, specifying for a

FR-100

terminal sessions, closing

FR-101

terminal padding command

terminal parity command

FR-104

FR-104

terminal rxspeed command

FR-117

FR-11, FR-12

terminal speed command

FR-103

terminal-queue command

FR-119

terminal special-character-bits command

FR-102

terminal port queue, retry interval

FR-111

line connection, specifying for a

FR-99

terminal monitor command

FR-120

FR-82

terminal international command

terminal length command

FR-99

screen width

settings, saving

FR-40

terminal hold-character command

FR-73

session, changing for a

FR-38

terminal history command

FR-104

line, configuring for a

FR-37

terminal full-help command

FR-71

screen length

FR-92

terminal flowcontrol command

FR-90

FR-105, FR-118

terminals

FR-108

terminal start-character command

terminal stopbits command

FR-109

FR-110

terminal stop-character command

FR-111

terminal telnet break-on-ip command

activation character, setting

FR-54, FR-545

character padding
FR-78

debug messages, displaying

end-of-line character

FR-100

FR-116

escape character
line, defining for a

session, defining for a

file download mode
flow control
line speed

FR-93

FR-92

FR-108, FR-118

location, recording
lock access

terminal terminal-type command

terminal width command

test flash command

FR-108
FR-74

FR-140

FR-115

FR-116

FR-117

FR-118

FR-119
FR-120

FR-656

test interfaces command

FR-95

line speed, changing

terminal telnet transparent command

terminal-type command

FR-113

FR-114

terminal telnet sync-on-break command

terminal txspeed command

FR-67

FR-112

terminal telnet refuse-negotiations command

terminal telnet speed command

line, configuring for a

FR-106

test memory command

FR-657
FR-658

TFTP (Trivial File Transfer Protocol)

server
booting automatically

FR-320

Cisco IOS Configuration Fundamentals Command Reference

IN-952

78-11740-02

Index

router, configuring to function as

tftp-server command

FR-369

tftp-server system command

timeout interval

FR-888

type tcpConnect command

FR-872

type udpEcho command

FR-873

FR-889
FR-891

FR-91

terminal character dispatch

trap message

FR-139

FR-65

FR-736

time-range command

U
undelete command

FR-478

FR-224

UNIX operating system

ToS (type of service)

compress command

SA Agent operations, defining for

FR-874

FR-874

FR-323

Syslog Serve, message logging to

uncompress command

trace

FR-506

FR-323

unrecognized command message

common problems
terminating

FR-663

help command

FR-663

tracing IP routes

FR-659

FR-663

trace command

vacant-message command

common problems
extended test

FR-659

verify command

FR-659

FR-164

FR-226

verify-data command

FR-660

FR-893

views, predefined as described in RFC 1447

privileged, overview

FR-739

FR-659

FR-659

user, overview

FR-663

traps
host, setting message queue length
message

FR-729

where command

FR-121

width command

FR-122

word help, description

establishing timeout
source interface

FR-736

FR-735

recipient, specifying
traps, enabling

xiv

FR-664

trace (user) command

terminating

FR-69

user EXEC mode, summary of

trace (privileged) command

IP routes

FR-886

type pathEcho command

EXEC process, setting for the

tos command

FR-884

type jitter command

See tftp-server command

timeout command

FR-882

type http command

FR-369

threshold command

type ftp command

FR-687

type dchp command

FR-875

type dlsw command

FR-877

type dns command

type echo command

write erase command

See erase nvram command

FR-717

Trimble GPS device, enabling

FR-15

FR-430

write memory command

FR-309

write network command

FR-310

write terminal command

See show running-config command

FR-879
FR-880
Cisco IOS Configuration Fundamentals Command Reference

78-11740-02

IN-953

Index

X
xmodem command

FR-291

Cisco IOS Configuration Fundamentals Command Reference

IN-954

78-11740-02