Cisco IOS Configuration Fundamentals Command Reference

monitor event-trace (EXEC)

To monitor and control the event trace function for a specified Cisco IOS software subsystem component, use the monitor event-trace command in privileged EXEC mode.

monitor event-trace component {clear | continuous | disable | dump [pretty] | enable | one-shot}

Cisco 10000 Series Routers

monitor event-trace component {disable | dump | enable | size | stacktrace}

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

monitor event-trace all-traces {continuous [cancel] | du [merged] [pretty]}

monitor event-trace l3 {clear | continuous [cancel] | disable | dump [pretty] | enable | interface type mod/port | one-shot}

monitor event-trace spa {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot}

monitor event-trace subsys {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot}

Syntax Description

Command Default

The event trace function is disabled by default.

Command Modes

Privileged EXEC (#)

Command History

Usage Guidelines

Use the monitor event-trace command to control what, when, and how event trace data is collected. Use this command after you have configured the event trace functionality on the networking device using the monitor event-trace command in global configuration mode.

Note The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace command in global configuration mode for each instance of a trace.

The Cisco IOS software allows for the subsystem components to define whether support for event tracing is enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the monitor event-trace command in privileged EXEC mode or using the monitor event-trace command in global configuration mode. To disable event tracing, you would enter either of these commands with the disable keyword. To enable event tracing again, you would enter either of these commands with the enable keyword.

To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? command to get a list of software components that support event tracing. To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to display trace messages.

Use the show monitor event-trace command to display trace messages. Use the monitor event-trace component dump command to save trace message information for a single event. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace component dump pretty command.

To write the trace messages for all events currently enabled on a networking device to a file, enter the monitor event-trace dump command.

To configure the file where you want to save trace information, use the monitor event-trace command in global configuration mode. The trace messages are saved in a binary format.

Examples

The following example shows the privileged EXEC commands to stop event tracing, clear the current contents of memory, and reenable the trace function for the interprocess communication (IPC) component. This example assumes that the tracing function is configured and enabled on the networking device.

Router# monitor event-trace ipc disable 

Router# monitor event-trace ipc clear 

Router# monitor event-trace ipc enable 

The following example shows how the monitor event-trace one-shot command accomplishes the same function as the previous example except in one command. In this example, once the size of the trace message file has been exceeded, the trace is terminated.

Router# monitor event-trace ipc one-shot 

The following example shows the command for writing trace messages for an event in binary format. In this example, the trace messages for the IPC component are written to a file.

Router# monitor event-trace ipc dump 

The following example shows the command for writing trace messages for an event in ASCII format. In this example, the trace messages for the MBUS component are written to a file.

Router# monitor event-trace mbus dump pretty 

Catalyst 6500 Series Switches and Cisco 7600 Series Routers Examples Only

This example shows how to stop event tracing, clear the current contents of memory, and reenable the trace function for the SPA component. This example assumes that the tracing function is configured and enabled on the networking device.

Router# monitor event-trace spa disable 

Router# monitor event-trace spa clear 

Router# monitor event-trace spa enable 

Related Commands

monitor event-trace (global)

To configure event tracing for a specified Cisco IOS software subsystem component, use the monitor event-trace command in global configuration mode.

monitor event-trace component {disable | dump-file filename | enable | size number | stacktrace number}

monitor event-trace timestamps [datetime [localtime] [msec] [show-timezone] | uptime]

Cisco 10000 Series Routers

monitor event-trace component {disable | dump-file filename | enable | clear | continuous | one-shot}

Syntax Description

Command Default

Event tracing is enabled or disabled depending on the software component.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

Use the monitor event-trace command to enable or disable event tracing and to configure event trace parameters for Cisco IOS software subsystem components.

Note Event tracing is intended for use as a software diagnostic tool and should be configured only under the direction of a Technical Assistance Center (TAC) representative. In Cisco IOS software images that do not provide subsystem support for the event trace function, the monitor event-trace command is not available.

The Cisco IOS software allows the subsystem components to define whether support for event tracing is enabled or disabled by default. The command interface for event tracing allows you to change the default two ways: using the monitor event-trace command in privileged EXEC mode or using the monitor event-trace command in global configuration mode.

Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the monitor event-trace component enable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a command entry in the configuration file.

Note The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace command for each instance of a trace.

To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? command to get a list of software components that support event tracing.

To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to display trace messages.

To specify the trace call stack at tracepoints, you must first clear the trace buffer.

Examples

The following example shows how to enable event tracing for the interprocess communication (IPC) subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to ipc-dump in slot0 (flash memory).

configure terminal

!

monitor event-trace ipc enable

monitor event-trace ipc dump-file slot0:ipc-dump 

monitor event-trace ipc size 4096

When you select Cisco Express Forwarding as the component for which to enable event tracing, you can use the following additional arguments and keywords: monitor event-trace cef [events | interface | ipv6 | ipv4][all]. The following example shows how to enable event tracing for IPv4 or IPv6 events of the Cisco Express Forwarding component in Cisco IOS software:

configure terminal

!

monitor event-trace cef ipv4 enable

configure terminal

!

monitor event-trace cef ipv6 enable

exit

The following example shows what happens when you try to enable event tracing for a component (in 
this case, adjacency events) when it is already enabled: 

configure terminal

!

monitor event-trace adjacency enable

%EVENT_TRACE-6-ENABLE: Trace already enabled.

Related Commands

monitor event-trace dump-traces

To save trace messages for all event traces currently enabled on the networking device, use the monitor event-trace dump-traces command in privileged EXEC mode.

monitor event-trace dump-traces [pretty]

Syntax Description

Command Modes

Privileged EXEC

Command History

Usage Guidelines

Use the monitor event-trace dump-traces command to save trace message information for all event traces currently enabled on a networking device. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace dump-traces pretty command.

To write the trace messages for an individual trace event to a file, enter the monitor event-trace (EXEC) command.

To configure the file where you want to save messages, use the monitor event-trace (global) command.

Examples

The following example shows how to save the trace messages in binary format for all event traces enabled on the networking device.

monitor event-trace dump-traces 

The following example shows how to save the trace messages in ASCII format for all event traces enabled on the networking device.

monitor event-trace dump-traces pretty

Related Commands

monitor event-trace gdoi (global)

To configure event tracing for the Group Domain of Interpretation (GDOI) software subsystem component, use the monitor event-trace gdoi command in global configuration mode.

monitor event-trace gdoi [coop | infra | registration | rekey] {disable | dump-file filename | enable | size number | stacktrace number}

Syntax Description

Command Default

Event tracing is disabled.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

Use the monitor event-trace gdoi command to enable or disable event tracing for GDOI and to configure event trace parameters for the Cisco IOS software GDOI subsystem component.

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.

Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the monitor event-trace component enable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a command entry in the configuration file.

Note The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace gdoi command for each instance of a trace.

To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace gdoi 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 GDOI subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to gdoi-dump in slot0 (flash memory).

configure terminal

!

monitor event-trace gdoi enable

monitor event-trace gdoi dump-file slot0:gdoi-dump 

monitor event-trace gdoi size 4096

Related Commands

monitor pcm-tracer capture-destination

To configure a location to save the Pulse Code Modulation (PCM) trace information, use the monitor pcm-tracer capture-destination command in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer capture-destination destination

no monitor pcm-tracer capture-destination

Syntax Description

Command Default

The PCM trace information is saved to the NVRAM.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

You can use the monitor pcm-tracer capture-destination command to specify a location to save the PCM trace information. When Cisco IOS software saves the data to network file systems, such as TFTP and FTP, it assumes the location is valid and has write access.

After the PCM capture is complete, the router automatically copies the captured contents to the specified location. The filename format at the destination location is as follows:

<Configured name>_tx_<DS0 slot>_<DS0 unit>_<DS0 channel>—For TX

<Configured name>_rx_<DS0 slot>_<DS0 unit>_<DS0 channel>—For RX

You can identify the dial feature card (DFC) channel from where the PCM is traced using the filename format.

Consider the following example:

Router(config)# monitor pcm-tracer capture-destination tftp: 
://223.255.254.254/benzeer/cap/cap_data

In this example, two files are created for the data corresponding to each DS0s, one for each direction (transmitter and receiver). When the debug pcmtracer command is enabled, the trace data is copied into the following files:

•cap_data_tx_6_1_22 and cap_data_rx_6_1_22—This corresponds to the traffic flowing through DS0 6/1:22.

•cap_data_tx_6_1_22 and cap_data_rx_6_1_22—cap_data_tx_6_1_22 is the data in the transmit direction (from the DFC to the system backplane) and cap_data_rx_6_1_22 is the data in the receiver direction (to the DFC from the system backplane).

Examples

The following example shows how to configure a router to save the PCM trace information to a flash drive:

Router# configure terminal

Router(config)# monitor pcm-tracer capture-destination flash:

Related Commands

monitor pcm-tracer delayed-start

To configure the delay time to start the Pulse Code Modulation (PCM) trace capture, use the monitor pcm-tracer delayed-start command in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer delayed-start seconds

no monitor pcm-tracer delayed-start

Syntax Description

Command Default

The default delay time is zero.

Command Modes

Global configuration (config)

Command History

Examples

The following example shows how to configure the PCM tracer delay time to 1000 seconds:

Router# configure terminal

Router(config)# monitor pcm-tracer delayed-start 1000

Related Commands

monitor pcm-tracer profile

To create Pulse Code Modulation (PCM) capture profiles, use the monitor pcm-tracer profile command in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer profile profile-number

no monitor pcm-tracer profile profile-number

Syntax Description

Command Default

PCM capture profiles are disabled.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

You must create at least one user profile under the channels that need to be traced. You can create the following profile operations:

•Create a user profile identified by a profile number.

•Add one or more profiles. A user profile consists of capture groups in which the channels that are to be traced are specified.

•Configure one or more capture groups under a profile.

Examples

The following example shows how to create a PCM capture profile with profile number 1:

Router# configure terminal

Router(config)# monitor pcm-tracer profile 1

Related Commands

monitor permit-list

To configure a destination port permit list or add to an existing destination port permit list, use the monitor permit-list command in global configuration mode. To delete from or clear an existing destination port permit list, use the no form of this command.

Activate monitoring

monitor permit-list

no monitor permit-list

Activate monitoring on one port

monitor permit-list destination interface interface-type slot/port

no monitor permit-list destination interface interface-type slot/port

Activate monitoring on one range of ports

monitor permit-list destination interface interface-type slot/port-last-port

no monitor permit-list destination interface interface-type slot/port-last-port

Activate monitoring on two or more ranges of ports

monitor permit-list destination interface interface-type slot/port-last-port , [port-last-port ]

no monitor permit-list destination interface interface-type slot/port-last-port , [port-last-port ]

Syntax Description

Defaults

Disabled

Command Modes

Global configuration

Command History

Usage Guidelines

To prevent accidental configuration of ports as destinations, you can create a permit list of the ports that are valid for use as destinations. With a destination port permit list configured, you can only configure the ports in the permit list as destinations.

When you enter multiple instances of interface interface-type slot/port-last-port, you must enter a space before and after the comma. For example, interface interface-type slot/port-last-port , interface-type slot/port-last-port , interface-type slot/port-last-port.

Examples

This example shows how to configure a destination port permit list that includes Gigabit Ethernet ports 5/1 through 5/4, and activate monitoring:

Router# configure terminal 

Router(config)# monitor permit-list destination interface gigabitethernet 5/1-4

Router(config)# monitor permit-list 

This example shows how to configure a destination port permit list that includes Fast Ethernet ports 1/1-48, 2/1-48, and Gigabit Ethernet ports 3/1 through 3/4, and activate monitoring:

Router# configure terminal 

Router(config)# monitor permit-list destination interface fastEthernet 1/1-48 , 
fastEthernet 2/1-48 , gigabitEthernet 3/1-4

Router(config)# monitor permit-list

Related Commands

monitor session egress replication-mode

To switch the egress-span mode from the default mode (either centralized or distributed depending on your Cisco IOS software release), use the monitor session egress replication-mode command in global configuration mode. To return to the default mode, use the no form of the command.

Cisco IOS Release 12.2(33)SXH2a and Later Releases

monitor session egress replication-mode centralized

no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2

monitor session egress replication-mode distributed

no monitor session egress replication-mode distributed

Syntax Description

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

Usage Guidelines

Note Prior to Cisco IOS Release 12.2(33)SXH and the introduction of this feature, the operating mode was centralized and could not be changed.

Centralized egress span monitoring redirects traffic to the supervisor engine for egress monitoring.

Distributed egress span monitoring is performed in the ingress module. Distributed replication for Switched Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN) increases the total throughput at the span destination.

