To monitor and control the event trace function for a specified Cisco IOS software subsystem component, use the
monitorevent-trace command in privileged EXEC mode.
Name of the Cisco IOS software subsystem component that is the subject of the event trace. To get a list of components that support event tracing, use the
monitorevent-trace? command.
clear
Clears existing trace messages for the specified component from memory on the networking device.
continuous
Continuously displays the latest event trace entries.
disable
Turns off event tracing for the specified component.
dump
Writes the event trace results to the file configured using the
monitorevent-trace command in global configuration mode. The trace messages are saved in binary format.
pretty
(Optional) Saves the event trace message in ASCII format.
enable
Turns on event tracing for the specified component.
one-shot
Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the
monitorevent-tracecommand in global configuration mode.
size
Sets the number of messages that can be written to memory for a single instance of a trace.
Note
Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the
showmonitorevent-tracecomponentparameters command.
When the number of event trace messages in memory exceeds the size, new messages will begin to overwrite the older messages in the file.
stacktrace
Enables the stack trace at tracepoints.
all-traces
Displays the configured merged-event traces.
merged
(Optional) Dumps the entries in all event traces sorted by time.
l3
Displays information about the Layer 3 trace.
spa
Displays information about the Shared Port Adapter (SPA) trace.
interfacetypemod/port
Specifies the interface to be logged.
cancel
(Optional) Cancels the continuous display of latest trace entries.
subsys
Displays information about the subsystem’s initial trace.
Command Default
The event trace function is disabled by default.
Command Modes
Privileged EXEC (#)
Command History
Release
Modification
12.0(18)S
This command was introduced.
12.2(8)T
This command was integrated into Cisco IOS Release 12.2(8)T.
12.2(14)SX
Support for this command was introduced on the Supervisor Engine 720.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S. Themonitorevent-tracecefipv4clearcommand replaces the
clearipcefevent-logcommand.
12.2(28)SB
This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.2(33)SXH
This command was integrated into Cisco IOS Release 12.2(33)SXH.
12.4(20)T
This command was integrated into Cisco IOS Release 12.4(20)T.
Usage Guidelines
Use the
monitorevent-trace command to control what, when, and how event trace data is collected. Use this command after you have configured the event trace functionality on the networking device using the
monitorevent-trace command in global configuration mode.
Note
The amount of data collected from the trace depends on the trace message size configured using the
monitorevent-tracecommand in global configuration mode for each instance of a trace.
The Cisco IOS software allows for the subsystem components to define whether support for event tracing is enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the
monitorevent-tracecommand in privileged EXEC mode or using the
monitorevent-tracecommand in global configuration mode. To disable event tracing, you would enter either of these commands with the disable keyword. To enable event tracing again, you would enter either of these commands with the enable keyword.
To determine whether you can enable event tracing on a subsystem, use the
monitorevent-trace?commandto get a list of software components that support event tracing. To determine whether event tracing is enabled by default for the subsystem, use the
showmonitorevent-trace command to display trace messages.
Use the
showmonitorevent-trace command to display trace messages. Use the
monitorevent-tracecomponentdump command to save trace message information for a single event. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use themonitorevent-tracecomponentdumppretty command.
To write the trace messages for all events currently enabled on a networking device to a file, enter the
monitorevent-tracedumpcommand.
To configure the file where you want to save trace information, use the
monitorevent-trace command in global configuration mode. The trace messages are saved in a binary format.
Examples
The following example shows the privileged EXEC commands to stop event tracing, clear the current contents of memory, and reenable the trace function for the interprocess communication (IPC) component. This example assumes that the tracing function is configured and enabled on the networking device.
The following example shows how the
monitorevent-traceone-shotcommand accomplishes the same function as the previous example except in one command. In this example, once the size of the trace message file has been exceeded, the trace is terminated.
Router# monitor event-trace ipc one-shot
The following example shows the command for writing trace messages for an event in binary format. In this example, the trace messages for the IPC component are written to a file.
Router# monitor event-trace ipc dump
The following example shows the command for writing trace messages for an event in ASCII format. In this example, the trace messages for the MBUS component are written to a file.
Router# monitor event-trace mbus dump pretty
Examples
This example shows how to stop event tracing, clear the current contents of memory, and reenable the trace function for the SPA component. This example assumes that the tracing function is configured and enabled on the networking device.
Name of the Cisco IOS software subsystem component that is the object of the event trace. To get a list of components that support event tracing, use the
monitorevent-trace? command.
disable
Turns off event tracing for the specified component.
dump-filefilename
Specifies the file where event trace messages are written from memory on the networking device. The maximum length of the filename (path and filename) is 100 characters, and the path can point to flash memory on the networking device or to a TFTP or FTP server.
enable
Turns on event tracing for the specified component provided that the component has been configured using the
monitorevent-tracecommand.
sizenumber
Sets the number of messages that can be written to memory for a single instance of a trace. Valid values are from1 to 65536.
Note
Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the
showmonitorevent-tracecomponentparameters command.
When the number of event trace messages in memory exceeds the configured size, new messages will begin to overwrite the older messages in the file.
stacktracenumber
Enables the stack trace at tracepoints and specifies the depth of the stack trace stored. Valid values are from 1 to 16.
timestamps
(Optional) Includes time stamp information with the event trace messages for the specified component.
datetime
(Optional) Specifies that the time stamp information included with event trace messages will consist of the date and time of the event trace.
localtime
(Optional) Specifies that the time given in the time stamp will be local time.
msec
(Optional) Includes milliseconds in the time stamp.
show-timezone
(Optional) Includes time zone information in the time stamp.
uptime
(Optional) Displays time stamped information about the system uptime.
clear
Clears existing trace messages for the specified component from memory on the networking device.
continuous
Continuously displays the latest event trace entries.
one-shot
Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the
monitorevent-tracecommand.
Command Default
Event tracing is enabled or disabled depending on the software component.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.0(18)S
This command was introduced.
12.2(8)T
This command was integrated into Cisco IOS Release 12.2(8)T.
12.2(14)SX
This command was integrated into Cisco IOS Release 12.2(14)SX and implemented on the Supervisor Engine 720.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
12.2(28)SB
This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.4(20)T
This command was integrated into Cisco IOS Release 12.4(20)T.
Usage Guidelines
Use the
monitorevent-trace command to enable or disable event tracing and to configure event trace parameters for Cisco IOS software subsystem components.
Note
Event tracing is intended for use as a software diagnostic tool and should be configured only under the direction of a Technical Assistance Center (TAC) representative. In Cisco IOS software images that do not provide subsystem support for the event trace function, the
monitorevent-trace command is not available.
The Cisco IOS software allows the subsystem components to define whether support for event tracing is enabled or disabled by default. The command interface for event tracing allows you to change the default two ways: using the
monitorevent-tracecommand in privileged EXEC mode or using the
monitorevent-tracecommand in global configuration mode.
Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the
monitorevent-tracecomponentenable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a command entry in the configuration file.
Note
The amount of data collected from the trace depends on the trace message size configured using the
monitorevent-tracecommand for each instance of a trace.
To determine whether you can enable event tracing on a subsystem, use the
monitorevent-trace?commandto get a list of software components that support event tracing.
To determine whether event tracing is enabled by default for the subsystem, use the
showmonitorevent-trace command to display trace messages.
To specify the trace call stack at tracepoints, you must first clear the trace buffer.
Examples
The following example shows how to enable event tracing for the interprocess communication (IPC) subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to ipc-dump in slot0 (flash memory).
When you select Cisco Express Forwarding as the component for which to enable event tracing, you can use the following additional arguments and keywords:
monitorevent-tracecef [events |
interface|ipv6 |
ipv4][all]. The following example shows how to enable event tracing for IPv4 or IPv6 events of the Cisco Express Forwarding component in Cisco IOS software:
configure terminal
!
monitor event-trace cef ipv4 enable
configure terminal
!
monitor event-trace cef ipv6 enable
exit
The following example shows what happens when you try to enable event tracing for a component (in this case, adjacency events) when it is already enabled:
configure terminal
!
monitor event-trace adjacency enable
%EVENT_TRACE-6-ENABLE: Trace already enabled.
Related Commands
Command
Description
monitorevent-trace(EXEC)
Controls the event trace function for a specified Cisco IOS software subsystem component.
monitorevent-tracedump-traces
Saves trace messages for all event traces currently enabled on the networking device.
showmonitorevent-trace
Displays event trace messages for Cisco IOS software subsystem components.
monitor event-trace dump-traces
To save trace messages for all event traces currently enabled on the networking device, use the monitorevent-tracedump-tracescommand in privileged EXEC mode.
monitorevent-tracedump-traces [pretty]
Syntax Description
pretty
(Optional) Saves the event trace message in ASCII format.
Command Modes
Privileged EXEC
Command History
Release
Modification
12.0(18)S
This command was introduced.
12.2(8)T
This command was integrated into Cisco IOS Release 12.2(8)T.
Usage Guidelines
Use the monitorevent-tracedump-traces command to save trace message information for all event traces currently enabled on a networking device. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use themonitorevent-tracedump-tracespretty command.
To write the trace messages for an individual trace event to a file, enter the monitorevent-trace(EXEC) command.
To configure the file where you want to save messages, use the monitorevent-trace (global) command.
Examples
The following example shows how to save the trace messages in binary format for all event traces enabled on the networking device.
monitor event-trace dump-traces
The following example shows how to save the trace messages in ASCII format for all event traces enabled on the networking device.
monitor event-trace dump-traces pretty
Related Commands
Command
Description
monitorevent-trace (EXEC)
Controls event trace function for a specified Cisco IOS software subsystem component.
monitorevent-trace(global)
Configures event tracing for a specified Cisco IOS software subsystem component.
showmonitorevent-trace
Displays event trace messages for Cisco IOS software subsystem components.
monitor pcm-tracer capture-destination
To configure a location to save the Pulse Code Modulation (PCM) trace information, use the monitorpcm-tracercapture-destination command in global configuration mode. To disable the configuration, use the no form of this command.
monitorpcm-tracercapture-destinationdestination
nomonitorpcm-tracercapture-destination
Syntax Description
destination
Destination to save the PCM trace information.
You can specify any of the following values:
archive:--Saves trace to archive.
flash:--Saves trace to flash memory.
ftp:--Saves trace to an FTP network server.
http:--Saves trace to an HTTP server.
https:--Saves trace to a secure HTTP (HTTPS) server.
null:--Saves trace to file system.
nvram:--Saves trace to the NVRAM of the router.
pram:--Saves trace to the permanent RAM (PRAM) of the router.
rcp:--Saves trace to a remote copy protocol (RCP) network server.
scp:--Saves trace to a network server that supports Secure Shell (SSH).
syslog:--Saves trace to the system log.
system:--Saves trace to the system memory.
tftp:--Saves trace to a TFTP network server.
tmpsys:--Saves trace to a temporary system location.
Command Default
The PCM trace information is saved to the NVRAM.
Command Modes
Global configuration (config)
Command History
Release
Modification
15.0(1)M
This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.
Usage Guidelines
You can use the monitorpcm-tracercapture-destination command to specify a location to save the PCM trace information. When Cisco IOS software saves the data to network file systems, such as TFTP and FTP, it assumes the location is valid and has write access.
After the PCM capture is complete, the router automatically copies the captured contents to the specified location. The filename format at the destination location is as follows:
In this example, two files are created for the data corresponding to each DS0s, one for each direction (transmitter and receiver). When the debugpcmtracer command is enabled, the trace data is copied into the following files:
cap_data_tx_6_1_22 and
cap_data_rx_6_1_22--This corresponds to the traffic flowing through DS0 6/1:22.
cap_data_tx_6_1_22 and cap_data_rx_6_1_22--cap_data_tx_6_1_22
is the data in the transmit direction (from the DFC to the system backplane) and cap_data_rx_6_1_22 is the data in the receiver direction (to the DFC from the system backplane).
Examples
The following example shows how to configure a router to save the PCM trace information to a flash drive:
To configure the delay time to start the Pulse Code Modulation (PCM) trace capture, use the monitorpcm-tracerdelayed-start command in global configuration mode. To disable the configuration, use the no form of this command.
monitorpcm-tracerdelayed-startseconds
nomonitorpcm-tracerdelayed-start
Syntax Description
seconds
Delay, in seconds. The range is from 1 to 2147483.
Command Default
The default delay time is zero.
Command Modes
Global configuration (config)
Command History
Release
Modification
15.0(1)M
This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.
Examples
The following example shows how to configure the PCM tracer delay time to 1000 seconds:
To create Pulse Code Modulation (PCM) capture profiles, use the
monitorpcm-tracerprofile command in global configuration mode. To disable the configuration, use the
no form of this command.
To configure a destination port permit list or add to an existing destination port permit list, use the
monitorpermit-list command in global configuration mode. To delete from or clear an existing destination port permit list, use the
no form of this command.
Specifies the interface type; valid values are
ethernet,
fastethernet,
gigabitethernet, or
tengigabitethernet
slot
The slot that the interface module is installed in.
port
Specifies a single port on an interface module, or the first port on an interface module used in a range of ports.
last-port
(Optional) Specifies the port on an interface module used as the last port in a range of ports.
,
(Optional) Separates each instance of a port, or range of ports, that are monitored. See the Usage Guidelines and the Examples for more information.
Command Default
Disabled
Command Modes
Global configuration
Command History
Release
Modification
12.2(18)SXE
Support for this command was introduced on the Supervisor Engine 720.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
To prevent accidental configuration of ports as destinations, you can create a permit list of the ports that are valid for use as destinations. With a destination port permit list configured, you can only configure the ports in the permit list as destinations.
When you enter multiple instances of
interfaceinterface-typeslot/port-fastport, you must enter a space before and after the comma. For example,
interfaceinterface-typeslot/port-fastport ,
interface-typeslot/port-fastport,interface-typeslot/port-fastport.
Examples
This example shows how to configure a destination port permit list that includes Gigabit Ethernet ports 5/1 through 5/4, and activate monitoring:
This example shows how to configure a destination port permit list that includes Fast Ethernet ports 1/1-48, 2/1-48, and Gigabit Ethernet ports 3/1 through 3/4, and activate monitoring:
Displays the permit-list state and interfaces configured.
monitor session egress replication-mode
To switch the egress-span mode from the default mode (either centralized or distributed depending on your Cisco IOS software release), use the
monitorsessionegressreplication-modecommand in global configuration mode. To return to the default mode, use the
no form of the command.
Cisco IOS Release 12.2(33)SXH2a and Later Releases
monitorsessionegressreplication-modecentralized
nomonitorsessionegressreplication-modecentralized
Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2
monitorsessionegressreplication-modedistributed
nomonitorsessionegressreplication-modedistributed
Syntax Description
centralized
In Cisco IOS Release 12.2(33)SXH2a and later releases: Specifies centralized egress span monitoring as the default mode.
distributed
In Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2: Specifies distributed egress span monitoring as the default mode.
Command Default
Cisco IOS Releases 12.2(33)SXH2a and later releases: Centralized mode
Cisco IOS Releases 12.2(33)SXH, SXH1, and SXH2: Distributed mode
Command Modes
Global configuration (config)
Command History
Release
Modification
12.2(33)SXH
This command was introduced.
12.2(33)SXH2a
The command was changed as follows:
The default mode was changed from distributed mode to centralized mode.
The
centralized keyword was removed and the
distributed keyword was added.
Usage Guidelines
Note
Prior to Cisco IOS Release 12.2(33)SXH and the introduction of this feature, the operating mode was centralized and could not be changed.
Centralized egress span monitoring redirects traffic to the supervisor engine for egress monitoring.
Distributed egress span monitoring is performed in the ingress module. Distributed replication for Switched Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN) increases the total throughput at the span destination.
Note
Distributed egress span (DES) mode is applied to ASIC-based sessions only.
Examples
Examples
The following example shows how to switch the egress-span mode from the distributed default to centralized mode:
The following example shows how to switch the egress-span mode from distributed back to centralized mode:
Router(config)# no monitor session egress replication-mode distributed
Related Commands
Command
Description
showmonitorsession
Displays the operational mode and configured mode of the session and module session capabilities.
monitor session type
To configure a local Switched Port Analyzer (SPAN), RSPAN, or ERSPAN, use the
monitorsessiontypecommand in global configuration mode. To remove one or more source or destination interfaces from the SPAN session, use the
no form of this command.
Number of the local SPAN or ERSPAN session; valid values are from 1 to 66.
erspan-destination
Specifies the ERSPAN destination-session configuration mode.
erspan-source
Specifies the ERSPAN source-session configuration mode.
local
Specifies the local SPAN session configuration mode.
local-tx
Specifies the local egress-only SPAN session configuration mode.
rspan-destination
Specifies the RSPAN destination-session configuration mode.
rspan-source
Specifies the RSPAN source-session configuration mode.
Command Default
This command has no default settings.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.2(18)SXE
Support for this command was introduced on the Supervisor Engine 720.
12.2(18)SXF
This command was changed as follows:
Support for this command was introduced on the Supervisor Engine 32.
ERSPAN is supported in any switch fabric module functionality switching mode.
12.2(33)SXH
This command was changed to include the following keywords:
local
local-tx
rspan-destination
rspan-source
Usage Guidelines
Release 12.2(18)SXE and later releases support ERSPAN with the Supervisor Engine 720, hardware revision 3.2 or higher. Enter the
showmoduleversion|includeWS-SUP720-BASE command to display the hardware revision.
ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination session.
This command is not supported on Catalyst 6500 series switches that are configured with a Supervisor Engine 2.
All ERSPAN source sessions on a switch must use the same source IP address. You enter the
originipaddress command to configure the IP address for the ERSPAN source sessions.
All ERSPAN destination sessions on a switch must use the same IP address. You enter the
ipaddress command to configure the IP address for the ERSPAN destination sessions. If the ERSPAN destination IP address is not a Supervisor Engine 720 (for example, it is a network sniffer), the traffic arrives with the GRE and RSPAN headers/encapsulation intact.
The ERSPAN source session destination IP address, which must be configured on an interface on the destination switch, is the source of traffic that an ERSPAN destination session sends to the destination ports. You configure the same address in both the source and destination sessions with the
ipaddress command.
The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from different ERSPAN source sessions.
The local ERSPAN session limits are as follows:
Total sessions--66
Source sessions--2 (ingress or egress or both)
Destination sessions--23
The
monitorsessiontype command creates a new ERSPAN session or allows you to enter the ERSPAN session configuration mode. ERSPAN uses separate source and destination sessions. You configure the source and destination sessions on different switches. The ERSPAN session configuration mode prompts are as follows:
Router(config-mon-erspan-src)--Indicates the ERSPAN source session configuration mode.
Router(config-mon-erspan-src-dst)--Indicates the ERSPAN source session destination configuration mode.
Router(config-mon-erspan-dst)--Indicates the ERSPAN destination session configuration mode.
Router(config-mon-erspan-dst-src)--Indicates the ERSPAN destination session source configuration mode
The table below lists the ERSPAN destination session configuration mode syntaxes.
Associates the ERSPAN destination session number with the destination ports.
source
Enters ERSPAN destination session source configuration mode and changes the prompt to the following:
Router(config-mon-erspan-dst-src)#
Destination Session Source Configuration Mode
ipaddressip-address [force]
Configures the ERSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN destination session configuration.
erspan-iderspan-flow-id
Configures the ID number used by the destination and destination sessions to identify the ERSPAN traffic.
vrfvrf-name
(Optional) Configures the VRF name of the packets in the ERSPAN traffic.
The table below lists the ERSPAN source session configuration mode syntaxes.
Table 2 ERSPAN or RSPAN Source Session Configuration Mode Syntaxes
(Optional) Configures source VLAN filtering when the ERSPAN or RSPAN source is a trunk port.
descriptionsession-description
(Optional) Describes the ERSPAN or RSPAN source session.
Source Session Destination Configuration Mode
ipaddressip-address
Configures the ERSPAN or RSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN or RSPAN destination session configuration.
erspan-iderspan-flow-id
Configures the ID number used by the source and destination sessions to identify the ERSPAN or RSPAN traffic.
originipaddressip-address
Configures the IP address used as the source of the ERSPAN or RSPAN traffic.
ip {{ttlttl-value } | {precipp-value } | {dscpdscp-value }}
(Optional) Configures the following packet values in the ERSPAN or RSPAN traffic:
ttlttl-value --IP time-to-live (TTL) value
precipp-value-- IP-precedence value
dscpdscp-value-- IP-precedence value
vrfvrf-name
(Optional) Configures the VRF name of the packets in the ERSPAN or RSPAN traffic.
When you configure the monitor sessions, follow these syntax guidelines:
erspan-destination-span-session-number can range from 1 to 66.
single-interface is
interfacetype slot /port ;
type is
fastethernet,
gigabitethernet, or
tengigabitethernet.
interface-list is
single-interface
,
single-interface ,
single-interface ...
Note
In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash.
interface-range is
interfacetype slot /first-port -
last-port .
mixed-interface-list is, in any order,
single-interface ,
interface-range , ...
erspan-flow-id can range from 1 to 1023.
When you clear the monitor sessions, follow these syntax guidelines:
The no
monitorsessionsession-number command entered with no other parameters clears the session
session-number .
session-range is
first-session-number -last-session-number.
Note
When you enter the no
monitorsessionrange command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.
Use the
monitorsessiontypelocal command to configure ingress, egress, or both ingress and egress SPAN sessions.
Use the
monitorsessiontypelocal-tx command to configure egress-only SPAN sessions.
When you enter the local or the local egress-only SPAN session configuration mode, the prompt changes accordingly to Router(config-mon-local)# or Router(config-mon-local-tx)#, and the following commands are available:
description-- Describes the properties for this session using this syntax:
descriptiondescription
The
descriptioncan be up to 240 characters and cannot contain special characters or spaces.
destination-- Specifies the destination and the destination properties using this syntax:
Specifies the SPAN destination anomaly-detector-module.
interfacetypenumber
Specifies the
interfacetype and
number as follows:
GigabitEthernetmod/port
port-channelnum--Ethernet Channel of interfaces; valid values are from 1 to 496.
ingress
(Optional) Configures destinations to receive traffic from attached devices.
learning
(Optional) Enables MAC address learning from the destinations, which allows the switch to transmit traffic that is addressed to devices attached to the destinations.
intrusion-detection-modulenum
Specifies the SPAN destination intrusion-detection-module.
exit-- Exits from configuration session mode.
filtervlanvlan-id-- Limits the SPAN source traffic to specific VLANs; valid values are from 1 to 4096.
no-- Negates a command or sets its defaults.
shutdown-- Shuts down this session
source-- Specifies the SPAN source interface or VLAN using the following syntax:
cpu rp
Associates the local SPAN session number with the CPU on the route processor.
cpu sp
Associates the local SPAN session number with the CPU on the switch processor.
interfacetypenumber
Specifies the interface type and number as follows:
FastEthernetmod/port
GigabitEthernetmod/port
Port-channelnum--Ethernet Channel of interfaces; valid values are from 1 to 496.
vlan
vlan-id
Specifies the VLAN; valid values are from 1 to 4094.
,
(Optional) Specifies another range of interfaces.
-
(Optional) Specifies a range of interfaces.
both
(Optional) Monitors the received and the transmitted traffic.
rx
(Optional) Monitors the received traffic only.
txWhen you enter the local-tx keyword, the rx and both keywords are not available and the tx keyword is required.
(Optional) Monitors the transmitted traffic only.
The local SPAN session limits are as follows:
Total sessions--80
Source sessions--2 (ingress or egress or both)
Egress only--14
If you enter the
filter keyword on a monitored trunk interface, only traffic on the set of specified VLANs is monitored.
Only one destination per SPAN session is supported. If you attempt to add another destination interface to a session that already has a destination interface configured, you get an error. You must first remove a SPAN destination interface before changing the SPAN destination to a different interface.
You can configure up to 64 SPAN destination interfaces, but you can have one egress SPAN source interface and up to 128 ingress source interfaces only.
A SPAN session can either monitor VLANs or monitor individual interfaces, but it cannot monitor both specific interfaces and specific VLANs. Configuring a SPAN session with a source interface and then trying to add a source VLAN to the same SPAN session causes an error. Configuring a SPAN session with a source VLAN and then trying to add a source interface to that session also causes an error. You must first clear any sources for a SPAN session before switching to another type of source.
Port channel interfaces display in the list of interface options if you have them configured. VLAN interfaces are not supported. However, you can span a particular VLAN by entering the
monitorsessionsessionsourcevlanvlan-id command.
When you configure the
destination, use these guidelines:
A
single-interface is as follows:
interfacetypeslot/port;
type is
fastethernet,
gigabitethernet, or
tengigabitethernet.
interfaceport-channelnumber
Note
Destination port channel interfaces must be configured with the
channel-groupgroup-nummodeon command and the
nochannel-protocol command.
An
interface-list is
single-interface, single-interface ,
single-interface ...
Note
In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash.
An
interface-range is
interfacetypeslot/first-port-last-port.
A
mixed-interface-list is, in any order,
single-interface,interface-range, ...
A
single-vlan is the ID number of a single VLAN.
A
single-list is
single-vlan,single-vlan,single-vlan ...
A
vlan-range is
first-vlan-ID-last-vlan-ID.
A
mixed-vlan-list is, in any order,
single-vlan ,
vlan-range , ...
When you clear the monitor sessions, follow these syntax guidelines:
The no
monitorsessionsession-number command entered with no other parameters clears the session
session-number .
session-range is
first-session-number -last-session-number.
Note
When you enter the no
monitorsessionrange command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.
Examples
This example shows how to configure an ERSPAN source session number and enter the ERSPAN source session configuration mode for the session:
Router(config)# monitor session 55 type erspan-source
Router(config-mon-erspan-src)#
This example shows how to configure an ERSPAN destination session number and enter the ERSPAN destination session configuration mode for the session:
Router(config)# monitor session 55 type erspan-destination
Router(config-mon-erspan-dst)#
This example shows how to associate the ERSPAN destination session number with the destination ports:
This example shows how to configure session 1 to monitor ingress traffic from Gigabit Ethernet port 1/1 and configure Gigabit Ethernet port 1/2 as the destination:
Router(config)# monitor session 1 type local
Router(config-mon-local)# source interface gigabitethernet 1/1 rx
Router(config-mon-local)# destination interface gigabitethernet 1/2
This example shows how to configure session 1 to monitor egress-only traffic from Gigabit Ethernet port 5/1 and configure Gigabit Ethernet port 5/2 as the destination:
This example shows how to remove an interface from a session:
Router(config)# no monitor session 1 type local-tx
Related Commands
Command
Description
monitorsessiontype
Creates an ERSPAN source session number or enters the ERSPAN session configuration mode for the session.
showmonitorsession
Displays information about the ERSPAN, SPAN, and RSPAN sessions.
mop device-code
To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification (sysid) messages and request program messages, use the mopdevice-codecommand in global configuration mode. To set the identity to the default value, use the no form of this command.
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The sysid messages and request program messages use the identity information indicated by this command.
Examples
The following example identifies a DECserver 200 device as sending MOP sysid and request program messages:
mop device-code ds200
Related Commands
Command
Description
mopsysid
Enables an interface to send out periodic MOP system identification messages.
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 mopretransmit-timercommand in global configuration mode. To reinstate the default value, use the no form of this command.
mopretransmit-timerseconds
nomopretransmit-timer
Syntax Description
seconds
Sets the length of time (in seconds) that the software waits before resending a message. The value is a number from 1 to 20.
Command Default
4 seconds
Command Modes
Global configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
By default, when the software sends a request that requires a response from a MOP boot server and the server does not respond, the message is re-sent after 4 seconds. If the MOP boot server and router are separated by a slow serial link, it might take longer than 4 seconds for the software to receive a response to its message. Therefore, you might want to configure the software to wait longer than 4 seconds before resending the message if you are using such a link.
Examples
In the following example, if the MOP boot server does not respond within 10 seconds after the router sends a message, the server will resend the message:
mop retransmit-timer 10
Related Commands
Command
Description
mopdevice-code
Identifies the type of device sending MOP sysid messages and requests program messages.
mopenabled
Enables an interface to support the MOP.
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 mopretriescommand in global configuration mode. To reinstate the default value, use the no form of this command.
mopretriescount
nomopretries
Syntax Description
count
Indicates the number of times the software will resend a MOP boot request. The value is a number from 3 to 24. The default is 8.
Command Default
8 times
Command Modes
Global configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Examples
In the following example, the software will attempt to resend a message to an unresponsive host 11 times before declaring a failure:
Router(config)# mop retries 11
Related Commands
Command
Description
mopdevice-code
Identifies the type of device sending MOP sysid messages and requests program messages.
mopenabled
Enables an interface to support the MOP server.
mopretransmit-timer
Configures the length of time that the Cisco IOS software waits before resending boot requests to a MOP server.
more
To display the contents of a file, use the
morecommand in privileged EXEC mode.
more
[ /ascii | /binary | /ebcdic ]
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.
url
The URL of the file to display. A URL in the CLI consists of a file-system prefix (such as
system: or
nvram:), an optional path (such as a folder name), and the name of a file.
Command Default
The command displays the conent of a file in its native format. Optional formats include ascii, binary, and ebcdic.
Command Modes
Privileged EXEC (>)
Command History
Release
Modification
11.3 AA
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Cisco IOS XE Release 2.5
This command was implemented on Cisco ASR 1000 series routers.
Usage Guidelines
The
moresystem:running-config command displays the same output as the
showrunning-config command. The
morenvram:startup-config command is recommended as a replacement for the
showstartup-config command and the
showconfiguration command.
You can use this command to display configuration files, as follows:
The
morenvram: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
moresystem:running-config command displays the running configuration.
These commands show the version number of the software used when you last changed the configuration file.
You can also display the contents of files on remote systems using the
more command. For example, you could display a saved running configuration file on an FTP server using
moreftp://username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the
copy command for more information on file-system prefixes available in the Cisco IOS CLI.
Options for filtering and redirecting the output of this command are available by appending a pipe character (|). See the Related Commands table for a list of
more<url> command extensions.
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
.
.
.
end
The following is partial sample output from the
morenvram:startup-configcommand 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
bootconfig
Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).
more<url>begin
Begins the output of any
morecommand from a matched string.
more<url>exclude
Filters the output of any
more command to exclude a matched string.
more<url>include
Filters the output of any
more command to display only the lines that match the specified string.
servicecompress-config
Compresses startup configuration files.
showbootvar
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.
more url begin
To search the output of any morecommand, use the moreurl|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.
{ moreurl | beginregular-expression }
Syntax Description
url
The Universal Resource Locator (RLl) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
A vertical bar (the “pipe” symbol) indicates that an output processing specification follows.
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
User EXEC
Privileged 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.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt.
To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
To filter the remaining output of the more command, use one of the following commands at the --More-- prompt:
-regular-expression
+regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Note
Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the morenvram:startup-config|begincommand that begins unfiltered output with the first line that contain the regular expression “ip.” At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression “ip.”
router# more nvram:startup-config | begin ip
ip subnet-zero
ip domain-name cisco.com
ip name-server 198.92.30.32
ip name-server 171.69.2.132
!
isdn switch-type primary-5ess
.
.
.
interface Ethernet1
ip address 5.5.5.99 255.255.255.0
--More--
-ip
filtering...
media-type 10BaseT
!
interface Serial0:23
encapsulation frame-relay
no keepalive
dialer string 4001
dialer-group 1
isdn switch-type primary-5ess
no fair-queue
Related Commands
Command
Description
more<url>exclude
Filters more command output so that it excludes lines that contain a particular regular expression.
more<url>include
Filters more command output so that it displays only lines that contain a particular regular expression.
show<command>begin
Searches the output of any show command and displays the output from the first instance of a specified string.
show<command>exclude
Filters show command output so that it excludes lines that contain a particular regular expression.
show<command>include
Filters show command output so that it displays only lines that contain a particular regular expression.
more url exclude
To filter morecommand output so that it excludes lines that contain a particular regular expression, use the moreexclude command in EXEC mode.
{ moreurl | excluderegular-expression }
Syntax Description
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.
The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include:
prefix:[directory/]filename
Prefixes can be local file systems or file locations, such as nvram: or system:. Alternatively, you can specify network locations using the following syntax:
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.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the morenvram:startup-config|excludecommand. The use of|excludeservice in the command specifies a filter that excludes lines that contain the regular expression “service.” At the --More-- prompt, the user searches for the regular expression “Dialer1,” which continues filtered output with the first line that contains “Dialer1.”
router# more nvram:startup-config | exclude service
!
version 12.0
!
hostname router
!
boot system flash
no logging buffered
!
ip subnet-zero
ip domain-name cisco.com
.
.
.
--More--
/Dialer1
filtering...
interface Dialer1
no ip address
no ip directed-broadcast
dialer in-band
no cdp enable
Related Commands
Command
Description
more<url>begin
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
more<url>include
Filters more command output so that it displays only lines that contain a particular regular expression.
show<command>begin
Searches the output of any show command and displays the output from the first instance of a specified string.
show<command>exclude
Filters show command output so that it excludes lines that contain a particular regular expression.
show<command>include
Filters show command output so that it displays only lines that contain a particular regular expression.
more url include
To filter morecommand output so that it displays only lines that contain a particular regular expression, use the moreinclude command in EXEC mode.
{ moreurl | includeregular-expression }
Syntax Description
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.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the morenvram:startup-config|includecommand. It only displays lines that contain the regular expression “ip.”
router# more nvram:startup-config | include ip
ip subnet-zero
ip domain-name cisco.com
ip name-server 198.92.30.32
ip name-server 171.69.2.132
description ip address 172.21.53.199 255.255.255.0
ip address 172.21.53.199 255.255.255.0
Related Commands
Command
Description
more<url>begin
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
more<url>exclude
Filters more command output so that it excludes lines that contain a particular regular expression.
show<command>begin
Searches the output of any show command and displays the output from the first instance of a specified string.
show<command>exclude
Filters show command output so that it excludes lines that contain a particular regular expression.
show<command>include
Filters show command output so that it displays only lines that contain a particular regular expression.
more flh:logfile
To view the system console output generated during the Flash load helper operation, use the
moreflh:logfileprivileged EXEC command.
moreflh: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.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
If you are a remote Telnet user performing the Flash upgrade without a console connection, this command allows you to retrieve console output when your Telnet connection has terminated due to the switch to the ROM image. The output indicates what happened during the download, and is particularly useful if the download fails.
This command is a form of the
more command. See the
more command for more information.
Examples
The following is sample output from the
moreflh:logfilecommand:
Router# more flh:logfile
%FLH: abc/igs-kf.914 from 172.16.1.111 to flash...
System flash directory:
File
Length Name/status
1 2251320
abc/igs-kf.914
[2251384 bytes used, 1942920 available, 4194304 total]
Accessing file 'abc/igs-kf.914' on 172.16.1.111...
Loading from 172.16.13.111:
Erasing device...... erased
Loading from 172.16.13.111:
- [OK -
2251320/4194304 bytes]
Verifying checksum... OK (0x97FA)
Flash copy took 79292 msecs
%FLH: Re-booting system after download
Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK]
F3: 2183364+67924+259584 at 0x3000060
Restricted Rights Legend
Use, duplication, or disclosure by the Government is
subject to restrictions as set forth in subparagraph
(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.
motd-banner
To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the
motd-banner command in line configuration mode. To suppress the MOTD banners on the specified line or lines, use the
no form of this command.
motd-banner
nomotd-banner
Syntax Description
This command has no arguments or keywords.
Command Default
Enabled on all lines.
Command Modes
Line configuration
Command History
Release
Modification
11.1
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command determines whether the router will display the MOTD banner when an EXEC session is created on the specified line or lines. The MOTD banner is defined with the
bannermotd global configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner on specific lines using the
nomotd-banner line configuration command.
The MOTD banners can also be disabled by the
noexec-banner line configuration command, which disables both MOTD banners and EXEC banners on a line. If the
noexec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the
motd-bannercommand is enabled or disabled. The table below summarizes the effects of the
exec-banner command and the
motd-banner command.
Table 3 Banners Displayed Based On exec-banner and motd-banner Combinations
exec-banner (default)
no exec-banner
motd-banner (default)
MOTD banner
EXEC banner
None
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
noexec-banner command or
nomotd-banner command is configured. The table below summarizes the effects of the
exec-banner command and the
motd-banner command for reverse Telnet connections.
Table 4 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 (default)
MOTD banner
Incoming banner
Incoming banner
no motd-banner
Incoming banner
Incoming banner
Examples
The following example suppresses the MOTD banner on vty lines 0 through 4:
line vty 0 4
no motd-banner
Related Commands
Command
Description
bannerexec
Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.
bannerincoming
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.
bannermotd
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.
name-connection
To assign a logical name to a connection, use the name-connectioncommand in user EXEC mode.
name-connection
Syntax Description
This command has no arguments or keywords.
Command Default
No logical name is defined.
Command Modes
User EXEC
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command can be useful for keeping track of multiple connections.
You are prompted for the connection number and name to assign. The where command displays a list of the assigned logical connection names.
Examples
The following example assigns the logical name blueto the connection:
Router> where
Conn Host Address Byte Idle Conn Name
* 1 doc-2509 172.30.162.131 0 0 doc-2509
Router> name-connection
Connection number: 1
Enter logical name:blue
Connection 1 to doc-2509 will be named "BLUE" [confirm]
Related Commands
Command
Description
where
Lists open sessions associated with the current terminal line.
no menu
To delete a user menu from the configuration file, use the
nomenu command in global configuration mode.
nomenumenu-name
Syntax Description
menu-name
Name of the menu to delete from the configuration file.
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Use this command to remove any
menu commands for a particular menu from the configuration file.
As with all global configuration commands, this command will only effect the startup configuration file when you save the running configuration using the
copyrunning-configstartup-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.
menucommand
Specifies underlying commands for user menus.
menuprompt
Specifies the prompt for a user menu.
menutext
Specifies the text of a menu item in a user menu.
menutitle
Creates a title, or banner, for a user menu.
notify
To enable terminal notification about pending output from other Telnet connections, use the notify command in line configuration mode. To disable notifications, use the noform of this command.
notify
nonotify
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Line configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command sets a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one.
Examples
In the following example, notification of pending output from connections is enabled on virtual terminal lines 0 to 4:
Router(config)# line vty 0 4
Router(config-line)# notify
Related Commands
Command
Description
terminalnotify
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.
notify syslog
To enable the sending of notifications of configuration changes to a remote system message logging (syslog), use the notifysyslog command in configuration change logger configuration mode. To disable the sending of notifications of configuration changes to the syslog, use the form of this command.
notifysyslog
[ contenttype
{ plaintext | xml } ]
nonotifysyslog
[ contenttype
{ plaintext | xml } ]
Syntax Description
contenttype
(Optional) Allows you to choose a format for the configuration change messages that are sent via syslog.
plaintext
(Optional) Specifies that the configuration change messages are sent as plain text.
xml
(Optional) Specifies that the configuration change messages are sent in XML format.
This command was integrated into Cisco IOS Release 12.2(25)S.
12.2(27)SBC
This command was integrated into Cisco IOS Release 12.2(27)SBC.
12.2(33)SRA
The contenttypeplaintext, and xml keywords were added.
12.2(33)SB
This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series.
Cisco IOS XE Release 3.9S
This command was integrated into Cisco IOS XE Release 3.9S.
Usage Guidelines
Enable thenotifysyslog command if you use the syslog to monitor your device. Syslog monitoring prevents the need to gather configuration log information manually.
Examples
The following example shows how to enable the device to send notifications (in XML format) to the syslog:
Device# configure terminal
!
Device(config)# archive
Device(config-archive)# log config
Device(config-archive-log-config)# notify syslog contenttype xml
Device(config-archive-log-config)# end
Related Commands
Command
Description
archive
Enters archive configuration mode.
hidekeys
Suppresses the display of password information in configuration log files.
Specifies the maximum number of entries retained in the configuration log.
showarchivelogconfig
Displays entries from the configuration log.
padding
To set the padding on a specific output character, use thepadding command in line configuration mode. To remove padding for the specified output character, use the no form of this command.
paddingascii-numbercount
nopaddingascii-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.
Command Default
No padding
Command Modes
Line configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Use this command when the attached device is an old terminal that requires padding after certain characters (such as ones that scrolled or moved the carriage). See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters.
Examples
In the following example, the Return (decimal character 13) is padded with 25 NULL bytes on the console line:
Router(config)# line console
Router(config-line)# padding 13 25
Related Commands
Command
Description
terminalpadding
Changes the character padding on a specific output character for the current session.
parity
To define generation of a parity bit, use the parity command in line configuration mode. To specify no parity, use the no form of this command.
parity
{ none | even | odd | space | mark }
noparity
Syntax Description
none
No parity. This is the default.
even
Even parity.
odd
Odd parity.
space
Space parity.
mark
Mark parity.
Command Default
No parity.
Command Modes
Line configuration
Command History
Release
Modification
10.0
This command was introduced.
12.4
This command was modified to enable parity setting on Cisco AS5350 and Cisco AS5400 NextPort lines.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Communication protocols provided by devices such as terminals and modems sometimes require a specific parity bit setting. Refer to the documentation for your device to determine required parity settings.
If you use this command to set parity on Cisco AS5350 and Cisco AS5400 NextPort lines, do not also set parity by means of S-register settings in a modemcap. (A modemcap is a series of parameter settings that are sent to your modem to configure it to interact with a Cisco device in a specified way. Cisco IOS software defines modemcaps that have been found to properly initialize most modems so that they function properly with Cisco routers and access servers.)
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
terminalparity
Defines the generation of the parity bit for the current for the current session and line.
parser cache
To reenable the Cisco software parser cache after disabling it, use the parsercache command in global configuration mode. To disable the parser cache, use the no form of this command.
parsercache
noparsercache
Syntax Description
This command has no arguments or keywords.
Command Default
Parser cache is enabled by default.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.1(5)T
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Cisco IOS XE Release 3.9S
This command was integrated into Cisco IOS XE Release 3.9S.
Usage Guidelines
The Parser Cache feature optimizes the parsing (translation and execution) of Cisco 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 noparsercache command in global configuration mode. To reenable the parser cache after it has been disabled, use the parsercache command.
When the noparsercache 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 Parser Cache feature is disabled:
Device(config)# no parser cache
Related Commands
Command
Description
clearparsercache
Clears the parse cache entries and hit/miss statistics stored for the Parser Cache feature.
showparserstatistics
Displays statistics about the last configuration file parsed and the status of the Parser Cache feature.
parser command serializer
To enable configuration access only to the users holding a configuration lock and to prevent other clients from accessing the running configuration, use the parsercommandserializer command in global configuration mode. To disable this configuration, use the no form of this command.
parsercommandserializer
noparsercommandserializer
Syntax Description
This command has no arguments or keywords.
Command Default
Access is granted only to the user holding the lock.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.2(33)SRE
This command was introduced.
15.1(1)T
This command was included in Cisco IOS Release 15.1(1)T.
Usage Guidelines
The Parser Concurrency and Locking Improvements feature ensures that exclusive access is granted only to a requested process and prevents other users from concurrently accessing the Cisco IOS configuration. That is, it prevents simultaneous execution of two or more commands. Use the parsercommandserializer command to configure the Parser Concurrency and Locking Improvements feature.
Examples
The following example shows how to configure the Parser Concurrency and Locking Improvements feature:
Enables single-user (exclusive) access functionality for the Cisco IOS CLI.
configureterminallock
Locks the running configuration into exclusive configuration mode for the duration of your configuration session.
testparsersession-lock
Tests the behavior of the Parser Concurrency and Locking Improvements feature.
parser config cache interface
To reduce the time required for the command-line interpreter to execute commands that manage the running system configuration files, use the parserconfigcacheinterfacecommand in global configuration mode. To disable the reduced command execution time functionality, use the no form of this command.
parserconfigcacheinterface
noparserconfigcacheinterface
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration (config)
Command History
Release
Modification
12.3(7)T
This command was introduced.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
12.2(27)SBC
This command was integrated into Cisco IOS Release 12.2(27)SBC.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
12.2(33)SB
This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series.
12.2(33)SXI
This command was integrated into Cisco IOS Release 12.2(33)SXI.
Cisco IOS XE Release 3.9S
This command was integrated into Cisco IOS XE Release 3.9S.
Usage Guidelines
Enable the parserconfigcacheinterfacecommand to reduce the execution time required for running configuration management commands such as the showrunning-configuration,writeterminal, and copysystem:running-configuration commands. Information for these configuration management commands is supplied by nonvolatile generation (NVGEN) processes that query the system for configuration details. The parserconfigcacheinterfacecommand is especially useful for managing large system configurations that contain numerous interface configurations.
Once enabled, the command provides faster execution of the NVGEN commands that process the running system configuration by caching interface configurations in system memory, and by retrieving only configuration information that has changed. For this reason, the device on which this command is enabled must have enough memory available to store the interface configuration. For example, if the interface configurations take up 15 KB of memory, using this command would require having an additional 15 KB of memory space available.
The first time you display the configuration file, you will not see much evidence of improvement in performance because the interface cache will be filled up. However, you will notice performance improvements when you enter subsequent NVGEN-type commands such as the showrunning-configuration EXEC command.
Each time the interface configuration is changed, the interface cache is flushed. Entering an NVGEN-type command after modifying the interface configuration will once again not show any performance improvement until the next NVGEN-type command is entered.
Examples
The following example shows how to enable the functionality for reducing the time required for the command-line interpreter to execute commands that manage the running system configuration files:
Device(config)# parser config cache interface
Related Commands
Command
Description
copysystem:running-configuration
Copies the running configuration to another destination.
showrunning-configuration
Displays the configuration currently running on the terminal.
writeterminal
Displays the configuration currently running on the terminal.
parser config partition
To enable configuration partitioning, use the parserconfigpartition command. To disable the partitioning of the running configuration, use the noform of thiscommand.
parserconfigpartition
noparserconfigpartition
Syntax Description
No arguments or keywords.
Command Default
This command is enabled by default.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.2(33)SRB
This command was introduced as part of the Configuration Partitioning feature.
12.2(33)SB
This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series.
12.2(33)SXI
This command was integrated into Cisco IOS Release 12.2(33)SXI.
Cisco IOS XE Release 3.9S
This command was integrated into Cisco IOS XE Release 3.9S.
Usage Guidelines
This command controls (enables or disables) the Configuration Partitioning feature.
Note
This command is not related to disk partitions or disk partitioning.
To display the list of commands that make up the current running configuration for a specific part (“partition”) of the system’s global running configuration, use the showrunning-configpartition command in privileged Exec mode.
The Configuration Partitioning feature uses a small amount of system resources. The noparserconfigpartition command allows you to disable this feature if the feature is not needed on your system.
Note
Only the no form of this command appears in configuration files. To determine if config partitioning is supported on your system and whether it is enabled, use the showrunning-configparser? command.
Examples
The following example shows how to disable partitioning of the system running configuration:
Device> enable
Device# config t
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# no parser config partition
System configured
Related Commands
Command
Description
showrunning-configpartition
Displays the list of commands that make up the current running configuration for a specific part of the system’s global running configuration. When used with the ? CLI help keyword, can also be used to determine the availability and status of the Configuration Partitioning feature.
parser maximum
To specify performance maximums for CLI operations use the parser maximum command in global configuration mode. To clear any previously established maximums, us the No form of the command.
parsermaximum
{ latencylimit | utilizationlimit }
noparsermaximum
{ latency | utilization }
Syntax Description
latency
Specifies the maximum process latency to allow.
limit
Numerical latency between 20 and 200.
utilization
Specifies the maximum CPU utilization to allow.
limit
Numerical CPU utilization between 1 and 100.
Command Default
No performance maximums enabled by default.
Command Modes
Global Configuration
Command History
Release
Modification
15.1(3)T
This command was introduced.
Usage Guidelines
The Parser Maximum feature provides a workaround in the event of a problem with the coding of a protocol, allowing the error to be bypassed untill it can be corrected.
Examples
The following example shows how to impose a latency limit of 100.
Router(config)#paser maximum latency 100
The following example shows how to clear latency limits.
Router(config)#no paser maximum latency
Related Commands
Command
Description
parser cache
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.
partition
To separate Flash memory into partitions on Class B file system platforms, use the
partition command in global configuration mode. To undo partitioning and to restore Flash memory to one partition, use the
no form of this command.
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).
Command Default
Flash memory consists of one partition.
If the partition size is not specified, partitions of equal size are created.
Command Modes
Global configuration
Command History
Release
Modification
10.3
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
For the Cisco 1600 series and Cisco 3600 series routers, to undo partitioning, use the
partitionflash-filesystem:1 or
nopartitionflash-filesystem: command. For other Class B platforms, use either the
partitionflash1 or
nopartitionflash command. If there are files in a partition other than the first, you must use the
eraseflash-filesystem:partition-numbercommand to erase the partition before reverting to a single partition.
When creating two partitions, you must not truncate a file or cause a file to spill over into the second partition.
Note
The partition command will only create 3MB or larger partitions and may not be used if the device memory contains logging persistent files.
Examples
The following example creates two partitions of 4 MB each in Flash memory:
Router(config)# partition flash 2 4 4
The following example divides the Flash memory card in slot 0 into two partitions, each 8 MB in size on a Cisco 3600 series router:
Router(config)#partition slot0: 2 8 8
The following example creates four partitions of equal size in the card on a Cisco 1600 series router:
Router(config)# partition flash: 4
path (archive configuration)
To specify the location and filename prefix for the files in the Cisco configuration archive, use the path command in archive configuration mode. To disable this function, use the no form of this command.
pathurl
nopathurl
Syntax Description
url
URL (accessible by the Cisco file system) used for saving archive files of the running configuration file in the Cisco configuration archive.
Command Default
If this command is not configured, no location or filename prefix is specified for files in the Cisco configuration archive.
Command Modes
Archive configuration (config-archive)
Command History
Release
Modification
12.3(7)T
This command was introduced.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
12.2(28)SB
This command was integrated into Cisco IOS Release 12.2(28)SB.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.2(31)SB2
This command was implemented on the Cisco 10000 series.
12.2(33)SXH
This command was integrated into Cisco IOS Release 12.2(33)SXH.
12.2(33)SB
This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series.
Cisco IOS XE Release 3.9S
This command was integrated into Cisco IOS XE Release 3.9S.
Usage Guidelines
When this command is entered, an archive file of the running configuration is saved when the archiveconfig, write-memory, or copyrunning-configstartup-config command is entered.
URLs are commonly used to specify files or location on the World Wide Web. On Cisco devices, URLs can be used to specify the location of a file or directory on a device or a remote file server. The path command uses a URL to specify the location and filename prefix for the Cisco configuration archive.
The locations or file systems that you can specify in the url argument are as follows:
If your platform has disk0--disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp:
If your platform does not have disk0--ftp:, http:, pram:, rcp:, or tftp:
The colon is required in the location format.
The filename of the first archive file is the filename specified in the url argument followed by -1. The filename of the second archive file is the filename specified in the url argument followed by -2 and so on.
Because some file systems are incapable of storing the date and time that a file was written, the filename of the archive file can contain the date, time, and device hostname. To include the device hostname in the archive file filename, enter the characters $h (for example, disk0:$h). To include the date and time in the archive file filename, enter the characters $t.
When a configuration archive operation is attempted on a local file system, the file system is tested to determine if it is writable and if it has sufficient space to save an archive file. If the file system is read-only or if there is not enough space to save an archive file, an error message is displayed.
If you specify the tftp: file server as the location with the path command, you need to create the configuration file on the TFTP file server and change the file’s privileges before the archiveconfig command works properly.
Examples
The following example of the path command shows how to specify the hostname, date, and time as the filename prefix for which to save archive files of the running configuration. In this example, the time-period command is also configured to automatically save an archive file of the running configuration every 20 minutes.
configure terminal
!
archive
path disk0:$h$t
time-period 20
end
The following is sample output from the showarchive command illustrating the format of the resulting configuration archive filenames.
Device# show archive
There are currently 3 archive configurations saved.
The next archive file will be named routerJan-16-01:12:23.019-4
Archive # Name
0
1 disk0:routerJan-16-00:12:23.019-1
2 disk0:routerJan-16-00:32:23.019-2
3 disk0:routerJan-16-00:52:23.019-3 <- Most Recent
4
5
6
7
8
9
10
11
12
13
14
Examples
The following example shows how to use the path command to specify the TFTP file server, address 10.48.71.226, as the archive configuration location and router-cfg as the configuration filename. First you create the configuration file on the TFTP server and change the file’s privileges, then you can save the configuration file to the configuration archive.
The following example shows the commands to use to create the file and change the file’s privileges on the TFTP server (UNIX commands):
> touchrouter-cfg-1
> chmod777 router-cfg-1
The following example show how to create the configuration archive, save the running configuration to the archive, and display the files in the archive:
configure terminal
!
archive
path tftp://10.48.71.226/router-cfg
exit
exit
!
archive config
Device# show archive
The next archive file will be named tftp://10.48.71.226/router-cfg-2
Archive # Name
0
1 tftp://10.48.71.226/router-cfg-1 <- Most Recent
2
3
4
5
6
7
8
9
10
11
12
13
14
The following is sample output from the showarchive command if you did not create the configuration file on the TFTP server before attempting to archive the current running configuration file:
configure terminal
!
archive
path tftp://10.48.71.226/router-cfg
exit
exit
archive config
Device# show archive
The next archive file will be named tftp://10.48.71.226/router-cfg-1
Archive # Name
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Related Commands
Command
Description
archive
Enters archive configuration mode.
archiveconfig
Saves a copy of the current running configuration to the Cisco configuration archive.
configureconfirm
Confirms replacement of the current running configuration with a saved Cisco configuration file.
configurereplace
Replaces the current running configuration with a saved Cisco configuration file.
maximum
Sets the maximum number of archive files of the running configuration to be saved in the Cisco configuration archive.
showarchive
Displays information about the files saved in the Cisco configuration archive.
time-period
Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco configuration archive.
periodic
To specify a recurring (weekly) time range for functions that support the time-range feature, use the periodic command in time-range configuration mode. To remove the time limitation, use the
no form of this command.
The first occurrence of this argument is the starting day or day of the week that the associated time range is in effect. The second occurrence is the ending day or day of the week the associated statement is in effect.
This argument can be any single day or combinations of days:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday, and
Sunday. Other possible values are:
daily--Monday through Sunday
weekdays--Monday through Friday
weekend--Saturday and Sunday
If the ending days of the week are the same as the starting days of the week, they can be omitted.
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.”
Command Default
No recurring time range is defined.
Command Modes
Time-range configuration (config-time-range)
Command History
Release
Modification
12.0(1)T
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
For Cisco IOS Release 12.2(11)T, IP and Internetwork Packet Exchange (IPX) extended access lists are the only functions that can use time ranges. For further information on using these functions, refer to the
Cisco IOS IP Configuration Guide and the
Cisco IOS AppleTalk and Novell IPX Configuration Guide.
The
periodiccommand is one way to specify when a time range is in effect. Another way is to specify an absolute time period with the
absolute command. Use either of these commands after the
time-range global configuration command, which specifies the name of the time range. Multiple
periodicentries are allowed per
time-range command.
If the end days-of-the-week value is the same as the start value, they can be omitted.
If a
time-range command has both
absolute and
periodic values specified, then the
periodic items are evaluated only after the
absolutestart time is reached, and are not further evaluated after the
absoluteend time is reached.
Note
All time specifications are taken as local time. To ensure that the time range entries take effect at the desired times, you should synchronize the system software clock using Network Time Protocol (NTP).
The table below lists some typical settings for your convenience:
Table 5 Typical Examples of periodic Command Syntax
If you want:
Configure this:
Monday through Friday, 8:00 a.m. to 6:00 p.m. only
periodicweekday8:00to18:00
Every day of the week, from 8:00 a.m. to 6:00 p.m. only
periodicdaily8:00to18:00
Every minute from Monday 8:00 a.m. to Friday 8:00 p.m.
periodicmonday8:00tofriday20:00
All weekend, from Saturday morning through Sunday night
periodicweekend00:00to23:59
Saturdays and Sundays, from noon to midnight
periodicweekend12:00to23:59
Examples
The following example configuration denies HTTP traffic on Monday through Friday from 8:00 a.m. to 6:00 p.m.:
Router# show startup-config
.
.
.
time-range no-http
periodic weekdays 8:00 to 18:00
!
ip access-list extended strict
deny tcp any any eq http time-range no-http
!
interface ethernet 0
ip access-group strict in
.
.
.
The following example configuration permits Telnet traffic on Mondays, Tuesdays, and Fridays from 9:00 a.m. to 5:00 p.m.:
Router# show startup-config
.
.
.
time-range testing
periodic Monday Tuesday Friday 9:00 to 17:00
!
ip access-list extended legal
permit tcp any any eq telnet time-range testing
!
interface ethernet 0
ip access-group legal in
.
.
.
Related Commands
Command
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.
ping
To diagnose basic network connectivity on AppleTalk, ATM, Connectionless Network Service (CLNS), DECnet, IP, Novell IPX, or source-route bridging (SRB) networks, use the
ping command in user EXEC or privileged EXEC mode.
(Optional) Protocol keyword, either
appletalk,
atm,
clns,
decnet,
ipx, or
srb. If a protocol is not specified, a basic ping will be sent using IP (IPv4). For extended options for ping over IP, see the documentation for the
pingip command.
The
pingatminterfaceatm,
pingip,
pingipv6,
pingsna, and
pingvrfcommands are documented separately.
tag
(Optional) Specifies a tag encapsulated IP (tagIP) ping.
host-name
Hostname of the system to ping. If a
host-name or
system-address is not specified at the command line, it will be required in the
ping system dialog.
system-address
Address of the system to ping. If a
host-name or
system-address is not specified at the command line, it will be required in the
ping system dialog.
Command Default
This command has no default values.
Command Modes
User EXEC (>) Privileged EXEC (#)
Command History
Release
Modification
10.0
This command was introduced.
12.0(7)T
The
pingsna command was introduced.
12.1(12c)E
The
pingvrf command was introduced.
12.2(2)T
Support for the IPv6 protocol was added.
12.2(13)T
The
atmprotocol keyword was added.
The following keywords were removed because the Apollo Domain, Banyan VINES, and XNS protocols are no longer supported in Cisco IOS software:
apollo
vines
xns
12.2(28)SB
This command was integrated into Cisco IOS Release 12.2(28)SB.
12.2(25)SG
This command was integrated into Cisco IOS Release 12.2(25)SG.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.2(33)SXH
This command was integrated into Cisco IOS Release 12.2(33)SXH.
Cisco IOS XE Release 2.1
This command was introduced on Cisco ASR 1000 Series Routers.
Usage Guidelines
The
ping command sends an echo request packet to an address then waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. For example, the
pingclns command sends International Organization for Standardization (ISO) CLNS echo packets to test the reachability of a remote router over a connectionless Open System Interconnection (OSI) network.
If you enter the
ping command without any keywords or argument values, an interactive system dialog prompts you for the additional syntax appropriate to the protocol you specify. (See the “Examples” section.)
To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The default escape sequence is
Ctrl-^,
X (Simultaneously press and release the
Ctrl,
Shift, and
6 keys and then press the
X key). The escape sequence will vary depending on your line configuration. For example, another commonly used escape sequence is
Ctrl-c.
The table below describes the test characters sent by the
pingfacility.
Table 6
ping Test Characters
Character
Description
!
Each exclamation point indicates receipt of a reply.
.
Each period indicates that the network server timed out while waiting for a reply.
U
A destination unreachable error protocol data unit (PDU) was received.
C
A reply packet does not validate the reply data, and hence is marked "Corrupted".
Note
This character will only appear if the "validate" option is selected in the ping request.
I
User interrupted test.
M
A destination unreachable error protocol data unit (PDU) was received (Type 3) MTU required but DF bit set (code 4) with the “Next-Hop MTU” set to a non-zero value. If the “Next-hop MTU“ is zero then ‘U’ is printed.
?
Unknown packet type.
&
Packet lifetime exceeded.
Note
Not all protocols require hosts to support pings. For some protocols, the pings are Cisco defined and can be answered only by another Cisco router.
The availability of protocol keywords depends on what protocols are enabled on your system.
Issuing the
ping command in user EXEC mode will generally offer fewer syntax options than issuing the
ping command in privileged EXEC mode.
Examples
After you enter the
ping command in privileged EXEC mode, the system prompts you for a protocol keyword. The default protocol is IP.
If you enter a hostname or address on the same line as the
ping command, the default action is taken as appropriate for the protocol type of that name or address.
The following example is sample dialog from the
ping command using default values. The specific dialog varies somewhat from protocol to protocol.
Router# ping
Protocol [ip]:
Target IP address: 192.168.7.27
Repeat count [5]:
Datagram size [100]:
Timeout in seconds [2]:
Extended commands [n]:
Sweep range of sizes [n]:
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:
!!!!!
Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms
The table below describes the significant fields shown in the display.
Table 7
ping Field Descriptions for IP
Field
Description
Protocol [ip]:
Prompt for a supported protocol. Default:
ip.
Target IP address:
Prompt for the IP address or hostname of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here. Default: none.
Repeat count [5]:
Number of ping packets that will be sent to the destination address. Default: 5.
Datagram size [100]:
Size of the ping packet (in bytes). Default: 100 bytes.
Timeout in seconds [2]:
Timeout interval. Default: 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 maximum transmission units (MTUs) configured on the nodes along the path to the destination address. Packet fragmentation contributing to performance problems can then be reduced.
!!!!!
Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.
Success rate is 100 percent
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
Round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds).
The following example verifies connectivity to the neighboring ATM device for the ATM permanent virtual circuit (PVC) with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16:
Router# ping
Protocol [ip]:atm
ATM Interface:atm1/0
VPI value [0]:
VCI value [1]:16
Loopback - End(0), Segment(1) [0]:1
Repeat Count [5]:
Timeout [2]:
Type escape sequence to abort.
Sending 5, 53-byte segment OAM echoes, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/1 ms
The table below describes the default
ping fields shown in the display.
Table 8
ping Field Descriptions for ATM
Field
Description
Protocol [ip]:
Prompt for a supported protocol. Default:
ip.
ATM Interface:
Prompt for the ATM interface.
VPI value [0]:
Prompt for the virtual path identifier. Default: 0.
VCI value [1]:
Prompt for the virtual channel identifier. Default:1.
Loopback - End(0), Segment(1) [0]:
Prompt to specify end loopback, which verifies end-to-end PVC integrity, or segment loopback, which verifies PVC integrity to the neighboring ATM device. Default: segment loopback.
Repeat Count [5]:
Number of ping packets that will be sent to the destination address. Default: 5.
Timeout [2]:
Timeout interval. Default: 2 (seconds).
!!!!!
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
Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic.
round-trip min/avg/max = 1/1/1 ms
Round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds).
Related Commands
Command
Description
pingatminterfaceatm
Tests the connectivity of a specific PVC.
pingip
Tests network connectivity on IP networks.
pingipv6
Tests the connection to a remote host on the network using IPv6.
pingsna
Tests network integrity and timing characteristics over an SNA Switching network.
pingvrf
Tests the connection in the context of a specific VPN (VRF).
ping (privileged)
To diagnose basic network connectivity on Apollo, AppleTalk,
Connectionless Network Service (CLNS), DECnet, IP, Novell IPX, VINES, or XNS
networks, use the
pingcommand in privileged EXEC command mode.
(Optional) Protocol to use for the ping. Valid values are:
apollo,
appletalk,
clns,
decnet,
ethernet,
ip,
ipv6,
ipx,
srb,
vines,
xns.
tag
(Optional) Specifies a tag encapsulated IP ping.
data
(Optional) Specifies the data pattern.
hex-data-pattern
(Optional) Hexidecimal value of the data in the range of 0
to FFFF.
df-bit
(Optional) Enables the “do not fragment” bit in the IP
header.
repeat
(Optional) Specifies the number of times the ping should be
sent.
repeat-count
(Optional) Integer in the range of 1 to 2147483647. The
default is 5.
size
(Optional) Size, in bytes, of the ping datagram.
datagram-size
(Optional) Integer in the range of 40 to 18024.
source
(Optional) Device sending the ping
source-address
(Optional) Address or name of the device sending the ping.
async
(Optional) Asynchronous interface.
bvi
(Optional) Bridge-Group Virtual interface.
ctunnel
(Optional) CTunnel interface.
dialer
(Optional) Dialer interface.
ethernet
(Optional) Ethernet IEEE 802.3 interface.
fastethernet
(Optional) FastEthernet IEEE 802.3 interface.
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) Pragmatic General Multicast (PGM) 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.
seconds
(Optional) Integer in the range of 0 to 3600. The default
is 2.
validate
(Optional) Validates the reply data.
Command Default
A ping operation is not performed.
Command Modes
Privileged EXEC
Command History
Release
Modification
10.0
This command was introduced.
12.0
The following keywords were added in Cisco IOS Release
12.0:
data,
df-bit,
repeat,
size,
source,
timeout,
validate.
12.2(33)SRA
The ethernet option for protocol was added in Cisco IOS
Release 12.2(33)SRA.
Usage Guidelines
The
ping (packet internet groper) command tests
the reachability of a remote router over a connectionless Open System
Interconnection (OSI) network. The command sends ISO CLNS echo packets to an
address and waits for a reply. Ping output can help you evaluate path-to-host
reliability, delays over the path, and whether the host can be reached or is
functioning.
When you type the
ping command, you are prompted to enter
options before the
ping command executes. The characters in
brackets ([]) indicate default values. When you want to use a default value,
press Enter on your keyboard.
If you enter a hostname or system address when you enter the
ping command, the default action is taken for
the protocol type of that hostname or system address.
The optional
data,
df-bit,
repeat,
size,
source,
timeout, and
validate keywords can be used to prevent
extended
ping command output. You can use as many of
these keywords as you need, and you can use them in any order after the
hostname or
system-address arguments.
When you enter the
ethernet protocol option, you will be
prompted to enter MAC address and maintenance domain in addition to the
information common across protocols.
To terminate a ping session before it completes, type the escape
sequence (Ctrl-^ X) by simultaneously pressing and releasing the Ctrl, Shift,
and 6 keys and then pressing the X key.
Note
Not all protocols require hosts to support pings. For some
protocols, the pings are defined by Cisco and answered only by a Cisco router.
The table below describes the test characters that the ping operation
uses.
Table 9 ping Command Response Characters and Their
Meanings
Character
Description
!
Receipt of a reply.
.
Network server timed out while waiting for a reply.
U
Destination unreachable error protocol data unit (PDU) was
received.
C
A reply packet does not validate the reply data, and hence is
marked "Corrupted".
Note
This character will only appear if the
"validate" option is selected in the ping request.
I
User interrupted test.
?
Unknown packet type.
&
Packet lifetime exceeded.
Examples
The following example shows a
ping command and output. The precise dialog
varies from protocol to protocol, but all are similar to the ping session shown
here using default values.
Router#
ping
Protocol [ip]:
Target IP address: 192.168.7.27
Repeat count [5]:
Datagram size [100]:
Timeout in seconds [2]:
Extended commands [n]:
Sweep range of sizes [n]:
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:
!!!!
Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms
The following example shows how to send a ping specifying the
ethernet protocol option, MAC address, and
maintenance domain and using the default values for the remaining parameters:
(Optional) Specifies the data pattern. Range is from 0 to FFFF.
df-bit
(Optional) Enables the “do-not-fragment” bit in the IP header.
repeatrepeat-count
(Optional) Specifies the number of pings sent. The range is from 1 to 2147483647. The default is 5.
tosservice value
(Optional) Specifies the type of service value. The range is from 1 to 255.
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 source interface.
source-address
(Optional) IP address to use as the source in the ping packets.
source-interface
(Optional) Name of the interface from which the ping should be sent, and the Interface ID (slot/port/number). Interface name keywords include the following:
async ( Asynchronous Interface)
bvi ( Bridge-Group Virtual Interface)
ctunnel
dialer
ethernet
fastEthernet
lex
loopback
multilink ( Multilink-group interface)
null
port-channel ( Ethernet channel of interfaces)
tunnel
vif ( PGM Multicast Host interface)
virtual-template
virtual-tokenring
xtagatm (Extended Tag ATM interface)
The availability of these keywords depends on your system hardware.
timeoutseconds
(Optional) Specifies the timeout interval in seconds. The default is 2 seconds. Range is from 0 to 3600.
validate
(Optional) Validates the reply data.
verbose
(Optional) Enables verbose output, which lists individual ICMP packets, as well as Echo Responses.
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.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
15.2(02)S
The
tos keyword was added.
Usage Guidelines
The
ping command sends an echo request packet to an address, then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.
To abnormally terminate a ping session, type the escape sequence--by default,Ctrl-^X. You type the default by simultaneously pressing and releasing the
Ctrl,
Shift, and
6 keys, and then pressing the
X key.
The table below describes the test characters that the ping facility sends.
Table 10 ping Test Characters
Character
Description
!
Each exclamation point indicates receipt of a reply.
.
Each period indicates that the network server timed out while waiting for a reply.
U
A destination unreachable error protocol data unit (PDU) was received.
C
A reply packet does not validate the reply data, and hence is marked "Corrupted".
Note
This character will only appear if the "validate" option is selected in the ping request.
I
User interrupted test.
?
Unknown packet type.
&
Packet lifetime exceeded.
Note
Not all protocols require hosts to support pings. For some protocols, the pings are Cisco-defined and are only answered by another Cisco router.
Examples
After you enter the
ping command in privileged mode, the system prompts you for a protocol keyword.The default protocol is IP.
If you enter a host name or address on the same line as the
ping command, the default action is taken as appropriate for the protocol type of that name or address.
The optional
data,
df-bit,
repeat,
size,
source,
timeout, and
validate keywords can be used to avoid extended
ping command output. You can use as many of these keywords as you need, and you can use them in any order after the
host-name or
system-address arguments.
Although the precise dialog varies somewhat from protocol to protocol, all are similar to the ping session using default values shown in the following output:
Router# ping
Protocol [ip]:
Target IP address: 192.168.7.27
Repeat count [5]:
Datagram size [100]:
Timeout in seconds [2]:
Extended commands [n]:
Sweep range of sizes [n]:
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:
!!!!!
Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms
The table below describes the default
ping fields shown in the display.
Table 11 ping Field Descriptions
Field
Description
Protocol [ip]:
Prompts for a supported protocol. 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 p eriod ( .) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.
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).
Related Commands
Command
Description
pingipv6
Tests the connection to a remote host on the network using IPv6.
pingvrf
Tests the connection in the context of a specific VPN (VRF).
ping srb
To test network connectivity for Source Route Bridging (SRB) networks, use the pingsrb command in privileged EXEC mode.
pingsrbname
Syntax Description
name
Destination IP address or hostname.
Command Modes
Privileged EXEC (#)
Command History
Release
Modification
15.0(1)M
This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.
12.2(33)SRE
This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRE.
12.2(33)SXI
This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI.
Cisco IOS XE Release 2.1
This command was integrated into Cisco IOS XE Release 2.1 and implemented on the Cisco ASR 1000 Series Aggregation Services Routers.
Examples
The following example shows how to ping the target host of IP address 192.0.2.1:
Router# ping srb 192.0.2.1
Related Commands
Command
Description
pingip
Tests network connectivity on IP networks.
ping vrf
To test a connection in the context of a specific VPN connection, use the
pingvrf command in user EXEC or privileged EXEC mode.
(Optional) Specifies a tag encapsulated IP (tagIP) ping.
connection
(Optional) Connection options include
atm,
clns,
decnet,
ip,
ipv6,
ipx,
sna, or
srb. The default is
ip.
target-address
The destination ID for the ping operation. Usually, this is the IPv4 address of the host. For example, the target for an IPv4 ping in a VRF context would be the IPv4 address or domain name of the target host. The target for an IPv6 ping in a VRF context would be the IPv6 prefix or domain name of the target host.
If the target address is not specified, the CLI will enter the interactive dialog for ping.
connection-options
(Optional) Each connection type may have its own set of connection options. For example, connection options for IPv4 are
source,
df-bit, and
timeout. See the appropriate
ping command documentation for details.
Command Default
The default connection type for ping is IPv4.
Command Modes
User EXEC
Privileged EXEC
Command History
Release
Modification
12.1(12c)E, 12.2
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.2(33)SB
This command was integrated into Cisco IOS Release 12.2(33)SB.
12.2(33)SXI
This command was integrated into Cisco IOS Release 12.2(33)SXI.
12.2(33)SCF
This command was integrated into Cisco IOS Release 12.2(33)SCF.
Usage Guidelines
A VPN routing and forwarding (VRF) instance is used to identify a VPN. To check if a configured VRF is working, you can use the
pingvrf command.
When attempting to ping from a provider edge (PE) router to a customer edge (CE) router, or from a PE router to PE router, the standard
ping command will not usually work. The
pingvrf command allows you to ping the IP addresses of LAN interfaces on CE routers.
If you are on a PE router, be sure to indicate the specific VRF (VPN) name, as shown in the “Examples” section.
If all required information is not provided at the command line, the system will enter the interactive dialog (extended mode) for ping.
Examples
In the following example, the target host in the domain 209.165.201.1 is pinged (using IP/ICMP) in the context of the “CustomerA” VPN connection.
Router# ping vrf CustomerA 209.165.201.1
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 209.165.201.1, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 176/264/576 ms
Pressing the Enter key before providing all of the required options will begin the interactive dialog for ping. In the following example, the interactive dialog is started after the “ip” protocol is specified, but no address is given:
Router# ping vrf CustomerB ip
Target IP address: 209.165.200.225
Repeat count [5]:
Datagram size [100]:
Timeout in seconds [2]:
Extended commands [n]: y
Source address or interface:
Type of service [0]:
Set DF bit in IP header? [no]:
Validate reply data? [no]:
Data pattern [0xABCD]:
Loose, Strict, Record, Timestamp, Verbose[none]: Record
Number of hops [ 9 ]:
Loose, Strict, Record, Timestamp, Verbose[RV]:
Sweep range of sizes [n]:
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 209.165.200.225, timeout is 2 seconds:
Packet has IP options: Total option bytes= 39, padded length=40
Record route: <*>
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
(0.0.0.0)
.
.
.
Success rate is 100 percent (5/5), round-trip min/avg/max = 4/4/4 ms
The following example shows the various options for IP in the
pingvrf command:
Router# show parser dump exec | include ping vrf
1 ping vrf <string>
1 ping vrf <string> ip <string>
1 ping vrf <string> ip (interactive)
1 ping vrf <string> ip <string>
1 ping vrf <string> ip <string> source <address>
1 ping vrf <string> ip <string> source <interface>
1 ping vrf <string> ip <string> repeat <1-2147483647>
1 ping vrf <string> ip <string> size Number
1 ping vrf <string> ip <string> df-bit
1 ping vrf <string> ip <string> validate
1 ping vrf <string> ip <string> data <0-65535>
1 ping vrf <string> ip <string> timeout <0-3600>
1 ping vrf <string> ip <string> verbose
1 ping vrf <string> ip <string> data <0-65535>
1 ping vrf <string> ip <string> timeout <0-3600>
1 ping vrf <string> tag
1 ping vrf <string> atm
1 ping vrf <string> ipv6
1 ping vrf <string> appletalk
1 ping vrf <string> decnet
1 ping vrf <string> clns
1 ping vrf <string> ipx
1 ping vrf <string> sna
1 ping vrf <string> srb
Cisco CMTS Routers: Example
The following example shows how to verify the matching and marking configuration in an MPLS network:
Router# ping vrf vrfa 1.3.99.98
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 1.3.99.98, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 8/10/20 ms
Related Commands
Command
Description
ping
Diagnoses basic network connectivity to a specific host.
pingatminterfaceatm
Tests the connectivity of a specific PVC.
pingip
Tests the connection to a remote host on the network using IPv4.
pingipv6
Tests the connection to a remote host on the network using IPv6.
pingsna
Tests network integrity and timing characteristics over an SNA Switching network.
platform shell
To grant shell access and enter shell access grant configuration mode, use the platformshellcommand in global configuration mode. To disable this function, use the no form of this command.
platformshell
noplatformshell
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled.
Command Modes
Global configuration (config)
Command History
Release
Modification
12.2(33)XNC
Usage Guidelines
This command should be entered before using the request platform software system shell command.
Examples
The following example shows how to grant shell access:
Router(config)# platform shell
Router(config)#
Related Commands
Command
Description
requestplatformsoftwaresystemshell
Requests platform shelll access.
power enable
To turn on power for the modules, use the
powerenablecommand in global configuration mode. To power down a module, use the
no form of this command.
powerenablemoduleslot
nopowerenablemoduleslot
Syntax Description
moduleslot
Specifies a module slot number; see the “Usage Guidelines” section for valid values.
Command Default
Enabled
Command Modes
Global configuration
Command History
Release
Modification
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 Release 12.2(17d)SXB.
12.2(18)SXD
This command was changed to allow you to disable power to empty slots.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
When you enter the
nopowerenablemoduleslot command to power down a module, the module’s configuration is not saved.
When you enter the
nopowerenablemoduleslot command to power down an empty slot, the configuration is saved.
The
slot argument designates the module number. Valid values for
slotdepend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13.
Examples
This example shows how to turn on the power for a module that was previously powered down:
Router(config)#
power enable module 5
Router(config)#
This example shows how to power down a module:
Router(config)#
no power enable module 5
Router(config)#
Related Commands
Command
Description
showpower
Displays information about the power status.
power redundancy-mode
To set the power-supply redundancy mode, use the
powerredundancy-mode command in global configuration mode.
powerredundancy-mode
{ combined | redundant }
Syntax Description
combined
Specifies no redundancy (combine power-supply outputs).
redundant
Specifies redundancy (either power supply can operate the system).
Command Default
redundant
Command Modes
Global configuration
Command History
Release
Modification
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 Release 12.2(17d)SXB.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Examples
This example shows how to set the power supplies to the no-redundancy mode:
Router(config)#
power redundancy-mode combined
Router(config)#
This example shows how to set the power supplies to the redundancy mode:
Router(config)#
power redundancy-mode redundant
Router(config)#
Related Commands
Command
Description
showpower
Displays information about the power status.
printer
To configure a printer and assign a server tty line (or lines) to it, use the
printercommand in global configuration mode. To disable printing on a tty line, use the
no form of this command.
Thenumberargument can be any one of the following parameters:
aux--Specifies the auxiliary line.
console--Specifies the primary terminal line.
slot/port--First slot and port numbers for the internal modems.
ttynumber--Specifies the terminal controller value.
tty-number--tty number, in the range 0 to 491.
vtyvalue--Specifies the virtual terminal value.
rotarynumber
Assigns a rotary group of tty lines to the printer.
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.
jobtimeoutseconds
(Optional) Changes the default time for line acquisition. The range is from 1 to 3600 seconds.
newline-convert
(Optional) Converts newline (linefeed) characters to a two-character sequence “carriage-return, linefeed” (CR+LF).
jobtypestype
(Optional) Specifies allowed job types.
Command Default
No printers are defined.
Command Modes
Global configuration (config)
Command History
Release
Modification
10.3
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
15.0(1)M
This command was modified in a release earlier than Cisco IOS Release 15.0(1)M. The
jobtimeoutseconds and
jobtypestype keywords and arguments were added.
Usage Guidelines
This command enables you to configure a printer for operations and assign either a single tty line or a group of tty lines to it. To make multiple printers available through the same printer name, specify the number of a rotary group.
In addition to configuring the printer with the
printer command, you must modify the file /etc/printcap on your UNIX system to include the definition of the remote printer in the Cisco IOS software. Refer to the
Cisco IOS Configuration Fundamentals Configuration Guide for additional information.
Use the optional
newline-convert keyword in UNIX environments that cannot handle single-character line terminators. This converts newline characters to a carriage-return, linefeed sequence. Use the
formfeed keyword when using the line printer daemon (lpd) protocol to print and your system is unable to separate individual output jobs with a form feed (page eject). You can enter the
newline-convert and
formfeed keywords together and in any order.
Examples
The following example shows how to configure a printer named printer1 and to assign the output to tty line 4:
Router# configure terminal
Router(config)# printer printer1 line 4
Related Commands
Command
Description
clearline
Returns a terminal line to idle state.
private
To save user EXEC command changes between terminal sessions, use the private command in line configuration mode. To restore the default condition, use the no form of this command.
private
noprivate
Syntax Description
This command has no arguments or keywords.
Command Default
User-set configuration options are cleared with the exit EXEC command or when the interval set with the exec-timeout line configuration command has passed.
Command Modes
Line configuration
Command History
Release
Modification
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command ensures that the terminal parameters set by the user remain in effect between terminal sessions. This behavior is desirable for terminals in private offices.
Examples
In the following example, line 15 (in this example, vty 1) is configured to keep all user-supplied settings at system restarts:
Router(config)# line 15
Router(config-line)# private
Related Commands
Command
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.
process cpu statistics limit entry-percentage
To set the process entry limit and the size of the history table for CPU utilization statistics, use the processcpustatisticslimitentry-percentage command in global configuration mode. To disable CPU utilization statistics, use the no form of this command.
Integer from 1 to 100 that indicates the percentage of CPU utilization that a process must use to become part of the history table.
sizeseconds
(Optional) Changes the duration of time in seconds for which CPU statistics are stored in the history table. Valid values are 5 to 86400. The default is 600.
Command Default
size seconds: 600 seconds
Command Modes
Global configuration
Command History
Release
Modification
12.0(26)S
This command was introduced.
12.3(4)T
This command was integrated into Cisco IOS Release 12.3(4)T.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
Usage Guidelines
Use the processcpustatisticslimitentry-percentage command to set the entry limit and size of CPU utilization statistics.
Examples
The following example shows how to set an entry limit at 40 percent and a size of 300 seconds:
configure terminal
!
process cpu statistics limit entry-percentage 40 size 300
end
Related Commands
Command
Description
processcputhresholdtype
Defines CPU usage thresholds that, when crossed, cause a CPU threshold notification.
snmp-serverenabletrapscpu
Enables CPU threshold violations traps.
snmp-serverhost
Specifies the recipient of SNMP notifications.
process cpu threshold type
To set CPU thresholding notification types and values, use the processcputhresholdtype command in global configuration mode. To disable CPU thresholding notifications, use the no form of this command.
processcputhresholdtype
{ total | process | interrupt }
risingpercentageintervalseconds
[ fallingfall-percentageintervalseconds ]
noprocesscputhresholdtype
{ total | process | interrupt }
Syntax Description
total
Sets the CPU threshold type to total CPU utilization.
process
Sets the CPU threshold type to CPU process utilization.
interrupt
Sets the CPU threshold type to CPU interrupt utilization.
risingpercentage
The percentage (1 to 100) of CPU resources that, when exceeded for the configured interval, triggers a CPU thresholding notification.
intervalseconds
The duration of the CPU threshold violation, in seconds (5 to 86400), that must be met to trigger a CPU thresholding notification.
fallingfall-percentage
(Optional) The percentage (1 to 100) of CPU resources that, when usage falls below this level for the configured interval, triggers a CPU thresholding notification.
This value must be equal to or less than the risingpercentage value.
If not specified, the fallingfall-percentage value is set to the same value as the risingpercentage value.
Command Default
CPU thresholding notifications are disabled.
Command Modes
Global configuration
Command History
Release
Modification
12.0(26)S
This command was introduced.
12.3(4)T
This command was integrated into Cisco IOS Release 12.3(4)T.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
Usage Guidelines
This command defines CPU usage thresholds that, when crossed, cause a CPU thresholding notification. When this command is enabled, Cisco IOS software polls the system at the configured interval. Notification occurs in two situations:
When a configured CPU usage threshold is exceeded (risingpercentage)
When CPU usage falls below the configured threshold (fallingfall-percentage)
Examples
The following example shows how to set the total CPU utilization notification threshold at 80 percent for a rising threshold notification and 20 percent for a falling threshold notification, with a 5-second polling interval:
configure terminal
!
process cpu threshold type total rising 80 interval 5 falling 20 interval 5
end
Related Commands
Command
Description
processcpustatisticslimitentry
Sets the entry limit and size of CPU utilization statistics.
snmp-serverenabletrapscpu
Enables CPU threshold violations traps.
snmp-serverhost
Specifies the recipient of SNMP notifications.
process-max-time
To configure the amount of time after which a process should voluntarily yield to another process, use the process-max-timecommand in global configuration mode. To reset this value to the system default, use the no form of this command.
process-max-timemilliseconds
noprocess-max-timemilliseconds
Syntax Description
milliseconds
Maximum duration (in milliseconds) that a process can run before suspension. The range is from 20to 200 milliseconds.
Command Default
The default maximum process time is 200 milliseconds.
Command Modes
Global configuration
Command History
Release
Modification
12.1
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Lowering the maximum time a process can run is useful in some circumstances to ensure equitable division of CPU time among different tasks.
Only use this command if recommended to do so by the Cisco Technical Assistance Center (TAC).
Examples
The following example limits the duration that a process will run to 100 milliseconds:
Router(config)# process-max-time 100
prompt
To customiz e the CLI prompt, use the
promptcommand in global configuration mode. To revert to the default prompt, use the
noform of this command.
promptstring
noprompt [string]
Syntax Description
string
Text that will be displayed on screen as the CLI prompt, including any desired prompt variables.
Command Default
The default prompt is either Router or the name defined with the
hostname global configuration command, followed by an angle bracket (>) for user EXEC mode or a pound sign (#) for privileged EXEC mode.
Command Modes
Global configuration
Command History
Release
Modification
10.3
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
You can include customized variables when specifying the prompt. All prompt variables are preceded by a percent sign (%). The table below lists the available prompt variables.
Table 12 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
noprompt command.
Examples
The following example changes the EXEC prompt to include the tty number, followed by the name and a space:
Router(config)# prompt TTY%n@%h%s%p
The following are examples of user and privileged EXEC prompts that result from the previous command:
TTY17@Router1 > enable
TTY17@Router1 #
Related Commands
Command
Description
hostname
Specifies or modifies the host name for the network server.
prompt config
To configure the system’s prompt for configuration mode, use the promptconfig command in global configuration mode. To disable the configuration, use the no form of this command.
promptconfighostname-lengthnumber
noprompt [config]
Syntax Description
hostname-length
Sets the length of the hostname in the configuration prompt.
number
Maximum length of the hostname. The range is from 0 to 80.
Command Default
The system's prompt is not configured for configuration mode.
Command Modes
Global configuration (config)
Command History
Release
Modification
15.0(1)M
This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M.
Examples
This example shows how to configure the system’s prompt for configuration mode:
Router(config)#
prompt config hostname-length 4
Related Commands
Command
Description
prompt
Customizes the CLI prompt.
pwd
To show the current setting of the cd command, use the pwd command in EXEC mode.
pwd
Syntax Description
This command has no arguments or keywords.
Command Modes
User EXEC
Priviledged EXEC
Command History
Release
Modification
11.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Use the pwd command to show which
directory or file system is specified as the default by the cd command. For all EXEC commands that have an optional filesystemargument, the system uses the file system specified by the cd command when you omit the optional filesystemargument.
For example, the dir command contains an optional filesystemargument and displays a list of files on a particular file system. When you omit this filesystemargument, the system shows a list of the files on the file system specified by the cd command.
Examples
The following example shows that the present working file system specified by the cd command is slot 0:
Router> pwd
slot0:/
The following example uses the cd command to change the present file system to slot 1 and then uses the pwd command to display that present working file system: