-
Cisco IOS Configuration Fundamentals and Network Management Command Reference, Release 12.3
-
Introduction
-
CFR Commands: absolute -- clock timezone
-
CFR Commands: clock update-calendar -- escape-character
-
CFR Commands: exception core-file -- ip ftp passive
-
CFR Commands: ip ftp password -- lsr-path
-
CFR Commands: memory sanity -- periodic
-
CFR Commands: ping -- service sequence numbers
-
CFR Commands: service slave-log -- show
tee -
CFR Commands: show context -- show ip http server
-
CFR Commands: show kron schedule -- show rtr enhanced-history
-
12.3 CF CR Commands: show rtr distributions-statistics -- snmp-server enable informs
-
CFR Commands: snmp-server enable traps -- statistics-distribution-interval
-
CFR Commands: stopbits -- ttl ip
-
CFR Commands: type dhcp - xsm vdm
-
CFR Appendix: ASCII Character Set and Hex Values
-
Table Of Contents
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 Default
This command has no default values.
Command Modes
User EXEC (>)
Privileged EXEC (#)Command History
Usage Guidelines
The ping command sends an echo request packet to an address then waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. For example, the 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 keywords or argument values, an interactive system dialog prompts you for the additional syntax appropriate to the protocol you specify. (See the "Examples" section.)
To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The default escape sequence is Ctrl-^, X (Simultaneously press and release the Ctrl, Shift, and 6 keys and then press the X key). The escape sequence will vary depending on your line configuration. For example, another commonly used escape sequence is Ctrl-c.
Table 37 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 hostname or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.
The following example is sample dialog from the ping command using default values. The specific dialog varies somewhat from protocol to protocol.
Router# 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 38 describes the significant fields shown in the display.
The following example verifies connectivity to the neighboring ATM device for the ATM permanent virtual circuit (PVC) with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16:
Router# 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 39 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 | system-address} [data [hex-data-pattern] | df-bit | repeat [repeat-count] | size [datagram-size] [source {source-address | source-interface} ] [timeout seconds] [validate]
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 40 describes the test characters that the ping facility sends.
Note
Examples
After you enter the ping command in privileged mode, the system prompts for one of the following keywords: apollo, appletalk, clns, decnet, ip, novell, vines, or xns. The default protocol is IP.
If you enter a host name or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address.
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 41 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 a 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 Exec
Command 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-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
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-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 100prompt
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 42 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 EXEC mode.
pwd
Syntax Description
This command has no arguments or keywords.
Command Modes
User EXEC
Priviledged EXEC
Command 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.
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 EXEC mode.
reload [text | in [hh:]mm [text] | at hh:mm [month day | day month] [text] | cancel]
Syntax Description
Command Modes
User EXEC
Priviledged 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 prevents the system from dropping to the ROM monitor 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 asks you if you want to proceed with the save if the CONFIG_FILE variable points to a startup configuration file that no longer exists. If you say "yes" in this situation, the system goes to setup mode upon reload.
When you schedule a reload to occur at a later time, it must take place within approximately 24 days.
The at keyword can be used only if the system clock has be set on the router (either through NTP, the hardware calendar, or manually). The time is relative to the configured time zone on the router. To schedule reloads across several routers to occur simultaneously, the time on each router must be synchronized with NTP.
To display information about a scheduled reload, use the show reload EXEC command.
Examples
The following example immediately reloads the software on the router:
Router# reloadThe following example reloads 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 reloads 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 reloads 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 cancels a pending reload:
Router# reload cancel%Reload cancelled.Related Commands
copy system:running-config nvram:startup-config
Copies any file from a source to a destination.
show reload
Displays the reload status on the router.
rename
To rename a file in a Class C Flash file system, use the rename command in EXEC mode.
rename url1 url2
Syntax Description
Command Modes
User EXEC
Priviledged EXEC
Command 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 the Service Assurance Agent (SAA) operation's request packet, use the request-data-size command in SAA 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. The default is 1 byte.
Defaults
1 byte
Command Modes
SAA RTR configuration
Command History
Usage Guidelines
When the protocol name has the suffix "appl," the packet uses both a request and respond data size (see the response-data-size SAA RTR configuration command), and the data size is 12 bytes smaller than the normal payload size (this 12 bytes is the ARR Header used to control send and data response sizes).
Examples
The following example sets the request packet size to 40 bytes for operation 3:
Router(config)# rtr 3Router(config-rtr)# type echo protocol snalu0echoappl cwbc0aRouter(config-rtr)# request-data-size 40Related Commands
response-data-size
Sets the protocol data size in the payload of the SAA operation's response packet.
rtr
Specifies an SAA operation and enters SAA RTR configuration mode.
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
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.
rmdir
To remove an existing directory in a Class C Flash file system, use the rmdir command in EXEC mode.
rmdir directory
Syntax Description
Command Modes
User EXEC
Priviledged EXEC
Command 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 key-chain
To enable Service Assurance Agent (SAA) 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
Usage Guidelines
The authentication configuration on the SAA source and SAA Responder devices must be the same. In other words, both devices must be configured with the same key chain or both devices must not use authentication.
If the rtr key-chain command is entered, at least one key must be added to the specified MD5 key chain in order for MD5 authentication to occur.
Examples
In the following example, the SAA control message uses MD5 authentication, and the key chain name is CSAA. The authentication string for key 1 is csaakey1.
rtr key-chain csaakey chain csaakey 1key-string csaakey1
Related Commands
rtr low-memory
To specify how much unused memory must be available to allow Service Assurance Agent (SAA) 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 SAA (RTR). 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
Usage Guidelines
The rtr low-memory command allows the user to specify the amount of memory that the SAA can use. If the amount of available free memory falls below the value specified in the rtr low-memory command, then the SAA will not allow new operations to be configured. If this command is not used, the default low-memory value is 25 percent. This means that if 75 percent of system memory has been utilized you will not be able to configure any SAA characteristics.
The value of the rtr low-memory command should not exceed the amount of free memory available on the system. To determine the amount of free memory available on the system, use the show memory EXEC command.
Examples
In the following example, the router is configured so that no less than 2 MB of memory will be free for RTR configuration:
Router(config)# rtr low-memory 2000000Related Commands
rtr
Specifies an identification number for an operation and enters SAA RTR configuration mode.
show memory
Displays statistics about memory, including memory-free pool statistics.
rtr reaction-configuration
To configure certain actions to occur based on events under the control of the Service Assurance Agent (SAA), use the rtr reaction-configuration command in global configuration mode. To return to the default values of the operation, use the no form of this command.
rtr reaction-configuration operation-number [verify-error-enable] [connection-loss-enable] [timeout-enable] [threshold-falling milliseconds] [threshold-type option] [action-type option]
no rtr reaction-configuration operation-number
Syntax Description
Defaults
No reactions are generated.
Error verification is disabled.
Connection loss is disabled.
Checking the timeout is disabled.
The falling threshold value is 3000 ms.
The algorithm threshold is never.
Command Modes
Global configuration
Command History
11.2
This command was introduced.
12.1(1)T
The verify-error-enable optional keyword was added.
Usage Guidelines
Triggers are used for diagnostics purposes and are not used in normal operation.
You can use triggers to assist you in determining where delays are happening in the network when excessive delays are being seen on an end-to-end basis.
The reaction applies only to attempts to the target (that is, attempts to any hops along the path in pathEcho do not generate reactions).
Note
Examples
In the following example, operation 19 sends an SNMP trap when there is an over or falling threshold violation:
Router(config)# rtr reaction-configuration 19 threshold-type immediate action-type trapOnlyFigure 1 shows that an alert (rising trap) would be issued immediately when the response time exceeds the rising threshold and a resolution (falling trap) would be issued immediately when the response time drops below the falling threshold.
Figure 1 Example of Rising and Falling Thresholds
Related Commands
rtr reaction-trigger
To define a second Service Assurance Agent (SAA) operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration 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
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
To perform a shutdown and restart of the Service Assurance Agent 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
Usage Guidelines
The rtr reset command stops all operations, clears SAA/RTR configuration information, and returns the SAA feature to the startup condition. This command does not reread the SAA RTR configuration stored in startup-config in NVRAM. You must retype the configuration or load a previously saved configuration file.
Caution
Examples
The following example resets SAA, clearing all stored SAA information and configuration:
Router(config)# rtr resetRelated Commands
rtr responder
To enable the Service Assurance Agent (SAA) Responder for general SAA operations, use the rtr responder command in global configuration mode. To disable the SAA 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
Usage Guidelines
This command is used on the destination device for SAA operations to enable the sending of receiving of RTR Control packets. Enabling the SAA/RTR Responder allows the generation of packet loss statistics on the device sending SAA operations.
Examples
The following example enables the SAA Responder:
Router(config)# rtr responderRelated Commands
rtr responder type tcpConnect
Enables the SAA Responder for TCP Connect operations.
rtr responder type udpEcho
Enables the SAA Responder for UDP Echo and Jitter operations.
rtr responder type frame-relay
To enable the Service Assurance Agent (SAA) 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 SAA 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 SAA Responder to respond to Frame Relay operations without receiving RTR 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 SAA 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
To enable the Service Assurance Agent (SAA) Responder for TCP Connect operations, use the rtr responder type tcpConnect command in global configuration mode. To disable the SAA 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
12.0(3)T
This command was introduced.
12.1(1)T
The ipaddr and port keywords were added.
Usage Guidelines
This command is used on the destination device for SAA operations to enable the acceptance and return of TCP Connect operation packets.
Related Commands
rtr responder type udpEcho
To enable the Service Assurance Agent (SAA) Responder for User Datagram Protocol (UDP) Echo or Jitter operations, use the rtr responder command in global configuration mode. To disable the SAA 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
Usage Guidelines
This command is used on the destination device for SAA operations to enable UPD Echo and Jitter (UDP+) operations on non-native interfaces.
Examples
The following example enables the SAA Responder for Jitter operations:
Router(config)# rtr responder type udpEcho ipaddress A.B.C.D port 1Related Commands
rtr responder
Enables the SAA Responder for non-specific SAA operations.
rtr responder type frame-relay
Enables the SAA Responder for Frame Relay operations.
rtr restart
To restart an Service Assurance Agent (SAA) operation, use the rtr restart command in global configuration mode.
rtr restart operation-number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration.
Command History
12.1(1)T
This command was introduced.
12.2(11)T
The maximum number of operations was increased from 500 to 2000 (SAA Engine II).
Usage Guidelines
To restart an operation, the operation should be in an "active" state (as defined in the rtr reaction-configuration command).
SAA allows a maximum of 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 SAA/RTR statistics and configuration information from the router and resets the SAA engine.
rtr schedule
To configure the time parameters for an Service Assurance Agent (SAA) 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 operation-number [life {forever | seconds}] [start-time {hh:mm[:ss] [month day | day month] | pending | now | after hh:mm::ss}] [ageout seconds]
no rtr schedule operation-number
Syntax Description
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
11.2
This command was introduced.
12.1(1)T
The after and forever keywords were added.
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 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.
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 foreverRelated Commands
rtr
To begin configuring an Service Assurance Agent (SAA) operation by entering SAA RTR configuration mode, use the rtr command in global configuration mode. To remove all configuration information for an operation, including the schedule of the operation, reaction configuration, and reaction triggers, use the no form of this command.
rtr operation-number
no rtr operation-number
Syntax Description
operation-number
Operation number used for the identification of the SAA operation you wish to configure.
Defaults
Disabled.
Command Modes
Global configuration
Command History
11.2
This command was introduced.
12.2(11)T
The maximum number of operations was increased from 500 to 2000 (SAA Engine II).
Usage Guidelines
The rtr command is used to configure Cisco Service Assurance Agent (SAA) operations. Use this command to specify an identification number for the operation you are about to configure. After you enter this command, you will enter the SAA RTR configuration mode, indicated by the (config-rtr) router prompt. The "Related Commands" table lists the commands you can use in SAA RTR configuration mode.
For detailed information on the configuration of the Cisco SAA feature, see the "Network Monitoring Using Cisco Service Assurance Agent" chapter in the Cisco IOS Configuration Fundamentals Configuration Guide.
SAA 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 global configuration command. You can also optionally set reaction triggers for the operation. For information on reaction triggers, refer to the rtr reaction-configuration and rtr reaction-trigger global configuration commands.
Note
To display the current configuration settings of the operation, use the show rtr configuration EXEC command.
Examples
In the following example, operation 1 is configured to perform end-to-end response time operations using an SNA LU Type 0 connection with the host name cwbc0a. Only the type SAA RTR configuration command is required; all others are optional.
Router(config)# rtr 1Router(config-rtr)# type echo protocol snalu0echoappl cwbc0aRouter(config-rtr)# request-data-size 40Router(config-rtr)# response-data-size 1440Router(config-rtr)# exitRouter(config)#
Note
Related Commands
rtr slm frame-relay statistics
To enable the Service Assurance Agent (SAA) 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
Usage Guidelines
The rtr slm frame-relay statistics command should be issued prior to configuring any of the Frame Relay service level monitoring SAA 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 SAA operation (type frame-relay).
Examples
In the following example the SAA Frame Relay service level monitoring feature is enabled:
Router(config)# rtr slm frame-relay statisticsRelated Commands
saa apm cache-size
To set the size of the Service Assurance Agent (SAA) Application Performance Monitor (APM) cache, use the saa apm cache-size command in global configuration mode. To reset the SAA 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
Usage Guidelines
SAA APM script and scheduler files are kept in an area of memory called the SAA 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 SAA 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 SAA APM cache and information about the files stored in the cache.
saa apm copy
To copy script or scheduler files from an FTP server to the device that will initiate the Service Assurance Agent (SAA) 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
Usage Guidelines
The saa apm copy command downloads an SAA APM script or scheduler file from an FTP server to the local SAA 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
To specify the lowest amount of free memory that must be available on the system to allow additional Service Assurance Agent (SAA) 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
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 the SAA 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 SAA 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 SAA 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
To start or stop an Service Assurance Agent (SAA) Application Performance Monitor (APM) operation, use the saa apm operation command in global configuration mode. To delete existing SAA 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 SAA APM operations exist.
Command Modes
Global configuration
Command History
Usage Guidelines
The following files are required to perform an SAA 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 SAA APM, and to download the documentation ("readme" files) for the scripts, go to the "Cisco 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 SAA 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 SAA Application Performance Monitor.
samples-of-history-kept
To set the number of entries kept in the history table per bucket for the Service Assurance Agent (SAA) operation, use the samples-of-history-kept command in SAA 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
samples
Number of entries kept in the history table per bucket. The default is 16 entries for type pathEcho and 1 entry for type echo.
Defaults
16 entries for type pathEcho
1 entry for type echo
Command Modes
SAA RTR configuration
Command History
Usage Guidelines
Use the samples-of-history-kept command to control how many entries are saved in the history table. To control the type of information that gets saved in the history table, use the filter-for-history command. To set how many buckets get created in the history table, use the buckets-of-history-kept command.
An operation can collect history and capture statistics. By default, history is not collected. When a problem arises where history is useful (for example, a large number of timeouts are occurring), you can configure the lives-of-history-kept SAA RTR configuration command to collect history.
Note
Examples
In the following example, ten entries are kept in the history table for each of the lives of operation 3:
Router(config)# rtr 1Router(config-rtr)# type pathecho protocol ipIcmpEcho 172.16.1.176Router(config-rtr)# lives-of-history-kept 3Router(config-rtr)# samples-of-history-kept 10Related 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}]]
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
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
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
send
To send messages to one or all terminal lines, use the send command in EXEC mode.
send {line-number | * | aux number | console number | tty number | vty number}
Syntax Description
Defaults
No messages are sent.
Command Modes
User EXEC
Priviledged EXEC
Command History
Usage Guidelines
After entering this command, the system prompts for the message to be sent, which can be up to 500 characters long. Enter Ctrl-Z to end the message. Enter Ctrl-C to abort this command.
Caution
Examples
The following example sends a message to all lines:
2509# send *Enter message, end with CTRL/Z; abort with CTRL/C:The system 2509 will be shut down in 10 minutes for repairs.^ZSend message? [confirm]2509#********* Message from tty0 to all terminals:***The system 2509 will be shut down in 10 minutes for repairs.server (boomerang)
To configure the server address for a specified boomerang domain, use the server command in boomerang configuration mode. To remove this command from the configuration file and restore the system to its default condition with respect to this command, use the no form of this command.
server server-ip-address
no server server-ip-address
Syntax Description
Defaults
No default behavior or values.
Command Modes
Boomerang configuration
Command History
Usage Guidelines
The server command can be used only on a Director Response Protocol (DRP) agent. The boomerang client is the Director Response Protocol (DRP) agent.
Use the server command to specify a server address that is to be associated with a given domain name. This configuration overrides the server-to-DRP agent association that is configured on DistributedDirector.
Examples
The following example configures the server for a domain named www.boom1.com. The server address for www.boom1.com is 172.16.101.101:
Router(config)# ip drp domain www.boom1.comRouter(config-boomerang)# server 172.16.101.101Router# show running-config...ip drp domain www.boom1.comcontent-server 172.16.101.101Related Commands
service compress-config
To compress startup configuration files, use the service compress-config command in global configuration mode. To disable compression, use the no form of this command.
service compress-config
no service compress-config
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
After you configure the service compress-config command, the router will compress configuration files every time you save a configuration to the startup configuration. For example, when you enter the copy system:running-config nvram:startup-config command, the running configuration will be compressed before storage in NVRAM.
If the file compression succeeds, the following message is displayed:
Compressing configuration from configuration-size to compressed-size[OK]If the boot ROMs do not recognize a compressed configuration, the following message is displayed:
Boot ROMs do not support NVRAM compression Config NOT written to NVRAMIf the file compression fails, the following message is displayed:
Error trying to compress nvramOne way to determine whether a configuration file will be compressed enough to fit into NVRAM is to use a text editor to enter the configuration, then use the UNIX compress command to check the compressed size. To get a closer approximation of the compression ratio, use the UNIX compress -b12 command.
Once the configuration file has been compressed, the router functions normally. At boot time, the system recognizes that the configuration file is compressed, uncompresses it, and proceeds normally. A partition nvram:startup-config command uncompresses the configuration before displaying it.
To disable compression of the configuration file, enter configuration mode and specify the no service compress-config command. Then, exit global configuration mode and enter the copy system:running-config nvram:startup-config command. The router displays an OK message if it is able to write the uncompressed configuration to NVRAM. Otherwise, the router displays an error message indicating that the configuration is too large to store. If the configuration file is larger than the physical NVRAM, the following message is displayed:
##Configuration too large to fit uncompressed in NVRAM Truncate configuration? [confirm]When the file is truncated, commands at the end of the file are erased. Therefore, you will lose part of your configuration. To truncate and save the configuration, type Y. To not truncate and not save the configuration, type N.
Examples
In the following example, the configuration file is compressed:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# service compress-configRouter(config)# endRouter#%SYS-5-CONFIG_I: Configured from console by consoleRouter# copy system:running-config nvram:startup-configBuilding configuration...Compressing configuration from 1179 bytes to 674 bytes[OK]Related Commands
partition nvram:startup-config
Separates Flash memory into partitions on Class B file system platforms.
service config
To enable autoloading of configuration files from a network server, use the service config command in global configuration mode. To restore the default, use the no form of this command.
service config
no service config
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled, except on systems without NVRAM or with invalid or incomplete information in NVRAM. In these cases, autoloading of configuration files from a network server is enabled automatically.
Command Modes
Global configuration
Command History
Usage Guidelines
Usually, the service config command is used in conjunction with the boot host or boot network command. You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command.
With IOS software versions 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active.
If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg.
Examples
In the following example, a router is configured to autoload the default network and host configuration files. Because no boot host or boot network commands are specified, the router uses the broadcast address to request the files from a TFTP server.
Router(config)# service configThe following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the network configuration file resides:
Router(config)# service configRouter(config)# boot network rcp://172.16.1.111/bridge_9.1Related Commands
service decimal-tty
To specify that line numbers be displayed and interpreted as octal numbers rather than decimal numbers, use the no service decimal-tty command in global configuration mode. To restore the default, use the service decimal-tty command.
service decimal-tty
no service decimal-tty
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled (line numbers displayed as decimal numbers)
Command Modes
Global configuration
Command History
Examples
In the following example, the router is configured to display decimal rather than octal line numbers:
Router(config)# service decimal-ttyservice exec-wait
To delay the startup of the EXEC on noisy lines, use the service exec-wait command in global configuration mode. To disable the delay function, use the no form of this command.
service exec-wait
no service exec-wait
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command delays startup of the EXEC until the line has been idle (no traffic seen) for 3 seconds. The default is to enable the line immediately on modem activation.
This command is useful on noisy modem lines or when a modem attached to the line is configured to ignore MNP/V.42 negotiations, and MNP/V.42 modems may be dialing in. In these cases, noise or MNP/V.42 packets may be interpreted as usernames and passwords, causing authentication failure before the user has a chance to type a username or password. The command is not useful on nonmodem lines or lines without some kind of login configured.
Examples
The following example delays the startup of the EXEC:
Router(config)# service exec-waitservice finger
The service finger command has been replaced by the ip finger command. However, the service finger and no service finger commands continue to function to maintain backward compatibility with older versions of Cisco IOS software. Support for this command may be removed in a future release. See the description of the ip finger command for more information.
service hide-telnet-address
To hide addresses while trying to establish a Telnet session, use the service hide-telnet-address command in global configuration mode. To disable this service, use the no form of this command.
service hide-telnet-address
no service hide-telnet-address
Syntax Description
This command has no arguments or keywords.
Defaults
Addresses are displayed.
Command Modes
Global configuration
Command History
Usage Guidelines
When you attempt to connect to a device, the router displays addresses and other messages (for example, "Trying router1 (171.69.1.154, 2008)...)." With the hide feature, the router suppresses the display of the address (for example, "Trying router1 address #1..."). The router continues to display all other messages that would normally be displayed during a connection attempt, such as detailed error messages if the connection was not successful.
The hide feature improves the functionality of the busy-message feature. When you configure only the busy-message command, the normal messages generated during a connection attempt are not displayed; only the busy-message is displayed. When you use the hide and busy features together you can customize the information displayed during Telnet connection attempts. When you configure the service hide-telnet-address command and the busy-message command, the router suppresses the address and displays the message specified with the busy-message command if the connection attempt is not successful.
Examples
The following example hides Telnet addresses:
Router(config)# service hide-telnet-addressRelated Commands
busy-message
Creates a "host failed" message that is displayed when a connection fails.
service linenumber
To configure the Cisco IOS software to display line number information after the EXEC or incoming banner, use the service linenumber command in global configuration mode. To disable this function, use the no form of this command.
service linenumber
no service linenumber
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
With the service linenumber command, you can have the Cisco IOS software display the host name, line number, and location each time an EXEC process is started, or an incoming connection is made. The line number banner appears immediately after the EXEC banner or incoming banner. This feature is useful for tracking problems with modems, because the host and line for the modem connection are listed. Modem type information can also be included.
Examples
In the following example, a user Telnets to Router2 before and after the service linenumber command is enabled. The second time, information about the line is displayed after the banner.
Router1> telnet Router2Trying Router2 (172.30.162.131)... OpenWelcome to Router2.User Access VerificationPassword:Router2> enablePassword:Router2# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router2(config)# service linenumberRouter2(config)# endRouter2# logout[Connection to Router2 closed by foreign host]Router1> telnet Router2Trying Router2 (172.30.162.131)... OpenWelcome to Router2.Router2 line 10User Access VerificationPassword:Router2>Related Commands
service nagle
To enable the Nagle congestion control algorithm, use the service nagle command in global configuration mode. To to disable the algorithm, use the no form of this command.
service nagle
no service nagle
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
When using a standard TCP implementation to send keystrokes between machines, TCP tends to send one packet for each keystroke typed. On larger networks, many small packets use up bandwidth and contribute to congestion.
The algorithm developed by John Nagle (RFC 896) helps alleviate the small-packet problem in TCP. In general, it works this way: The first character typed after connection establishment is sent in a single packet, but TCP holds any additional characters typed until the receiver acknowledges the previous packet. Then the second, larger packet is sent, and additional typed characters are saved until the acknowledgment comes back. The effect is to accumulate characters into larger chunks, and pace them out to the network at a rate matching the round-trip time of the given connection. This method is usually effective for all TCP-based traffic. However, do not use the service nagle command if you have XRemote users on X Window system sessions.
Examples
The following example enables the Nagle algorithm:
Router(config)# service nagleservice prompt config
To display the configuration prompt (config), use the service prompt config command in global configuration mode. To remove the configuration prompt, use the no form of this command.
service prompt config
no service prompt config
Syntax Description
This command has no arguments or keywords.
Defaults
The configuration prompts appear in all configuration modes.
Command Modes
Global configuration
Command History
Examples
In the following example, the no service prompt config command prevents the configuration prompt from being displayed. The prompt is still displayed in EXEC mode. When the service prompt config command is entered, the configuration mode prompt reappears.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# no service prompt confighostname newnameendnewname# configure terminalEnter configuration commands, one per line. End with CNTL/Z.service prompt confignewname(config)# hostname RouterRouter(config)# endRouter#Related Commands
hostname
Specifies or modifies the host name for the network server.
prompt
Customizes the prompt.
service sequence-numbers
To enable visible sequence numbering of system logging messages, use the service sequence-numbers command in global configuration mode. To disable visible sequence numbering of logging messages, use the no form of this command.
service sequence-numbers
no service sequence-numbers
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
Each system status messages logged in the system logging process have a sequence reference number applied. This command makes that number visible by displaying it with the message. The sequence number is displayed as the first part of the system status message. See the description of the logging commands for information on displaying logging messages.
Examples
In the following example logging message sequence numbers are enabled:
.Mar 22 15:28:02 PST: %SYS-5-CONFIG_I: Configured from console by consoleRouter# config terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# service sequence-numbersRouter(config)# endRouter#000066: .Mar 22 15:35:57 PST: %SYS-5-CONFIG_I: Configured from console by consoleRelated Commands
logging on
Enables system logging globally.
service timestamps
Enables time-stamping of system logging messages or debugging messages.