Note Distributed egress span (DES) mode is applied to ASIC-based sessions only.

Examples

Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2

The following example shows how to switch the egress-span mode from the distributed default to centralized mode:

Router(config)# monitor session egress replication-mode centralized

The following example shows how to switch the egress-span mode from centralized back to distributed mode:

Router(config)# no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH2a and Later Releases

The following example shows how to switch the egress-span mode from the centralized default to distributed mode:

Router(config)# monitor session egress replication-mode distributed

The following example shows how to switch the egress-span mode from distributed back to centralized mode:

Router(config)# no monitor session egress replication-mode distributed

Related Commands

monitor session type

To configure a local Switched Port Analyzer (SPAN), RSPAN, or ERSPAN, use the monitor session type command in global configuration mode. To remove one or more source or destination interfaces from the SPAN session, use the no form of this command.

monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx | rspan-destination | rspan-source}

no monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx | rspan-destination | rspan-source}

Syntax Description

Defaults

This command has no default settings.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

Release 12.2(18)SXE and later releases support ERSPAN with the Supervisor Engine 720, hardware revision 3.2 or higher. Enter the show module version | include WS-SUP720-BASE command to display the hardware revision.

ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination session.

This command is not supported on Catalyst 6500 series switches that are configured with a Supervisor Engine 2.

