-
Cisco IOS Configuration Fundamentals and Network Management Command Reference, Release 12.3 T
-
Introduction
-
CFR Commands: absolute through clock timezone
-
CFR Commands: clock update-calendar through escape-character
-
CFR Commands: event application through ip ftp passive
-
CFR Commands: major rising through periodic
-
CFR Commands: ping through service sequence-numbers
-
CFR Commands: service slave-log through show
tee -
CFR Commands: show context through show ip sla monitor total-statistics
-
CFR Commands [12.3T]: 'show kron schedule' through 'show rtr collection-statistics'
-
CFR Commands: show rtr configuration through snmp-server enable informs
-
CFR Commands: snmp-server enable traps through statistics-distribution-interval
-
CFR Commands: stopbits through ttl ip
-
CFR Commands: type dhcp through xsm vdm
-
Appendix: ASCII Character Set and Hex Values (12.3T CF CR)
-
Table Of Contents
Configuration Fundamentals and Network Management Commands
clear ip sla monitor apm cache
Configuration Fundamentals and Network Management Commands
absolute
To specify an absolute time when a time range is in effect, use the absolute command in time-range configuration mode. To remove the time limitation, use the no form of this command.
absolute [start time date] [end time date]
no absolute
Syntax Description
Defaults
There is no absolute time when the time range is in effect.
Command Modes
Time-range configuration
Command History
Usage Guidelines
Time ranges are used by IP and Internetwork Packet Exchange (IPX) extended access lists. For more information on using these functions, see the Cisco IOS IP Configuration Guide and the Cisco IOS AppleTalk and Novell IPX Configuration Guide. Time ranges are applied to the permit or deny statements found in these access lists.
The absolute command is one way to specify when a time range is in effect. Another way is to specify a periodic length of time with the periodic command. Use either of these commands after the time-range command, which enables time-range configuration mode and specifies a name for the time range. Only one absolute entry is allowed per time-range command.
If a time-range command has both absolute and periodic values specified, then the periodic items are evaluated only after the absolute start time is reached, and are not further evaluated after the absolute end time is reached.
Note
All time specifications are interpreted as local time. To ensure that the time range entries take effect at the desired times, the software clock should be synchronized using the Network Time Protocol (NTP), or some other authoritative time source. For more information, refer to the "Performing Basic System Management" chapter of the Cisco IOS Configuration Fundamentals Configuration Guide.
Examples
The following example configures an access list named northeast, which references a time range named xyz. The access list and time range together permit traffic on Ethernet interface 0 starting at noon on January 1, 2001 and going forever.
time-range xyzabsolute start 12:00 1 January 2001!ip access-list extended northeastpermit ip any any time-range xyz!interface ethernet 0ip access-group northeast inThe following example permits UDP traffic until noon on December 31, 2000. After that time, UDP traffic is no longer allowed out Ethernet interface 0.
time-range abcabsolute end 12:00 31 December 2000!ip access-list extended northeastpermit udp any any time-range abc!interface ethernet 0ip access-group northeast outThe following example permits UDP traffic out Ethernet interface 0 on weekends only, from 8:00 a.m. on January 1, 1999 to 6:00 p.m. on December 31, 2001:
time-range testabsolute start 8:00 1 January 1999 end 18:00 31 December 2001 periodic weekends 00:00 to 23:59!ip access-list extended northeastpermit udp any any time-range test!interface ethernet 0ip access-group northeast outRelated Commands
action cli
To specify the action of executing a Cisco IOS command-line interface (CLI) command when an Embedded Event Manager (EEM) applet is triggered, use the action cli command in applet configuration mode. To remove the action of executing a CLI command, use the no form of this command.
action label cli command cli-string
no action label cli command cli-string
Syntax Description
Defaults
No CLI commands are executed when an EEM applet is triggered.
Command Modes
Applet configuration
Command History
Examples
The following example shows how to specify an EEM applet to run when the Cisco IOS interface loopback CLI command is configured three times. The applet executes the no shutdown command to ensure that the loopback interfaces are operational.
Router(config)# event manager applet cli-matchRouter(config-applet)# event cli pattern {.*interface loopback*} sync yes occurs 3Router(config-applet)# action 1.0 cli command "no shutdown"
Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action cns-event
To specify the action of sending a message to the CNS Event Bus when an Embedded Event Manager (EEM) applet is triggered, use the action cns-event command in applet configuration mode. To remove the action of sending a message to the CNS Event Bus, use the no form of this command.
action label cns-event msg msg-text
no action label cns-event msg msg-text
Syntax Description
Defaults
No messages are sent to the CNS Event Bus.
Command Modes
Applet configuration
Command History
Examples
The following example shows how to specify a message to be sent to the CNS Event Bus when the memory-fail applet is triggered.
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 1.0 cns-event msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action counter
To specify the action of setting or modifying a named counter when an Embedded Event Manager (EEM) applet is triggered, use the action counter command in applet configuration mode. To restore the default value to the counter, use the no form of this command.
action label counter name counter-name value counter-value op {dec | inc | nop | set}
no action label counter name counter-name
Syntax Description
Defaults
No counter values are modified.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
Use the action counter command when an event occurs periodically and you want an action to be implemented after a specified number of occurrences of that event. When the action counter command completes, the $_counter_value_remain environment variable is updated.
Use the event counter command with the action counter command when an event occurs periodically and you want an action to be implemented after a specified number of occurrences of the event.
Examples
The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message saying that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incThe following example shows a policy—EventCounter_A—that is configured to run once a minute and to increment a well-known counter called critical_errors. A second policy—EventCounter_B—is registered to be triggered when the well-known counter called critical_errors exceeds a threshold of 3. When policy EventCounter_B runs, it resets the counter back to 0.
Router(config)# event manager applet EventCounter_ARouter(config-applet)# event timer watchdog time 60.0Router(config-applet)# action 1.0 syslog msg "EventCounter_A"Router(config-applet)# action 2.0 counter name critical_errors value 1 op incRouter(config-applet)# exitRouter(config)# event manager applet EventCounter_BRouter(config-applet)# event counter name critical_errors entry-op gt entry-val 3 exit-op lt exit-val 3Router(config-applet)# action 1.0 syslog msg "EventCounter_B"Router(config-applet)# action 2.0 counter name critical_errors value 0 op setRelated Commands
action force-switchover
To specify the action of switching to a secondary processor in a fully redundant environment when an Embedded Event Manager (EEM) applet is triggered, use the action force-switchover command in applet configuration mode. To remove the action of switching to a secondary processor, use the no form of this command.
action label force-switchover
no action label force-switchover
Syntax Description
Defaults
A switch to a secondary processor is not made.
Command Modes
Applet configuration
Command History
Usage Guidelines
Before using the action force-switchover command, you must install a backup processor in the device. If the hardware is not fully redundant, the switchover action will not be performed.
Examples
The following example shows how to specify a switch to the secondary Route Processor (RP) when the memory-fail applet is triggered.
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 2.0 force-switchoverRelated Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action info
To specify the action of obtaining system information when an Embedded Event Manager (EEM) applet is triggered, use the action info command in applet configuration mode. To remove the action info command from the configuration, use the no form of this command.
action label info type {cli frequency | cli history | syslog frequency | syslog history | router-name | snmp oid oid-value get-type {exact | next}}
no action label info type {cli frequency | cli history | syslog frequency | syslog history | router-name | snmp oid oid-value get-type {exact | next}}
Syntax Description
Defaults
No system information is requested.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the action info command when an event occurs and you want to request some system information.
Examples
The following example shows how to specify an EEM applet to run when the Cisco IOS interface loopback CLI command is configured three times. The applet runs the no shutdown command to ensure that the loopback interfaces are operational, and a request to obtain information about the frequency of recent CLI commands is sent to the EEM.
Router(config)# event manager applet cli-matchRouter(config-applet)# event cli pattern {.*interface loopback*} sync yes occurs 3Router(config-applet)# action 1.0 cli command "no shutdown"Router(config-applet)# action 1.1 info type cli frequencyRelated Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action mail
To specify the action of sending a short e-mail when an Embedded Event Manager (EEM) applet is triggered, use the action mail command in applet configuration mode. To remove the action mail command from the configuration, use the no form of this command.
action label mail server server-address to to-address from from-address [cc cc-address] subject subject body body-text
no action label mail server server-address to to-address from from-address [cc cc-address] subject subject body body-text
Syntax Description
Defaults
No e-mails are sent.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the action mail command when an event occurs and you want to send an e-mail to inform an administrator, for example, that the event has occurred.
Examples
The following example shows how to send an e-mail when an EEM applet executes. The applet named EventInterface is triggered every time the receive_throttle counter for the Fast Ethernet interface 0/0 is incremented by 5. The polling interval to check the counter is specified to run once every 10 seconds. When the applet is triggered, a syslog message and an e-mail are sent.
Router(config)# event manager applet EventInterfaceRouter(config-applet)# event interface name FastEthernet0/0 parameter receive_throttle entry-op ge entry-val 5 entry-val-is-increment true poll-interval 10Router(config-applet)# action 1.0 syslog msg "Applet EventInterface"Router(config-applet)# action 1.1 mail server mailserver.cisco.com to engineering@cisco.com from devtest@cisco.com cc manager@cisco.com subject "Receive_throttle counter incremented" body "Receive_throttle counter for FastEthernet0/0 interface has incremented by 5"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action policy
To specify the action of manually running an Embedded Event Manager (EEM) policy when an EEM applet is triggered, use the action policy command in applet configuration mode. To remove the action policy command from the configuration, use the no form of this command.
action label policy policy-filename
no action label policy policy-filename
Syntax Description
Defaults
No EEM policies are run.
Command Modes
Applet configuration
Command History
Usage Guidelines
EEM usually schedules and runs policies on the basis of an event specification that is contained within the policy itself. The event none command allows EEM to identify an EEM policy that can be run manually or when an EEM applet is triggered. To run the policy, use either the action policy command in applet configuration mode or the event manager run command in global configuration mode.
Examples
The following example shows how to register a policy named manual-policy to be run manually and then execute the policy:
Router(config)# event manager applet policy-manualRouter(config-applet)# event none policy-manualRouter(config-applet)# action policy policy-manualRelated Commands
action publish-event
To specify the action of publishing an application-specific event when the event specified for an Embedded Event Manager (EEM) applet is triggered, use the action publish-event command in applet configuration mode. To remove the action of publishing an application-specific event, use the no form of this command.
action label publish-event sub-system sub-system-id type event-type arg1 argument-data
[arg2 argument-data] [arg3 argument-data] [arg4 argument-data]no action label publish-event
Syntax Description
Defaults
No application-specific events are published.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Examples
The following example shows how a policy named EventPublish_A runs every 20 seconds and publishes an event to a well-known EEM event type numbered 1. A second policy named EventPublish_B is registered to run when the well-known EEM event type of 1 occurs. When policy EventPublish_B runs, it outputs a message to syslog containing the argument 1 argument data passed from EventPublish_A.
Router(config)# event manager applet EventPublish_ARouter(config-applet)# event timer watchdog time 20.0Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_A"Router(config-applet)# action 2.0 publish-event sub-system 798 type 1 arg1 twentyRouter(config-applet)# exitRouter(config)# event manager applet EventPublish_BRouter(config-applet)# event application sub-system 798 type 1Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_B arg1 $_application_data1"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action reload
To specify the action of reloading the Cisco IOS software when an Embedded Event Manager (EEM) applet is triggered, use the action reload command in applet configuration mode. To remove the action of reloading the Cisco IOS software, use the no form of this command.
action label reload
no action label reload
Syntax Description
Defaults
No reload of the Cisco IOS software is performed.
Command Modes
Applet configuration
Command History
Usage Guidelines
Before configuring the action reload command, you should ensure that the device is configured to reboot the software version that you are expecting. Use the show startup-config command and look for any boot system commands.
Examples
The following example shows how to reload the Cisco IOS software when the memory-fail applet is triggered.
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 3.0 reloadRelated Commands
action snmp-trap
To specify the action of generating a Simple Network Management Protocol (SNMP) trap when an Embedded Event Manager (EEM) applet is triggered, use the action snmp-trap command in applet configuration mode. To remove the action of generating an SNMP trap, use the no form of this command.
action label snmp-trap [intdata1 integer] [intdata2 integer] [strdata string]
no action label snmp-trap
Syntax Description
Defaults
No SNMP traps are generated when an EEM applet is triggered.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
Before configuring this command, you must enable the snmp-server enable traps event-manager command to permit SNMP traps to be sent from the Cisco IOS device to the SNMP server. Other relevant snmp-server commands must also be configured.
This command generates an asynchronous message that is sent from the Cisco IOS device to the SNMP agent. The SNMP agent can be coded to understand customized data such as the optional integer and string data that can be sent in the SNMP trap message.
The SNMP trap that is generated uses the EEM MIB, CISCO-EMBEDDED-EVENT-MGR-MIB.my. Details about the MIB can be found using Cisco MIB Locator found at the following URL:
Examples
The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message saying that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incRelated Commands
action syslog
To specify the action of writing a message to syslog when an Embedded Event Manager (EEM) applet is triggered, use the action syslog command in applet configuration mode. To remove the syslog message event criteria, use the no form of this command.
action label syslog [priority priority-level] msg msg-text
no action label syslog [priority priority-level] msg msg-text
Syntax Description
Defaults
No messages are written to syslog.
Command Modes
Applet configuration
Command History
Examples
The following example shows how to specify a message to be sent to syslog when the memory-fail applet is triggered:
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 4.0 syslog msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
activation-character
To define the character you enter at a vacant terminal to begin a terminal session, use the activation-character command in line configuration mode. To make any character activate a terminal, use the no form of this command.
activation-character ascii-number
no activation-character
Syntax Description
Defaults
Return (decimal 13)
Command Modes
Line configuration
Command History
Usage Guidelines
See the "ASCII Character Set and Hex Values" appendix for a list of ASCII characters.
Note
Examples
The following example sets the activation character for the console to Delete, which is decimal character 127:
Router(config)# line consoleRouter(config-line)# activation-character 127add (bulkstat object)
To add a MIB object to a bulk statistics object list, use the add command in Bulk Statistics Object List configuration mode. To remove a MIB object from an SNMP bulk statistics object list, use the no form of this command.
add {object-name | OID}
no add {object-name | OID}
Syntax Description
Defaults
No MIB objects are listed in the bulk statistics object list.
Command Modes
Bulk Statistics Object List configuration (config-bulk-objects)
Command History
Usage Guidelines
All the objects in an object-list need to be indexed by the same MIB index, but the objects need not belong to the same MIB table. For example, it is possible to group ifInOctets and an Ether MIB object in the same schema, because the containing tables are indexed by the ifIndex (in the IF-MIB).
Object names are available in the relevant MIB modules. For example, the input byte count of an interface is defined in the Interfaces Group MIB (IF-MIB.my) as ifInoctets. Complete MIB modules can be downloaded from Cisco.com using http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.
Examples
In the following example, two bulk statistics object lists are configured: one for IF-MIB objects and one for CISCO-CAR-MIB objects. Because the IF-MIB objects and the CISCO-CAR-MIB objects do not have the same index, they must be defined in separate object lists.
Router(config)# snmp mib bulkstat object-list if-ObjectsRouter(config-bulk-objects)# add ifInoctetsRouter(config-bulk-objects)# add ifOutoctetsRouter(config-bulk-objects)# add ifInUcastPktsRouter(config-bulk-objects)# add ifInDiscardsRouter(config-bulk-objects)# exitRouter(config)# snmp mib bulkstat object-list CAR-ObjectsRouter(config-bulk-objects)# add CcarStatSwitchedPktsRouter(config-bulk-objects)# add ccarStatSwitchedBytesRouter(config-bulk-objects)# add CcarStatFilteredBytesRouter(config-bulk-objects)# exitRouter(config)#Related Commands
snmp mib bulkstat object-list
Names a bulk statistics object list and enters Bulk Statistics Object List configuration mode.
alias
To create a command alias, use the alias command in global configuration mode. To delete all aliases in a command mode or to delete a specific alias, and to revert to the original command syntax, use the no form of this command.
alias mode command-alias original-command
no alias mode [command-alias]
Syntax Description
mode
Command mode of the original and alias commands.
command-alias
Command alias.
original-command
Original command syntax.
Defaults
A set of six basic EXEC mode aliases are enabled by default. See the "Usage Guidelines" section of this command for a list of default aliases.
Command Modes
Global configuration
Command History
Usage Guidelines
You can use simple words or abbreviations as command aliases.
Table 5 lists the basic EXEC mode aliases that are enabled by default.
Table 5 Default Command Aliases
h
help
lo
logout
p
ping
r
resume
s
show
w
where
The default aliases in Table 5 are predefined. These default aliases can be disabled with the no alias exec command.
Common keyword aliases (which cannot be disabled) include running-config (keyword alias for system:running-config) and startup-config (keyword alias for nvram:startup-config). See the description of the copy command for more information about these keyword aliases.
Note that aliases can be configured for keywords instead of entire commands. You can create, for example, an alias for the first part of any command and still enter the additional keywords and arguments as normal.
To determine the value for the mode argument, enter the command mode in which you would issue the original command (and in which you will issue the alias) and enter the ? command. The name of the command mode should appear at the top of the list of commands. For example, the second line in the following sample output shows the name of the command mode as "Interface configuration":
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# interface e0Router(config-if)# ?Interface configuration commands:access-expression Build a bridge boolean access expression...To match the name of the command mode to the acceptable mode keyword for the alias command, issue the alias ? command. As shown in the following sample output, the keyword needed to create a command alias for the access-expression command is interface:
Router(config)# alias ?accept-dialin VPDN group accept dialin configuration modeaccept-dialout VPDN group accept dialout configuration modeaddress-family Address Family configuration modecall-discriminator Call Discriminator Configurationcascustom Cas custom configuration modeclid-group CLID group configuration modeconfigure Global configuration modecongestion Frame Relay congestion configuration modecontroller Controller configuration modecptone-set custom call progress tone configuration modecustomer-profile customer profile configuration modedhcp DHCP pool configuration modednis-group DNIS group configuration modeexec Exec modeflow-cache Flow aggregation cache config modefr-fr FR/FR connection configuration modeinterface Interface configuration mode...Router(config)# alias interface express access-expressionFor a list of command modes with descriptions and references to related documentation, refer to the "Cisco IOS Command Modes" appendix of the Cisco IOS Configuration Fundamentals Configuration Guide.
When you use online help, command aliases are indicated by an asterisk (*), and displayed in the following format:
*command-alias=original-command
For example, the lo command alias is shown here along with other EXEC mode commands that start with "lo":
Router# lo?*lo=logout lock login logoutWhen you use online help, aliases that contain multiple keyword elements separated by spaces are displayed in quotes, as shown here:
Router(config)#alias exec device-mail telnet device.cisco.com 25Router(config)#endRouter#device-mail?*device-mail="telnet device.cisco.com 25"To list only commands and omit aliases, begin your input line with a space. In the following example, the alias td is not shown, because there is a space before the t? command line.
Router(config)#alias exec td telnet deviceRouter(config)#endRouter# t?telnet terminal test tn3270 traceTo circumvent command aliases, use a space before entering the command. In the following example, the command alias express is not recognized because a space is used before the command.
Router(config-if)#exp?*express=access-expressionRouter(config-if)# express ?% Unrecognized commandAs with commands, you can use online help to display the arguments and keywords that can follow a command alias. In the following example, the alias td is created to represent the command telnet device. The /debug and /line switches can be added to telnet device to modify the command:
Router(config)#alias exec td telnet deviceRouter(config)#endRouter#td ?/debug Enable telnet debugging mode/line Enable telnet line mode...whois Whois port<cr>Router# telnet deviceYou must enter the complete syntax for the command alias. Partial syntax for aliases is not accepted. In the following example, the parser does not recognize the command t as indicating the alias td:
Router# t% Ambiguous command: "t"Examples
In the following example, the alias fixmyrt is configured for the clear iproute 192.168.116.16 EXEC mode command:
Router(config)#alias exec fixmyrt clear ip route 192.168.116.16In the following example, the alias express is configured for the first part of the access-expression interface configuration command:
Router#configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)#interface e0Router(config-if)#?Interface configuration commands:access-expression Build a bridge boolean access expression...Router(config-if)#exitRouter(config)#alias ?accept-dialin VPDN group accept dialin configuration modeaccept-dialout VPDN group accept dialout configuration modeaddress-family Address Family configuration modecall-discriminator Call Discriminator Configurationcascustom Cas custom configuration modeclid-group CLID group configuration modeconfigure Global configuration modecongestion Frame Relay congestion configuration modecontroller Controller configuration modecptone-set custom call progress tone configuration modecustomer-profile customer profile configuration modedhcp DHCP pool configuration modednis-group DNIS group configuration modeexec Exec modeflow-cache Flow aggregation cache config modefr-fr FR/FR connection configuration modeinterface Interface configuration mode...Router(config)#alias interface express access-expressionRouter(config)#int e0Router(config-if)#exp?*express=access-expressionRouter(config-if)#express ?input Filter input packetsoutput Filter output packets!Note that the true form of the command/keyword alias appears on the screen after issuing!the express ? command.Router(config-if)#access-expression ?input Filter input packetsoutput Filter output packetsRouter(config-if)#ex?*express=access-expression exit!Note that in the following line, a space is used before the ex? command!so the alias is not displayed.Router(config-if)# ex?exit!Note that in the following line, the alias cannot be recognized because!a space is used before the command.Router#(config-if)# express ?% Unrecognized commandRouter(config-if)# endRouter# show alias interfaceInterface configuration mode aliases:express access-expressionRelated Commands
alias (boomerang)
To configure an alias name for a specified domain, use the alias command in boomerang configuration mode. To remove this command from the configuration file and restore the system to its default condition with respect to this command, use the no form of this command.
alias alias-name
no alias alias-name
Syntax Description
Defaults
No domain name alias is configured.
Command Modes
Boomerang configuration
Command History
Usage Guidelines
The alias command can be used only on a Director Response Protocol (DRP) agent. The boomerang client is the DRP agent.
Use the alias command to specify one or more alias names for an existing domain. Because the boomerang client maintains separate counters for requests received for each domain name (alias or otherwise), use the show ip drp boomerang command to view these counters for a specified domain name and each of its aliases.
Examples
In the following example, the domain name alias is configured for www.boom1.com. The new alias for www.boom1.com is www.boom2.com:
Router(config)# ip drp domain www.boom1.comRouter(config-boomerang)# alias www.boom2.comRouter# show running-config...ip drp domain www.boom1.comalias www.boom2.comRelated Commands
announce config
To specify that an unsolicited configuration inventory is sent out by the CNS inventory agent at bootup, use the announce config command in CNS inventory configuration mode. To disable the sending of the configuration inventory, use the no form of this command.
announce config
no announce config
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
CNS inventory configuration
Command History
Usage Guidelines
Use this command to limit inventory requests by the CNS inventory agent. When configured, the routing device details will be announced on the CNS Event Bus, but the routing device will not respond to any queries from the CNS Event Bus.
Examples
The following example shows how to configure the CNS inventory agent to send out an unsolicited configuration inventory one time only at bootup:
Router(config)# cns inventoryRouter(cns_inv)# announce configRelated Commands
cns inventory
Enables the CNS inventory agent and enters CNS inventory configuration mode.
archive
To enter archive configuration mode, use the archive command in global configuration mode.
archive
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
12.3(4)T
This command was introduced.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
Examples
The following example shows how to place the router in archive configuration mode:
Router(config)# archiveRouter(config-archive)# path disk0:myconfigRelated Commands
archive config
To save a copy of the current running configuration to the Cisco IOS configuration archive, use the archive config command in privileged EXEC mode.
archive config
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
12.3(7)T
This command was introduced.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
Usage Guidelines
Note
The Cisco IOS configuration archive is intended to provide a mechanism to store, organize, and manage an archive of Cisco IOS configuration files in order to enhance the configuration rollback capability provided by the configure replace command. Before this feature was introduced, you could save copies of the running configuration using the copy running-config destination-url command, storing the target file either locally or remotely. However, this method lacked any automated file management. On the other hand, the Configuration Replace and Configuration Rollback feature provides the capability to automatically save copies of the running configuration to the Cisco IOS configuration archive. These archived files serve as checkpoint configuration references and can be used by the configure replace command to revert to previous configuration states.
The archive config command allows you to save Cisco IOS configurations in the configuration archive using a standard location and filename prefix that is automatically appended with an incremental version number (and optional timestamp) as each consecutive file is saved. This functionality provides a means for consistent identification of saved Cisco IOS configuration files. You can specify how many versions of the running configuration will be kept in the archive. After the maximum number of files has been saved in the archive, the oldest file will be automatically deleted when the next, most recent file is saved. The show archive command displays information for all configuration files saved in the Cisco IOS configuration archive.
Examples
The following example shows how to save the current running configuration to the Cisco IOS configuration archive using the archive config command. Before using the archive config command, you must configure the path command in order to specify the location and filename prefix for the files in the Cisco IOS configuration archive. In this example, the location and filename prefix is specified as disk0:myconfig as follows:
Router# configure terminalRouter(config)# archiveRouter(config-archive)# path disk0:myconfigYou then save the current running configuration in the configuration archive as follows:
Router# archive configThe show archive command displays information on the files saved in the configuration archive as shown in the following sample output:
Router# show archiveThere are currently 1 archive configurations saved.The next archive file will be named disk0:myconfig-2Archive # Name01 disk0:myconfig-1 <- Most Recent2345678910Related Commands
async-bootp
To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the async-bootp command in global configuration mode. To restore the default, use the no form of this command.
async-bootp tag [:hostname] data
no async-bootp
Syntax Description
tag
Item being requested; expressed as filename, integer, or IP dotted decimal address. See Table 6 for possible keywords.
:hostname
(Optional) This entry applies only to the specified host. The :hostname argument accepts both an IP address and a logical host name.
data
List of IP addresses entered in dotted decimal notation or as logical host names, a number, or a quoted string.
Defaults
If no extended BOOTP commands are entered, the Cisco IOS software generates a gateway and subnet mask appropriate for the local network.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the show async-bootp EXEC command to list the configured parameters. Use the no async-bootp command to clear the list.
Examples
The following example illustrates how to specify different boot files: one for a PC, and one for a Macintosh. With this configuration, a BOOTP request from the host on 172.30.1.1 results in a reply listing the boot filename as pcboot. A BOOTP request from the host named "mac" results in a reply listing the boot filename as "macboot."
async-bootp bootfile :172.30.1.1 "pcboot"async-bootp bootfile :mac "macboot"The following example specifies a subnet mask of 255.255.0.0:
async-bootp subnet-mask 255.255.0.0The following example specifies a negative time offset of the local subnetwork of 3600 seconds:
async-bootp time-offset -3600The following example specifies the IP address of a time server:
async-bootp time-server 172.16.1.1Related Commands
show async bootp
Displays the extended BOOTP request parameters that have been configured for asynchronous interfaces.
atm slm statistics
To enable the Cisco IOS IP Service Level Agreements (SLAs) ATM Service Level Monitoring (SLM) feature, use the atm slm statistics command in global configuration mode. To disable ATM SLM, use the no form of this command.
atm slm statistics
no atm slm statistics
Syntax Description
This command has no arguments or keywords.
Defaults
ATM SLM is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
To generate and retrieve performance statistics for ATM services using IP SLAs, the ATM SLM feature must first be enabled on the device using the atm slm statistics global configuration command. (Note that these performance statistics can be retrieved by other applications such as Cisco Networking Services [CNS] or Visual Uptime.) If this command is not used, IP SLAs SLM operations cannot be configured on the system.
Disabling the ATM SLM feature with the no atm slm statistics command will cause any currently configured IP SLAs SLM operations to be removed from the configuration. When ATM SLM is disabled, no CNS or Extensible Markup Language (XML) requests are processed.
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 7). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
Examples
In the following examples, the ATM SLM feature is enabled before an IP SLAs SLM operation is configured for ATM interface 0/1. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 7).
IP SLA Monitor Configuration
atm slm statistics!ip sla monitor 1type slm atm interface ATM0/1enhanced-history interval 900 buckets 100!ip sla monitor schedule 1 start-time now life foreverRTR Configuration
atm slm statistics!rtr 1type slm atm interface ATM0/1enhanced-history interval 900 buckets 100!rtr schedule 1 start-time now life foreverRelated Commands
attach
To connect to a specific line card for the purpose of executing monitoring and maintenance commands on that line card only, use the attach command in privileged EXEC mode. To exit from the Cisco IOS software image on the line card and return to the Cisco IOS image on the gigabit route processor (GRP), use the exit command.
attach slot-number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
You must first use the attach privileged EXEC command to access the Cisco IOS software image on a line card before using line card-specific show EXEC commands. Alternatively, you can use the execute-on privileged EXEC command to execute a show command on a specific line card.
After you connect to the Cisco IOS image on the line card using the attach command, the prompt changes to LC-Slotx#, where x is the slot number of the line card.
The commands executed on the line card use the Cisco IOS image on that line card.
You can also use the execute-on slot privileged EXEC command to execute commands on one or all line cards.
Note
Examples
In the following example, the user connects to the Cisco IOS image running on the line card in slot 9, gets a list of valid show commands, and returns the Cisco IOS image running on the GRP:
Router# attach 9Entering Console for 4 Port Packet Over SONET OC-3c/STM-1 in Slot: 9Type exit to end this sessionPress RETURN to get started!LC-Slot9# show ?cef Cisco Express Forwardingclock Display the system clockcontext Show context information about recent crash(s)history Display the session command historyhosts IP domain-name, lookup style, nameservers, and host tableipc Interprocess communications commandslocation Display the system locationsessions Information about Telnet connectionsterminal Display terminal configuration parametersusers Display information about terminal linesversion System hardware and software statusLC-Slot9# exitDisconnecting from slot 9.Connection Duration: 00:01:04Router#
Note
Related Commands
autobaud
To set the line for automatic baud rate detection (autobaud), use the autobaud command in line configuration mode. To disable automatic baud detection, use the no form of this command.
autobaud
no autobaud
Syntax Description
This command has no arguments or keywords.
Defaults
Autobaud detection is disabled. Fixed speed of 9600 bps.
Command Modes
Line configuration
Command History
Usage Guidelines
The autobaud detection supports a range from 300 to 19200 baud. A line set for autobaud cannot be used for outgoing connections, nor can you set autobaud capability on a line using 19200 baud when the parity bit is set (because of hardware limitations).
Note
Examples
In the following example, the auxiliary port is configured for autobaud detection:
Router(config)# line auxRouter(config-line)# autobaudbanner exec
To specify and enable a message to be displayed when an EXEC process is created (an EXEC banner), use the banner exec command in global configuration mode. To delete the existing EXEC banner, use the no form of this command.
banner exec d message d
no banner exec
Syntax Description
d
Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message.
message
Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 8.
Defaults
Disabled (no EXEC banner is displayed).
Command Modes
Global configuration
Command History
10.0
This command was introduced.
11.3(7.5)AA
Token functionality was introduced.
12.0(3)T
Token functionality was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
This command specifies a message to be displayed when an EXEC process is created (a line is activated, or an incoming connection is made to a vty). Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.
When a user connects to a router, the message-of-the-day (MOTD) banner appears first, followed by the login banner and prompts. After the user logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.
To disable the EXEC banner on a particular line or lines, use the no exec-banner line configuration command.
To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router's host name and IP address. The tokens are described in Table 8.
Examples
The following example sets an EXEC banner that uses tokens. The percent sign (%) is used as a delimiting character. Notice that the $(token) syntax is replaced by the corresponding configuration variable.
Router(config)# banner exec %Enter TEXT message. End with the character '%'.Session activated on line $(line), $(line-desc). Enter commands at the prompt.%When a user logs on to the system, the following output is displayed:
User Access VerificationUsername: joeuserPassword: <password>Session activated on line 50, vty default line. Enter commands at the prompt.Router>Related Commands
banner incoming
To define and enable a banner to be displayed when there is an incoming connection to a terminal line from a host on the network, use the banner incoming command in global configuration mode. To delete the incoming connection banner, use the no form of this command.
banner incoming d message d
no banner incoming
Syntax Description
d
Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message.
message
Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 9.
Defaults
Disabled (no incoming banner is displayed).
Command Modes
Global configuration
Command History
10.0
This command was introduced.
11.3(7.5)AA
Token functionality was introduced.
12.0(3)T
Token functionality was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
Follow the banner incoming command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.
An incoming connection is one initiated from the network side of the router. Incoming connections are also called reverse Telnet sessions. These sessions can display MOTD banners and incoming banners, but they do not display EXEC banners. Use the no motd-banner line configuration command to disable the MOTD banner for reverse Telnet sessions on asynchronous lines.
When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, before the login prompt. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.
Incoming banners cannot be suppressed. If you do not want the incoming banner to appear, you must delete it with the no banner incoming command.
To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router's host name and IP address. The tokens are described in Table 9.
Examples
The following example sets an incoming connection banner. The pound sign (#) is used as a delimiting character.
Router(config)# banner incoming #This is the Reuses router.#The following example sets an incoming connection banner that uses several tokens. The percent sign (%) is used as a delimiting character.
darkstar(config)# banner incoming %Enter TEXT message. End with the character '%'.You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %When the incoming connection banner is executed, the user will see the following banner. Notice that the $(token) syntax is replaced by the corresponding configuration variable.
You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)Related Commands
banner login
To define and enable a customized banner to be displayed before the username and password login prompts, use the banner login command in global configuration mode. To disable the login banner, use no form of this command.
banner login d message d
no banner login
Syntax Description
d
Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message.
message
Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 10.
Defaults
Disabled (no login banner is displayed).
Command Modes
Global configuration
Command History
10.0
This command was introduced.
11.3(7.5)AA
Token functionality was introduced.
12.0(3)T
Token functionality was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
Follow the banner login command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.
When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, followed by the login banner and prompts. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.
To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router's host name and IP address. The tokens are described in Table 10.
Examples
The following example sets a login banner. Double quotes (") are used as the delimiting character.
Router# banner login " Access for authorized users only. Please enter your username and password. "The following example sets a login banner that uses several tokens. The percent sign (%) is used as the delimiting character.
darkstar(config)# banner login %Enter TEXT message. End with the character '%'.You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %When the login banner is executed, the user will see the following banner. Notice that the $(token) syntax is replaced by the corresponding configuration variable.
You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)Related Commands
banner motd
To define and enable a message-of-the-day (MOTD) banner, use the banner motd command in global configuration mode. To delete the MOTD banner, use the no form of this command.
banner motd d message d
no banner motd
Syntax Description
Defaults
Disabled (no MOTD banner is displayed).
Command Modes
Global configuration
Command History
10.0
This command was introduced.
11.3(7.5)AA
Token functionality was introduced.
12.0(3)T
Token functionality was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.
This MOTD banner is displayed to all terminals connected and is useful for sending messages that affect all users (such as impending system shutdowns). Use the no exec-banner or no motd-banner command to disable the MOTD banner on a line. The no exec-banner command also disables the EXEC banner on the line.
When a user connects to the router, the MOTD banner appears before the login prompt. After the user logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner.
To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router's host name and IP address. The tokens are described in Table 11.
Examples
The following example configures an MOTD banner. The pound sign (#) is used as a delimiting character.
Router# banner motd # Building power will be off from 7:00 AM until 9:00 AM this coming Tuesday. #The following example configures an MOTD banner with a token. The percent sign (%) is used as a delimiting character.
darkstar(config)# banner motd %Enter TEXT message. End with the character '%'.Notice: all routers in $(domain) will be upgraded beginning April 20%When the MOTD banner is executed, the user will see the following. Notice that the $(token) syntax is replaced by the corresponding configuration variable.
Notice: all routers in ourdomain.com will be upgraded beginning April 20Related Commands
banner slip-ppp
To customize the banner that is displayed when a Serial Line Internet Protocol (SLIP) or PPP connection is made, use the banner slip-ppp command in global configuration mode. To restore the default SLIP or PPP banner, use the no form of this command.
banner slip-ppp d message d
no banner slip-ppp
Syntax Description
Defaults
The default SLIP or PPP banner message is:
Entering encapsulation mode. Async interface address is unnumbered (Ethernet0) Your IP address is 10.000.0.0 MTU is 1500 bytesThe banner message when using the service old-slip-prompt command is:
Entering encapsulation mode.Your IP address is 10.100.0.0 MTU is 1500 byteswhere encapsulation is SLIP or PPP.
Command Modes
Global configuration
Command History
Usage Guidelines
Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character.
Use this command to define a custom SLIP or PPP connection message. This is useful when legacy client applications require a specialized connection string. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the routers host name, IP address, encapsulation type, and Maximum Transfer Unit (MTU) size. The banner tokens are described in Table 12.
Examples
The following example sets the SLIP/PPP banner using several tokens and the percent sign (%) as the delimiting character:
Router(config)# banner slip-ppp %Enter TEXT message. End with the character '%'.Starting $(encap) connection from $(gate-ip) to $(peer-ip) using a maximum packet size of $(mtu) bytes... %The new SLIP/PPP banner will now be displayed when the slip EXEC command is used. Notice that the $(token) syntax is replaced by the corresponding configuration variable.
Router# slipStarting SLIP connection from 172.16.69.96 to 192.168.1.200 using a maximum packet size of 1500 bytes...Related Commands
boot
To boot the router manually, use the boot command in ROM monitor mode. The syntax of this command varies according to the platform and ROM monitor version.
boot
boot file-url
boot filename [tftp-ip-address]
boot flash [flash-fs:][partition-number:][filename]
Cisco 7000 Series, 7200 Series, 7500 Series Routers
boot flash-fs:[filename]
Cisco 1600 and Cisco 3600 Series Routers
boot [flash-fs:][partition-number:][filename]
Syntax Description
Defaults
For most platforms, if you enter the boot command and press Enter, the router boots from ROM by default. However, for some platforms, such as the Cisco 3600 series routers, if you enter the boot command and press Return, the router boots the first image in Flash memory. Refer to the documentation for your platform for information about the default image.
If the partition-number is not specified, the first partition is used.
If the filename is not specified, the first file in the partition or file system is used. As of Cisco IOS Release 12.3(4)T, the first valid image file in the partition or file system is used.
For other defaults, see the "Syntax Description" section.
Command Modes
ROM monitor
Command History
Usage Guidelines
To determine which form of this command to use, refer to the documentation for your platform or use the CLI help (?) feature.
Use this command only when your router cannot find the boot configuration information needed in NVRAM. To enter ROM monitor mode, use one of the following methods:
•
•
The ROM Monitor prompt is either ">" or, for newer platforms, "rommon x>". Enter only lowercase commands.
These commands work only if there is a valid image to boot. Also, from the ROM monitor prompt, issuing a prior reset command is necessary for the boot to be consistently successful.
In Cisco IOS Release 12.3(4)T, MONLIB was modified to search in media for a valid Cisco IOS image. This change prevents boot failures that result when the first file read in disk or flash is not a valid Cisco IOS image.
Refer to your hardware documentation for information on correct jumper settings for your platform.
Note
Examples
In the following example, a router is manually booted from ROM:
> bootF3:(ROM Monitor copyrights)In the following example, a router boots the file named routertest from a network server with the IP address 172.16.15.112 using the file-url syntax:
> boot tftp://172.16.15.112/routertestF3(ROM Monitor copyrights)The following example shows the boot flash command without the filename argument. The first valid file in Flash memory is loaded.
> boot flashF3: 1858656+45204+166896 at 0x1000Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]F3: 1858676+45204+166896 at 0x1000(ROM Monitor copyrights)The following example boots from Flash memory using the file named gs7-k:
> boot flash gs7-kF3: 1858656+45204+166896 at 0x1000Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]F3: 1858676+45204+166896 at 0x1000(ROM Monitor copyrights)In the following example, the boot flash flash: command boots the relocatable image file named igs-bpx-l from partition 2 in Flash memory:
> boot flash flash:2:igs-bpx-lF3: 3562264+98228+303632 at 0x30000B4(ROM Monitor copyrights)In the following command, the Cisco 7000 family router accepts the flash keyword for compatibility but ignores it, and boots from slot 0:
> boot flash slot0:gs7-k-mz.103-9F3: 8468+3980384+165008 at 0x1000In the following example, the command did not function because it must be entered in lowercase:
rommon 10 > BOOTcommand "BOOT" not foundThe following example boots the first file in the first partition of internal Flash memory of a Cisco 3600 series router:
> boot flash:The following example boots the first image file in the first partition of the Flash memory card in slot 0 of a Cisco 3600 series router:
> boot slot0:The following example shows the ROM monitor booting the first file in the first Flash memory partition on a Cisco 1600 series router:
> boot flash:Related Commands
continue
Returns to EXEC mode from ROM monitor mode by completing the boot process.
boot bootldr
To specify the location of the boot image that ROM uses for booting, use the boot bootldr command in global configuration mode. To remove this boot image specification, use the no form of this command.
boot bootldr file-url
no boot bootldr
Syntax Description
Defaults
Refer to your platform documentation for the location of the default boot image.
Command Modes
Global configuration
Command History
Usage Guidelines
The boot bootldr command sets the BOOTLDR variable in the current running configuration. You must specify both the Flash file system and the filename.
Note
The no form of the command sets the BOOTLDR variable to a null string. On the Cisco 7000 family routers, a null string causes the first image file in boot Flash memory to be used as the boot image that ROM uses for booting.
Use the show boot command to display the current value for the BOOTLDR variable.
Examples
In the following example, the internal Flash memory contains the boot image:
boot bootldr bootflash:boot-imageThe following example specifies that the Flash memory card inserted in slot 0 contains the boot image:
boot bootldr slot0:boot-imageRelated Commands
boot bootstrap
To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap command in global configuration mode. To disable booting from a secondary bootstrap image, use the no form of this command.
boot bootstrap file-url
no boot bootstrap file-url
boot bootstrap flash [filename]
no boot bootstrap flash [filename]
boot bootstrap [tftp] filename [ip-address]
no boot bootstrap [tftp] filename [ip-address]
Syntax Description
Defaults
No secondary bootstrap
Command Modes
Global configuration
Command History
Usage Guidelines
The boot bootstrap command causes the router to load a secondary bootstrap image from the specified URL, such as from a remote server. After the bootstrap image is loaded, the bootstrap image loads the specified system image file. See the appropriate hardware installation guide for details on the setting the configuration register and secondary bootstrap filename.
Use this command when you have attempted to load a system image but have run out of memory even after compressing the system image. Secondary bootstrap images allows you to load a larger system image through a smaller secondary image.
Examples
In the following example, the system image file named sysimage-2 will be loaded by using a secondary bootstrap image:
Router(config)# boot bootstrap bootflash:sysimage-2boot buffersize
The boot buffersize global configuration command no longer functions.
Executing this command has no effect on the system. Using this command will not generate CLI errors; the boot buffersize command syntax is still allowed to be entered at the CLI and in configuration files in order to accommodate existing configuration scripts used by customers.
Command History
boot config
To specify the device and filename of the configuration file from which the router configures itself during initialization (startup), use the boot config command in global configuration mode. To remove the specification, use the no form of this command.
boot config file-system-prefix:[directory/]filename
no boot config
Syntax Description
Defaults
NVRAM (nvram:)
Command Modes
Global configuration
Command History
11.0
This command was introduced.
12.3(14)T
Support for Class B file system platforms and the following file system prefix options were added: usbflash[0-9]: and usbtoken[0-9]:.
Usage Guidelines
This command is available only on Class A and Class B file system platforms.
You set the CONFIG_FILE environment variable in the current running memory when you use the boot config command. This variable specifies the configuration file used for initialization (startup). The configuration file must be an ASCII file located in either NVRAM or Flash memory.
Note
The software displays an error message and does not update the CONFIG_FILE environment variable in the following situations:
•
•
The router uses the NVRAM configuration during initialization when the CONFIG_FILE environment variable does not exist or when it is null (such as at first-time startup). If the software detects a problem with NVRAM or the configuration it contains, the device enters setup mode.
When you use the no form of this command, the router returns to using the default NVRAM configuration file as the startup configuration.
Examples
In the following example, the first line specifies that the router should use the configuration file named router-config located in internal Flash memory to configure itself during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload.
Router(config)# boot config flash:router-configRouter(config)# endRouter# copy system:running-config nvram:startup-configThe following example instructs a Cisco 7500 series router to use the configuration file named router-config located on the Flash memory card inserted in the second PCMCIA slot of the RSP card during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload.
Router (config)# boot config slot1:router-configRouter (config)# endRouter# copy system:running-config nvram:startup-configRelated Commands
boot host
To specify the host-specific configuration file to be used at the next system startup, use the boot host command in global configuration mode. To restore the host configuration filename to the default, use the no form of this command.
boot host remote-url
no boot host remote-url
Syntax Description
Defaults
If you do not specify a filename using this command, the router uses its configured host name to request a configuration file from a remote server. To form the configuration filename, the router converts its name to all lowercase letters, removes all domain information, and appends -confg or -config.
Command Modes
Global configuration
Command History
Usage Guidelines
This command instructs the system to "Boot using host-specific configuration file x," where x is the filename specified in the remote-url argument. In other words, this command specifies the remote location and filename of the host-specific configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file.
Before using the boot host command, use the service config global configuration command to enable the loading of the specified configuration file at reboot time. Without this command, the router ignores the boot host command and uses the configuration information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service config command is enabled automatically.
The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot network command to identify the network configuration file. The second is the host configuration file containing commands that apply to one network server in particular. Use the boot host command to identify the host configuration file.
Note
With Cisco IOS Release 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active.
If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file.
The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg.Loading a Configuration File Using rcp
The rcp software requires that a client send the remote username on each rcp request to the network server. If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username.
When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list:
1.
2.
3.
Note
Loading a Configuration File Using FTP
The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory is associated with the username on the server. Refer to the documentation for your FTP server for more details.
When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list:
1.
2.
3.
The router sends the first valid password in the following list:
1.
2.
3.
Examples
The following example sets the host filename to wilma-confg at address 192.168.7.19:
Router(config)# boot host tftp://192.168.7.19/usr/local/tftpdir/wilma-confgRouter(config)# service configRelated Commands
boot network
To change the default name of the network configuration file from which to load configuration commands, use the boot network command in global configuration mode. To restore the network configuration filename to the default, use the no form of this command.
boot network remote-url
no boot network remote-url
Syntax Description
Defaults
The default filename is network-config.
Command Modes
Global configuration
Command History
Usage Guidelines
This command instructs the system to "Boot using network configuration file x," where x is the filename specified in the remote-url argument. This command specifies the remote location and filename of the network configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file.
When booting from a network server, routers ignore routing information, static IP routes, and bridging information. As a result, intermediate routers are responsible for handling FTP, rcp, or TFTP requests. Before booting from a network server, verify that a server is available by using the ping command.
Use theservice config command to enable the loading of the specified configuration file at reboot time. Without this command, the router ignores the boot network command and uses the configuration information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service config command is enabled automatically.
The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot network command to identify the network configuration file. The second is the host configuration file containing commands that apply to one network server in particular. Use the boot host command to identify the host configuration file.
Note
With Cisco IOS Release 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active.
If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file.
The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg.Loading a Configuration File Using rcp
The rcp software requires that a client send the remote username on each rcp request to the network server. If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username.
When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list:
1.
2.
3.
Note
Loading a Configuration File Using FTP
The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory associated with the username on the server. Refer to the documentation for your FTP server for more details.
When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list:
1.
2.
3.
The router sends the first valid password in the following list:
1.
2.
3.
Examples
The following example changes the network configuration filename to bridge_9.1 and uses the default broadcast address:
Router(config)# boot network tftp:bridge_9.1Router(config)# service configThe following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the network configuration file resides:
Router(config)# service configRouter(config)# boot network rcp://172.16.1.111/bridge_9.1Related Commands
boot system
To specify the system image that the router loads at startup, use one of the following boot system commands in global configuration mode. To remove the startup system image specification, use the no form of this command.
boot system {file-url | filename}
no boot system {file-url | filename}
boot system flash [flash-fs:] [partition-number:] [filename]
no boot system flash [flash-fs:] [partition-number:] [filename]
boot system mop filename [mac-address] [interface]
no boot system mop filename [mac-address] [interface]
boot system rom
no boot system rom
boot system {rcp | tftp | ftp} filename [ip-address]
no boot system {rcp | tftp | ftp} filename [ip-address]
Syntax Description
Defaults
If you configure the router to boot from a network server but do not specify a system image file with the boot system command, the router uses the configuration register settings to determine the default system image filename. The router forms the default boot filename by starting with the word cisco and then appending the octal equivalent of the boot field number in the configuration register, followed by a hyphen (-) and the processor type name (cisconn-cpu). Refer to the appropriate hardware installation guide for details on the configuration register and default filename. See also the config-register or confreg command.
Command Modes
Global configuration
Command History
Usage Guidelines
For this command to work, the config-register command must be set properly.
Enter several boot system commands to provide a fail-safe method for booting your router. The router stores and executes the boot system commands in the order in which you enter them in the configuration file. If you enter multiple boot commands of the same type—for example, if you enter two commands that instruct the router to boot from different network servers—then the router tries them in the order in which they appear in the configuration file. If a boot system command entry in the list specifies an invalid device, the router omits that entry. Use the boot system rom command to specify use of the ROM system image as a backup to other boot commands in the configuration.
For some platforms, the boot image must be loaded before the system image is loaded. However, on many platforms, the boot image is loaded only if the router is booting from a network server or if the flash file system is not specified. If the file system is specified, the router will boot faster because it need not load the boot image first.
This section contains the following usage guideline topics:
•
•
•
•
•
•
•
Changing the List of Boot System Commands
To remove a single entry from the bootable image list, use the no form of the command with an argument. For example, to remove the entry that specifies a bootable image on a flash memory card inserted in the second slot, use the no boot system flash slot1:[filename] command. All other entries in the list remain.
To eliminate all entries in the bootable image list, use the no boot system command. At this point, you can redefine the list of bootable images using the previous boot system commands. Remember to save your changes to your startup configuration by issuing the copy system:running-config nvram:startup-config command.
Each time you write a new software image to flash memory, you must delete the existing filename in the configuration file with the no boot system flash filename command. Then add a new line in the configuration file with the boot system flash filename command.
Note
Booting Compressed Images
You can boot the router from a compressed image on a network server. When a network server boots software, both the image being booted and the running image must fit into memory. Use compressed images to ensure that enough memory is available to boot the router. You can compress a software image on any UNIX platform using the compress command. Refer to your UNIX platform's documentation for the exact usage of the compress command. (You can also uncompress data with the UNIX uncompress command.)
Understanding rcp
The rcp requires that a client send the remote username in an rcp request to a server. When the router executes the boot system rcp command, the Cisco IOS software sends the hostname as both the remote and local usernames by default. For the rcp to execute properly, an account must be defined on the network server for the remote username configured on the router.
If the server has a directory structure, the rcp software searches for the system image to boot from the remote server relative to the directory of the remote username.
By default, the router software sends hostname as the remote username. You can override the default remote username by using the ip rcmd remote-username command. For example, if the system image resides in the home directory of a user on the server, you can specify that user's name as the remote username.
Understanding TFTP
You need a TFTP server running in order to retrieve the router image from the host.
Understanding FTP
You need to an FTP server running in order to fetch the router image from the host. You also need an account on the server or anonymous file access to the server.
Stopping Booting and Entering ROM Monitor Mode
During the first 60 seconds of startup, you can force the router to stop booting by pressing the Break key. The router will enter ROM Monitor mode, where you can change the configuration register value or boot the router manually.
Cisco 1600 Series, Cisco 3600 Series, and Cisco 7000 Family Router Notes
For the Cisco 3600 series and Cisco 7000 family, the boot system command modifies the BOOT variable in the running configuration. The BOOT variable specifies a list of bootable images on various devices.
Note
To view the contents of the BOOT variable, use the show bootenv privileged EXEC command.
Examples
The following example illustrates a configuration that specifies two possible internetwork locations for a system image, with the ROM software being used as a backup:
Router(config)# boot system tftp://192.168.7.24/cs3-rx.90-1Router(config)# boot system tftp://192.168.7.19/cs3-rx.83-2Router(config)# boot system romThe following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of the flash device:
Router(config)# boot system flash:2:igs-bpx-lThe following example instructs the router to boot from an image located on the flash memory card inserted in slot 0:
Router(config)# boot system slot0:new-configThe following example specifies the file named new-ios-image as the system image for a Cisco 3600 series router to load at startup. This file is located in the fourth partition of the flash memory card in slot 0.
Router(config)# boot system slot0:4:dirt/images/new-ios-imageThis example boots from the image file named c1600-y-l in partition 2 of flash memory of a Cisco 1600 series router:
Router(config)# boot system flash:2:c1600-y-lRelated Commands
boot-end-marker
The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software configuration files, are not CLI commands. These markers are written to configuration files automatically to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these markers allow the router to more reliably load Cisco IOS images during bootup.
A boot statement is one or more lines in a configuration file that tells the router which software image to load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around any boot commands, including:
•
•
•
•
•
Note, however, that these markers will always appear in the output of the show running-config or more system:running-config commands, regardless of whether any actual boot commands have been entered. This means that no boot commands will appear between the markers if no boot commands have been entered, or if all boot commands have been removed from the configuration, as shown in the "Examples" section.
The boot-start-marker and boot-end-marker flags cannot be removed or modified using the CLI. These markers are written to the startup configuration file whenever a copy running-config startup-config command is issued.
These flags were also introduced to circumvent errors in the configuration file, such as a leading space before a boot command (such as those sometimes introduced by manually edited configuration files), or the use of text strings that include the word "boot" in banners or other user-specified text.
If the "boot start-marker" flag is not found in the configuration file, the system will use the traditional method to identify the boot commands. However, if you are manually creating configuration files, or copying from older Cisco IOS software releases, the addition of these markers is recommended.
Command History
12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B,
The boot-start-marker and boot-end-marker flags were introduced.
Examples
In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file:
Router# configure terminalEnter configuration commands, one per line. End with the end command.Router(config)# boot system slot0:Router(config)# endRouter# copy running-config startup-configRouter# show startup-configUsing 1398 out of 129016 bytes!version 12.3service timestamps debug uptimeservice timestamps log uptimeno service password-encryption!hostname C3660-2!boot-start-markerboot system slot0:boot-end-marker!logging count...In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered:
Router# show running-configurationCurrent configuration :3055 bytes!! No configuration change since last restart!version 12.3service timestamps debug datetime msecservice timestamps log datetime msecno service password-encryption!hostname Router!boot-start-markerboot-end-marker!...Related Commands
boot-start-marker
The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software configuration files, are not CLI commands. These markers are written to configuration files automatically to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these markers allow the router to more reliably load Cisco IOS images during bootup.
A boot statement is one or more lines in a configuration file that tells the router which software image to load after a power cycling (reboot). The boot-start-marker and boot-end-marker flags will appear around any boot commands, including:
•
•
•
•
•
Note, however, that these markers will always appear in the output of the show running-config or more system:running-config commands, regardless of whether any actual boot commands have been entered. This means that no boot commands will appear between the markers if no boot commands have been entered, or if all boot commands have been removed from the configuration, as shown in the "Examples" section.
The boot-start-marker and boot-end-marker flags cannot be removed or modified using the CLI. These markers are written to the startup configuration file whenever a copy running-config startup-config command is issued.
These flags were also introduced to circumvent errors in the configuration file, such as a leading space before a boot command (such as those sometimes introduced by manually edited configuration files), or the use of text strings that include the word "boot" in banners or other user-specified text.
If the "boot start-marker" flag is not found in the configuration file, the system will use the traditional method to identify the boot commands. However, if you are manually creating configuration files, or copying from older Cisco IOS software releases, the addition of these markers is recommended.
Command History
12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B
The boot-start-marker and boot-end-marker flags were introduced.
Examples
In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file:
Router# configure terminalEnter configuration commands, one per line. End with the end command.Router(config)# boot system slot0:Router(config)# endRouter# copy running-config startup-configRouter# show startup-configUsing 1398 out of 129016 bytes!version 12.3service timestamps debug uptimeservice timestamps log uptimeno service password-encryption!hostname C3660-2!boot-start-markerboot system slot0:boot-end-marker!logging count...In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered:
Router# show running-configurationCurrent configuration :3055 bytes!! No configuration change since last restart!version 12.3service timestamps debug datetime msecservice timestamps log datetime msecno service password-encryption!hostname Router!boot-start-markerboot-end-marker!...Related Commands
buckets-of-history-kept
To set the number of history buckets that are kept during the lifetime of a Cisco IOS IP Service Level Agreements (SLAs) operation, use the buckets-of-history-kept command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode. To return to the default value, use the no form of this command.
buckets-of-history-kept size
no buckets-of-history-kept
Syntax Description
size
Number of history buckets kept during the lifetime of the operation. The default is 50 buckets.
Defaults
50 buckets
Command Modes
IP SLA Monitor Configuration
DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
Frame Relay configuration (config-sla-monitor-frameRelay)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
VoIP configuration (config-sla-monitor-voip)RTR Configuration
DHCP configuration (config-rtr-dhcp)
DLSw configuration (config-rtr-dlsw)
DNS configuration (config-rtr-dns)
Frame Relay configuration (config-rtr-frameRelay)
FTP configuration (config-rtr-ftp)
HTTP configuration (config-rtr-http)
ICMP echo configuration (config-rtr-echo)
ICMP path echo configuration (config-rtr-pathEcho)
ICMP path jitter configuration (config-rtr-pathJitter)
TCP connect configuration (config-rtr-tcp)
UDP echo configuration (config-rtr-udp)
Note
Command History
Usage Guidelines
Each time IP SLAs starts an operation, a new bucket is created until the number of history buckets matches the specified size or the operation's lifetime expires. History buckets do not wrap (that is, the oldest information is not replaced by newer information). The operation's lifetime is defined by the ip sla monitor schedule or rtr schedule global configuration command.
Note
An IP SLAs operation can collect history and capture statistics. By default, the history for an IP SLAs operation is not collected. If history is collected, each history bucket contains one or more history entries from the operation. When the operation type is ICMP path echo, an entry is created for each hop along the path that the operation takes to reach its destination. The type of entry stored in the history table is controlled by the filter-for-history command. The total number of entries stored in the history table is controlled by the combination of the samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept commands.
Note
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 13). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the buckets-of-history-kept command varies depending on the Cisco IOS release you are running (see Table 13) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP echo operation type is configured, you would enter the buckets-of-history-kept command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.
Examples
The following examples show how to configure IP SLAs ICMP echo operation 1 to keep 25 history buckets during the operation lifetime. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 13).
IP SLA Monitor Configuration
ip sla monitor 1type echo protocol ipIcmpEcho 172.16.161.21buckets-of-history-kept 25lives-of-history-kept 1!ip sla monitor schedule 1 start-time now life foreverRTR Configuration
rtr 1type echo protocol ipIcmpEcho 172.16.161.21buckets-of-history-kept 25lives-of-history-kept 1!rtr schedule 1 start-time now life foreverRelated Commands
buffer public
To enter the buffer owner configuration mode and set thresholds for buffer usage, use the buffer public command in resource policy node configuration mode. To disable this function, use the no form of this command.
buffer public
no buffer public
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Resource policy node configuration
Command History
Usage Guidelines
This command allows you to enter the buffer owner configuration mode and set rising and falling values for critical, major, and minor thresholds.
Examples
The following example shows how to enter buffer owner configuration mode:
Router(config-res-policy-node)# buffer publicRelated Commands
buffer tune automatic
To enable automatic tuning of buffers, use the buffer tune automatic command in global configuration mode. To disable automatic tuning of buffers, use the no form of this command.
buffer tune automatic
no buffer tune automatic
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables automatic tuning of buffers. Even when the command is not enabled, the parameters are computed. When you enable the command later, the buffer parameters change to the computed values.
Examples
The following example shows how to enable automatic tuning of buffers:
Router(config)# buffer tune automaticRelated Commands
buffer-length
To specify the maximum length of the data stream to be forwarded, use the buffer-length command in line configuration mode. To restore the default setting, use the no form of this command.
buffer-length length
no buffer-length
Syntax Description
length
Specifies the length of the buffer in bytes. Valid values for the length argument range from 16 to 1536. The default buffer length is 1536 bytes.
Defaults
1536 bytes
Command Modes
Line configuration
Command History
Usage Guidelines
The buffer-length command configures the size of the forwarded data stream. The higher the value used for the length argument is, the longer the delay between data transmissions will be. Configuring a smaller buffer length can prevent connections from timing out inappropriately.
Examples
The following example configures a buffer length of 500 bytes:
Router(config)# line 1Router(config-line)# buffer-length 500buffers
To make adjustments to initial buffer pool settings and to the limits at which temporary buffers are created and destroyed, use the buffers command in global configuration mode. To return the buffers to their default size, use the no form of this command.
buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free | min-free | initial} number-of-buffers
no buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free | min-free | initial} number-of-buffers
Syntax Description
Defaults
The default number of buffers in a pool is determined by the hardware configuration and can be displayed with the show buffers EXEC command.
Command Modes
Global configuration
Command History
Usage Guidelines
Normally you need not adjust these parameters; do so only after consulting with technical support personnel.
Note
You cannot configure FDDI buffers.
Examples
Examples of Public Buffer Pool Tuning
The following example keeps at least 50 small buffers free in the system:
Router(config)# buffers small min-free 50The following example increases the permanent buffer pool allocation for big buffers to 200:
Router(config)# buffers big permanent 200Example of Interface Buffer Pool Tuning
A general guideline is to display buffers with the show buffers command, observe which buffer pool is depleted, and increase that one.
The following example increases the permanent Ethernet interface 0 buffer pool on a Cisco 4000 router to 96 when the Ethernet 0 buffer pool is depleted:
Router(config)# buffers ethernet 0 permanent 96Related Commands
load-interval
Changes the length of time for which data is used to compute load statistics.
show buffers
Displays statistics for the buffer pools on the network server.
buffers huge size
To dynamically resize all huge buffers to the value you specify, use the buffers huge size command in global configuration mode. To restore the default buffer values, use the no form of this command.
buffers huge size number-of-bytes
no buffers huge size number-of-bytes
Syntax Description
Defaults
18,024 bytes
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command only after consulting with technical support personnel. The buffer size cannot be lowered below the default.
Note
Examples
The following example resizes huge buffers to 20,000 bytes:
Router(config)# buffers huge size 20000Related Commands
buffer-size (bulkstat)
To configure a maximum buffer size for the transfer of bulk statistics files, use the buffer-size command in Bulk Statistics Transfer configuration mode. To remove a previously configured buffer size from the configuration, use the no form of this command.
buffer-size bytes
no buffer-size bytes
Syntax Description
bytes
Size of the bulk statistics transfer buffer, in bytes. The valid range is from 1024 to 2147483647 bytes. The default buffer size is 2048 bytes.
Defaults
The default bulk statistics transfer buffer is 2048 bytes.
Command Modes
Bulk Statistics Transfer configuration (config-bulk-tr)
Command History
Usage Guidelines
A configurable buffer size limit is available primarily as a safety feature. Normal bulk statistics files should not generally meet or exceed the default value while being transferred.
Examples
In the following example, the bulk statistics transfer buffer size is set to 3072 bytes:
Router(config)# snmp mib bulkstat transfer bulkstat1Router(config-bulk-tr)# schema ATM2/0-IFMIBRouter(config-bulk-tr)# url primary ftp://user:pswrd@host/folder/bulkstat1Router(config-bulk-tr)# buffer-size 3072Router(config-bulk-tr)# enableRouter(config-bulk-tr)# exitRouter(config)#Related Commands
snmp mib bulkstat transfer
Identifies the transfer configuration with a name and enters Bulk Statistics Transfer configuration mode.
calendar set
To manually set the hardware clock (calendar), use one of the formats of the calendar set command in EXEC mode.
calendar set hh:mm:ss day month year
calendar set hh:mm:ss month day year
Syntax Description
hh:mm:ss
Current time in hours (using 24-hour notation), minutes, and seconds.
day
Current day (by date) in the month.
month
Current month (by name).
year
Current year (no abbreviation).
Command Modes
EXEC
Command History
Usage Guidelines
Some platforms have a hardware clock that is separate from the software clock. In Cisco IOS software syntax, the hardware clock is called the "calendar." The hardware clock is a battery-powered chip that runs continuously, even if the router is powered off or rebooted. After you set the hardware clock, the software clock will be automatically set from the hardware clock when the system is restarted or when the clock read-calendar EXEC command is issued. The time specified in this command is relative to the configured time zone.
Examples
The following example manually sets the hardware clock to 1:32 p.m. on May 19, 2003:
Router# calendar set 13:32:00 May 19 2003Related Commands
cd
To change the default directory or file system, use the cd command in EXEC mode.
cd [filesystem:]
Syntax Description
Defaults
The initial default file system is flash:. For platforms that do not have a physical device named flash:, the keyword flash: is aliased to the default Flash device.
If you do not specify a directory on a file system, the default is the root directory on that file system.
Command Modes
EXEC
Command History
Usage Guidelines
For all EXEC commands that have an optional filesystem argument, the system uses the file system specified by the cd command when you omit the optional filesystem argument. For example, the dir EXEC command, which displays a list of files on a file system, contain an optional filesystem argument. When you omit this argument, the system lists the files on the file system specified by the cd command.
Examples
In the following example, the cd command is used to set the default file system to the Flash memory card inserted in slot 0:
Router# pwdbootflash:/Router# cd slot0:Router# pwdslot0:/Related Commands
cdp advertise-v2
To enable Cisco Discovery Protocol Version 2 (CDPv2) advertising functionality on a device, use the cdp advertise-v2 command in global configuration mode. To disable advertising CDPv2 functionality, use the no form of the command.
cdp advertise-v2
no cdp advertise-v2
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Global configuration
Command History
Usage Guidelines
CDP Version 2 has three additional type-length values (TLVs): VTP Management Domain Name, Native VLAN, and full/half-Duplex.
Examples
In the following example, CDP Version 2 advertisements are disabled on the router:
Router# show cdpGlobal CDP information:Sending CDP packets every 60 secondsSending a holdtime value of 180 secondsSending CDPv2 advertisements is enabledRouter# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# no cdp advertise-v2Router(config)# endRouter# show cdpGlobal CDP information:Sending CDP packets every 60 secondsSending a holdtime value of 180 secondsSending CDPv2 advertisements is not enabledRouter#Related Commands
cdp enable
Enables CDP on a supported interface.
cdp run
Reenables CDP on a Cisco device.
cdp enable
To enable Cisco Discovery Protocol (CDP) on an interface, use the cdp enable command in interface configuration mode. To disable CDP on an interface, use the no form of this command.
cdp enable
no cdp enable
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled at the global level and on all supported interfaces.
Command Modes
Interface configuration
Command History
Usage Guidelines
CDP is enabled by default at the global level and on each supported interface in order to send or receive CDP information. However, some interfaces, such as ATM interfaces, do not support CDP.
Note
Examples
In the following example, CDP is disabled on the Ethernet 0 interface only:
Router# show cdpGlobal CDP information:Sending CDP packets every 60 secondsSending a holdtime value of 180 secondsSending CDPv2 advertisements is enabledRouter# config terminalRouter(config)# interface ethernet 0Router(config-if)# no cdp enableRelated Commands
cdp run
Reenables CDP on a Cisco device.
cdp timer
Specifies how often the Cisco IOS software sends CDP updates.
router odr
Enables on-demand routing on a hub router.
cdp holdtime
To specify the amount of time the receiving device should hold a Cisco Discovery Protocol (CDP) packet from the router before discarding it, use the cdp holdtime command in global configuration mode. To revert to the default setting, use the no form of this command.
cdp holdtime seconds
no cdp holdtime
Syntax Description
Defaults
180 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
CDP packets are sent with a time to live, or hold time, value. The receiving device will discard the CDP information in the CDP packet after the hold time has elapsed.
You can set the hold time lower than the default setting of 180 seconds if you want the receiving devices to update their CDP information more rapidly.
The CDP hold time must be set to a higher number of seconds than the time between CDP transmissions, which is set using the cdp timer command.
Examples
In the following example, the CDP packets being sent from the router are configured with a hold time of 60 seconds.
Router(config)# cdp holdtime 60Related Commands
cdp timer
Specifies how often the Cisco IOS software sends CDP updates.
show cdp
Displays global CDP information, including timer and hold-time information.
cdp log mismatch duplex
To display the log of duplex mismatches generated by the Cisco Discovery Protocol (CDP) on Ethernet interfaces on a router, use the cdp log mismatch duplex command in global configuration or interface configuration mode. To disable the display of duplex messages on all Ethernet interfaces, use the no form of this command.
cdp log mismatch duplex
no cdp log mismatch duplex
Syntax Description
This command has no arguments or keywords.
Defaults
The router reports duplex mismatches from all Ethernet interfaces.
Command Modes
Global configuration
Interface configurationCommand History
Usage Guidelines
When you enter the cdp log mismatch duplex command in global configuration mode, duplex mismatches are displayed on all Ethernet interfaces on the router. When you enter this command in interface configuration mode, only duplex mismatches for the specified Ethernet interface are displayed.
If the cdp log mismatch duplex command is disabled in global configuration mode, it cannot be configured per interface using interface configuration mode.
Duplex mismatch can occur only on Ethernet interfaces.
Examples
The following example of the cdp log mismatch duplex command in global configuration mode enables the display of duplex messages from all Ethernet interfaces on the router:
Router(config)# cdp log mismatch duplexThe following example of the cdp log mismatch duplex command in interface configuration mode enables only the display of duplex messages that may be generated from Ethernet interface 2/1:
Router(config-if)# interface ethernet2/1Router(config-if)# cdp log mismatch duplexThe following is sample output from the show running-config command. The bold text shows that the cdp log mismatch duplex command is disabled globally.
Router# show running-configBuilding configuration...Current configuration : 1395 bytes!version 12.2!hostname 7200_C!!interface Ethernet2/1no ip addressduplex halfno cdp log mismatch duplex!!!!!no cdp log mismatch duplexcdp timer 5!!!!line con 0line aux 0line vty 0 4password labRelated Commands
show running-config
Displays the contents of the currently running configuration file.
cdp run
To enable Cisco Discovery Protocol (CDP), use the cdp run command in global configuration mode. To disable CDP, use the no form of this command.
cdp run
no cdp run
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Global configuration
Command History
Usage Guidelines
CDP is enabled by default, which means the Cisco IOS software will receive CDP information. CDP also is enabled on supported interfaces by default. To disable CDP on an interface, use the no cdp enable interface configuration command.
Note
Examples
In the following example, CDP is disabled globally, then the user attempts to enable CDP on the Ethernet 0 interface:
Router(config)# no cdp runRouter(config)# endRouter# show cdp% CDP is not enabledRouter# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# int eth0Router(config-if)# cdp enable% Cannot enable CDP on this interface, since CDP is not runningRouter(config-if)#Related Commands
cdp enable
Enables CDP on a supported interface.
cdp timer
Specifies how often the Cisco IOS software sends CDP updates.
router odr
Enables ODR on the hub router.
cdp source-interface
To configure the Cisco Discovery Protocol source interface, use the cdp source-interface command in global configuration mode.
cdp source-interface type number
no cdp source-interface
Syntax Description
Defaults
No Cisco Discovery Protocol source-interface is specified.
Command Modes
Global configuration
Command History
Usage Guidelines
Use of this command ensures that Cisco Discovery Protocol packets use the IP address that has been previously assigned to an interface. Without this command, Cisco Discovery Protocol uses the IP address of the first available interface.
The conditions that an interface should satisfy to be the source interface are as follows:
•
•
•
When Cisco Discovery Protocol is enabled and the Cisco Discovery Protocol source interface has not been configured, then Cisco Discovery Protocol uses the IP address of the first available interface.
Examples
The following example configures Cisco Discovery Protocol to use the IP address that has been assigned to interface loopback 1.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cdp source-interface loopback 1Router(config)# exitRouter#Related Commands
cdp enable
Enables Cisco Discovery Protocol on a supported interface.
cdp run
Reenables Cisco Discovery Protocol on a Cisco device.
cdp timer
To specify how often the Cisco IOS software sends Cisco Discovery Protocol (CDP) updates, use the cdp timer command in global configuration mode. To revert to the default setting, use the no form of this command.
cdp timer seconds
no cdp timer
Syntax Description
Defaults
60 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
The trade-off with sending more frequent CDP updates to provide up-to-date information, is that bandwidth is used more often.
Note
Examples
In the following example, CDP updates are sent every 80 seconds, less frequently than the default setting of 60 seconds. You might want to make this change if you are concerned about preserving bandwidth.
cdp timer 80Related Commands
clear cdp counters
To reset Cisco Discovery Protocol (CDP) traffic counters to zero, use the clear cdp counters command in privileged EXEC mode.
clear cdp counters
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Examples
The following example clears the CDP counters. The show cdp traffic output shows that all of the traffic counters have been reset to zero.
Router# clear cdp countersRouter# show cdp trafficCDP counters:Packets output: 0, Input: 0Hdr syntax: 0, Chksum error: 0, Encaps failed: 0No memory: 0, Invalid packet: 0, Fragmented: 0Related Commands
clear cdp table
Clears the table that contains CDP information about neighbors.
show cdp traffic
Displays traffic information from the CDP table.
clear cdp table
To clear the table that contains Cisco Discovery Protocol (CDP) information about neighbors, use the clear cdp table command in privileged EXEC mode.
clear cdp table
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Examples
The following example clears the CDP table. The output of the show cdp neighbors command shows that all information has been deleted from the table.
Router# clear cdp tableCDP-AD: Deleted table entry for neon.cisco.com, interface Ethernet0CDP-AD: Deleted table entry for neon.cisco.com, interface Serial0Router# show cdp neighborsCapability Codes: R - Router, T - Trans Bridge, B - Source Route BridgeS - Switch, H - Host, I - IGMPDevice ID Local Intrfce Holdtme Capability Platform Port IDRelated Commands
clear cns config stats
To clear the statistics about the CNS configuration agent, use the clear cns config stats command in privileged EXEC mode.
clear cns config stats
Syntax Description
This command has no arguments or keywords.
Defaults
No statistics are cleared.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The clear cns config stats command clears all the statistics displayed by the show cns config stats command.
Examples
The following example shows how to clear all of the statistics for the CNS configuration agent:
Router# clear cns config statsRelated Commands
clear cns counters
To clear all CNS statistics, use the clear cns counters command in privileged EXEC mode.
clear cns counters
Syntax Description
This command has no arguments or keywords.
Defaults
No statistics are cleared.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The clear cns counters command clears all the statistics tracked and displayed by CNS agents.
Examples
The following example shows how to clear all of the statistics used by CNS:
Router# clear cns countersRelated Commands
clear cns event stats
To clear the statistics about the CNS event agent, use the clear cns event stats command in privileged EXEC mode.
clear cns event stats
Syntax Description
This command has no arguments or keywords.
Defaults
No statistics are cleared.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The clear cns event stats command clears all the statistics displayed by the show cns event stats command.
Examples
The following example shows how to clear all of the statistics for the CNS event agent:
Router# clear cns event statsRelated Commands
clear cns image connections
To clear the CNS image agent connections statistics, use the clear cns image connections command in privileged EXEC mode.
clear cns image connections
Syntax Description
This command has no arguments or keywords.
Defaults
No statistics are cleared.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The clear cns image connections command clears all the statistics displayed by the show cns image connections command.
Examples
The following example shows how to clear all of the connection statistics for the CNS image agent:
