-
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
process cpu statistics limit entry-percentage
rtr responder type frame-relay
rtr slm frame-relay statistics
ping
To diagnose basic network connectivity on AppleTalk, ATM, Connectionless Network Service (CLNS), DECnet, IP, Novell IPX, or source-route bridging (SRB) networks, use the ping command in user EXEC or privileged EXEC mode.
ping [[protocol [tag] {host-name | system-address}]
Syntax Description
Command Modes
User EXEC
Privileged EXECCommand History
Usage Guidelines
The ping command sends an echo request packet to an address, and then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. For example, the ping clns command sends International Organization for Standardization (ISO) CLNS echo packets to test the reachability of a remote router over a connectionless Open System Interconnection (OSI) network.
If you enter the ping command without any other syntax (ping<cr>), the CLI will display an interactive system dialog that prompts you for the additional syntax appropriate to the protocol you specify (See the "Examples" section).
To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The default escape sequence is Ctrl-^,X (Simultaneously press and release the Ctrl, Shift, and 6 keys and then press the X key). The escape sequence will vary depending on your line configuration. For example, another commonly used escape sequence is Ctrl-c.
Table 53 describes the test characters sent by the ping facility.
Note
Not all protocols require hosts to support pings. For some protocols, the pings are Cisco-defined and can be answered only by another Cisco router.
The availability of protocol keywords depends on what protocols are enabled on your system.
Issuing the ping command in User EXEC mode will generally offer fewer syntax options than issuing the ping command in Privileged EXEC mode.
Examples
After you enter the ping command in privileged EXEC mode, the system prompts you for a protocol keyword. The default protocol is IP.
If you enter a host name or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.
The following example is sample dialog from the ping command using default values. The specific dialog varies somewhat from protocol to protocol.
Router# pingProtocol [ip]:Target IP address: 192.168.7.27Repeat count [5]:Datagram size [100]:Timeout in seconds [2]:Extended commands [n]:Sweep range of sizes [n]:Type escape sequence to abort.Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:!!!!!Success rate is 100 percent, round-trip min/avg/max = 1/2/4 msTable 54 describes the significant fields shown in the display.
Table 54 ping Field Descriptions for IP
Protocol [ip]:
Prompts for a supported protocol. Default: ip.
Target IP address:
Prompts for the IP address or host name of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here. Default: none.
Repeat count [5]:
Number of ping packets that will be sent to the destination address. Default: 5.
Datagram size [100]:
Size of the ping packet (in bytes). Default: 100 bytes.
Timeout in seconds [2]:
Timeout interval. Default: 2 (seconds).
Extended commands [n]:
Specifies whether a series of additional commands appears.
Sweep range of sizes [n]:
Allows you to vary the sizes of the echo packets being sent. This capability is useful for determining the minimum sizes of the MTUs1 configured on the nodes along the path to the destination address. Packet fragmentation contributing to performance problems can then be reduced.
!!!!!
Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.
Success rate is 100 percent
Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic.
round-trip min/avg/max = 1/2/4 ms
Round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds).
1 MTU = maximum transmission unit
The following example verifies connectivity to the neighboring ATM device for the ATM PVC with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16:
Router# pingProtocol [ip]:atmATM Interface:atm1/0VPI value [0]:VCI value [1]:16Loopback - End(0), Segment(1) [0]:1Repeat Count [5]:Timeout [2]:Type escape sequence to abort.Sending 5, 53-byte segment OAM echoes, timeout is 2 seconds:!!!!!Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/1 msTable 55 describes the default ping fields shown in the display.
Related Commands
ping ip
To test network connectivity on IP networks, use the ping ip command in privileged EXEC mode.
ping ip {host-name | ip-address} [data [hex-data-pattern] | df-bit | repeat [repeat-count] | size [datagram-size] [source {source-address | source-interface} ] [timeout seconds] [validate] [verbose]
Syntax Description
Command Modes
Privileged EXEC
Command History
10.0
This command was introduced.
12.0
The data, df-bit, repeat, size, source, timeout, and validate keywords were added.
Usage Guidelines
The ping command sends an echo request packet to an address, then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.
To abnormally terminate a ping session, type the escape sequence—by default, Ctrl-^ X. You type the default by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing the X key.
Table 56 describes the test characters that the ping facility sends.
Note
Examples
After you enter the ping command in privileged mode, the system prompts you for a protocol keyword. The default protocol is IP.
If you enter a host name or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.
The optional data, df-bit, repeat, size, source, timeout, and validate keywords can be used to avoid extended ping command output. You can use as many of these keywords as you need, and you can use them in any order after the host-name or system-address arguments.
Although the precise dialog varies somewhat from protocol to protocol, all are similar to the ping session using default values shown in the following output:
Router# pingProtocol [ip]:Target IP address: 192.168.7.27Repeat count [5]:Datagram size [100]:Timeout in seconds [2]:Extended commands [n]:Sweep range of sizes [n]:Type escape sequence to abort.Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:!!!!!Success rate is 100 percent, round-trip min/avg/max = 1/2/4 msTable 57 describes the default ping fields shown in the display.
Related Commands
ping ipv6
Tests the connection to a remote host on the network using IPv6.
ping vrf
Tests the connection in the context of a specific VPN (VRF).
ping vrf
To test a connection in the context of a specific VPN connection, use the ping vrf command in Exec mode.
ping vrf vrf-name [tag] [connection] target-address [connection-options]
Syntax Description
Defaults
The default connection type for ping is IP (specifically, IPv4).
Command Modes
User EXEC
Privileged EXECCommand History
Usage Guidelines
A VPN routing/forwarding (VRF) instance is used to identify a VPN. To check if a configured VRF is working, you can use the ping vrf command.
When attempting to ping from a provider edge (PE) router to a customer edge (CE) router, or from a PE router to PE router, the standard ping command will not usually work. The ping vrf command allows you to ping the IP addresses of LAN interfaces on CE routers.
If you are on a PE router, be sure to indicate the specific VRF (VPN) name, as shown in the "Examples" section.
If all required information is not provided at the command line, the system will enter the interactive dialog (extended mode) for ping.
Examples
In the following example, the target host in the domain 209.165.201.1 is pinged (using IP/ICMP) in the context of the "Customer_A" VPN connection.
Router# ping vrf Customer_A 209.165.201.1Type escape sequence to abort.Sending 5, 100-byte ICMP Echos to 209.165.201.1, timeout is 2 seconds:!!!!!Success rate is 100 percent (5/5), round-trip min/avg/max = 176/264/576 msPressing the Enter key before providing all of the required options will begin the interactive dialog for ping. In the following example, the interactive dialog is started after the "ip" protocol is specified, but no address is given:
Router# ping vrf Customer_B ipTarget IP address: 209.165.200.225Repeat count [5]:Datagram size [100]:Timeout in seconds [2]:Extended commands [n]: ySource address or interface:Type of service [0]:Set DF bit in IP header? [no]:Validate reply data? [no]:Data pattern [0xABCD]:Loose, Strict, Record, Timestamp, Verbose[none]: RecordNumber of hops [ 9 ]:Loose, Strict, Record, Timestamp, Verbose[RV]:Sweep range of sizes [n]:Type escape sequence to abort.Sending 5, 100-byte ICMP Echos to 209.165.200.225, timeout is 2 seconds:Packet has IP options: Total option bytes= 39, padded length=40Record route: <*>(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)(0.0.0.0)...Success rate is 100 percent (5/5), round-trip min/avg/max = 4/4/4 msThe following example shows the various options for IP in the ping vrf command:
Router# show parser dump exec | include ping vrf1 ping vrf <string>1 ping vrf <string> ip <string>1 ping vrf <string> ip (interactive)1 ping vrf <string> ip <string>1 ping vrf <string> ip <string> source <address>1 ping vrf <string> ip <string> source <interface>1 ping vrf <string> ip <string> repeat <1-2147483647>1 ping vrf <string> ip <string> size Number1 ping vrf <string> ip <string> df-bit1 ping vrf <string> ip <string> validate1 ping vrf <string> ip <string> data <0-65535>1 ping vrf <string> ip <string> timeout <0-3600>1 ping vrf <string> ip <string> verbose1 ping vrf <string> ip <string> data <0-65535>1 ping vrf <string> ip <string> timeout <0-3600>1 ping vrf <string> tag1 ping vrf <string> atm1 ping vrf <string> ipv61 ping vrf <string> appletalk1 ping vrf <string> decnet1 ping vrf <string> clns1 ping vrf <string> ipx1 ping vrf <string> sna1 ping vrf <string> srbRelated Commands
policy (ERM)
To configure an ERM resource policy, use the policy command in ERM configuration mode. To disable this function, use the no form of this command.
policy policy-name [global | type resource-user-type]
no policy policy-name
Syntax Description
Command Default
Disabled
Command Modes
ERM configuration
Command History
Usage Guidelines
You can configure a resource policy only in ERM configuration mode.
Examples
The following example shows how to configure a resource policy with the policy name cpu_mem_policy and the resource type iosprocess:
Router(config-erm)# policy cpu_mem_policy type iosprocessRelated Commands
policy (resource group)
To apply an already configured policy to a specified resource group, use the policy command in resource group configuration mode. To disable this function, use the no form of this command.
policy policy-name
no policy policy-name
Syntax Description
policy-name
Applies the specified policy to a resource group. The policy-name argument specifies the name of the policy you want to apply to the resource group.
Command Default
Disabled
Command Modes
Resource group configuration
Command History
Usage Guidelines
Before applying a policy to a resource group, you must configure a resource policy using the policy policy-name command in ERM configuration mode and create a resource group using the user group resource-group-name type resource-user-type command in ERM configuration mode.
When you apply a policy using the policy policy-name command in resource group configuration mode, you are applying a policy (which contains the thresholds) to the resource group you created using the user group resource-group-name type resource-user-type command in ERM configuration mode.
For example, say you have created a resource group with the name lowPrioUsers and iosprocess as the type. You have some low-priority RUs or tasks like HTTP and SNMP, and you want to set a threshold for all the low-priority RUs together, not separately. You must add the RUs to the resource group using the instance instance-name command and then apply a resource policy. If the resource policy you applied sets a minor rising threshold value of 10% for the resource group, then when the accumulated usage of both HTTP and SNMP RUs crosses the 10% mark, a notification is sent to the RUs in the resource group lowPrioUsers. That is, if HTTP usage is 4% and SNMP usage is 7%, then a notification is sent to the resource group. This facility helps to set thresholds for a group of RUs, as it is difficult to set a threshold for every single RU.
Examples
The following example shows how to apply a resource policy named cpu_mem_policy to a resource group named lowPrioUsers:
Router(config-erm)# user group lowPrioUsers type iosprocessRouter(config-res-group)# policy group-policy1Related Commands
policy-list
To associate a policy list with a Command Scheduler occurrence, use the policy-list command in kron-occurrence configuration mode. To delete a policy list from the Command Scheduler occurrence, use the no form of this command.
policy-list list-name
no policy-list list-name
Syntax Description
list-name
Name of policy list. If the list-name is new, a policy list structure will be created. If the list-name is not new, the existing policy list will be edited.
Defaults
No policy list is associated.
Command Modes
Kron-occurrence configuration (config-kron-occurrence)
Command History
Usage Guidelines
Use the policy-list command with the kron occurrence command to schedule one or more policy lists to run at the same time or interval. Use the kron policy-list command in conjunction with the cli command to create a Command Scheduler policy list containing EXEC command line interface (CLI) commands to be scheduled to run on the router at a specified time.
The Command Scheduler process is useful to automate the running of EXEC commands at recurring intervals, and can it be used in remote routers to minimize manual intervention.
Examples
The following example shows how to create a Command Scheduler occurrence named may and associate a policy list named sales-may with the occurrence:
Router(config)# kron occurrence may at 6:30 may 20 oneshotRouter(config-kron-occurrence)# policy-list sales-mayRelated Commands
poll-interval
To configure the polling interval for a bulk statistics schema, use the poll-interval command in Bulk Statistics Schema configuration mode. To remove a previously configured polling interval, use the no form of this command.
poll-interval minutes
no poll-interval minutes
Syntax Description
minutes
Polling interval of data for this schema in minutes. The valid range is from 1 minute to 20000 minutes. The default is 5 minutes.
Defaults
Object instances are polled once every five minutes.
Command Modes
Bulk Statistics Schema configuration (config-bulk-sc)
Command History
Usage Guidelines
The poll-interval command sets how often the MIB instances specified by the schema and associated object list are to be polled. Collected data is stored in the local bulk statistics file for later transfer.
Examples
In the following example the polling interval for bulk statistics collection is set to once every 3 minutes in the schema called Ethernet2/1-CAR:
Router(config)# snmp mib bulkstat schema Ethernet2/1-CARRouter(config-bulk-sc)# object-list CAR-mibRouter(config-bulk-sc)# poll-interval 3Router(config-bulk-sc)# instance wildcard oid 3.1Router(config-bulk-sc)# exitRelated Commands
snmp mib bulkstat schema
Names a bulk statistics schema and enters Bulk Statistics Schema configuration mode.
printer
To configure a printer and assign a server tty line (or lines) to it, use the printer command in global configuration mode. To disable printing on a tty line, use the no form of this command.
printer printer-name {line number | rotary number} [newline-convert | formfeed]
no printer
Syntax Description
Defaults
No printers are defined by default.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables you to configure a printer for operations and assign either a single tty line or a group of tty lines to it. To make multiple printers available through the same printer name, specify the number of a rotary group.
In addition to configuring the printer with the printer command, you must modify the file /etc/printcap on your UNIX system to include the definition of the remote printer in the Cisco IOS software. Refer to the Cisco IOS Configuration Fundamentals Configuration Guide for additional information.
Use the optional newline-convert keyword in UNIX environments that cannot handle single-character line terminators. This converts newline characters to a carriage-return, linefeed sequence. Use the formfeed keyword when using the line printer daemon (lpd) protocol to print and your system is unable to separate individual output jobs with a form feed (page eject). You can enter the newline-convert and formfeed keywords together and in any order.
Examples
In the following example a printer named printer1 is configured and output is assigned to tty line 4:
Router(config)# printer printer1 line 4Related Commands
private
To save user EXEC command changes between terminal sessions, use the private command in line configuration mode. To restore the default condition, use the no form of this command.
private
no private
Syntax Description
This command has no arguments or keywords.
Defaults
User-set configuration options are cleared with the exit EXEC command or when the interval set with the exec-timeout line configuration command has passed.
Command Modes
Line configuration
Command History
Usage Guidelines
This command ensures that the terminal parameters set by the user remain in effect between terminal sessions. This behavior is desirable for terminals in private offices.
Examples
In the following example, line 15 (in this example, vty 1) is configured to keep all user-supplied settings at system restarts:
Router(config)# line 15Router(config-line)# privateRelated Commands
process cpu statistics limit entry-percentage
To set the process entry limit and the size of the history table for CPU utilization statistics, use the process cpu statistics limit entry-percentage command in global configuration mode. To disable CPU utilization statistics, use the no form of this command.
process cpu statistics limit entry-percentage number [size seconds]
no process cpu statistics limit entry-percentage
Syntax Description
Defaults
size seconds: 600 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
Use the process cpu statistics limit entry-percentage command to set the entry limit and size of CPU utilization statistics.
Examples
The following example shows how to set an entry limit at 40 percent and a size of 300 seconds:
Router(config)# process cpu statistics limit entry-percentage 40 size 300Related Commands
process cpu threshold type
To set CPU thresholding notification types and values, use the process cpu threshold type command in global configuration mode. To disable CPU thresholding notifications, use the no form of this command.
process cpu threshold type {total | process | interrupt} rising percentage interval seconds [falling percentage interval seconds]
no process cpu threshold type {total | process | interrupt}
Syntax Description
Defaults
CPU thresholding notifications are disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This command defines CPU usage thresholds that, when crossed, cause a CPU thresholding notification. When this command is enabled, Cisco IOS software polls the system at the configured interval. Notification occurs in two situations:
•
•
Examples
The following example shows how to set the total CPU utilization notification threshold at 80 percent for a rising threshold notification and 20 percent for a falling threshold notification, with a 5-second polling interval.
Router(config)# process cpu threshold type total rising 80 interval 5 falling 20 interval 5Related Commands
process-max-time
To configure the amount of time after which a process should voluntarily yield to another process, use the process-max-time command in global configuration mode. To reset this value to the system default, use the no form of this command.
process-max-time milliseconds
no process-max-time milliseconds
Syntax Description
milliseconds
Maximum duration (in milliseconds) that a process can run before suspension. The range is from 20to 200 milliseconds.
Defaults
The default maximum process time is 200 milliseconds.
Command Modes
Global configuration
Command History
Usage Guidelines
Lowering the maximum time a process can run is useful in some circumstances to ensure equitable division of CPU time among different tasks.
Only use this command if recommended to do so by the Cisco Technical Assistance Center (TAC).
Examples
The following example limits the duration that a process will run to 100 milliseconds:
Router(config)# process-max-time 100processes cpu autoprofile hog
To enable automatic profiling of CPUHOGs, use the processes cpu autoprofile hog command in global configuration mode. To disable this function, use the no form of this command.
processes cpu autoprofile hog
no processes cpu autoprofile hog
Syntax Description
This command has no arguments or keywords.
Command Default
Enabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables automatic profiling of CPUHOGS by monitoring the CPUHOG process and starting the profiling process at the same time.
Examples
The following example shows how to enable automatic profiling of CPUHOGS:
Router(config)# processes cpu autoprofile hogRelated Commands
processes cpu extended
To enable or disable the collection or to change the history size of extended CPU load, use the processes cpu extended command in global configuration mode. If the command is not configured, the default behavior is to collect one minute history. To disable this function, use the no form of this command.
processes cpu extended [history history-size]
no processes cpu extended
Syntax Description
Command Default
Enabled
Command Modes
Global configuration
Command History
Examples
The following example shows how to enable the collection of extended CPU load for a history size of 36 (which is equivalent to 3 minutes of history):
Router(config)# processes cpu extended history 36Related Commands
prompt
To customize the CLI prompt, use the prompt command in global configuration mode. To revert to the default prompt, use the no form of this command.
prompt string
no prompt [string]
Syntax Description
string
Text that will be displayed on screen as the CLI prompt, including any desired prompt variables.
Defaults
The default prompt is either Router or the name defined with the hostname global configuration command, followed by an angle bracket (>) for user EXEC mode or a pound sign (#) for privileged EXEC mode.
Command Modes
Global configuration
Command History
Usage Guidelines
You can include customized variables when specifying the prompt. All prompt variables are preceded by a percent sign (%). Table 58 lists the available prompt variables.
Issuing the prompt %h command has the same effect as issuing the no prompt command.
Examples
The following example changes the EXEC prompt to include the tty number, followed by the name and a space:
Router(config)# prompt TTY%n@%h%s%pThe following are examples of user and privileged EXEC prompts that result from the previous command:
TTY17@Router1 > enableTTY17@Router1 #Related Commands
pwd
To show the current setting of the cd command, use the pwd command in user EXEC or privileged EXEC mode.
pwd
Syntax Description
This command has no arguments or keywords.
Command Modes
User EXEC
Privileged EXECCommand History
Usage Guidelines
Use the pwd command to show which directory or file system is specified as the default by the cd command. For all EXEC commands that have an optional filesystem argument, the system uses the file system specified by the cd command when you omit the optional filesystem argument.
For example, the dir command contains an optional filesystem argument and displays a list of files on a particular file system. When you omit this filesystem argument, the system shows a list of the files on the file system specified by the cd command.
Examples
The following example shows that the present working file system specified by the cd command is slot 0:
Router> pwdslot0:/The following example uses the cd command to change the present file system to slot 1 and then uses the pwd command to display that present working file system:
Router> cd slot1:Router> pwdslot1:/Related Commands
cd
Changes the default directory or file system.
dir
Displays a list of files on a file system.
redistribute (IP)
To redistribute routes from one routing domain into another routing domain, use the redistribute command in router configuration mode. To disable redistribution, use the no form of this command.
redistribute protocol [process-id] {level-1 | level-1-2 | level-2} [as-number] [metric {metric-value | transparent}] [metric-type type-value] [match {internal | external 1 | external 2}]
[tag tag-value] [route-map map-tag] [subnets]no redistribute protocol [process-id] {level-1 | level-1-2 | level-2} [as-number] [metric {metric-value | transparent}] [metric-type type-value] [match {internal | external 1 | external 2}] [tag tag-value] [route-map map-tag] [subnets]
Syntax Description
Command Default
Route redistribution is disabled.
protocol: No source protocol is defined.
process-id: No process ID is defined.
metric metric-value: 0
metric-type type-value: Type 2 external route
match internal | external: Internal, external 1, external 2
external: Internal
tag tag-value: If no value is specified, the remote autonomous system number is used for routes from BGP and EGP; for other protocols, the default is 0.
route-map map-tag: If the route-map keyword is not entered, all routes are redistributed; if no map-tag value is entered, no routes are imported.
subnets: No subnets are defined.Command Modes
Router configuration
Address family configurationCommand History
Usage Guidelines
Changing or disabling any keyword will not affect the state of other keywords.
A router receiving a link-state protocol with an internal metric will consider the cost of the route from itself to the redistributing router plus the advertised cost to reach the destination. An external metric only considers the advertised metric to reach the destination.
Routes learned from IP routing protocols can be redistributed at Level 1 into an attached area or at Level 2. The level-1-2 keyword allows both Level 1 and Level 2 routes in a single command.
Redistributed routing information must be filtered by the distribute-list out router configuration command. This guideline ensures that only those routes intended by the administrator are passed along to the receiving routing protocol.
Whenever you use the redistribute or the default-information router configuration commands to redistribute routes into an OSPF routing domain, the router automatically becomes an ASBR. However, an ASBR does not, by default, generate a default route into the OSPF routing domain.
When routes are redistributed into OSPF from protocols other than OSPF or BGP, and no metric has been specified with the metric-type keyword and type-value argument, OSPF will use 20 as the default metric. When routes are redistributed into OSPF from BGP, OSPF will use 1 as the default metric. When routes are redistributed from one OSPF process to another OSPF process, Autonomous system (AS) external and not-so-stubby-area (NSSA) routes will use 20 as the default metric. When intra-area and inter-area routes are redistributed between OSPF processes, the internal OSPF metric from the redistribution source process is advertised as the external metric in the redistribution destination process. (This is the only case in which the routing table metric will be preserved when routes are redistributed into OSPF.)
When routes are redistributed into OSPF, only routes that are not subnetted are redistributed if the subnets keyword is not specified.
Routes configured with the connected keyword affected by this redistribute command are the routes not specified by the network router configuration command.
You cannot use the default-metric command to affect the metric used to advertise connected routes.
Note
Default redistribution of IGPs or EGP into BGP is not allowed unless the default-information originate router configuration command is specified.
Examples
The following example shows how OSPF routes are redistributed into a BGP domain:
router bgp 109redistribute ospfThe following example causes Enhanced Interior Gateway Routing Protocol (EIGRP) routes to be redistributed into an OSPF domain:
router ospf 110redistribute eigrpThe following example causes the specified EIGRP process routes to be redistributed into an OSPF domain. The EIGRP-derived metric will be remapped to 100 and RIP routes to 200.
router ospf 109redistribute eigrp 108 metric 100 subnetsredistribute rip metric 200 subnetsThe following example configures BGP routes to be redistributed into IS-IS. The link-state cost is specified as 5, and the metric type will be set to external, indicating that it has lower priority than internal metrics.
router isisredistribute bgp 120 metric 5 metric-type externalIn the following example, network 172.16.0.0 will appear as an external link-state advertisement (LSA) in OSPF 1 with a cost of 100 (the cost is preserved):
interface ethernet 0ip address 172.16.0.1 255.0.0.0ip ospf cost 100interface ethernet 1ip address 10.0.0.1 255.0.0.0!router ospf 1network 10.0.0.0 0.255.255.255 area 0redistribute ospf 2 subnetrouter ospf 2network 172.16.0.0 0.255.255.255 area 0Related Commands
refuse-message
To define and enable a line-in-use message, use the refuse-message command in line configuration mode. To disable the message, use the no form of this command.
refuse-message d message d
no refuse-message
Syntax Description
d
Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the message.
message
Message text.
Defaults
Disabled (no line-in-use message is displayed).
Command Modes
Line configuration
Command History
Usage Guidelines
Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. You cannot use the delimiting character within the text of the message.
When you define a message using this command, the Cisco IOS software performs the following steps:
1.
2.
3.
Examples
In the following example, line 5 is configured with a line-in-use message, and the user is instructed to try again later:
line 5refuse-message /The dial-out modem is currently in use.Please try again later./reload
To reload the operating system, use the reload command in privileged EXEC mode.
reload [/verify | /noverify] [warm [file url]] [in [hh:]mm | at hh:mm [month day | day month]] [cancel] [text]
Syntax Description
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The reload command halts the system. If the system is set to restart on error, it reboots itself. Use the reload command after configuration information is entered into a file and saved to the startup configuration.
You cannot reload from a virtual terminal if the system is not set up for automatic booting. This restriction prevents the system from dropping to the ROM monitor (ROMMON) and thereby taking the system out of the remote user's control.
If you modify your configuration file, the system prompts you to save the configuration. During a save operation, the system prompts whether you want to proceed with the save if the CONFIG_FILE variable points to a startup configuration file that no longer exists. If you say "yes" in this situation, the system enters setup mode upon reload.
When you schedule a reload to occur at a later time, it must take place within approximately 24 days.
The at keyword can be used only if the system clock has been set on the router (either through Network Time Protocol (NTP), the hardware calendar, or manually). The time is relative to the configured time zone on the router. To schedule reloads across several routers to occur simultaneously, the time on each router must be synchronized with NTP.
To display information about a scheduled reload, use the show reload EXEC command.
The /verify and /noverify Keywords
If the /verify keyword is specified, the integrity of the image will be verified before it is reloaded onto a router. If verification fails, the image reload will not occur. Image verification is important because it assures the user that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user.
The /noverify keyword overrides any global automatic image verification that may be enabled via the file verify auto command.
The warm Keyword
If you issue the reload command after you have configured the warm-reboot global configuration command, a cold reboot will occur. Thus, if you wish to reload your system, but do not want to override the warm reboot functionality, you should specify the warm keyword with the reload command. The warm reboot functionality allows a Cisco IOS image to reload without ROMMON intervention. That is, read-write data is saved in RAM during a cold startup and restored during a warm reboot. Warm rebooting allows the router to reboot quicker than conventional rebooting (where control is transferred to ROMMON and back to the image) because nothing is copied from flash to RAM.
Examples
The following example shows how to immediately reloads the software on the router:
Router# reloadThe following example shows how to reload the software on the router in 10 minutes:
Router# reload in 10Router# Reload scheduled for 11:57:08 PDT Fri Apr 21 1996 (in 10 minutes)Proceed with reload? [confirm]Router#The following example shows how to reload the software on the router at 1:00 p.m. today:
Router# reload at 13:00Router# Reload scheduled for 13:00:00 PDT Fri Apr 21 1996 (in 1 hour and 2 minutes)Proceed with reload? [confirm]Router#The following example shows how to reload the software on the router on April 20 at 2:00 a.m.:
Router# reload at 02:00 apr 20Router# Reload scheduled for 02:00:00 PDT Sat Apr 20 1996 (in 38 hours and 9 minutes)Proceed with reload? [confirm]Router#The following example shows how to cancel a pending reload:
Router# reload cancel%Reload cancelled.The following example shows how to perform a warm reboot at 4:00 today:
Router# reload warm at 4:00
The following example shows how to specify image verification via the /verify keyword before reloading an image onto the router:
Router# reload /verifyVerifying file integrity of bootflash:c7200-kboot-mz.121-8a.E%ERROR:Signature not found in file bootflash:c7200-kboot-mz.121-8a.E.Signature not present. Proceed with verify? [confirm]Verifying file disk0:c7200-js-mz ......................................................................................................................................Done!Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCDComputed Hash MD5 :CFA258948C4ECE52085DCF428A426DCDCCO Hash MD5 :44A7B9BDDD9638128C35528466318183Signature VerifiedProceed with reload? [confirm]nRelated Commands
rename
To rename a file in a Class C Flash file system, use the rename command in user EXEC or privileged EXEC mode.
rename url1 url2
Syntax Description
Command Modes
User EXEC
Privileged EXECCommand History
Usage Guidelines
This command is valid only on Class C Flash file systems.
Examples
In the following example, the file named Karen.1 is renamed test:
Router# dirDirectory of disk0:/Karen.dir/0 -rw- 0 Jan 21 1998 09:51:29 Karen.10 -rw- 0 Jan 21 1998 09:51:29 Karen.20 -rw- 0 Jan 21 1998 09:51:29 Karen.30 -rw- 0 Jan 21 1998 09:51:31 Karen.4243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur340492288 bytes total (328400896 bytes free)Router# rename disk0:Karen.dir/Karen.1 disk0:Karen.dir/testRouter# dirDirectory of disk0:/Karen.dir/0 -rw- 0 Jan 21 1998 09:51:29 Karen.20 -rw- 0 Jan 21 1998 09:51:29 Karen.30 -rw- 0 Jan 21 1998 09:51:31 Karen.4243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur0 -rw- 0 Apr 24 1998 09:49:19 test340492288 bytes total (328384512 bytes free)request-data-size
To set the protocol data size in the payload of a Cisco IOS IP Service Level Agreements (SLAs) operation's request packet, use the request-data-size 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.
request-data-size bytes
no request-data-size
Syntax Description
bytes
Size of the protocol data in the payload of the request packet of the operation. Range is 0 to the maximum of the protocol.
Defaults
The default data size will vary depending on the type of IP SLAs operation you are configuring.
Command Modes
IP SLA Monitor Configuration
DLSw configuration (config-sla-monitor-dlsw)
Frame Relay configuration (config-sla-monitor-frameRelay)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)RTR Configuration
DLSw configuration (config-rtr-dlsw)
Frame Relay configuration (config-rtr-frameRelay)
ICMP echo configuration (config-rtr-echo)
ICMP path echo configuration (config-rtr-pathEcho)
ICMP path jitter configuration (config-rtr-pathJitter)
UDP echo configuration (config-rtr-udp)
UDP jitter configuration (config-rtr-jitter)
Note
Command History
Usage Guidelines
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 59). 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 request-data-size command varies depending on the Cisco IOS release you are running (see Table 59) 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 request-data-size command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.
Examples
The following examples show how to set the request packet size to 40 bytes for IP SLAs ICMP echo operation 3. 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 59).
IP SLA Monitor Configuration
ip sla monitor 3type echo protocol ipIcmpEcho 172.16.1.175request-data-size 40!ip sla monitor schedule 3 life forever start-time nowRTR Configuration
rtr 3type echo protocol ipIcmpEcho 172.16.1.175request-data-size 40!rtr schedule 3 life forever start-time nowRelated Commands
resource policy
To enter ERM configuration mode and configure an ERM policy, use the resource policy command in global configuration mode. To disable this function, use the no form of this command.
resource policy
no resource policy
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command enters into ERM configuration mode.
Examples
The following example shows how to configure an ERM policy.
Router(config)# resource policyRelated Commands
response-data-size
To set the protocol data size in the payload of an Service Assurance Agent (SAA) operation's response packet, use the response-data-size command in SAA RTR configuration mode. To return to the default value, use the no form of this command.
response-data-size bytes
no response-data-size
Syntax Description
Defaults
0 bytes
Command Modes
SAA RTR configuration
Command History
11.2
This command was introduced.
12.3(14)T
The Service Assurance Agent (SAA) feature is replaced by the Cisco IOS IP Service Level Agreements (IP SLAs) feature.
Usage Guidelines
The response-data-size command is only applicable for the following operations:
•
•
•
•
Note that these protocols are defined with the type command that end in "appl" (for example, snalu0echoappl). When the protocol ends in "appl," the response data size is 12 bytes smaller than normal payload size.
Examples
The following example configures the response packet size of snaLU0 Echo operation 3 to 1440 bytes:
Router(config)# rtr 3Router(config-rtr)# type echo protocol snalu0echoappl cwbc0aRouter(config-rtr)# response-data-size 1440Related Commands
request-data-size
Sets the protocol data size in the payload of the SAA operation's request packet.
rtr
Specifies an SAA operation and enters SAA RTR configuration mode.
retain
To configure the retention interval for bulk statistics files, use the retain command in Bulk Statistics Transfer configuration mode. To remove a previously configured retention interval from the configuration, use the no form of this command.
retain minutes
no retain minutes
Syntax Description
minutes
Length of time, in minutes, that the local bulk statistics file should be kept in system memory (the retention interval). The valid range is 0 to 20000. The default is 0.
Defaults
The default bulk statistics file retention interval is 0.
Command Modes
Bulk Statistics Transfer configuration (config-bulk-tr)
Command History
Usage Guidelines
This command specifies how long the bulk statistics file should be kept in system memory, in minutes, after the completion of the collection interval and a transmission attempt is made. The default value of zero (0) indicates that the file will be deleted immediately from local memory after a successful transfer.
If the retry command is used, you should configure a retention interval larger than 0. The interval between retries is the retention interval divided by the retry number. For example, if retain 10 and retry 2 are configured, retries will be attempted once every 5 minutes. Therefore, if the retain command is not configured (retain default is 0), no retries will be attempted.
Examples
In the following example, the bulk statistics transfer retention interval is set to 10 minutes:
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)# retry 2Router(config-bulk-tr)# retain 10Router(config-bulk-tr)# exitRelated Commands
retry (bulkstat)
To configure the number of retries that should be attempted for a bulk statistics file transfer, use the retry command in Bulk Statistics Transfer configuration mode. To return the number of bulk statistics retries to the default, use the no form of this command.
retry number
no retry number
Syntax Description
number
Specifies the number of transmission retries. The valid range is 0 to 100. The default is 0 (no retry attempts).
Defaults
No retry attempts.
Command Modes
Bulk Statistics Transfer configuration (config-bulk-tr)
Command History
Usage Guidelines
If an attempt to send the bulk statistics file fails, the system can be configured to attempt to send the file again using the retry command. One retry includes an attempt first to the primary destination then, if the transmission fails, to the secondary location; for example, if the retry value is 1, an attempt will be made first to the primary URL, then to the secondary URL, then to the primary URL again, then to the secondary URL again.
If the retry command is used, you should also use the retain command to configure a retention interval larger than 0. The interval between retries is the retention interval divided by the retry number. For example, if retain 10 and retry 2 are configured, retries will be attempted once every 5 minutes. Therefore, if the retain command is not configured (or the retain 0 command is used) no retries will be attempted.
Examples
In the following example, the number of retries for the bulk statistics transfer is set to 2:
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)# retry 2Router(config-bulk-tr)# retain 10Router(config-bulk-tr)# exitRelated Commands
rmdir
To remove an existing directory in a Class C Flash file system, use the rmdir command in user EXEC or privileged EXEC mode.
rmdir directory
Syntax Description
Command Modes
User EXEC
Privileged EXECCommand History
Usage Guidelines
This command is valid only on Class C Flash file systems.
Examples
The following example deletes the directory named newdir:
Router# dirDirectory of flash:2 drwx 0 Mar 13 1993 13:16:21 newdir8128000 bytes total (8126976 bytes free)Router# rmdir newdirRmdir file name [newdir]?Delete flash:newdir? [confirm]Removed dir flash:newdirRouter# dirDirectory of flash:No files in directory8128000 bytes total (8126976 bytes free)Related Commands
dir
Displays a list of files on a file system.
mkdir
Creates a new directory in a Class C Flash file system.
rmon
To enable Remote Monitoring (RMON) on an Ethernet interface, use the rmon command in interface configuration mode. To disable RMON on the interface, use the no form of this command.
rmon {native | promiscuous}
no rmon
Syntax Description
Defaults
RMON is disabled on the interface.
Command Modes
Interface configuration
Command History
Usage Guidelines
This command enables RMON on Ethernet interfaces. A generic RMON console application is recommended in order to use the RMON network management capabilities. SNMP must also be configured. RMON provides visibility of individual nodal activity and allows you to monitor all nodes and their interaction on a LAN segment. When the rmon command is issued, the router automatically installs an Ethernet statistics study for the associated interface.
Note
All Cisco IOS software feature sets support RMON alarm and event groups. Additional RMON groups are supported in certain feature sets. Refer to the Release Notes for feature set descriptions. As a security precaution, support for the packet capture group allows capture of packet header information only; data payloads are not captured.
The RMON MIB is described in RFC 1757.
Examples
The following example enables RMON on Ethernet interface 0 and allows the router to examine only packets destined for the interface:
interface ethernet 0rmon nativeRelated Commands
rmon alarm
To set an alarm on any MIB object, use the rmon alarm command in global configuration mode. To disable the alarm, use the no form of this command.
rmon alarm number variable interval {delta | absolute} rising-threshold value [event-number] falling-threshold value [event-number] [owner string]
no rmon alarm number
Syntax Description
Defaults
No alarms configured
Command Modes
Global configuration
Command History
Usage Guidelines
The MIB object must be specified as a dotted decimal value after the entry sequence (for example, ifEntry.10.1). You cannot specify the variable name and the instance (for example, ifInOctets.1) or the entire dotted decimal notation. The variable must be of the form entry.integer.instance.
To disable the RMON alarms, you must use the no form of the command on each configured alarm. For example, enter no rmon alarm 1, where the 1 identifies which alarm is to be removed.
See RFC 1757 for more information about the RMON alarm group.
Examples
The following example configures an RMON alarm using the rmon alarm command:
rmon alarm 10 ifEntry.20.1 20 delta rising-threshold 15 1 falling-threshold 0owner jjohnsonThis example configures RMON alarm number 10. The alarm monitors the MIB variable ifEntry.20.1 once every 20 seconds until the alarm is disabled, and checks the change in the variable's rise or fall. If the ifEntry.20.1 value shows a MIB counter increase of 15 or more, such as from 100000 to 100015, the alarm is triggered. The alarm in turn triggers event number 1, which is configured with the rmon event command. Possible events include a log entry or a SNMP trap. If the ifEntry.20.1 value changes by 0 (falling-threshold 0), the alarm is reset and can be triggered again.
Related Commands
rmon capture-userdata
To disable the packet zeroing feature that initializes the user payload portion of each Remote Monitoring (RMON) MIB packet, use the rmon capture-userdata command in global configuration mode. To enable packet zeroing, use the no form of this command.
rmon capture-userdata
no rmon capture-userdata
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the show rmon matrix command to display RMON statistics.
Examples
The following command disables the packet zeroing feature:
Router(config)# rmon capture-userdataRelated Commands
rmon collection matrix
Enables a RMON MIB matrix group of statistics on an interface.
rmon collection history
To enable Remote Monitoring (RMON) history gathering on an interface, use the rmon collection history command in interface configuration mode. To disable the history gathering on an interface, use the no form of this command.
rmon collection history controlEntry integer [owner ownername] [buckets bucket-number] [interval seconds]
no rmon collection history controlEntry integer [owner ownername] [buckets bucket-number] [interval seconds]
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
Use the show rmon capture and show rmon matrix commands to display RMON statistics.
Examples
The following command enables an RMON MIB collection history group of statistics with an ID number of 20 and an owner as john:
Router(config-if)# rmon collection history controlEntry 20 owner johnRelated Commands
show rmon capture
Displays the contents of the RMON history table.
show rmon matrix
Displays the RMON MIB matrix table.
rmon collection host
To enable a Remote Monitoring (RMON) MIB host collection group of statistics on the interface, use the rmon collection host command in interface configuration mode. To remove the specified RMON host collection, use the no form of the command.
rmon collection host controlEntry integer [owner ownername]
no rmon collection host controlEntry integer [owner ownername]
Syntax Description
Defaults
No RMON host collection is specified.
Command Modes
Interface configuration
Command History
Usage Guidelines
Use the show rmon hosts and show rmon matrix commands to display RMON statistics.
Examples
The following command enables an RMON collection host group of statistics with an ID number of 20, and specifies john as the owner:
Router(config-if)# rmon collection host controlEntry 20 owner johnRelated Commands
show rmon hosts
Displays the RMON MIB hosts table.
show rmon matrix
Displays the RMON MIB matrix table.
rmon collection matrix
To enable a Remote Monitoring (RMON) MIB matrix group of statistics on an interface, use the rmon collection matrix command in interface configuration mode. To remove a specified RMON matrix group of statistics, use the no form of the command.
rmon collection matrix controlEntry integer [owner ownername]
no rmon collection matrix controlEntry integer [owner ownername]
Syntax Description
Defaults
No RMON matrix group of statistics is specified.
Command Modes
Interface configuration
Command History
Usage Guidelines
Use the show rmon matrix command to display RMON statistics.
Examples
The following command enables the RMON collection matrix group of statistics with an ID number of 25, and specifies john as the owner:
Router(config-if)# rmon collection matrix controlEntry 25 owner johnRelated Commands
rmon collection rmon1
To enable all possible autoconfigurable Remote Monitoring (RMON) MIB statistic collections on the interface, use the rmon collection rmon1 command in interface configuration mode. To disable these statistic collections on the interface, use the no form of the command.
rmon collection rmon1 controlEntry integer [owner ownername]
no rmon collection rmon1 controlEntry integer [owner ownername]
Syntax Description
Defaults
Disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
Use the show rmon matrix command to display RMON statistics.
Examples
The following command enables the RMON collection rmon1 group of statistics with an ID number of 30, and specifies "john" as the owner:
Router(config-if)# rmon collection rmon1 controlEntry 30 owner johnRelated Commands
rmon event
To add or remove an event in the RMON event table that is associated with an RMON event number, use the rmon event command in global configuration mode. To disable RMON on the interface, use the no form of this command.
rmon event number [log] [trap community] [description string] [owner string]
no rmon event number
Syntax Description
Defaults
No events are configured.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies only to the Cisco 2500 series and Cisco AS5200 series.
See RFC 1757 for more information about the RMON MIB.
Examples
The following example enables the rmon event command:
rmon event 1 log trap eventtrap description "High ifOutErrors" owner sdurhamThis example configuration creates RMON event number 1, which is defined as High ifOutErrors, and generates a log entry when the event is triggered by an alarm. The user sdurham owns the row that is created in the event table by this command. This configuration also generates a Simple Network Management Protocol (SNMP) trap when the event is triggered.
Related Commands
rmon
Enables RMON on an Ethernet interface.
show rmon
Displays the current RMON agent status on the router.
rmon queuesize
To change the size of the queue that holds packets for analysis by the Remote Monitoring (RMON) process, use the rmon queuesize command in global configuration mode. To restore the default value, use the no form of this command.
rmon queuesize size
no rmon queuesize
Syntax Description
size
Number of packets allowed in the queue awaiting RMON analysis. Default queue size is 64 packets.
Defaults
64 packets
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to the RMON function, which is available on Ethernet interfaces of Cisco 2500 series and Cisco AS5200 series routers only.
You might want to increase the queue size if the RMON function indicates it is dropping packets. You can determine this from the output of the show rmon command or from the etherStatsDropEvents object in the etherStats table. A feasible maximum queue size depends on the amount of memory available in the router and the configuration of the buffer pool.
Examples
The following example configures the RMON queue size to be 128 packets:
Router(config)# rmon queuesize 128Related Commands
rommon-pref
To select a ReadOnly or Upgrade ROMmon image to be booted on the next reload of a Cisco 7200 VXR router or Cisco 7301 router when you are in ROMmon, use the rommon-pref command in ROMmon mode.
rommon-pref [readonly | upgrade]
Syntax Description
readonly
Selects the ReadOnly ROMmon image to be booted on the next reload.
upgrade
Selects the Upgrade, second ROMmon image to be booted on the next reload.
Defaults
No default behavior or values
Command Modes
ROMmon
Command History
Usage Guidelines
You might select the ReadOnly ROMmon image to be booted on the next reload because the Upgrade image has features or side effects you do not like.
When you are in ROMmon, there is no descriptive output to inform you whether the ReadOnly ROMmon image was reloaded. To confirm the reload, use the showmon command after entering the rommon-pref readonly command.
Use this command when you are in ROMmon mode. Use the upgrade rom-monitor preference command when you are in Cisco IOS.
Examples
The following example, applicable to both the Cisco 7200 VXR and Cisco 7301 routers, shows how to select the ReadOnly ROMmon image to be booted on the next reload of the router when you are already in ROMmon mode:
rommon 2 > rommon-pref readonlyRelated Commands
showmon
Shows both the ReadOnly and the Upgrade ROMmon image versions when you are in ROMmon mode, as well as which ROMmon image is running.
rsh
To execute a command remotely on a remote shell protocol (rsh) host, use the rsh command in privileged EXEC mode.
rsh {ip-address | host} [/user username] remote-command
Syntax Description
Defaults
If you do not specify the /user username keyword and argument, the Cisco IOS software sends a default remote username. As the default value of the remote username, the software sends the username associated with the current tty process, if that name is valid. For example, if the user is connected to the router through Telnet and the user was authenticated through the username command, then the software sends that username as the remote username. If the tty username is invalid, the software uses the host name as the both the remote and local usernames.
Note
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the rsh command to execute commands remotely. The host on which you remotely execute the command must support the rsh protocol, and the .rhosts files on the rsh host must include an entry that permits you to remotely execute commands on that host.
For security reasons, the software does not default to a remote login if no command is specified, as does UNIX. Instead, the router provides Telnet and connect services that you can use rather than rsh.
Examples
The following command specifies that the user named sharon attempts to remotely execute the UNIX ls command with the -a argument on the remote host named mysys.cisco.com. The command output resulting from the remote execution follows the command example:
Router1# rsh mysys.cisco.com /user sharon ls -a....alias.cshrc.emacs.exrc.history.login.mailrc.newsrc.oldnewsrc.rhosts.twmrc.xsessionjazzrtr
Note
To begin configuration for a Cisco IOS IP Service Level Agreements (IP SLAs) operation and enter RTR configuration mode, use the rtr command in global configuration mode. To remove all configuration information for an operation, including the schedule of the operation, reaction configuration, and reaction triggers, use the no form of this command.
rtr operation-number
no rtr operation-number
Syntax Description
operation-number
Operation number used for the identification of the IP SLAs operation you wish to configure.
Defaults
No IP SLAs operation is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
The rtr command is used to configure Cisco IOS IP Service Level Agreements (IP SLAs) operations. Use this command to specify an identification number for the operation you are about to configure. After you enter this command, you will enter the RTR configuration mode.
IP SLAs allows a maximum of 2000 operations.
Debugging is supported only on the first 32 operation numbers.
After you configure a operation, you must schedule the operation. For information on scheduling a operation, refer to the rtr schedule and rtr group schedule global configuration commands. You can also optionally set reaction triggers for the operation. For information on reaction triggers, refer to the rtr reaction-configuration and rtr reaction-trigger global configuration commands.
Note
To display the current configuration settings of the operation, use the show rtr configuration EXEC command.
Examples
In the following example, operation 1 is configured to perform end-to-end IP SLAs operations using an SNA LU Type 0 connection with the host name cwbc0a. Only the type RTR configuration command is required; all others are optional.
Router(config)# rtr 1Router(config-rtr)# type echo protocol snalu0echoappl cwbc0aRouter(config-rtr)# request-data-size 40Router(config-rtr)# response-data-size 1440Router(config-rtr)# exit
Note
Related Commands
rtr group schedule
Note
To perform group scheduling for Cisco IOS IP Service Level Agreements (IP SLAs) operations, use the rtr group schedule command in global configuration mode. To stop the operation and place it in the default state of normal scheduling, use the no form of this command.
rtr group schedule group-operation-number operation-id-numbers schedule-period schedule-period-range [ageout seconds] [frequency group-operation-frequency] [life {forever | seconds}] [start-time {hh:mm[:ss] [month day | day month] | pending | now | after hh:mm:ss}]
no rtr group schedule
Syntax Description
Defaults
The operation is placed in a pending state (that is, the operation is enabled but is not actively collecting information).
Command Modes
Global configuration
Command History
Usage Guidelines
Though IP SLAs multiple operations scheduling functionality helps in scheduling thousands of operations, you should be cautious while specifying the number of operations, the schedule period, and the operation group frequency to avoid CPU hogging.
For example, consider a scenario where you are scheduling 1 to 780 operations at a schedule period of 60 seconds, the command would be as follows:
rtr group schedule 2 1-780 schedule-period 60 start-now
IP SLAs calculates how many operations it should start in each 1-second interval by dividing the number of operations by the schedule period (780 operations divided by 60 seconds, which is 13 operations per second). Operations 1 to 13 in operation group 2 start after 0 seconds, operations 14 to 26 start after 1 second, operations 27 to 40 start after 2 seconds, and the iteration continues until operations 768 to 780 start after 59 seconds. This high value of operations starting at every 1-second interval (especially for jitter operations) can load the CPU to very high values.
The maximum recommended value of operations per second is 6 or 7. This is approximately 350 to 400 operations per minute. This value of 6 or 7 operation per second will be the maximum that does not have any major performance (CPU) impact. However, this value varies from platform to platform. The above value is verified and tested on a Cisco 2600 router.
Note
When you reboot the router, the IP SLAs multiple operations scheduling functionality schedules the operations in the same order as was done before the reboot. For example, assume the following operation had been scheduled:
rtr group schedule 2 1-20 schedule-period 40 start-time now
Over a range of 40 seconds, 20 operations have to be started (that is, one operation every 2 seconds). After the system reboot, operation 1 will start at t seconds and operation 2 starts at t+2 seconds, operation 3 starts at t+4 seconds, and so on.
The IP SLAs multiple operations scheduling functionality schedules the maximum number of operations possible without aborting. However, this functionality skips those IP SLAs operations that are already running or those that are not configured and hence do not exist. The total number of operations will be calculated based on the number of operations specified in the command, irrespective of the number of operations that are missing or already running. The IP SLAs multiple operations scheduling functionality displays a message showing the number of active and missing operations. However, these messages are displayed only if you schedule operations that are not configured or are already running.
Examples
The following example shows how to schedule IP SLAs operations 3, 4, and 6 to 10 in operation group 1:
Router(config)# rtr group schedule 1 3, 4, 6-10The following example shows how to schedule IP SLAs operations 3, 4, and 6 to 10 in operation group 1, with a schedule period of 20 seconds:
Router(config)# rtr group schedule 1 3, 4, 6-10 schedule-period 20The following example shows how to schedule IP SLAs operations 3, 4, and 6 to 10 in operation group 1, with a schedule period of 20 seconds with start time as now:
Router(config)# rtr group schedule 1 3, 4, 6-10 schedule-period 20 start-time nowRelated Commands
rtr key-chain
Note
To enable Cisco IOS IP Service Level Agreements (IP SLAs) control message authentication and specify an MD5 key chain, use the rtr key-chain command in global configuration mode. To remove control message authentication, use the no form of this command.
rtr key-chain name
no rtr key-chain
Syntax Description
Defaults
Control message authentication is disabled.
Command Modes
Global configuration
Command History
12.0(3)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor key-chain command.
Usage Guidelines
The authentication configuration on the IP SLAs collector and IP SLAs Responder must be the same. Both sides must configure the same key chain or both sides must not use authentication.
Examples
In the following example, the IP SLAs control message uses MD5 authentication, and the key chain name is CSAA:
Router(config)# rtr key-chain csaaRelated Commands
rtr logging traps
Note
To enable the generation of system logging SNMP notifications (traps) specific to IP SLAs thresholds, use the rtr logging traps command in global configuration mode. To disable IP SLAs system logging SNMP traps, use the no form of this command.
rtr logging traps
no rtr logging traps
Syntax Description
No arguments or keywords.
Defaults
Disabled (IP SLAs system logging traps are not generated).
Command Modes
Global configuration
Command History
Usage Guidelines
SNMP notifications (traps) for IP SLAs can be configured as a triggered action, to be sent when monitored values exceed an upper threshold or fall below a lower threshold, or when a set of defined conditions are met. For example, an SNMP trap can be triggered by 5 consecutive timeouts during an IP SLAs operation. The sending of SNMP traps is one of the options for triggered actions that can be configured for IP SLAs violations. The monitored values (also called monitored elements), the threshold type, and the triggered action are configured using the rtr reaction-configuration global configuration mode command.
SNMP traps for IP SLAs are handled through the system logging (syslog) process. This means that system logging messages for IP SLAs violations are generated when the specified conditions are met, then sent as SNMP traps using the CISCO-SYSLOG-MIB. The rtr logging traps command is used to enable the generation of these IP SLAs specific traps. The generation of IP SLAs specific logging messages is dependant on the configuration of the standard set of logging commands (for example, logging on). IP SLAs logging messages are generated as level 7 (debugging) messages.
Examples
The following example shows the configuration of IP SLAs traps to be triggered for round-trip-time (rtt) violations and VoIP mean opion score (MOS) violations, and the necessary SNMP configuration for enabling these SNMP logging traps:
Router(config)# rtr 1Router(config-rtr)# type jitter dest-ipaddr 209.165.200.225 dest-port 9234Router(config-rtr)# exitRouter(config)# rtr schedule 1 start now life foreverRouter(config)# rtr reaction-configuration 1 react rtt threshold-type immediate threshold-value 3000 2000 action-type trapOnlyRouter(config)# rtr reaction-configuration 1 react MOS threshold-type consecutive 4 threshold-value 390 220 action-type trapOnlyRouter(config)# rtr logging trapsRouter(config)#Router(config)# snmp-server community public RWRouter(config)# snmp-server enable traps syslogRouter(config)# snmp-server host 209.165.202.129 version 3 public syslogRouter(config)# logging trap debuggingRouter(config)# logging host 209.165.202.129Related Commands
rtr low-memory
Note
To specify how much unused memory must be available to allow Cisco IOS IP Service Level Agreements (IP SLAs) configuration, use the rtr low-memory command in global configuration mode. To remove the type configuration for the operation, use the no form of this command.
rtr low-memory value
no rtr low-memory
Syntax Description
value
Specifies amount of memory, in bytes, that must be available to configure IP SLAs. The range is from 0 to the maximum amount of free memory bytes available.
Defaults
The default value is 25 percent of the memory available on the system.
Command Modes
Global configuration
Command History
12.0(5)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor low-memory command.
Usage Guidelines
The rtr low-memory command allows the user to specify the amount of memory that IP SLAs can use. If the amount of available free memory falls below the value specified in the rtr low-memory command, then you will not be allowed to configure new IP SLAs operations. If this command is not used, the default low-memory value is 25 percent. This means that if 75 percent of system memory has been utilized you will not be able to configure any IP SLAs characteristics.
The value of the rtr low-memory command should not exceed the amount of free memory available on the system. To determine the amount of free memory available on the system, use the show memory EXEC command.
Examples
In the following example, the router is configured so that no less than 2 MB of memory will be free for IP SLAs configuration:
Router(config)# rtr low-memory 2000000Related Commands
rtr reaction-configuration
Note
To configure certain actions to occur based on events under the control of Cisco IOS IP Service Level Agreements (IP SLAs), use the rtr reaction-configuration command in global configuration mode. To clear the reaction configuration for a specified IP SLAs operation, use the no form of this command.
rtr reaction-configuration operation-number [react monitored-element] [threshold-type { never | immediate | consecutive [consecutive-occurrences ] | xofy [ x-value y-value ] | average [number-of-measurements] }] [threshold-value upper-threshold lower-threshold] [action-type { none | trapOnly | triggerOnly | trapAndTrigger }]
no rtr reaction-configuration operation-number
Syntax Description
Defaults
No IP SLAs reactions are generated.
Error verification is disabled.
Connection loss and timeout logging is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
You can configure the rtr reaction-configuration command multiple times so as to allow reactions for multiple monitored elements (for example, configuring thresholds for operation 1 for destination-to-source packet loss, and also configuring MOS thresholds for same operation). However, issuing the no rtr reaction-configuration operation-number will clear all reactions for the specified operation. In other words, disabling of granular reaction elements (no rtr reaction-configuration operation-number react monitored-element) is not currently supported, so as to provide backwards compatibility with the earlier version of this command.
You can check the configuration of the IP SLAs reaction configuration using the show rtr reaction-configuration command.
Note
Examples
In the following example, IP SLAs operation 10 (a Jitter operation) is configured to send an SNMP logging trap when the MOS value exceeds 4.9 (best quality) of falls below 2.5 (poor quality):
Router(config)# rtr reaction-configuration 10 react mos threshold-type immediate threshold-value 490 250 action-type trapOnlyThe following example shows the default settings for the rtr reaction-configuration command when none of the optional syntax is used:
Router# show rtr reaction-configuration 1Entry number: 1Reaction Configuration not configuredRouter# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# rtr reaction-configuration 1Router(config)# do show rtr reaction-configuration 1Entry number: 1Reaction: rttThreshold Type: NeverRising (milliseconds): 5000Falling (milliseconds): 3000Threshold Count: 5Threshold Count2: 5Action Type: NoneRelated Commands
rtr reaction-trigger
Note
To define a second Cisco IOS IP Service Level Agreements (IP SLAs) operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration command, use the rtr reaction-trigger command in global configuration mode. To remove the trigger combination, use the no form of this command.
rtr reaction-trigger operation-number target-operation
no rtr reaction-trigger operation
Syntax Description
Defaults
No trigger combination is defined.
Command Modes
Global configuration
Command History
11.2
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor reaction-trigger command.
Usage Guidelines
Triggers are usually used for diagnostics purposes and are not used in normal operation.
Examples
In the following example, the state of operation 1 is changed from pending state to active state when action-type of operation 2 occurs:
Router(config)# rtr reaction-trigger 2 1Related Commands
rtr reset
Note
To perform a shutdown and restart of the Cisco IOS IP Service Level Agreements (SLAs) engine, use the rtr reset command in global configuration mode.
rtr reset
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
11.2
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor reset command.
Usage Guidelines
The rtr reset command stops all operations, clears IP SLAs configuration information, and returns the IP SLAs feature to the startup condition. This command does not reread the IP SLAs configuration stored in startup-config in NVRAM. You must retype the configuration or load a previously saved configuration file.
Note
Caution
Examples
The following example resets IP SLAs, clearing all stored IP SLAs information and configuration:
Router(config)# rtr resetRelated Commands
rtr responder
Note
To enable the Cisco IOS IP Service Level Agreements (IP SLAs) Responder on a destination (operational target) device, use the rtr responder command in global configuration mode. To disable the IP SLAs Responder, use the no form of this command.
rtr responder
no rtr responder
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Global configuration
Command History
12.0(3)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor responder command.
Usage Guidelines
This command is used on the destination device for IP SLAs operations to enable the sending of receiving of IP SLAs Control packets. Enabling the IP SLAs Responder allows the generation of monitoring statistics on the device sending IP SLAs operations.
Examples
The following example enables the IP SLAs Responder:
Router(config)# rtr responderRelated Commands
rtr responder type frame-relay
Note
To enable the Cisco IOS IP Service Level Agreements (IP SLAs) Responder on the operational target device for Frame Relay operations, use the rtr responder type frame-relay command in global configuration mode. To disable the IP SLAs Responder, use the no form of this command.
rtr responder type frame-relay {all | interface {serial | fr-atm} interface-id dlci dlci-number}
no rtr responder type frame-relay {all | interface {serial | fr-atm} interface-id dlci dlci-number}
Syntax Description
Defaults
Disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This command allows the IP SLAs Responder to respond to Frame Relay operations without receiving IP SLAs Control Protocol packets.
Note that if you use this command, packet loss statistics will not be able to be generated for the operation because the Responder will not be able to determine the order of the received packets. To generate packet loss statistics, use the rtr responder command without specifying an operation type.
Examples
In the following example, the IP SLAs Responder is configured to respond to Frame Relay operations specifically on Serial interface 1/0, using DLCI number 16:
Router(config)# rtr responder type frame-relay interface serial1/0 dlci 16Related Commands
rtr responder type tcpConnect
Note
To enable the Cisco IOS IP Service Level Agreements (IP SLAs) Responder for TCP Connect operations, use the rtr responder type tcpConnect command in global configuration mode. To disable the IP SLAs Responder, use the no form of this command.
rtr responder type tcpConnect ipaddress ip-address port port
no rtr responder type tcpConnect ipaddress ip-address port port
Syntax Description
ipaddress ip-address
(Optional) Specifies the IP address that the operation will be received at.
port port
(Optional) Specifies the port number that the operation will be received on.
Defaults
Disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used on the destination device for IP SLAs operations to enable the acceptance and return of TCP Connect operation packets.
Related Commands
rtr responder type udpEcho
Note
To enable the Cisco IOS IP Service Level Agreements (IP SLAs) Responder for User Datagram Protocol (UDP) Echo or Jitter operations, use the rtr responder command in global configuration mode. To disable the IP SLAs Responder, use the no form of this command.
rtr responder type udpEcho ipaddress ip-address port port
no rtr responder type udpEcho ipaddress ip-address port port
Syntax Description
ipaddress ip-address
Specifies the IP address that the operation will be received at.
port port
Specifies the port number that the operation will be received on.
Defaults
Disabled.
Command Modes
Global configuration
Command History
12.1(1)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor type udpEcho command.
Usage Guidelines
This command is used on the destination device for IP SLAs operations to enable UPD Echo and Jitter (UDP+) operations on non-native interfaces.
Examples
The following example enables the IP SLAs Responder for Jitter operations:
Router(config)# rtr responder type udpEcho ipaddress A.B.C.D port 1Related Commands
rtr responder
Enables the IP SLAs Responder for non-specific IP SLAs operations.
rtr responder type frame-relay
Enables the IP SLAs Responder for Frame Relay operations.
rtr restart
Note
To restart a Cisco IOS IP Service Level Agreements (IP SLAs) operation, use the rtr restart command in global configuration mode.
rtr restart operation-number
Syntax Description
operation-number
Number of the IP SLAs operation to restart. IP SLAs allows a maximum of 2000 operations.
Defaults
No default behavior or values.
Command Modes
Global configuration.
Command History
Usage Guidelines
To restart an operation, the operation should be in an "active" state (as defined in the rtr reaction-configuration command).
IP SLAs allows a maximum of 2000 operations.
This command does not have a no form.
Examples
The following example restarts operation 12:
Router(config)# rtr restart 12Related Commands
rtr reset
Clears all current IP SLAs statistics and configuration information from the router and resets the IP SLAs engine.
rtr schedule
Note
To configure the scheduling parameters for a Cisco IOS IP Service Level Agreements (IP SLAs) single operation, use the rtr schedule command in global configuration mode. To stop the operation and place it in the default state (pending), use the no form of this command.
rtr schedule group-operation-number [life {forever | seconds}] [start-time {hh:mm[:ss] [month day | day month] | pending | now | after hh:mm:ss}] [ageout seconds] [recurring]
no rtr schedule group-operation-number
Syntax Description
Defaults
The operation is placed in a pending state (that is, the operation is enabled but not actively collecting information).
Command Modes
Global configuration
Command History
Usage Guidelines
After you schedule the operation with the rtr schedule command, you cannot change the configuration of the operation. To change the configuration of the operation, use the no form of the rtr global configuration command and reenter the configuration information.
If the operation is in a pending state, you can define the conditions under which the operation makes the transition from pending to active with the rtr reaction-trigger and rtr reaction-configuration global configuration commands. When the operation is in an active state, it immediately begins collecting information.
The following time line shows the age-out process of the operation:
W----------------------X----------------------Y----------------------Zwhere:
•
•
•
•
Age out starts counting down at W and Y, is suspended between X and Y, and is reset to its configured size at Y.
It is possible for the operation to age out before it executes (that is, Z can occur before X). To ensure that this does not happen, the difference between the operation's configuration time and start time (X and W) must be less than the age-out seconds.
Note
For Service Level Monitoring (SLM) operations (type slm), the operation will always start at the nearest 15-minute interval since the router start time. For example, if the rtr schedule 1 start-time now command is used, the operation will not start until the next quarter-hour time increment.
The recurring keyword is only supported for scheduling single IP SLAs operations. You cannot schedule multiple IP SLAs operations using the rtr schedule command. The life value for a recurring IP SLAs operation should be less than one day. The ageout value for a recurring operation must be "never" (which is specified with the value 0), or the sum of the life and ageout values must be more than one day. If the recurring option is not specified, the operations are started in the existing normal scheduling mode.
Examples
In the following example, operation 25 begins actively collecting data at 3:00 p.m. on April 5. This operation will age out after 12 hours of inactivity, which can be before it starts or after it has finished with its life. When this operation ages out, all configuration information for the operation is removed (that is, the configuration information is no longer in the running-config in RAM).
Router(config)# rtr schedule 25 life 43200 start-time 15:00 apr 5 ageout 43200In the following example, operation 1 begins collecting data after a 5-minute delay:
Router(config)# rtr schedule 1 start after 00:05:00In the following example, operation 3 begins collecting data immediately and is scheduled to run indefinitely:
Router(config)# rtr schedule 3 start-time now life foreverIn the following example, operation 15 begins automatically collecting data every day at 1:30 a.m.:
Router(config)# rtr schedule 15 start-time 01:30:00 recurringRelated Commands
rtr slm frame-relay statistics
Note
To enable the Cisco IOS IP Service Level Agreements (IP SLAs) or Cisco Networking Services (CNS) to collect Frame Relay performance monitoring statistics, use the rtr slm frame-relay statistics command in global configuration mode. To disable the collection of Frame Relay performance monitoring statistics, use the no form of this command.
rtr slm frame-relay statistics
no rtr slm frame-relay statistics
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration mode
Command History
12.3(1)
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor slm frame-relay statistics command.
Usage Guidelines
The rtr slm frame-relay statistics command should be issued prior to configuring any of the Frame Relay IP SLAs operations (type slm interface, type slm controller, type slm frame-relay or type slm frame-relay pvc). Performance statistics are not retained for these operations until this command is issued.
This command does not affect the standard Frame Relay IP SLAs operation (type frame-relay).
Examples
In the following example the IP SLAs Frame Relay service level monitoring feature is enabled:
Router(config)# rtr slm frame-relay statisticsRelated Commands
saa apm cache-size
Note
To set the size of the Cisco IOS IP Service Level Agreements (IP SLAs) Application Performance Monitor (APM) cache, use the saa apm cache-size command in global configuration mode. To reset the IP SLAs APM cache size to its default, use the no form of this command.
saa apm cache-size bytes
no saa apm cache-size bytes
Syntax Description
Defaults
The default APM cache size is 100000 bytes.
Command Modes
Global configuration
Command History
12.2(2)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor apm cache-size command.
Usage Guidelines
The IP SLAs APM script and scheduler files are kept in an area of memory called the IP SLAs APM cache. The cache size is checked by the system before each attempt to copy a new file to the cache. If the file to be downloaded puts the cache over its size limit, a "cache trimming" operation is performed, and all files in the cache not tagged with a "sticky bit" (sticky=1) will be deleted.
Examples
In the following example, the IP SLAs APM cache is set to 80,000 bytes (approximately 78 kilobytes):
Router(config)# saa apm cache-size 80000Router(config)# endRouter#00:01:50: %SYS-5-CONFIG_I: Configured from console by consoleRouter# show saa apm cacheCache Size (bytes): 80000Cache used (bytes): 793File Name TimeCreated TimeAccessed ref Type stickyapm.cf.1234567 00:02:50 00:00:00 1 CFG 0apm/config/smtp-1000.cfg 00:02:50 00:00:00 1 CFG 0Related Commands
show saa apm cache
Displays the amount of memory available in the IP SLAs APM cache and information about the files stored in the cache.
saa apm copy
Note
To copy script or scheduler files from an FTP server to the device that will initiate the Cisco IOS IP Service Level Agreements (IP SLAs) Application Performance Monitor (APM) operations, use the saa apm copy command in global configuration mode.
saa apm copy {script | scheduler} ftp://[username:password@]server-name/path-to-file/filename [sticky]
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.2(2)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor apm copy command.
Usage Guidelines
The saa apm copy command downloads an IP SLAs APM script or scheduler file from an FTP server to the local IP SLAs APM cache in NVRAM.
A file tagged as "sticky" will not be deleted from the local APM cache during a cache trimming operation. APM cache trimming operations are initiated when the saa apm lowWaterMark value is reached.
You can force a file tagged as "sticky" to be deleted using the clear saa apm cache command.
Examples
In the following example, a Frame Relay emulation script titled frm.scr is downloaded from the FTP server FTP101. The username joe and the password letmein are used to access the server:
Router(config)# saa apm copy script ftp://joe:letmein@FTP101/userbin/joefiles/frm.scr stickyRelated Commands
saa apm lowWaterMark
Note
To specify the lowest amount of free memory that must be available on the system to allow additional Cisco IOS IP Service Level Agreements (IP SLAs) Application Performance Monitor (APM) operations to be configured, use the saa apm lowWaterMark command in global configuration mode. To restore the default low-memory-watermark value, use the no form of this command.
saa apm lowWaterMark bytes
no saa apm lowWaterMark
Syntax Description
Defaults
The default APM low-memory-watermark is 25 percent of free memory at startup.
Command Modes
Global configuration
Command History
12.2(2)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor apm lowWaterMark command.
Usage Guidelines
The saa apm lowWaterMark global configuration command configures the lowest amount of free memory (low-memory-watermark) that must be available on the system. If the amount of available free memory falls below the value specified in the saa apm lowWaterMark command, then IP SLAs will not allow new APM operations to be configured. The default value is 25 percent of the memory available on the system at startup.
Note
For example, if there are 6 MB of free memory when the router starts up, and the default low-memory-watermark of 25 percent is used, then the IP SLAs APM can use up to 4.5 MB memory for creating operations. If the free memory drops below 1.5 MB, then new APM operations cannot be created.
The value of the saa apm lowWaterMark command should not exceed the amount of free memory available on the system. To determine the amount of free memory available on the system, use the show memory EXEC command.
The show saa apm information EXEC command will display the number of operations that can be configured on the device in the "Max Number of operations supported" field.
Examples
In the following example, the IP SLAs APM low-memory-watermark is set to 3,145,728 bytes (3 MB):
Router(config)# saa apm lowWaterMark 3145728Router(config)# endRouter# show saa apm informationService Assurance Agent: Application Performance MonitorAPM Engine Version: 1.0Max Number of oper supported: 23Number of configurable oper: 23Number of oper configured: 0Number of files in cache: 0Cache Size (bytes): 100000Cache used (bytes): 0APM low memory water-mark: 3,145,728Related Commands
saa apm operation
Note
To start or stop a Cisco IOS IP Service Level Agreements (IP SLAs) Application Performance Monitor (APM) operation, use the saa apm operation command in global configuration mode. To delete existing IP SLAs APM operations, use the no form of this command.
saa apm operation operation-number {start ftp://[user:password@]server-name/path-to-file/filename | stop}
no saa apm operation [operation-number]
Syntax Description
Defaults
No IP SLAs APM operations exist.
Command Modes
Global configuration
Command History
12.2(2)T
This command was introduced.
12.3(14)T
This command was replaced by the ip sla monitor apm operation command.
Usage Guidelines
The following files are required to perform an IP SLAs APM operation:
•
•
•
•
All filenames can have a maximum of 255 characters.
The saa apm operation start command points to the APM configuration file to be used for the operation. The APM configuration file specifies the location of the other files used in the operation, and the target IP address for the operation.
To download script, configuration, data, and scheduler template files used by the IP SLAs APM, and to download the documentation ("readme" files) for the scripts, go to the "Cisco IP SAA APM" page at http://www.cisco.com/pcgi-bin/tablebuild.pl/saa-apm.
After an operation is started using the saa apm operation start command, the operation should be stopped using the saa apm operation stop command.
Examples
In the following example, an IP SLAs APM NNTP operation is started and stopped, and the operation is deleted from the configuration:
Router# config terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# saa apm operation 2 start ftp://user:password@saa-nms/apm/config/nntp-20.cfRouter(config)#1d09h: SAA-APM-1: downloading file (apm/config/nntp-20.cf) of size (532)1d09h: SAA-APM-1: using cached file (apm/scheduler/master.sch)1d09h: SAA-APM-1: using cached file (apm/scripts/nntp.scr)1d09h: SAA-APM-1: sending APM_SCRIPT_DONE message1d09h: SAA-APM-1: operation doneRouter(config)# saa apm operation 2 stopRouter(config)# no saa apm operation 2Related Commands
show saa apm results
Displays the data gathered using the IP SLAs Application Performance Monitor.
samples-of-history-kept
To set the number of entries kept in the history table per bucket for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the samples-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.
samples-of-history-kept samples
no samples-of-history-kept
Syntax Description
Defaults
16 entries
Command Modes
IP SLA Monitor Configuration
ICMP path echo configuration (config-sla-monitor-pathEcho)
RTR Configuration
ICMP path echo configuration (config-rtr-pathEcho)
Note
Command History
Usage Guidelines
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
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 60). 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 samples-of-history-kept command varies depending on the Cisco IOS release you are running (see Table 60) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP path echo operation type is configured, you would enter the samples-of-history-kept command in ICMP path echo configuration mode (config-sla-monitor-pathEcho) within IP SLA monitor configuration mode.
Examples
In the following examples, ten entries are kept in the history table for each of the lives of IP SLAs ICMP path echo operation 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 60).
IP SLA Monitor Configuration
ip sla monitor 1type pathecho protocol ipIcmpEcho 172.16.1.176lives-of-history-kept 3samples-of-history-kept 10!ip sla monitor schedule 1 life forever start-time nowRTR Configuration
rtr 1type pathecho protocol ipIcmpEcho 172.16.1.176lives-of-history-kept 3samples-of-history-kept 10!rtr schedule 1 life forever start-time nowRelated Commands
scheduler allocate
To guarantee CPU time for processes, use the scheduler allocate command in global configuration mode. To restore the default, use the no form of this command.
scheduler allocate interrupt-time process-time
no scheduler allocate
Syntax Description
Defaults
Approximately 5 percent of the CPU is available for process tasks.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to the Cisco 7200 series and Cisco 7500 series routers.
Note
Examples
The following example makes 20 percent of the CPU available for process tasks:
Router(config)# scheduler allocate 2000 500Related Commands
scheduler interval
Controls the maximum amount of time that can elapse without running system processes.
scheduler heapcheck process
To perform a "sanity check" for corruption in memory blocks when a process switch occurs, use the scheduler heapcheck process command in global configuration mode. To disable this feature, use the no form of this command.
scheduler heapcheck process [memory [fast] [io] [multibus] [pci] [processor] [checktype {all | magic | pointer | refcount | lite-chunks}]]
no scheduler heapcheck process
Syntax Description
Defaults
This command is not enabled by default. If no keywords are specified, a sanity check will be performed on all the memory blocks and memory pools.
Command Modes
Global configuration
Command History
12.2(15)T
This command was introduced.
12.3(11)T
The lite-chunks keyword was added.
Usage Guidelines
When configuring this command, you can choose none or all memory block keywords (fast, io, multibus, pci, processor, and checktype).
Enabling this command has a significant impact on router performance.
Examples
The following example shows how to sanity check for corruption in the I/O memory block when a process switch occurs. In this example, the values of only the block magic, red zone, and size will be checked.
scheduler heapcheck process memory io checktype magicThe following example shows how to sanity check for corruption in the processor memory block when a process switch occurs. In this example, the values of only the next and previous pointers will be checked.
scheduler heapcheck process memory processor checktype pointerRelated Commands
memory lite
Enables the malloc_lite feature.
memory sanity
Performs a "sanity check" for corruption in buffers and queues.
scheduler interval
To control the maximum amount of time that can elapse without running system processes, use the scheduler interval command in global configuration mode. To restore the default, use the no form of this command.
scheduler interval milliseconds
no scheduler interval
Syntax Description
milliseconds
Integer that specifies the interval (in milliseconds). The minimum interval that you can specify is 500 milliseconds; there is no maximum value.
Defaults
High-priority operations are allowed to use as much of the CPU as needed.
Command Modes
Global configuration
Command History
Usage Guidelines
The normal operation of the network server allows the switching operations to use as much of the central processor as is required. If the network is running unusually heavy loads that do not allow the processor the time to handle the routing protocols, give priority to the system process scheduler. High-priority operations are allowed to use as much of the CPU as needed.
Note
On the Cisco 7200 series and Cisco 7500 series, use the scheduler allocate global configuration command instead of the scheduler interval command.
Examples
The following example changes the low-priority process schedule to an interval of 750 milliseconds:
Router(config)# scheduler interval 750Related Commands
schema
To specify the bulk statistics schema to be used in a specific bulk statistics transfer configuration, use the schema command in Bulk Statistics Transfer configuration mode. To remove a previously configured schema from a specific bulk statistics transfer configuration, use the no form of this command.
schema