All ERSPAN source sessions on a switch must use the same source IP address. You enter the origin ip address command to configure the IP address for the ERSPAN source sessions.

All ERSPAN destination sessions on a switch must use the same IP address. You enter the ip address command to configure the IP address for the ERSPAN destination sessions. If the ERSPAN destination IP address is not a Supervisor Engine 720 (for example, it is a network sniffer), the traffic arrives with the GRE and RSPAN headers/encapsulation intact.

The ERSPAN source session destination IP address, which must be configured on an interface on the destination switch, is the source of traffic that an ERSPAN destination session sends to the destination ports. You configure the same address in both the source and destination sessions with the ip address command.

The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from different ERSPAN source sessions.

The local ERSPAN session limits are as follows:

•Total sessions—66

•Source sessions—2 (ingress or egress or both)

•Destination sessions—23

The monitor session type command creates a new ERSPAN session or allows you to enter the ERSPAN session configuration mode. ERSPAN uses separate source and destination sessions. You configure the source and destination sessions on different switches. The ERSPAN session configuration mode prompts are as follows:

•Router(config-mon-erspan-src)—Indicates the ERSPAN source session configuration mode.

•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

Table 35 lists the ERSPAN destination session configuration mode syntaxes.

Table 36 lists the ERSPAN source session configuration mode syntaxes.

When you configure the monitor sessions, follow these syntax guidelines:

•erspan-destination-span-session-number can range from 1 to 66.

•single-interface is interface type 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 interface type slot/first-port - last-port .

•mixed-interface-list is, in any order, single-interface , interface-range , ...

•erspan-flow-id can range from 1 to 1023.

When you clear the monitor sessions, follow these syntax guidelines:

•The no monitor session session-number command entered with no other parameters clears the session session-number.

•session-range is first-session-number-last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.

Use the monitor session type local command to configure ingress, egress, or both ingress and egress SPAN sessions.

Use the monitor session type local-tx command to configure egress-only SPAN sessions.

When you enter the local or the local egress-only SPAN session configuration mode, the prompt changes accordingly to Router(config-mon-local)# or Router(config-mon-local-tx)#, and the following commands are available:

•description—Describes the properties for this session using this syntax:

description description

The description can be up to 240 characters and cannot contain special characters or spaces.

•destination—Specifies the destination and the destination properties using this syntax:

destination {analysis-module num | anomaly-detector-module num | interface type number | intrusion-detection-module num}

•exit—Exits from configuration session mode.

•filter vlan vlan-id—Limits the SPAN source traffic to specific VLANs; valid values are from 1 to 4096.

•no—Negates a command or sets its defaults.

•shutdown—Shuts down this session

•source—Specifies the SPAN source interface or VLAN using the following syntax:

source {cpu {rp | sp} | {interface type number} | {intrusion-detection-module num} | {vlan vlan-id}} [, | - | rx | tx | both]

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 monitor session session source vlan vlan-id command.

When you configure the destination, use these guidelines:

•A single-interface is as follows:

–interface type slot/port; type is fastethernet, gigabitethernet, or tengigabitethernet.

–interface port-channel number

Note Destination port channel interfaces must be configured with the channel-group group-num mode on command and the no channel-protocol command.

•An interface-list is single-interface , single-interface , single-interface ...

Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash.

•An interface-range is interface type slot/first-port - last-port.

•A mixed-interface-list is, in any order, single-interface , interface-range , ...

•A single-vlan is the ID number of a single VLAN.

•A single-list is single-vlan , single-vlan , single-vlan ...

•A vlan-range is first-vlan-ID - last-vlan-ID.

•A mixed-vlan-list is, in any order, single-vlan , vlan-range , ...

When you clear the monitor sessions, follow these syntax guidelines:

•The no monitor session session-number command entered with no other parameters clears the session session-number.

•session-range is first-session-number-last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas.

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:

Router(config-mon-erspan-dst) destination interface fastethernet 1/2 , 2/3

This example shows how to enter the ERSPAN destination session source configuration:

Router(config-mon-erspan-dst)# source

Router(config-mon-erspan-dst-src)#

This example shows how to enter the ERSPAN destination session source configuration mode:

Router(config-mon-erspan-dst)# source

Router(config-mon-erspan-dst-src)#

This example shows how to configure multiple sources for a session:

Router(config-mon-erspan-src)# source interface fastethernet 5/15 , 7/3 rx

Router(config-mon-erspan-src)# source interface gigabitethernet 1/2 tx 

Router(config-mon-erspan-src)# source interface port-channel 102 

Router(config-mon-erspan-src)# source filter vlan 2 - 3

Router(config-mon-erspan-src)#

This example shows how to enter the ERSPAN source session destination configuration mode:

Router(config-mon-erspan-src)# destination

Router(config-mon-erspan-src-dst)#

This example shows how to configure the ID number that is used by the source and destination sessions to identify the ERSPAN traffic:

Router(config-mon-erspan-src-dst)# erspan-id 1005

Router(config-mon-erspan-src-dst)#

This example shows how to configure session 1 to monitor ingress traffic from Gigabit Ethernet port 1/1 and configure Gigabit Ethernet port 1/2 as the destination:

Router(config)# monitor session 1 type local 

Router(config-mon-local)# source interface gigabitethernet 1/1 rx 

Router(config-mon-local)# destination interface gigabitethernet 1/2 

This example shows how to configure session 1 to monitor egress-only traffic from Gigabit Ethernet port 5/1 and configure Gigabit Ethernet port 5/2 as the destination:

Router(config)# monitor session 1 type local-tx 

Router(config-mon-local)# source interface gigabitethernet 5/1 rx 

Router(config-mon-local)# destination interface gigabitethernet 5/2 

This example shows how to remove an interface from a session:

Router(config)# no monitor session 1 type local-tx 

Related Commands

mop device-code

To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification (sysid) messages and request program messages, use the mop device-code command in global configuration mode. To set the identity to the default value, use the no form of this command.

mop device-code {cisco | ds200}

no mop device-code {cisco | ds200}

Syntax Description

Defaults

Cisco device code

Command Modes

Global configuration

Command History

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

mop retransmit-timer

To configure the length of time that the Cisco IOS software waits before resending boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retransmit-timer command in global configuration mode. To reinstate the default value, use the no form of this command.

mop retransmit-timer seconds

no mop retransmit-timer

Syntax Description

Defaults

4 seconds

Command Modes

Global configuration

Command History

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

mop retries

To configure the number of times the Cisco IOS software will resend boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retries command in global configuration mode. To reinstate the default value, use the no form of this command.

mop retries count

no mop retries

Syntax Description

Defaults

8 times

Command Modes

Global configuration

Command History

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

more

To display the contents of a file, use the more command in EXEC mode.

more [/ascii | /binary | /ebcdic] url

Syntax Description

Defaults

The command displays the conent of a file in its native format. Optional formats include ascii, binary, and ebcdic.

Command Modes

EXEC

Command History

Usage Guidelines

The more system:running-config command displays the same output as the show running-config command. The more nvram:startup-config command is recommended as a replacement for the show startup-config command and the show configuration command.

You can use this command to display configuration files, as follows:

•The more nvram:startup-config command displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. The Cisco IOS software informs you whether the displayed configuration is a complete configuration or a distilled version. A distilled configuration is one that does not contain access lists.

•The more system:running-config command displays the running configuration.

These commands show the version number of the software used when you last changed the configuration file.

You can also display the contents of files on remote systems using the more command. For example, you could display a saved running configuration file on an FTP server using
more ftp://username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the copy command for more information on file-system prefixes available in the Cisco IOS CLI.

Options for filtering and redirecting the output of this command are available by appending a pipe character (|). See the Related Commands table for a list of more <url> command extensions.

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 more nvram:startup-config command when the configuration file has been compressed:

Router# more nvram:startup-config 

Using 21542 out of 65536 bytes, uncompressed size = 142085 bytes

!

version 12.1 

service compress-config

!

hostname rose

!

.

.

.

The following partial sample output displays the running configuration:

Router2# more system:running-config 

Building configuration...

Current configuration:

!

version 12.1

no service udp-small-servers

no service tcp-small-servers

!

hostname Router2

!

.

.

.

!

end

Related Commands

more <url> begin

To search the output of any more command, use the more url | begin command in EXEC mode. This command begins unfiltered output of the more command with the first line that contains the regular expression you specify.

more url | begin regular-expression

Syntax Description

Command Modes

User EXEC

Privileged EXEC

Command History

Usage Guidelines

The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at every --More-- prompt.

To search the remaining output of the more command, use the following command at the --More-- prompt:

/regular-expression

To filter the remaining output of the more command, use one of the following commands at the --More-- prompt:

-regular-expression

+regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Note Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples

The following is partial sample output of the more nvram:startup-config | begin command that begins unfiltered output with the first line that contain the regular expression "ip." At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression "ip."

router# more nvram:startup-config | begin ip

ip subnet-zero

ip domain-name cisco.com

ip name-server 198.92.30.32

ip name-server 171.69.2.132

!

isdn switch-type primary-5ess

.

.

.

interface Ethernet1

 ip address 5.5.5.99 255.255.255.0

 --More-- 

-ip

filtering...

 media-type 10BaseT

!

interface Serial0:23

 encapsulation frame-relay

 no keepalive

 dialer string 4001

 dialer-group 1

 isdn switch-type primary-5ess

 no fair-queue

Related Commands

more <url> exclude

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

more url | exclude regular-expression

Syntax Description

Command Modes

EXEC

Command History

Usage Guidelines

The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt:

/regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples

The following is partial sample output of the more nvram:startup-config | exclude command. The use of | exclude service in the command specifies a filter that excludes lines that contain the regular expression "service." At the --More-- prompt, the user searches for the regular expression "Dialer1," which continues filtered output with the first line that contains "Dialer1."

router# more nvram:startup-config | exclude service

!

version 12.0

!

hostname router

!

boot system flash

no logging buffered

!

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

more <url> include

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

more url | include regular-expression

Syntax Description

Command Modes

EXEC

Command History

Usage Guidelines

The regular-expression argument is case sensitive and allows for complex matching requirements.

You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt:

/regular-expression

When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples

The following is partial sample output of the more nvram:startup-config | include command. It only displays lines that contain the regular expression "ip."

router# more nvram:startup-config | include ip

ip subnet-zero

ip domain-name cisco.com

ip name-server 198.92.30.32

ip name-server 171.69.2.132

 description ip address 172.21.53.199 255.255.255.0

 ip address 172.21.53.199 255.255.255.0

Related Commands

more flh:logfile

To view the system console output generated during the Flash load helper operation, use the more flh:logfile privileged EXEC command.

more flh:logfile

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Usage Guidelines

If you are a remote Telnet user performing the Flash upgrade without a console connection, this command allows you to retrieve console output when your Telnet connection has terminated due to the switch to the ROM image. The output indicates what happened during the download, and is particularly useful if the download fails.

This command is a form of the more command. See the more command for more information.

Examples

The following is sample output from the more flh:logfile command:

Router# more flh:logfile

%FLH: abc/igs-kf.914 from 172.16.1.111 to flash... 

System flash directory:

File  Length   Name/status

  1   2251320  abc/igs-kf.914 

[2251384 bytes used, 1942920 available, 4194304 total]

Accessing file 'abc/igs-kf.914' on 172.16.1.111...

Loading from 172.16.13.111: 

Erasing device...... erased

Loading from 172.16.13.111: 

- [OK - 

2251320/4194304 bytes]

Verifying checksum... OK (0x97FA)

Flash copy took 79292 msecs

%FLH: Re-booting system after download

Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK]

F3: 2183364+67924+259584 at 0x3000060

              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

motd-banner

To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the motd-banner command in line configuration mode. To suppress the MOTD banners on the specified line or lines, use the no form of this command.

motd-banner

no motd-banner

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled on all lines.

Command Modes

Line configuration

Command History

Usage Guidelines

This command determines whether the router will display the MOTD banner when an EXEC session is created on the specified line or lines. The MOTD banner is defined with the banner motd global configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner on specific lines using the no motd-banner line configuration command.

The MOTD banners can also be disabled by the no exec-banner line configuration command, which disables both MOTD banners and EXEC banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-banner command is enabled or disabled. Table 37 summarizes the effects of the exec-banner command and the motd-banner command.

For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. Table 38 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections.

Examples

The following example suppresses the MOTD banner on vty lines 0 through 4:

line vty 0 4

 no motd-banner

Related Commands

name-connection

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

name-connection

Syntax Description

This command has no arguments or keywords.

Defaults

No logical name is defined.

Command Modes

User EXEC

Command History

Usage Guidelines

This command can be useful for keeping track of multiple connections.

You are prompted for the connection number and name to assign. The where command displays a list of the assigned logical connection names.

Examples

The following example assigns the logical name blue to the connection:

Router> where

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

network-clock select

To name a source to provide timing for the network clock and to specify the selection priority for this clock source, use the network-clock select command in global configuration mode. To cancel the network clock selection, use the no form of this command.

Cisco ASR 1000 Series

network-clock select priority [bits [R0 | R1] {e1 [crc4 | no-crc4 | unframed] | t1 [esf | sf | unframed]} | controller type number | global | interface type number | local | system]

no network-clock select priority [global | local]

Cisco 7600 Series and Cisco 10000 Series

network-clock select priority {controller type number | interface type number | slot number | system} [global | local]

no network-clock select priority [global | local]

Syntax Description

Command Default

The router uses the system clock (also called free-running mode).

Note Because default clock values are derived from an external source, they can fall outside the configurable range.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

When an active clock source fails, the system chooses the next-lower-priority clock source that is specified by this command. When a higher-priority clock source becomes available, the system automatically reselects it.

You can specify up to five clock priorities. The highest-priority active interface in the router supplies the primary reference source to all other interfaces that require network clock synchronization services.

For timing sources, the Route Processor can receive timing information through its BITS interface or through a TDM-based Shared Port Adapter (SPA). For some telecommunications deployments, BITS clocking is required to provide global clocking synchronization of network equipment in the end-to-end data path. A BITS clock can be supplied to the network clock module using a T1 or E1 connection.

If a controller is specified in the clock source hierarchy, you must configure that controller for line timing (by using the appropriate clock source line command for the controller). Any controller that is not currently acting as the clock source will automatically operate in loop timing mode. Both controllers can be given different clock source priority values. For more information, see the Cisco IOS Interface and Hardware Component Command Reference.

Note To minimize backplane clock shifts, the no network-clock select command does not take effect until you return to EXEC mode by entering exit or end. This process minimizes the number of times that clock sources are configured.

Use the show network-clocks command to display clock priorities that are configured on the router.

Examples

The following example shows how to configure the network clock as revertive and assign clock sources to two priorities:

Router> enable

Router# configure terminal

Router(config)# network-clock revertive

Router(config)# network-clock select 1 bits R0 e1

Router(config)# network-clock select 2 interface GigabitEthernet 0/0/1

Related Commands

no menu

To delete a user menu from the configuration file, use the no menu command in global configuration mode.

no menu menu-name

Syntax Description

Defaults

No default behavior or values.

Command Modes

Global configuration

Command History

Usage Guidelines

Use this command to remove any menu commands for a particular menu from the configuration file.

As with all global configuration commands, this command will only effect the startup configuration file when you save the running configuration using the copy running-config startup-config EXEC command.

Examples

The following example deletes the menu named Access1:

no menu Access1

Related Commands

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 no form of this command.

notify

no notify

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Line configuration

Command History

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

notify syslog

To enable the sending of notifications of configuration changes to a remote system message logging (syslog), use the notify syslog command in configuration change logger configuration mode. To disable the sending of notifications of configuration changes to the syslog, use the no form of this command.

notify syslog [contenttype {plaintext | xml}]

no notify syslog [contenttype {plaintext | xml}]

Syntax Description

Command Default

Notifications are not sent to the syslog.

Command Modes

Configuration change logger configuration (config-archive-log-config)

Command History

Usage Guidelines

Enable the notify syslog command if you use the syslog to monitor your router. Syslog monitoring prevents the need to gather configuration log information manually.

Examples

The following example shows how to enable the router to send notifications (in XML format) to the syslog:

Router# configure terminal

!

Router(config)# archive

Router(config-archive)# log config

Router(config-archive-log-config)# notify syslog contenttype xml

Router(config-archive-log-config)# end

Related Commands

padding

To set the padding on a specific output character, use the padding command in line configuration mode. To remove padding for the specified output character, use the no form of this command.

padding ascii-number count

no padding ascii-number

Syntax Description

Defaults

No padding

Command Modes

Line configuration

Command History

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

parity

To define generation of a parity bit, use the parity command in line configuration mode. To specify no parity, use the no form of this command.

parity {none | even | odd | space | mark}

no parity

Syntax Description

Defaults

No parity.

Command Modes

Line configuration

Command History

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

parser cache

To reenable the Cisco IOS software parser cache after disabling it, use the parser cache command in global configuration mode. To disable the parser cache, use the no form of this command.

parser cache

no parser cache

Syntax Description

This command has no arguments or keywords.

Defaults

Parser cache is enabled by default.

Command Modes

Global configuration

Command History

Usage Guidelines

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

The parser cache is enabled by default. However, if you wish to disable the parser cache, you may do so using the no parser cache command in global configuration mode. To reenable the parser cache after it has been disabled, use the parser cache command.

When the no parser cache is issued, the command line appears in the running configuration file. However, if the parser cache is reenabled, no command line appears in the running configuration file.

Examples

In the following example, the Cisco IOS software Parser Cache feature is disabled:

Router(config)# no parser cache

Related Commands

parser command serializer

To enable configuration access only to the users holding a configuration lock and to prevent other clients from accessing the running configuration, use the parser command serializer command in global configuration mode. To disable this configuration, use the no form of this command.

parser command serializer

no parser command serializer

Syntax Description

This command has no arguments or keywords.

Command Default

Access is granted only to the user holding the lock.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

The Parser Concurrency and Locking Improvements feature ensures that exclusive access is granted only to a requested process and prevents other users from concurrently accessing the Cisco IOS configuration. That is, it prevents simultaneous execution of two or more commands. Use the parser command serializer command to configure the Parser Concurrency and Locking Improvements feature.

Examples

The following example shows how to configure the Parser Concurrency and Locking Improvements feature:

Router# configure terminal

Router(config)# parser command serializer

Related Commands

parser config cache interface

To reduce the time required for the command-line interpreter to execute commands that manage the running system configuration files, use the parser config cache interface command in global configuration mode. To disable the reduced command execution time functionality, use the no form of this command.

parser config cache interface

no parser config cache interface

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration (config)

Command History

Usage Guidelines

Enable the parser config cache interface command to reduce the execution time required for running configuration management commands such as the show running-configuration, write terminal, and copy system:running-configuration commands. Information for these configuration management commands is supplied by nonvolatile generation (NVGEN) processes that query the system for configuration details. The parser config cache interface command 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 show running-configuration EXEC command.

Each time the interface configuration is changed, the interface cache is flushed. Entering an NVGEN-type command after modifying the interface configuration will once again not show any performance improvement until the next NVGEN-type command is entered.

Examples

The following example shows how to enable the functionality for reducing the time required for the command-line interpreter to execute commands that manage the running system configuration files:

Router(config)# parser config cache interface

Related Commands

parser config partition

To enable configuration partitioning, use the parser config partition command. To disable the partitioning of the running configuration, use the no form of this command.

parser config partition

no parser config partition

Syntax Description

No arguments or keywords.

Command Default

This command is enabled by default.

Command Modes

Global configuration (config)

Command History

Usage Guidelines

This command controls (enables or disables) the Configuration Partitioning feature.

Note This command is not related to disk partitions or disk partitioning.

To display the list of commands that make up the current running configuration for a specific part ("partition") of the system's global running configuration, use the show running-config partition command in privileged Exec mode.

The Configuration Partitioning feature uses a small amount of system resources. The no parser config partition command allows you to disable this feature if the feature is not needed on your system.

Note Only the no form of this command will appear in configuration files. To determine if config partitioning is supported on your system and whether it is enabled, use the show running-config parser ? command.

Examples

The following example shows how to disable partitioning of the system running configuration:

Router> enable

Router# config t 

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

Router(config)# no parser config partition

System configured 

Related Commands

partition

To separate Flash memory into partitions on Class B file system platforms, use the partition command in global configuration mode. To undo partitioning and to restore Flash memory to one partition, use the no form of this command.

Cisco 1600 Series and Cisco 3600 Series Routers

partition flash-filesystem: [number-of-partitions][partition-size]

no partition flash-filesystem:

All Other Class B Platforms

partition flash partitions [size1 size2]

no partition flash

Syntax Description

Defaults

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

Usage Guidelines

For the Cisco 1600 series and Cisco 3600 series routers, to undo partitioning, use the partition flash-filesystem:1 or no partition flash-filesystem: command. For other Class B platforms, use either the partition flash 1 or no partition flash command. If there are files in a partition other than the first, you must use the erase flash-filesystem:partition-number command to erase the partition before reverting to a single partition.

When creating two partitions, you must not truncate a file or cause a file to spill over into the second partition.

Examples

The following example creates two partitions of 4 MB each in Flash memory:

Router(config)# partition flash 2 4 4

The following example divides the Flash memory card in slot 0 into two partitions, each 8 MB in size on a Cisco 3600 series router:

Router(config)# partition slot0: 2 8 8

The following example creates four partitions of equal size in the card on a Cisco 1600 series router:

Router(config)# partition flash: 4

path (archive configuration)

To specify the location and filename prefix for the files in the Cisco IOS configuration archive, use the path command in archive configuration mode. To disable this function, use the no form of this command.

path url

no path url

Syntax Description

Command Default

If this command is not configured, no location or filename prefix is specified for files in the Cisco IOS configuration archive.

Command Modes

Archive configuration (config-archive)

Command History

Usage Guidelines

When this command is entered, an archive file of the running configuration is saved when the archive config, write-memory, or copy running-config startup-config command is entered.

URLs are commonly used to specify files or location on the World Wide Web. On Cisco routers, URLs can be used to specify the location of a file or directory on a router or a remote file server. The path command uses a URL to specify the location and filename prefix for the Cisco IOS configuration archive.

The locations or file systems that you can specify in the url argument are as follows:

•If your platform has disk0—disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp:

•If your platform does not have disk0—ftp:, http:, pram:, rcp:, or tftp:

The colon is required in the location format.

The filename of the first archive file is the filename specified in the url argument followed by -1. The filename of the second archive file is the filename specified in the url argument followed by -2 and so on.

Because some file systems are incapable of storing the date and time that a file was written, the filename of the archive file can contain the date, time, and router hostname. To include the router hostname in the archive file filename, enter the characters $h (for example, disk0:$h). To include the date and time in the archive file filename, enter the characters $t.

When a configuration archive operation is attempted on a local file system, the file system is tested to determine if it is writable and if it has sufficient space to save an archive file. If the file system is read-only or if there is not enough space to save an archive file, an error message is displayed.

If you specify the tftp: file server as the location with the path command, you need to create the configuration file on the TFTP file server and change the file's privileges before the archive config command works properly.

Examples

The following example of the path command shows how to specify the hostname, date, and time as the filename prefix for which to save archive files of the running configuration. In this example, the time-period command is also configured to automatically save an archive file of the running configuration every 20 minutes.

configure terminal

!

archive 

 path disk0:$h$t

 time-period 20

 end

The following is sample output from the show archive command illustrating the format of the resulting configuration archive filenames.

Router# show archive

There are currently 3 archive configurations saved.

The next archive file will be named routerJan-16-01:12:23.019-4

Archive #  Name

   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        

Cisco IOS Configuration Archive on the TFTP File Server

The following example shows how to use the path command to specify the TFTP file server, address 10.48.71.226, as the archive configuration location and router-cfg as the configuration filename. First you create the configuration file on the TFTP server and change the file's privileges, then you can save the configuration file to the configuration archive.

The following example shows the commands to use to create the file and change the file's privileges on the TFTP server (UNIX commands):

> touch router-cfg-1

> chmod 777 router-cfg-1

The following example show how to create the configuration archive, save the running configuration to the archive, and display the files in the archive:

configure terminal 

!

archive 

 path tftp://10.48.71.226/router-cfg

 exit

exit

!

archive config

Router# show archive

The next archive file will be named tftp://10.48.71.226/router-cfg-2

 Archive #  Name

   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 show archive command if you did not create the configuration file on the TFTP server before attempting to archive the current running configuration file:

configure terminal 

!