Table Of Contents
major rising
maximum
memory free low-watermark
memory lite
memory io
memory processor
memory reserve critical
memory sanity
memory scan
memory statistics history table
memory-size iomem
menu (EXEC)
menu <menu-name> single-space
menu clear-screen
menu command
menu default
menu line-mode
menu options
menu prompt
menu status-line
menu text
menu title
microcode (12000)
microcode (7000/7500)
microcode (7200)
microcode reload (12000)
microcode reload (7000/7500)
microcode reload (7200)
minor rising
mkdir
monitor event-trace (EXEC)
monitor event-trace (global)
monitor event-trace cpu-report (EXEC)
monitor event-trace cpu-report (global)
monitor event-trace dump-traces
monitor processes cpu extended
mop device-code
mop retransmit-timer
mop retries
more
more <url> begin
more <url> exclude
more <url> include
motd-banner
name-connection
no menu
no snmp-server
notify
notify syslog
ntp access-group
ntp authenticate
ntp authentication-key
ntp broadcast client
ntp broadcast
ntp broadcastdelay
ntp clock-period
ntp disable
ntp logging
ntp master
ntp max-associations
ntp multicast client
ntp multicast
ntp peer
ntp refclock
ntp server
ntp source
ntp trusted-key
ntp update-calendar
object-list
owner
padding
parity
parser cache
parser config cache interface
partition
path (archive configuration)
paths-of-statistics-kept
periodic
major rising
To set major level threshold values for the buffer, CPU, and memory ROs, use the major rising command in buffer owner configuration mode, CPU owner configuration mode, or memory owner configuration mode. To disable this function, use the no form of this command.
major rising rising-threshold-value [interval interval-value] [falling falling-threshold-value
[interval interval-value]] [global]
no major rising
Syntax Description
rising-threshold-value
|
Specifies the rising threshold value as a percentage.
Valid values are from 1 to 100.
|
interval interval-value
|
(Optional) Specifies the time in seconds during which the variation in rising or falling threshold values are not notified to the RU, resource group, or resource user types. For example, if the buffer usage count remains above the configured threshold value for the configured interval, a notification will be sent to the RU, resource group, or resource user types.
Valid values are from 5 to 86400 seconds. The default value is 5 seconds.
|
falling falling-threshold-value
|
(Optional) Specifies the falling threshold value as a percentage.
Valid values are from 1 to 100.
|
global
|
(Optional) Configures a global threshold.
The global keyword is optional while setting major threshold values for public buffer, processor CPU, I/O memory, and processor memory.
The global keyword is mandatory while setting major threshold values for interrupt CPU and total CPU.
|
Command Default
Disabled
Command Modes
Buffer owner configuration mode
CPU owner configuration mode
Memory owner configuration mode
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
The interval is the dampening or observation interval time in seconds during which the variations in the rising and falling threshold values are not notified to the ROs or RUs. That is, the interval is the time the system waits to check whether the threshold value stabilizes or not. The interval is set to avoid unnecessary and unwanted threshold notifications. If an interval is not specified, the system takes a default value of 5 seconds.
This command allows you to configure three types of thresholding:
•
System Global Thresholding
•
User Local Thresholding
•
Per User Global Thresholding
System Global Thresholding
System global thresholding is used when the entire resource reaches a specified value. That is, RUs are notified when the total resource utilization goes above or below a specified threshold value. The notification order is determined by the priority of the RU. The RUs with a lower priority will be notified first, so that these low-priority RUs are expected to reduce the resource utilization. This order prevents the high-priority RUs from getting affected with unwanted notifications.
You can set rising and falling threshold values. For example, if you have set a total CPU utilization threshold value of 70% as the rising major value and 15% as falling major value, then when the total CPU utilization crosses the 70% mark, a major Up notification is sent to all the RUs and when the total CPU utilization falls below 15%, a major Down notification is sent to all the RUs.
Similarly, if you have set a total buffer usage count threshold value of 70% as the rising major value and 15% as falling major value, then when the total buffer usage count crosses the 70% mark, a major Up notification is sent to all the RUs and when the total buffer usage count falls below 15%, a major Down notification is sent to all the RUs.
In the same way, if you have set a total I/O memory usage threshold value of 70% as the rising major value and 15% as falling major value, then when the total memory usage crosses the 70% mark, a major Up notification is sent to all the RUs and when the total memory usage falls below 15%, a major Down notification is sent to all the RUs.
User Local Thresholding
User local thresholding is used when a specified RU exceeds the configured limits. The user local thresholding method prevents a single RU from monopolizing the resources. That is, the specified RU is notified when the resource utilization of the specified RU goes above or below a configured threshold value. For example, if you have set a CPU utilization threshold value of 70% as the rising major value and 15% as falling major value, then when the CPU utilization of the specified RU crosses the 70% mark, a major Up notification is sent to that RU only and when the CPU utilization of the specified RU falls below 15%, a major Down notification is sent to that RU only. The same method applies to buffer and memory ROs also.
Per User Global Thresholding
Per user global thresholding is used when the entire resource reaches a specified value. This value is unique for each RU and notification is sent only to the specified RU. User global thresholding is similar to user local thresholding, except that the global resource usage is compared against the thresholds. That is, only the specified RU is notified when the total resource utilization goes above or below a configured threshold value. For example, if you have set a CPU utilization threshold value of 70% as the rising major value and 15% as falling major value, then when the total CPU utilization crosses the 70% mark, a major Up notification is sent to the specified RU only and when the total CPU utilization falls below 15%, a major Down notification is sent to the specified RU only. The same method applies to buffer and memory ROs also.
Threshold Violations
The Cisco IOS device sends out error messages whenever a threshold is violated. The following examples help you understand the error message pattern when different threshold violations occur in buffer, CPU, and memory ROs:
System Global Threshold Violation in Buffer RO
The threshold violation in buffer RO for a system global threshold shows the following output:
System global threshold-Violation (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:15:11: %SYS-4-GLOBALBUFEXCEED: Buffer usage has gone above global buffer Major
threshold
configured <value> Current usage :<value>
For example:
00:15:11: %SYS-4-GLOBALBUFEXCEED: Buffer usage has gone above global buffer Major
threshold
configured 100 Current usage :101
System global threshold- Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:17:10: %SYS-5-GLOBALBUFRECOVER: Buffer usage has gone below global buffer Major
threshold
configured <value> Current usage :<value>
For example:
00:17:10: %SYS-5-GLOBALBUFRECOVER: Buffer usage has gone below global buffer Critical
threshold
configured 70 Current usage :69
Per User Global Threshold Violation in Buffer RO
The threshold violation in buffer RO for a user global threshold shows the following output:
User global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:24:04: %SYS-4-RESGLOBALBUFEXCEED: Buffer usage has gone above buffer Major threshold
configured by resource user <user-name>
configured 100 Current usage :101
User global threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:25:08: %SYS-4-RESGLOBALBUFRECOVER: Buffer usage has gone below buffer Major threshold
configured by resource user <user-name>
configured 76 Current usage :75
User Local Threshold Violation in Buffer RO
The threshold violation in buffer RO for a user local threshold shows the following output:
User local threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:31:15: %SYS-4-RESBUFEXCEED: Resource user user_1 has exceeded the buffer Major
threshold. configured 108 Current usage :109
User local threshold- Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:31:05: %SYS-5-RESBUFRECOVER: Resource user user_1 has recovered after exceeding the
buffer Major threshold. configured 90 Current usage :89
System Global Threshold Violation in CPU RO
The threshold violation in CPU RO for a system global threshold shows the following output:
System global threshold- Violation
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly )
==========================================================================================
00:19:36: %SYS-4-CPURESRISING: System is seeing global cpu util 19% at total level more
than the configured major limit 11%
System global threshold - Recovery
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly )
==========================================================================================
00:20:56: %SYS-6-CPURESFALLING: System is no longer seeing global high cpu at total level
for the configured major limit 10%, current value 4%
Per User Global Threshold Violation in CPU RO
The threshold violation in CPU RO for a user global threshold shows the following output:
User global threshold - Violation
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly )
==========================================================================================
00:14:21: %SYS-4-CPURESRISING: Resource user <user-name> is seeing global cpu util 11% at
total level more than the configured major limit 6%
For example:
00:14:21: %SYS-4-CPURESRISING: Resource user Test-proc-14:99s:1w:100n is seeing global cpu
util 11% at total level more than the configured major limit 6%
User global threshold- Recovery
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly )
==========================================================================================
00:14:46: %SYS-6-CPURESFALLING: Resource user <user-name> is no longer seeing global high
cpu at total level for the configured critical limit 9%, current value 4%
For example:
00:14:46: %SYS-6-CPURESFALLING: Resource user Test-proc-14:99s:1w:100n is no longer seeing
global high cpu at total level for the configured critical limit 9%, current value 4%
User Local Threshold Violation in CPU RO
The threshold violation in CPU RO for a user local threshold shows the following output:
User local threshold - Violation (keywords Critical, Major and Minor will vary accordingly
- only process level)
==========================================================================================
00:12:11: %SYS-4-CPURESRISING: Resource user <user-name> is seeing local cpu util 15% at
process level more than the configured minor limit 6 %
For example:
00:12:11: %SYS-4-CPURESRISING: Resource user Test-proc-9:85s:15w:100n is seeing local cpu
util 15% at process level more than the configured minor limit 6%
User local threshold- Recovery (keywords Critical, Major and Minor will vary accordingly
- only process level)
==========================================================================================
00:13:11: %SYS-6-CPURESFALLING: Resource user <user-name> is no longer seeing local high
cpu at process level for the configured critical limit 9%, current value 3%
System Global Threshold Violation in Memory RO
The threshold violation in memory RO for a system global threshold shows the following output:
System global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
(If violation happens in IO memory pool will be : I/O)
==========================================================================================
13:53:22: %SYS-5-GLOBALMEMEXCEED: Global Memory has exceeded the Minor threshold
Pool: Processor Used: 422703520 Threshold: 373885200
For example:
13:54:03: %SYS-5-GLOBALMEMEXCEED: Global Memory has exceeded the Critical threshold
Pool: Processor Used: 622701556 Threshold: 467356500
System global threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
(If recovery happens in IO memory pool will be : I/O)
==========================================================================================
%SYS-5-GLOBALMEMRECOVER: Global Memory has recovered after exceeding Minor threshold
Pool: Processor Used: 222473448 Threshold: 355190940
For example:
13:50:41: %SYS-5-GLOBALMEMRECOVER: Global Memory has recovered after exceeding Critical
threshold
Pool: Processor Used: 222473152 Threshold: 443988675
Per User Global Threshold Violation in Memory RO
The threshold violation in memory RO for a user global threshold shows the following output:
User global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
(If violation happens in IO memory pool will be : I/O)
==========================================================================================
00:53:14: %SYS-4-RESGLOBALMEMEXCEED: Global Memory has exceeded the Minor threshold
configure by resource user <XYZ>
Pool: Processor Used: 62273916 Threshold: 62246820
User global threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
(If recovery happens in IO memory pool will be : I/O)
==========================================================================================
00:32:56: %SYS-4-RESGLOBALMEMRECOVER: Global Memory has recovered after exceeding the
Critical threshold configure by resource user <XYZ>
Pool: Processor Used: 329999508 Threshold: 375865440
User Local Threshold Violation in Memory RO
The threshold violation in memory RO for a user local threshold shows the following output:
User local threshold- Violation (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
01:05:42: %SYS-4-RESMEMEXCEED: Resource user <XYZ> has exceeded the Critical memory
threshold
Pool: Processor Used: 103754740 Threshold: 103744700
User local threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:44:43: %SYS-5-RESMEMRECOVER: Resource user <XYZ> has recovered after exceeding the
Critical memory threshold
Pool: Processor Used: 328892280 Threshold :375865440
Examples
Configuring Major Rising Values for System Global Thresholding
The following example shows how to configure the major threshold values for system global thresholding with major rising threshold of 70% at an interval of 12 seconds and major falling threshold of 15% at an interval of 10 seconds:
Router(config-owner-cpu)# major rising 70 interval 12 falling 15 interval 10 global
Router(config-owner-buffer)# major rising 70 interval 12 falling 15 interval 10 global
Router(config-owner-memory)# major rising 70 interval 12 falling 15 interval 10 global
Configuring Major Rising Values for User Local Thresholding
The following example shows how to configure the major threshold values for user local thresholding with major rising threshold of 70% at an interval of 12 seconds and major falling threshold of 15% at an interval of 10 seconds:
Router(config-owner-cpu)# major rising 70 interval 12 falling 15 interval 10
Router(config-owner-buffer)# major rising 70 interval 12 falling 15 interval 10
Router(config-owner-memory)# major rising 70 interval 12 falling 15 interval 10
Configuring Major Rising Values for Per User Global Thresholding
The following example shows how to configure the major threshold values for per user global thresholding with major rising threshold of 70% at an interval of 12 seconds and major falling threshold of 15% at an interval of 10 seconds:
Router(config-owner-cpu)# major rising 70 interval 12 falling 15 interval 10 global
Router(config-owner-buffer)# major rising 70 interval 12 falling 15 interval 10 global
Router(config-owner-memory)# major rising 70 interval 12 falling 15 interval 10 global
Related Commands
Command
|
Description
|
buffer public
|
Enters the buffer owner configuration mode and sets threshold values for buffer usage.
|
cpu interrupt
|
Enters the CPU owner configuration mode and sets threshold values for interrupt level CPU utilization.
|
cpu process
|
Enters the CPU owner configuration mode and sets threshold values for processor level CPU utilization.
|
cpu total
|
Enters the CPU owner configuration mode and sets threshold values for total CPU utilization.
|
memory io
|
Enters the memory owner configuration mode and sets threshold values for I/O memory.
|
memory processor
|
Enters the memory owner configuration mode and sets threshold values for processor memory.
|
policy (ERM)
|
Configures an ERM resource policy.
|
resource policy
|
Enters ERM configuration mode.
|
show resource all
|
Displays all the resource details.
|
slot (ERM policy)
|
Configures line cards.
|
system (ERM policy)
|
Configures system level ROs.
|
maximum
To set the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive, use the maximum command in archive configuration mode. To reset this command to its default, use the no form of this command.
maximum number
no maximum number
Syntax Description
number
|
Maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive.
|
Defaults
By default, a maximum of ten archive files of the running configuration are saved in the Cisco IOS configuration archive.
Command Modes
Archive configuration
Command History
Release
|
Modification
|
12.3(7)T
|
This command was introduced.
|
12.2(25)S
|
This command was integrated into Cisco IOS Release 12.2(25)S.
|
Usage Guidelines
Note
Before using this command, you must configure the path command in order to specify the location and filename prefix for the files in the Cisco IOS configuration archive.
After the maximum number of files has been saved in the Cisco IOS configuration archive, the oldest file will be automatically deleted when the next, most recent file is saved.
Note
This command should only be used when a local writable file system is specified in the url argument of the path command. Network file systems may not support deletion of previously saved files.
Examples
In the following example, a value of 20 is set as the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive:
Router(config-archive)# path disk0:myconfig
Router(config-archive)# maximum 20
Related Commands
Command
|
Description
|
archive config
|
Saves a copy of the current running configuration to the Cisco IOS configuration archive.
|
configure confirm
|
Confirms replacement of the current running configuration with a saved Cisco IOS configuration file.
|
configure replace
|
Replaces the current running configuration with a saved Cisco IOS configuration file.
|
path
|
Specifies the location and filename prefix for the files in the Cisco IOS configuration archive.
|
show archive
|
Displays information about the files saved in the Cisco IOS configuration archive.
|
time-period
|
Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive.
|
memory free low-watermark
To configure a router to issue system logging message notifications when available memory falls below a specified threshold, use the memory free low-watermark command in global configuration mode. To disable memory threshold notifications, use the no form of this command.
memory free low-watermark {processor threshold | io threshold}
no memory free low-watermark
Syntax Description
processor threshold
|
Sets the processor memory threshold in kilobytes. When available processor memory falls below this threshold, a notification message is triggered. Valid values are 1 to 4294967295.
|
io threshold
|
Sets the input/output (I/O) memory threshold in kilobytes. When available I/O memory falls below this threshold, a notification message is triggered. Valid values are 1 to 4294967295.
|
Defaults
Memory threshold notifications are disabled.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(18)S
|
This command was introduced.
|
12.0(26)S
|
This command was integrated into Cisco IOS Release 12.0(26)S.
|
12.3(4)T
|
This command was integrated into Cisco IOS Release 12.3(4)T
|
Usage Guidelines
Using this command, you can configure a router to issue a system logging message each time available free memory falls below a specified threshold ("low-watermark"). Once available free memory rises to 5 percent above the threshold, another notification message is generated.
Examples
The following example specifies a free processor memory notification threshold of 20000 KB:
Router(config)# memory free low-watermark processor 200000
If available free processor memory falls below this threshold, the router sends a notification message like this one:
000029: *Aug 12 22:31:19.559: %SYS-4-FREEMEMLOW: Free Memory has dropped below 20000k
Pool: Processor Free: 66814056 freemem_lwm: 204800000
Once available free processor memory rises to a point 5 percent above the threshold, another notification message like this is sent:
000032: *Aug 12 22:33:29.411: %SYS-5-FREEMEMRECOVER: Free Memory has recovered 20000k
Pool: Processor Free: 66813960 freemem_lwm: 0
Related Commands
Command
|
Description
|
memory reserve critical
|
Reserves memory for use by critical processes.
|
memory lite
To enable the memory allocation lite (malloc_lite) feature, use the memory lite command in global configuration mode. To disable this feature, use the no form of this command.
memory lite
no memory lite
Syntax Description
This command has no arguments or keywords.
Defaults
This command is enabled by default.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(11)T
|
This command was introduced.
|
Usage Guidelines
The malloc_lite feature was implemented to avoid excessive memory allocation overhead for situations where less than 128 bytes were required. This feature is supported for processor memory pools only.
The malloc_lite feature is enabled by default. If the malloc_lite feature is disabled using the no memory lite command, you can re-enable the feature by entering the memory lite command.
Examples
The following example shows how to disable the malloc_lite feature:
Related Commands
Command
|
Description
|
scheduler heapcheck process
|
Performs a "sanity check" for corruption in memory blocks when a process switch occurs.
|
memory io
To enter memory owner configuration mode and set threshold values for I/O memory, use the memory io command in resource policy node configuration mode. To disable this function, use the no form of this command.
memory io
no memory io
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Resource policy node configuration
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
This command allows you to enter the memory owner configuration mode and set rising and falling values for critical, major, and minor thresholds.
Examples
The following example shows how to enter memory owner configuration mode:
Router(config-res-policy-node)# memory io
Related Commands
Command
|
Description
|
critical rising
|
Sets the critical level threshold values for the buffer, CPU, and memory ROs.
|
major rising
|
Sets the major level threshold values for the buffer, CPU, and memory ROs.
|
minor rising
|
Sets the minor level threshold values for the buffer, CPU, and memory ROs.
|
policy (ERM)
|
Configures an ERM resource policy.
|
resource policy
|
Enters ERM configuration mode.
|
show resource all
|
Displays all the resource details.
|
slot (ERM policy)
|
Configures line cards.
|
system (ERM policy)
|
Configures system level ROs.
|
memory processor
To enter memory owner configuration mode and set the threshold values for the processor memory, use the memory processor command in resource policy node configuration mode. To disable this function, use the no form of this command.
memory processor
no memory processor
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Resource policy node configuration
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
This command allows you to enter the memory owner configuration mode and set rising and falling values for critical, major, and minor thresholds.
Examples
The following example shows how to enter memory owner configuration mode:
Router(config-res-policy-node)# memory procesaor
Related Commands
Command
|
Description
|
critical rising
|
Sets the critical level threshold values for the buffer, CPU, and memory ROs.
|
major rising
|
Sets the major level threshold values for the buffer, CPU, and memory ROs.
|
minor rising
|
Sets the minor level threshold values for the buffer, CPU, and memory ROs.
|
policy (ERM)
|
Configures an ERM resource policy.
|
resource policy
|
Enters ERM configuration mode.
|
show resource all
|
Displays all the resource details.
|
slot (ERM policy)
|
Configures line cards.
|
system (ERM policy)
|
Configures system level ROs.
|
memory reserve critical
To configure the size of the memory region to be used for critical notifications (system logging messages), use the memory reserve critical command in global configuration mode. To disable the reservation of memory for critical notifications, use the no form of this command.
memory reserve critical kilobytes
no memory reserve critical
Syntax Description
kilobytes
|
Specifies the amount of memory to be reserved in kilobytes. Valid values are 1 to 4294967295, but the value you specify cannot exceed 25 percent of total memory. The default is 100 kilobytes.
|
Defaults
100 kilobytes of memory is reserved for the logging process.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(18)S
|
This command was introduced.
|
12.0(26)S
|
This command was integrated into Cisco IOS Release 12.0(26)S.
|
12.3(4)T
|
This command was integrated into Cisco IOS Release 12.3(4)T
|
Usage Guidelines
This command reserves a region of memory on the router so that, when system resources are overloaded, the router retains enough memory to issue critical system logging messages.
Note
Once the size of the reserved memory region is specified, any change to the specified value takes effect only after the current configuration is saved and the system has been reloaded.
Examples
The following example shows how to reserve 1,000 KB of system memory for logging messages at the next system restart:
Router(config)# memory reserve critical 1000
Related Commands
Command
|
Description
|
memory free low-watermark
|
Configures a router to issue syslog notifications when available memory falls below a specified threshold.
|
memory sanity
To perform a "sanity check" for corruption in buffers and queues, use the memory sanity command in global configuration mode. To disable this feature, use the no form of this command.
memory sanity [buffer | queue | all]
no memory sanity
Syntax Description
buffer
|
(Optional) Specifies checking all buffers.
|
queue
|
(Optional) Specifies checking all queues.
|
all
|
(Optional) Specifies checking all buffers and queues.
|
Defaults
This command is not enabled by default.
If the buffer or queue keyword is not specified, a sanity check will be performed on all buffers and queues.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(15)T
|
This command was introduced.
|
Usage Guidelines
When the memory sanity buffer command is enabled, a sanity check is performed on buffers when a packet buffer is allocated or when a packet buffer is returned to the buffer pool. This command also time-stamps the buffer, which may be useful when tracking the age of a buffer.
The memory sanity command can be saved in the startup configuration file and, therefore, it is not necessary to reconfigure this command each time the router is reloaded. Like the scheduler heapcheck process memory command, the memory sanity command can check for corruption in the I/O memory block.
Enabling the memory sanity command may result in slight router performance degradation.
Examples
The following example shows how to perform a sanity check for corruption in all buffers and queues:
Related Commands
Command
|
Description
|
scheduler heapcheck process memory
|
Performs a "sanity check" for corruption in memory blocks when a process switch occurs.
|
memory scan
To enable the Memory Scan feature, use the memory scan command in global configuration mode. To restore the router configuration to the default, use the no form of this command.
memory scan
no memory scan
Syntax Description
This command has no arguments or keywords.
Defaults
This command is disabled by default.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(4)XE
|
This command was introduced.
|
12.0(7)T
|
This command was integrated in Cisco IOS Release 12.0 T for the Cisco 7500 series only.
|
Usage Guidelines
The Memory Scan feature adds a low-priority background process that searches all installed dynamic random-access memory (DRAM) for possible parity errors. If errors are found in memory areas that are not in use, this feature attempts to scrub (remove) the errors. The time to complete one memory scan and scrub cycle can range from 10 minutes to several hours, depending on the amount of installed memory. The impact of the Memory Scan feature on the central processing unit (CPU) is minimal. To view the status of the memory scan feature on your router, use the show memory scan command in EXEC mode.
Examples
The following example enables the Memory Scan feature on a Cisco 7500 series router:
Router(config)# memory scan
Related Commands
Command
|
Description
|
show memory scan
|
Displays the number and type of parity errors on your system.
|
memory statistics history table
To change the number of hours for which the memory log is maintained, use the memory statistics history table command in global configuration mode. To return the logging to its default values, use the no form of this command.
memory statistics history table number-of-hours
no memory statistics history table number-of-hours
Syntax Description
number-of-hours
|
Number of hours of history for which the log is maintained.
Valid values are from 12 to 72 hours. The default value is 24 hours.
|
Command Default
The memory log is maintained for 24 hours.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
This command allows you to change the number of hours for which the memory log is maintained. You cannot disable this command. The no form of the command only returns the logging to its default value.
Examples
The following example shows how to change the memory log time to 48 hours of history:
Router(config)# memory statistics history table 48
Related Commands
Command
|
Description
|
show memory statistics history table
|
Displays the history of memory consumption on the Cisco IOS router over a specified period of time.
|
memory-size iomem
To reallocate the percentage of DRAM to use for I/O memory and processor memory on Cisco 3600 series routers, use the memory-size iomem command in global configuration mode. To revert to the default memory allocation, use the no form of this command.
memory-size iomem i/o-memory-percentage
no memory-size iomem i/o-memory-percentage
Syntax Description
i/o-memory-percentage
|
The percentage of DRAM allocated to I/O memory. The values permitted are 10, 15, 20, 25, 30, 40, and 50. A minimum of 4 MB of memory is required for I/O memory.
|
Defaults
The default memory allocation is 25 percent I/O memory and 75 percent processor memory.
Note
If the smartinit process has been enabled, the default memory allocation of 25 percent to I/O does not apply. Instead, smartinit examines the network modules and then calculates the I/O memory required.
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2 P
|
This command was introduced.
|
Usage Guidelines
When you specify the percentage of I/O memory in the command line, processor memory automatically acquires the remaining percentage of DRAM memory.
Examples
The following example allocates 40 percent of the DRAM memory to I/O memory and the remaining 60 percent to processor memory:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# memory-size iomem 40
Router# copy system:running-config nvram:startup-config
Building configuration...
program load complete, entry point: 0x80008000, size: 0x32ea24
Self decompressing the image :
##########################################################################################
##########################################################################################
################################################################## [OK]
menu (EXEC)
To display a preconfigured user menu, use the menu command in user EXEC or privileged EXEC mode.
menu menu-name
Syntax Description
menu-name
|
The name of the menu.
|
Command Modes
User EXEC
Privileged EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
A user menu is a type of user interface where text descriptions of actions to be performed are displayed to the user. The user can use the menu to select services and functions without having to know the details of command-line interface (CLI) commands.
Menus can be created for users in global configuration mode, using the commands listed in the "Related Commands" section.
A menu can be invoked at either the user or privileged EXEC level, but if an item in the menu contains a privileged EXEC command, the user must be logged in at the privileged level for the command to succeed.
Examples
The following example invokes a menu named OnRamp:
Welcome to OnRamp Internet Services
Type a number to select an option;
Related Commands
Command
|
Description
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user interface menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an option number.
|
menu options
|
Sets options for items in user interface menus.
|
menu prompt
|
Specifies the prompt for a user interface menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu text
|
Specifies the text of a menu item in a user interface menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
no menu
|
Deletes a specified menu from a menu configuration.
|
menu <menu-name> single-space
To display menu items single-spaced rather than double-spaced, use the menu menu-name single-space command in global configuration mode.
menu menu-name single-space
Syntax Description
menu-name
|
Name of the menu this command should be applied to.
|
Defaults
Enabled for menus with more than nine items; disabled for menus with nine or fewer items.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
When more than nine menu items are defined, the menu is displayed single-spaced. To configure the menus with nine or fewer items to display single-spaced, use this command.
Examples
In the following example, single-spaced menu items are displayed for the menu named Access1:
menu Access1 single-space
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu clear-screen
To clear the terminal screen before displaying a menu, use the menu clear-screen command in global configuration mode.
menu menu-name clear-screen
Syntax Description
menu-name
|
Name of the menu this command should be applied to.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command uses a terminal-independent mechanism based on termcap entries defined in the router and the configured terminal type for the user. This command allows the same menu to be used on multiple types of terminals instead of having terminal-specific strings embedded within menu titles. If the termcap entry does not contain a clear string, the menu system enters 24 new lines, causing all existing text to scroll off the top of the terminal screen.
Examples
In the following example, the terminal screen is cleared before displaying the menu named Access1:
Router(config)# menu Access1 clear-screen
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
no menu
|
Deletes a specified menu from a menu configuration.
|
menu command
To specify underlying commands for user menus, use the menu command command in global configuration mode.
menu menu-name command menu-item {command | menu-exit}
Syntax Description
menu-name
|
Name of the menu. You can specify a maximum of 20 characters.
|
menu-item
|
Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu entries. When the tenth item is added to the menu, the line-mode and single-space options are activated automatically.
|
command
|
Command to issue when the user selects an item.
|
menu-exit
|
Provides a way for menu users to return to a higher-level menu or exit the menu system.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to assign actions to items in a menu. Use the menu text global configuration command to assign text to items. These commands must use the same menu name and menu selection key.
The menu command command has a special keyword for the command argument, menu-exit, that is available only within menus. It is used to exit a submenu and return to the previous menu level, or to exit the menu altogether and return to the EXEC command prompt.
You can create submenus that are opened by selecting entries in another menu. Use the menu EXEC command as the command for the submenu item.
Note
If you nest too many levels of menus, the system prints an error message on the terminal and returns to the previous menu level.
When a menu allows connections (their normal use), the command for an entry activating the connection should contain a resume command, or the line should be configured to prevent users from escaping their sessions with the escape-char none command. Otherwise, when they escape from a connection and return to the menu, there will be no way to resume the session and it will sit idle until the user logs out.
Specifying the resume command as the action that is performed for a selected menu entry permits a user to resume a named connection or connect using the specified name, if there is no active connection by that name. As an option, you can also supply the connect string needed to connect initially. When you do not supply this connect string, the command uses the specified connection name.
You can also use the resume/next command, which resumes the next connection in the user's list of connections. This function allows you to create a single menu entry that steps through all of the user's connections.
Note
A menu should not contain any exit paths that leave users in an unfamiliar interface environment.
When a particular line should always display a menu, that line can be configured with an autocommand line configuration command. Menus can be run on a per-user basis by defining a similar autocommand command for that local username. For more information about the autocommand command, refer to the Cisco IOS Dial Technologies Configuration Guide.
Examples
In the following example, the commands to be issued when the menu user selects option 1, 2, or 3 are specified for the menu named Access1:
menu Access1 command 1 tn3270 vms.cisco.com
menu Access1 command 2 rlogin unix.cisco.com
menu Access1 command 3 menu-exit
The following example allows a menu user to exit a menu by entering Exit at the menu prompt:
menu Access1 text Exit Exit
menu Access1 command Exit menu-exit
Related Commands
Command
|
Description
|
autocommand
|
Configures the Cisco IOS software to automatically execute a command when a user connects to a particular line.
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu default
To specify the menu item to use as the default, use the menu default command in global configuration mode.
menu menu-name default menu-item
Syntax Description
menu-name
|
Name of the menu. You can specify a maximum of 20 characters.
|
menu-item
|
Number, character, or string key of the item to use as the default.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to specify which menu entry is used when the user presses Enter without specifying an item. The menu entries are defined by the menu command and menu text global configuration commands.
Examples
In the following example, the menu user exits the menu when pressing Enter without selecting an item:
menu Access1 9 text Exit the menu
menu Access1 9 command menu-exit
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a preconfigured user menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu line-mode
To require the user to press Enter after specifying an item, use the menu line-mode command in global configuration mode.
menu menu-name line-mode
Syntax Description
menu-name
|
Name of the menu this command should be applied to.
|
Defaults
Enabled for menus with more than nine items. Disabled for menus with nine or fewer items.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
In a menu of nine or fewer items, you ordinarily select a menu item by entering the item number. In line mode, you select a menu entry by entering the item number and pressing Enter. Line mode allows you to backspace over the selected number and enter another number before pressing Enter to issue the command.
This option is activated automatically when more than nine menu items are defined but also can be configured explicitly for menus of nine or fewer items.
In order to use strings as keys for items, the menu line-mode command must be configured.
Examples
In the following example, the line-mode option is enabled for the menu named Access1:
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a preconfigured user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for a user menu.
|
menu default
|
Specifies the menu item to use as the default.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu options
To set options for items in user menus, use the menu options command in global configuration mode.
menu menu-name options menu-item {login | pause}
Syntax Description
menu-name
|
The name of the menu. You can specify a maximum of 20 characters.
|
menu-item
|
Number, character, or string key of the item affected by the option.
|
login
|
Requires a login before issuing the command.
|
pause
|
Pauses after the command is entered before redrawing the menu.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use the menu command and menu text global configuration commands to define a menu entry.
Examples
In the following example, a login is required before issuing the command specified by menu entry 3 of the menu named Access1:
menu Access1 options 3 login
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu prompt
To specify the prompt for a user menu, use the menu prompt command in global configuration mode.
menu menu-name prompt d prompt d
Syntax Description
menu-name
|
Name of the menu. You can specify a maximum of 20 characters.
|
d
|
A delimiting character that marks the beginning and end of a title. Text delimiters are characters that do not ordinarily appear within the text of a title, such as slash ( / ), double quote ("), and tilde (~). ^C is reserved for special use and should not be used in the text of the title.
|
prompt
|
Prompt string for the menu.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Press Enter after entering the first delimiter. The router will prompt you for the text of the prompt. Enter the text followed by the delimiter, and press Enter.
Use the menu command and menu text commands to define the menu selections.
Examples
In the following example, the prompt for the menu named Access1 is configured as "Select an item.":
Router(config)# menu Access1 prompt /
Enter TEXT message. End with the character '/'.
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu status-line
To display a line of status information about the current user at the top of a menu, use the menu <menu-name> status-line command in global configuration mode.
menu menu-name status-line
Syntax Description
menu-name
|
Name of the menu this command should be applied to.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command displays the status information at the top of the screen before the menu title is displayed. This status line includes the router's host name, the user's line number, and the current terminal type and keymap type (if any).
Examples
In the following example, status information is enabled for the menu named Access1:
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item in a menu.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu text
To specify the text of a menu item in a user menu, use the menu text command in global configuration mode.
menu menu-name text menu-item menu-text
Syntax Description
menu-name
|
Name of the menu. You can specify a maximum of 20 characters.
|
menu-item
|
Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu items. When the tenth item is added to the menu, the menu line-mode and menu single-space commands are activated automatically.
|
menu-text
|
Text of the menu item.
|
Defaults
No text appears for the menu item.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to assign text to items in a menu. Use the menu command command to assign actions to items. These commands must use the same menu name and menu selection key.
You can specify a maximum of 18 items in a menu.
Examples
In the following example, the descriptive text for the three entries is specified for options 1, 2, and 3 in the menu named Access1:
menu Access1 text 1 IBM Information Systems
menu Access1 text 2 UNIX Internet Access
menu Access1 text 3 Exit menu system
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
menu title
To create a title (banner) for a user menu, use the menu title command in global configuration mode.
menu menu-name title d menu-title d
Syntax Description
menu-name
|
Name of the menu. You can specify a maximum of 20 characters.
|
d
|
A delimiting character that marks the beginning and end of a title. Text delimiters are characters that do not ordinarily appear within the text of a title, such as slash ( / ), double quote ("), and tilde (~). ^C is reserved for special use and should not be used in the text of the title.
|
menu-title
|
Lines of text to appear at the top of the menu.
|
Defaults
The menu does not have a title.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The menu title command must use the same menu name used with the menu text and menu command commands used to create a menu.
You can position the title of the menu horizontally by preceding the title text with blank characters. You can also add lines of space above and below the title by pressing Enter.
Follow the title keyword with one or more blank characters and a delimiting character of your choice. Then enter one or more lines of text, ending the title with the same delimiting character. You cannot use the delimiting character within the text of the message.
When you are configuring from a terminal and are attempting to include special control characters, such as a screen-clearing string, you must use Ctrl-V before the special control characters so that they are accepted as part of the title string. The string ^[[H^[[J is an escape string used by many VT100-compatible terminals to clear the screen. To use a special string, you must enter Ctrl-V before each escape character.
You also can use the menu clear-screen global configuration command to clear the screen before displaying menus and submenus, instead of embedding a terminal-specific string in the menu title. The menu clear-screen command allows the same menu to be used on different types of terminals.
Examples
In the following example, the title that will be displayed is specified when the menu named Access1 is invoked. Press Enter after the second slash (/) to display the prompt.
Router(config)# menu Access1 title /^[[H^[[J
Enter TEXT message. End with the character '/'.
Welcome to Access1 Internet Services
Type a number to select an option;
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an item.
|
menu options
|
Sets options for items in user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
microcode (12000)
To load a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000 series Gigabit Switch Router (GSR), use the microcode command in global configuration mode. To load the microcode bundled with the GRP system image, use the no form of this command.
microcode {oc12-atm | oc12-pos | oc3-pos4} {flash file-id [slot] | system [slot]}
no microcode {oc12-atm | oc12-pos | oc3-pos4} [flash file-id [slot] | system [slot]]
Syntax Description
oc12-atm | oc12-pos | oc3-pos4
|
Interface name.
|
flash
|
Loads the image from the Flash file system.
|
file-id
|
Specifies the device and filename of the image file to download from Flash memory. A colon (:) must separate the device and filename (for example, slot0:gsr-p-mz). Valid devices include:
• bootflash:—Internal Flash memory.
• slot0:—First PCMCIA slot.
• slot1:—Second PCMCIA slot.
|
slot
|
(Optional) Slot number of the line card that you want to copy the software image to. Slot numbers range from 0 to 11 for the Cisco 12012 router and 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is downloaded on all line cards.
|
system
|
Loads the image from the software image on the GRP card.
|
Defaults
The default is to load the image from the GRP card (system).
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2 GS
|
This command was introduced for Cisco 12000 series GSRs.
|
Usage Guidelines
In addition to the Cisco IOS image that resides on the GRP card, each line card on a Cisco 12000 series has a Cisco IOS image. When the router is reloaded, the specified image is loaded onto the GRP card and then automatically downloaded to all the line cards.
Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a Cisco IOS image that is different from the one on the line card. Additionally, you might need to load a new image on the line card to work around a problem that is affecting only one of the line cards.
To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to download the image to the line card, followed by the microcode reload command to start the image. Immediately after you enter the microcode reload command and press Return, the system reloads all microcode. Global configuration mode remains enabled. After the reloading is complete, enter the exit command to return to the EXEC system prompt.
To verify that the correct image is running on the line card, use the execute-on slot slot show version command.
For additional information on GSR configuration, refer to the documentation specific to your Cisco IOS software release.
Examples
In the following example, the Cisco IOS software image in slot 0 is downloaded to the line card in slot 10. This software image is used when the system is booted, a line card is inserted or removed, or the microcode reload global configuration command is issued.
Router(config)# microcode oc3-POS-4 flash slot0:fip.v141-7 10
Router(config)# microcode reload 10
In this example, the user would issue the execute-on slot 10 show version command to verify that the correct version is loaded.
Related Commands
Command
|
Description
|
microcode reload (12000)
|
Reloads microcode on Cisco 12000 series GSRs.
|
microcode (7000/7500)
To specify the location of the microcode that you want to download from Flash memory into the writable control store (WCS) on Cisco 7000 series (including RSP based routers) or Cisco 7500 series routers, use the microcode command in global configuration mode. To load the microcode bundled with the system image, use the no form of this command.
microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]]}
no microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]}
Syntax Description
interface-type
|
One of the following interface processor names: aip, cip, eip, feip, fip, fsip, hip, mip, sip, sp, ssp, trip, vip, or vip2.
|
flash-filesystem:
|
Flash file system, followed by a colon. Valid file systems are bootflash, slot0, and slot1.
Slave devices such as slaveslot0 are invalid. The slave's file system is not available during microcode reloads.
|
filename
|
Name of the microcode file.
|
slot
|
(Optional) Number of the slot. Range is from 0 to 15.
|
rom
|
If ROM is specified, the router loads from the onboard ROM microcode.
|
system
|
If the system keyword is specified, the router loads the microcode from the microcode bundled into the system image you are running for that interface type.
|
Defaults
The default is to load from the microcode bundled in the system image.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.3
|
This command was introduced.
|
Usage Guidelines
If you do not use the microcode reload command after using the microcode command, the microcode reload command will be written to the configuration file automatically.
When using Dual RSPs for simple hardware backup, ensure that the master and slave RSP card contain the same microcode image in the same location when the router is to load the interface processor microcode from a Flash file system. Thus, if the slave RSP becomes the master, it will be able to find the microcode image and download it to the interface processor.
Examples
In the following example, all FIP cards will be loaded with the microcode found in Flash memory file fip.v141-7 when the system is booted, when a card is inserted or removed, or when the microcode reload global configuration command is issued. The configuration is then written to the startup configuration file.
Router(config)# microcode fip slot0:fip.v141-7
Router# copy system:running-config nvram:startup-config
Related Commands
Command
|
Description
|
more flh:logfile
|
Displays the system console output generated during the Flash load helper operation.
|
microcode (7200)
To configure a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router, use the microcode command in global configuration mode. To revert to the default microcode for the current running version of the Cisco IOS software, use the no form of this command.
microcode {ecpa | pcpa} location
no microcode {ecpa | pcpa}
Syntax Description
ecpa
|
ESCON Channel Port Adapter (CPA) interface.
|
pcpa
|
Parallel CPA interface.
|
location
|
Location of microcode, including the device and filename.
|
Defaults
If the default or no form of the command is specified, the driver uses the default microcode for the current running version of the Cisco IOS software.
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.3(3)T
|
This command was introduced.
|
Usage Guidelines
If there are any default overrides when the configuration is written, then the microcode reload command will be written to the configuration automatically. This action enables the configured microcode to be downloaded at system startup.
The CPA microcode image is preloaded on Flash memory cards for Cisco 7200-series routers for Cisco IOS Release 11.3(3)T and later releases. You may be required to copy a new image to Flash memory when a new microcode image becomes available.
For more information on the CPA configuration and maintenance, refer to the "Configuring Cisco Mainframe Channel Connection Adapters" chapter in the Release 12.2 Cisco IOS Bridging and IBM Networking Configuration Guide.
Examples
The following example instructs the Cisco IOS software to load the microcode from an individual microcode image that is stored as a file on the Flash card inserted in Flash card slot 0:
microcode ecpa slot0:xcpa26-1
Related Commands
Command
|
Description
|
microcode reload (7200)
|
Resets and reloads the specified hardware in a Cisco 7200 series router.
|
show microcode
|
Displays microcode information.
|
microcode reload (12000)
To reload the Cisco IOS image from a line card on Cisco 12000 series routers, use the microcode reload command in global configuration mode.
microcode reload [slot-number]
Syntax Description
slot-number
|
(Optional) Slot number of the line card that you want to reload the Cisco IOS software image on. Slot numbers range from 0 to 11 for the Cisco 12012 and from 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is reloaded on all line cards.
|
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2 GS
|
This command was introduced for Cisco 12000 series GSRs.
|
Usage Guidelines
In addition to the Cisco IOS image that resides on the GRP card, each line card on Cisco 12000 series routers has a Cisco IOS image. When the router is reloaded, the specified Cisco IOS image is loaded onto the GRP card and automatically downloaded to all the line cards.
Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a different Cisco IOS image. Additionally, you might need to load a new image on the line card to work around a problem affecting only one of the line cards.
To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to download the image to the line card, followed by the microcode reload command to start the image. To verify that the correct image is running on the line card, use the execute-on slot slot show version command.
For additional information on GSR configuration, refer to the "Observing System Startup and Performing a Basic Configuration" chapter in the Cisco 12000 series installation and configuration guides.
The microcode reload (12000) command allows you to issue another command immediately.
Note
Issuing a microcode reload command on any of the line cards in a Cisco 12000 GSR immediately returns the console command prompt. This allows you to issue a subsequent command immediately to the reloading line card. However, any commands entered at this time will not execute, and often no indication will be given that such a command failed to run. Verify that the microcode has reloaded before issuing new commands.
Examples
In the following example, the microcode firmware is reloaded on the line card in slot 10:
Router(config)# microcode reload 10
Related Commands
Command
|
Description
|
microcode (12000)
|
Loads a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000 series GSR.
|
microcode reload (7000/7500)
To reload the processor card on the Cisco 7000 series with RSP7000 or Cisco 7500 series routers, use the microcode reload command in global configuration mode.
microcode reload [slot-number]
Syntax Description
slot-number
|
(Optional) Reloads the specified processor card slot on a Cisco 7500 series router.
|
Defaults
No default behaviors or values.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.3
|
This command was introduced for Cisco 7500 series routers.
|
12.3(8)T
|
The slot-number argument was added for Cisco 7500 series routers.
|
Usage Guidelines
This command reloads the microcode without rebooting the router. Immediately after you enter the microcode reload command, the system reloads all microcode. Global configuration mode remains enabled.
Note
If you modify the system configuration to load a microcode image, the microcode reload command will be written to the configuration file automatically following the use of a microcode command. This action enables the configured microcode to be downloaded at system startup.
Examples
In the following example, all controllers are reset, and the microcode specified in the current configuration is loaded:
Router(config)# microcode reload
Related Commands
Command
|
Description
|
microcode (7000/7500)
|
Specifies the location from where microcode should be loaded when the microcode reload command is processed on RSP-based routers.
|
microcode reload (7200)
To reload the Cisco IOS microcode image on an ESCON CPA card in the Cisco 7200 series router, use the microcode reload command in privileged EXEC mode.
microcode reload {all | ecpa [slot slot-number] | pcpa [slot slot-number]}
Syntax Description
all
|
Resets and reloads all hardware types that support downloadable microcode.
|
ecpa
|
Resets and reloads only those slots that contain hardware type ecpa.
|
pcpa
|
Resets and reloads only those slots that contain hardware type pcpa.
|
slot slot-number
|
(Optional) Resets and reloads only the slot specified, and only if it contains the hardware specified.
|
Command Modes
Privileged EXEC
Command History
Release
|
Modification
|
11.3(3)T
|
This command was introduced.
|
Usage Guidelines
Hardware types that do not support downloadable microcode are unaffected by the microcode reload all command.
You will be prompted for confirmation before the microcode reload command is executed.
Examples
The following example reloads the ESCON CPA microcode in slot 5 with the currently configured microcode:
Router# microcode reload ecpa slot 5
Related Commands
Command
|
Description
|
microcode (7200)
|
Configures a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router.
|
show microcode
|
Displays the microcode bundled into a Cisco 7000 series with RSP7000, Cisco 7200 series, or Cisco 7500 series router.
|
minor rising
To set minor level threshold values for the buffer, CPU, and memory ROs, use the minor rising command in buffer owner configuration mode, CPU owner configuration mode, or memory owner configuration mode. To disable this function, use the no form of this command.
minor rising rising-threshold-value [interval interval-value] [falling falling-threshold-value
[interval interval-value]] [global]
no minor rising
Syntax Description
rising-threshold-value
|
Specifies the rising threshold value as a percentage.
Valid values are from 1 to 100.
|
falling falling-threshold-value
|
(Optional) Specifies the falling threshold value as a percentage.
Valid values are from 1 to 100.
|
interval interval-value
|
(Optional) Specifies the time in seconds during which the variation in rising or falling threshold values are not notified to the RU, resource group, or resource user types. For example, if the buffer usage count has gone above the configured threshold value, and if it remains more for the configured interval, then a notification will be sent to the RU, resource group, or resource user types.
Valid values are from 5 to 86400 seconds. The default value is 5 seconds.
|
global
|
(Optional) Configures a global threshold.
The global keyword is optional while setting major threshold values for public buffer, processor CPU, I/O memory, and processor memory.
The global keyword is mandatory while setting major threshold values for interrupt CPU and total CPU.
|
Command Default
Disabled by default.
Command Modes
Buffer owner configuration mode
CPU owner configuration mode
Memory owner configuration mode
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
The interval is the dampening or observation interval time in seconds during which the variations in the rising and falling threshold values are not notified to the ROs or RUs. That is, the interval is the time the system waits to check whether the threshold value stabilizes or not. The interval is set to avoid unnecessary and unwanted threshold notifications. If an interval is not specified, the system takes a default value of 5 seconds.
This command allows you to configure three types of thresholding:
•
System Global Thresholding
•
User Local Thresholding
•
Per User Global Thresholding
System Global Thresholding
System global thresholding is used when the entire resource reaches a specified value. That is, RUs are notified when the total resource utilization goes above or below a specified threshold value. The notification order is determined by the priority of the RU. The RUs with a lower priority will be notified first, so that these low-priority RUs are expected to reduce the resource utilization. This order prevents the high-priority RUs from getting affected with unwanted notifications.
You can set rising and falling threshold values. For example, if you have set a total CPU utilization threshold value of 60% as the rising minor value and 5% as falling minor value, then when the total CPU utilization crosses the 60% mark, a minor Up notification is sent to all the RUs and when the total CPU utilization falls below 5%, a minor Down notification is sent to all the RUs.
Similarly, if you have set a total buffer usage count threshold value of 60% as the rising minor value and 5% as falling minor value, then when the total buffer usage count crosses the 60% mark, a minor Up notification is sent to all the RUs and when the total buffer usage count falls below 5%, a minor Down notification is sent to all the RUs.
In the same way, if you have set a total I/O memory usage threshold value of 60% as the rising minor value and 5% as falling minor value, then when the total memory usage crosses the 60% mark, a minor Up notification is sent to all the RUs and when the total memory usage falls below 5%, a minor Down notification is sent to all the RUs.
User Local Thresholding
User local thresholding is used when a specified RU exceeds the configured limits. The user local thresholding method prevents a single RU from monopolizing the resources. That is, the specified RU is notified when the resource utilization of the specified RU goes above or below a configured threshold value. For example, if you have set a CPU utilization threshold value of 60% as the rising minor value and 5% as falling minor value, then when the CPU utilization of the specified RU crosses the 60% mark, a minor Up notification is sent to that RU only and when the CPU utilization of the specified RU falls below 5%, a minor Down notification is sent to that RU only. The same method applies to buffer and memory ROs also.
Per User Global Thresholding
Per user global thresholding is used when the entire resource reaches a specified value. This value is unique for each RU and notification is sent only to the specified RU. User global thresholding is similar to user local thresholding, except that the global resource usage is compared against the thresholds. That is, only the specified RU is notified when the total resource utilization goes above or below a configured threshold value. For example, if you have set a CPU utilization threshold value of 60% as the rising minor value and 5% as falling minor value, then when the total CPU utilization crosses the 60% mark, a minor Up notification is sent to the specified RU only and when the total CPU utilization falls below 5%, a minor Down notification is sent to the specified RU only. The same method applies to buffer and memory ROs also.
Threshold Violations
The Cisco IOS device sends out error messages whenever a threshold is violated. The following examples help you understand the error message pattern when different threshold violations occur in buffer, CPU, and memory ROs:
System Global Threshold Violation in Buffer RO
The threshold violation in buffer RO for a system global threshold shows the following output:
System global threshold-Violation (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:15:11: %SYS-4-GLOBALBUFEXCEED: Buffer usage has gone above global buffer Critical
threshold
configured <value> Current usage :<value>
For example:
00:15:11: %SYS-4-GLOBALBUFEXCEED: Buffer usage has gone above global buffer Critical
threshold
configured 144 Current usage :145
System global threshold- Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:17:10: %SYS-5-GLOBALBUFRECOVER: Buffer usage has gone below global buffer Critical
threshold
configured <value> Current usage :<value>
For example:
00:17:10: %SYS-5-GLOBALBUFRECOVER: Buffer usage has gone below global buffer Critical
threshold
configured 90 Current usage :89
Per User Global Threshold Violation in Buffer RO
The threshold violation in buffer RO for a user global threshold shows the following output:
User global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:24:04: %SYS-4-RESGLOBALBUFEXCEED: Buffer usage has gone above buffer Critical threshold
configured by resource user <user-name>
configured 144 Current usage :145
User global threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
==========================================================================================
00:25:08: %SYS-4-RESGLOBALBUFRECOVER: Buffer usage has gone below buffer Critical
threshold configured by resource user <user-name>
configured 126 Current usage :125
User Local Threshold Violation in Buffer RO
The threshold violation in buffer RO for a user local threshold shows the following output:
User local threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:31:15: %SYS-4-RESBUFEXCEED: Resource user user_1 has exceeded the buffer Critical
threshold. configured 108 Current usage :109
User local threshold- Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:31:05: %SYS-5-RESBUFRECOVER: Resource user user_1 has recovered after exceeding the
buffer Critical threshold. configured 90 Current usage :89
System Global Threshold Violation in CPU RO
The threshold violation in CPU RO for a system global threshold shows the following output:
System global threshold- Violation
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly
==========================================================================================
00:19:36: %SYS-4-CPURESRISING: System is seeing global cpu util 19% at total level more
than the configured minor limit 11%
System global threshold - Recovery
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly
==========================================================================================
00:20:56: %SYS-6-CPURESFALLING: System is no longer seeing global high cpu at total level
for the configured minor limit 10%, current value 4%
Per User Global Threshold Violation in CPU RO
The threshold violation in CPU RO for a user global threshold shows the following output:
User global threshold - Violation
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly
==========================================================================================
00:14:21: %SYS-4-CPURESRISING: Resource user <user-name> is seeing global cpu util 11% at
total level more than the configured minor limit 6 %
For example:
00:14:21: %SYS-4-CPURESRISING: Resource user Test-proc-14:99s:1w:100n is seeing global cpu
util 11% at total level more than the configured minor limit 6%
User global threshold- Recovery
(1) keywords Critical, Major and Minor will vary accordingly
(2) keywords total, process and interrupt will vary accordingly
==========================================================================================
00:14:46: %SYS-6-CPURESFALLING: Resource user <user-name> is no longer seeing global high
cpu at total level for the configured critical limit 9%, current value 4%
For example:
00:14:46: %SYS-6-CPURESFALLING: Resource user Test-proc-14:99s:1w:100n is no longer seeing
global high cpu at total level for the configured critical limit 9%, current value 4%
User Local Threshold Violation in CPU RO
The threshold violation in CPU RO for a user local threshold shows the following output:
User local threshold - Violation (keywords Critical, Major and Minor will vary accordingly
- only process level)
==========================================================================================
00:12:11: %SYS-4-CPURESRISING: Resource user <user-name> is seeing local cpu util 15% at
process level more than the configured minor limit 6%
For example:
00:12:11: %SYS-4-CPURESRISING: Resource user Test-proc-9:85s:15w:100n is seeing local cpu
util 15% at process level more than the configured minor limit 6%
User local threshold- Recovery (keywords Critical, Major and Minor will vary accordingly
- only process level)
==========================================================================================
00:13:11: %SYS-6-CPURESFALLING: Resource user <user-name> is no longer seeing local high
cpu at process level for the configured critical limit 9%, current value 3%
System Global Threshold Violation in Memory RO
The threshold violation in memory RO for a system global threshold shows the following output:
System global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
(If violation happens in IO memory pool will be : I/O)
==========================================================================================
13:53:22: %SYS-5-GLOBALMEMEXCEED: Global Memory has exceeded the Minor threshold
Pool: Processor Used: 422703520 Threshold: 373885200
For example:
13:54:03: %SYS-5-GLOBALMEMEXCEED: Global Memory has exceeded the Critical threshold
Pool: Processor Used: 622701556 Threshold: 467356500
System global threshold - Recovery ( keywords Critical, Major and Minor alone will vary
accordingly )
(If recovery happens in IO memory pool will be : I/O)
==========================================================================================
%SYS-5-GLOBALMEMRECOVER: Global Memory has recovered after exceeding Minor threshold
Pool: Processor Used: 222473448 Threshold: 355190940
For example:
13:50:41: %SYS-5-GLOBALMEMRECOVER: Global Memory has recovered after exceeding Critical
threshold
Pool: Processor Used: 222473152 Threshold: 443988675
Per User Global Threshold Violation in Memory RO
The threshold violation in memory RO for a user global threshold shows the following output:
User global threshold - Violation (keywords Critical, Major and Minor alone will vary
accordingly)
(If violation happens in IO memory pool will be : I/O)
==========================================================================================
00:53:14: %SYS-4-RESGLOBALMEMEXCEED: Global Memory has exceeded the Minor threshold
configure by resource user <XYZ>
Pool: Processor Used: 62273916 Threshold: 62246820
User global threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
(If recovery happens in IO memory pool will be : I/O)
==========================================================================================
00:32:56: %SYS-4-RESGLOBALMEMRECOVER: Global Memory has recovered after exceeding the
Critical threshold configure by resource user <XYZ>
Pool: Processor Used: 329999508 Threshold: 375865440
User Local Threshold Violation in Memory RO
The threshold violation in memory RO for a user local threshold shows the following output:
User local threshold- Violation (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
01:05:42: %SYS-4-RESMEMEXCEED: Resource user <XYZ> has exceeded the Critical memory
threshold
Pool: Processor Used: 103754740 Threshold: 103744700
User local threshold - Recovery (keywords Critical, Major and Minor alone will vary
accordingly)
=========================================================================================
00:44:43: %SYS-5-RESMEMRECOVER: Resource user <XYZ> has recovered after exceeding the
Critical memory threshold
Pool: Processor Used: 328892280 Threshold :375865440
Examples
Configuring Minor Rising Values for System Global Thresholding
The following example shows how to configure the minor threshold values for the system global thresholding with minor rising threshold of 60% at an interval of 12 seconds and minor falling threshold of 5% at an interval of 10 seconds:
Router(config-owner-cpu)# minor rising 60 interval 12 falling 5 interval 10 global
Router(config-owner-buffer)# minor rising 60 interval 12 falling 5 interval 10 global
Router(config-owner-memory)# minor rising 60 interval 12 falling 5 interval 10 global
Configuring Minor Rising Values for User Local Thresholding
The following example shows how to configure the minor threshold values for user local thresholding with minor rising threshold of 60% at an interval of 12 seconds and minor falling threshold of 5% at an interval of 10 seconds:
Router(config-owner-cpu)# minor rising 60 interval 12 falling 5 interval 10
Router(config-owner-buffer)# minor rising 60 interval 12 falling 5 interval 10
Router(config-owner-memory)# minor rising 60 interval 12 falling 5 interval 10
Configuring Minor Rising Values for Per User Global Thresholding
The following example shows how to configure the minor threshold values for per user global thresholding with minor rising threshold of 60% at an interval of 12 seconds and minor falling threshold of 5% at an interval of 10 seconds:
Router(config-owner-cpu)# minor rising 60 interval 12 falling 5 interval 10 global
Router(config-owner-buffer)# minor rising 60 interval 12 falling 5 interval 10 global
Router(config-owner-memory)# minor rising 60 interval 12 falling 5 interval 10 global
Related Commands
Command
|
Description
|
buffer public
|
Enters the buffer owner configuration mode and sets threshold values for buffer usage.
|
cpu interrupt
|
Enters the CPU owner configuration mode and sets threshold values for interrupt level CPU utilization.
|
cpu process
|
Enters the CPU owner configuration mode and sets threshold values for processor level CPU utilization.
|
cpu total
|
Enters the CPU owner configuration mode and sets threshold values for total CPU utilization.
|
memory io
|
Enters the memory owner configuration mode and sets threshold values for I/O memory.
|
memory processor
|
Enters the memory owner configuration mode and sets threshold values for processor memory.
|
policy (ERM)
|
Configures an ERM resource policy.
|
resource policy
|
Enters ERM configuration mode.
|
show resource all
|
Displays all the resource details.
|
slot (ERM policy)
|
Configures line cards.
|
system (ERM policy)
|
Configures system level ROs.
|
mkdir
To create a new directory in a Class C Flash file system, use the mkdir command in EXEC mode.
mkdir directory
Syntax Description
directory
|
The name of the directory to create.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
This command was introduced.
|
Usage Guidelines
This command is only valid on Class C Flash file systems.
If you do not specify the directory name in the command line, the router prompts you for it.
Examples
The following example creates a directory named newdir:
Mkdir file name [newdir]?
2 drwx 0 Mar 13 1993 13:16:21 newdir
8128000 bytes total (8126976 bytes free)
Related Commands
Command
|
Description
|
dir
|
Displays a list of files on a file system.
|
rmdir
|
Removes an existing directory in a Class C Flash file system.
|
monitor event-trace (EXEC)
To control the event trace function for a specified Cisco IOS software subsystem component, use the monitor event-trace (EXEC) command in privileged EXEC mode.
monitor event-trace component {clear | disable | dump [pretty] | enable | one-shot}
Syntax Description
component
|
Name of the Cisco IOS software subsystem component that is the subject of the event trace. To get a list of components that support event tracing in this release, use the monitor event-trace ? command.
|
clear
|
Clears existing trace messages for the specified component from memory on the networking device.
|
disable
|
Turns off event tracing for the specified component.
|
dump
|
Writes the event trace results to the file configured using the monitor event-trace (global) command. The trace messages are saved in binary format.
|
pretty
|
(Optional) Saves the event trace message in ASCII format.
|
enable
|
Turns on event tracing for the specified component.
|
one-shot
|
Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the monitor event-trace (global) command.
|
Command Modes
Privileged EXEC
Command History
Release
|
Modification
|
12.0(18)S
|
This command was introduced.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T.
|
Usage Guidelines
Use the monitor event-trace (EXEC) command to control what, when, and how event trace data is collected. Use this command after you have configured the event trace functionality on the networking device using the monitor event-trace (global) command.
Note
The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace (global) command for each instance of a trace.
The Cisco IOS software allows for the subsystem components to define whether support for event tracing is enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the monitor event-trace (EXEC) command in privileged EXEC mode or using the monitor event-trace (global) command in global configuration mode. To enable event tracing again, you would enter the enable form of either of these commands.
To determine whether a subsystem has enabled or disabled event tracing, use the monitor event-trace ? command to get a list of software components that support event tracing. To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to view trace messages.
Use the show monitor event-trace command to display trace messages.
Use the monitor event-trace component dump command to save trace message information for a single event. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace component dump pretty command.
To write the trace messages for all events currently enabled on a networking device to a file, enter the monitor event-trace dump-traces command.
To configure the file where you want to save trace information, use the monitor event-trace (global) command.
Examples
The following example shows the privileged EXEC commands to stop event tracing, clear the current contents of memory, and re-enable the trace function for the IPC component. This example assumes that the tracing function is configured and enabled on the networking device.
Router# monitor event-trace ipc disable
Router# monitor event-trace ipc clear
Router# monitor event-trace ipc enable
The following example shows how the monitor event-trace one-shot command accomplishes the same function as the previous example except in one command. In this example, once the size of the trace message file has been exceeded, the trace is terminated.
Router# monitor event-trace ipc one-shot
The following example shows the command for writing trace messages for an event in binary format. In this example, the trace messages for the IPC component are written to a file.
Router# monitor event-trace ipc dump
The following example shows the command for writing trace messages for an event in ASCII format. In this example, the trace messages for the MBUS component are written to a file.
Router# monitor event-trace mbus dump pretty
Related Commands
Command
|
Description
|
monitor event-trace (global)
|
Configures event tracing for a specified Cisco IOS software subsystem component.
|
monitor event-trace dump-traces
|
Saves trace messages for all event traces currently enabled on the networking device.
|
show monitor event-trace
|
Displays event trace messages for Cisco IOS software subsystem components.
|
monitor event-trace (global)
To configure event tracing for a specified Cisco IOS software subsystem component, use the monitor event-trace (global) command in global configuration mode. To change the default setting to enable or disable event tracing, refer to the "Usage Guidelines" section for this command.
monitor event-trace component {disable | dump-file filename | enable | size number}
Syntax Description
component
|
Name of the Cisco IOS software subsystem component that is the object of the event trace. To get a list of components that support event tracing in this release, use the monitor event-trace ? command.
|
disable
|
Turns off event tracing for the specified component.
|
dump-file
|
Specifies the file where event trace messages are written from memory on the networking device.
|
filename
|
Name of the file for writing trace messages. The maximum length of the filename (path and filename) is 100 characters and path can point to flash memory on the networking device or to a TFTP or FTP server.
|
enable
|
Turns on event tracing for the specified component provided that the component has been configured using the monitor event-trace (global) command.
|
size
|
Sets the number of messages that can be written to memory for a single instance of a trace.
Note Some Cisco IOS software subsystem components set the size by default. To view the size parameter, use the show monitor event-trace component parameters command.
When the number of event trace messages in memory exceeds the size, new messages will begin to overwrite the older messages in the file.
|
number
|
Number of messages for each instance of a trace. Specify a number in the range 1 to 65536.
|
Defaults
Enabled or disabled depending on the software component.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(18)S
|
This command was introduced.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T.
|
Usage Guidelines
Use the monitor event-trace (global) command to enable or disable event tracing and to configure event trace parameters for Cisco IOS software subsystem components.
Note
Event tracing is intended for use as a software diagnostic tool and should be configured only under the direction of a TAC representative. In Cisco IOS software images that do not provide subsystem support for the event trace function, the monitor event-trace (global) command is not available.
The Cisco IOS software allows the subsystem components to define whether support for event tracing is enabled or disabled by default. The command interface for event tracing allows users to change the default two ways: using the monitor event-trace (EXEC) command in privileged EXEC mode or using the monitor event-trace (global) command in global configuration mode.
Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the monitor event-trace component enable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a line in the configuration file.
Note
The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace (global) command for each instance of a trace.
To determine whether a subsystem has enabled or disabled event tracing, use the monitor event-trace ? command to get a list of software components that support event tracing.
To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to view trace messages.
Examples
The following example shows how to enable event tracing for the IPC subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to ipc-dump in slot0 (flash memory).
monitor event-trace ipc enable
monitor event-trace ipc dump-file slot0:ipc-dump
monitor event-trace ipc size 4096
Related Commands
Command
|
Description
|
monitor event-trace (EXEC)
|
Controls event trace function for a specified Cisco IOS software subsystem component.
|
monitor event-trace dump-traces
|
Saves trace messages for all event traces currently enabled on the networking device.
|
show monitor event-trace
|
Displays event trace messages for Cisco IOS software subsystem components.
|
monitor event-trace cpu-report (EXEC)
To monitor the event tracing of the CPU reports, use the monitor event-trace cpu-report command in user EXEC or privileged EXEC mode.
monitor event-trace cpu-report {clear | continuous [cancel] | disable | dump [pretty] | enable |
one-shot}
Syntax Description
clear
|
Clears the event tracing.
|
continuous
|
Displays continuously the latest event trace entries.
|
cancel
|
(Optional) Cancels the continuous display of the latest event trace entries.
|
disable
|
Disables event tracing.
|
dump
|
Dumps the event buffer into a file.
|
pretty
|
(Optional) Dumps the event buffer into a file in ASCII format.
|
enable
|
Enables the event tracing.
|
one-shot
|
Indicates that first clears the event trace, sets running, and then disables at wrap point.
|
Command Default
Disabled
Command Modes
User EXEC
Privileged EXEC
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Examples
The following example shows how to enable event tracing of the CPU reports:
Router# monitor event-trace cpu-report enable
The following example shows how to enable continuous event tracing of the CPU reports:
Router# monitor event-trace cpu-report continuous
The following example shows how to dump the event tracing information into a file in ASCII format:
Router# monitor event-trace cpu-report dump pretty
The following example shows how to clear the event tracing information:
Router# monitor event-trace cpu-report clear
Related Commands
Command
|
Description
|
show monitor event-trace cpu-report
|
Displays the CPU report details for event tracing on a networking device.
|
monitor event-trace cpu-report (global)
To monitor the collection of CPU report traces, use the monitor event-trace cpu-report command in global configuration mode.
monitor event-trace cpu-report {disable | dump-file location | enable | size | stacktrace}
Syntax Description
disable
|
Disables event tracing.
|
dump-file location
|
Dumps the event buffer into a file. The location argument specifies the URL at which the file is stored.
|
enable
|
Enables the event tracing.
|
size
|
Sets the size of event trace. Valid values are from 1 to 1000000.
|
stacktrace
|
Clears the trace buffer first and then traces the call stack at tracepoints. Valid values for the depth of stack traces stored are from 1 to 16.
|
Command Default
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Examples
The following example shows how to enable event tracing of the CPU reports:
Router(config)# monitor event-trace cpu-report enable
The following example shows how to dump the event tracing information into a file at \\http:\\www.cisco.com location:
Router# monitor event-trace cpu-report dump-file http:\\www.cisco.com
The following example shows how to disable the event tracing information:
Router# monitor event-trace cpu-report disable
The following example shows how to first clear the event tracing and then trace the call stacks at the tracepoints 4:
Router# monitor event-trace cpu-report stacktrace 4
Related Commands
Command
|
Description
|
show monitor event-trace cpu-report
|
Displays the CPU report details for event tracing on a networking device.
|
monitor event-trace dump-traces
To save trace messages for all event traces currently enabled on the networking device, use the monitor event-trace dump-traces command in privileged EXEC mode.
monitor event-trace dump-traces [pretty]
Syntax Description
pretty
|
(Optional) Saves the event trace message in ASCII format.
|
Command Modes
Privileged EXEC
Command History
Release
|
Modification
|
12.0(18)S
|
This command was introduced.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T.
|
Usage Guidelines
Use the monitor event-trace dump-traces command to save trace message information for all event traces currently enabled on a networking device. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace dump-traces pretty command.
To write the trace messages for an individual trace event to a file, enter the monitor event-trace (EXEC) command.
To configure the file where you want to save messages, use the monitor event-trace (global) command.
Examples
The following example shows how to save the trace messages in binary format for all event traces enabled on the networking device.
monitor event-trace dump-traces
The following example shows how to save the trace messages in ASCII format for all event traces enabled on the networking device.
monitor event-trace dump-traces pretty
Related Commands
Command
|
Description
|
monitor event-trace (EXEC)
|
Controls event trace function for a specified Cisco IOS software subsystem component.
|
monitor event-trace (global)
|
Configures event tracing for a specified Cisco IOS software subsystem component.
|
show monitor event-trace
|
Displays event trace messages for Cisco IOS software subsystem components.
|
monitor processes cpu extended
To configure a process or processes to be included in the extended load monitor report, use the monitor processes cpu extended command in user EXEC or privileged EXEC mode. To disable this function, use the no form of this command.
monitor processes cpu extended process-id-list
no monitor processes cpu extended process-id-list
Syntax Description
process-id-list
|
Specifies the list of process identifiers (PIDs). You can specify a maximum of eight processes. Valid value ranges from 1 to 2147483647.
|
Command Default
Disabled by default.
Command Modes
User EXEC
Privileged EXEC
Command History
Release
|
Modification
|
12.3(14)T
|
This command was introduced.
|
Usage Guidelines
This command marks a process or processes to be monitored for extended CPU load. You can specify a maximum of eight processes to be monitored using this command. This command is used to forcibly put a process in the latency report generated by the extended load monitor.
Examples
The following example shows how to enable extended CPU load monitor for the process with PID 2:
Router# monitor processes cpu extended 2
Related Commands
Command
|
Description
|
show processes cpu extended
|
Displays an extended CPU load report.
|
mop device-code
To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification (sysid) messages and request program messages, use the mop device-code command in global configuration mode. To set the identity to the default value, use the no form of this command.
mop device-code {cisco | ds200}
no mop device-code {cisco | ds200}
Syntax Description
cisco
|
Denotes a Cisco device code. This is the default.
|
ds200
|
Denotes a DECserver 200 device code.
|
Defaults
Cisco device code
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The sysid messages and request program messages use the identity information indicated by this command.
Examples
The following example identifies a DECserver 200 device as sending MOP sysid and request program messages:
Related Commands
Command
|
Description
|
mop sysid
|
Enables an interface to send out periodic MOP system identification messages.
|
mop retransmit-timer
To configure the length of time that the Cisco IOS software waits before resending boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retransmit-timer command in global configuration mode. To reinstate the default value, use the no form of this command.
mop retransmit-timer seconds
no mop retransmit-timer
Syntax Description
seconds
|
Sets the length of time (in seconds) that the software waits before resending a message. The value is a number from 1 to 20.
|
Defaults
4 seconds
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
By default, when the software sends a request that requires a response from a MOP boot server and the server does not respond, the message is re-sent after 4 seconds. If the MOP boot server and router are separated by a slow serial link, it might take longer than 4 seconds for the software to receive a response to its message. Therefore, you might want to configure the software to wait longer than 4 seconds before resending the message if you are using such a link.
Examples
In the following example, if the MOP boot server does not respond within 10 seconds after the router sends a message, the server will resend the message:
Related Commands
Command
|
Description
|
mop device-code
|
Identifies the type of device sending MOP sysid messages and requests program messages.
|
mop enabled
|
Enables an interface to support the MOP.
|
mop retries
To configure the number of times the Cisco IOS software will resend boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retries command in global configuration mode. To reinstate the default value, use the no form of this command.
mop retries count
no mop retries
Syntax Description
count
|
Indicates the number of times the software will resend a MOP boot request. The value is a number from 3 to 24. The default is 8.
|
Defaults
8 times
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Examples
In the following example, the software will attempt to resend a message to an unresponsive host 11 times before declaring a failure:
Router(config)# mop retries 11
Related Commands
Command
|
Description
|
mop device-code
|
Identifies the type of device sending MOP sysid messages and requests program messages.
|
mop enabled
|
Enables an interface to support the MOP server.
|
mop retransmit-timer
|
Configures the length of time that the Cisco IOS software waits before resending boot requests to a MOP server.
|
more
To display the contents of a file, use the more command in EXEC mode.
more [/ascii | /binary | /ebcdic] url
Syntax Description
/ascii
|
(Optional) Displays a binary file in ASCII format.
|
/binary
|
(Optional) Displays a file in hex/text format.
|
/ebcdic
|
(Optional) Displays a binary file in EBCDIC format.
|
url
|
The URL of the file to display. A URL in the CLI consists of a file-system prefix (such as system: or nvram:), an optional path (such as a folder name), and the name of a file.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
This command was introduced.
|
Usage Guidelines
The more system:running-config command displays the same output as the show running-config command. The more nvram:startup-config command is recommended as a replacement for the show startup-config command and the show configuration command.
You can use this command to display configuration files, as follows:
•
The more nvram:startup-config command displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. The Cisco IOS software informs you whether the displayed configuration is a complete configuration or a distilled version. A distilled configuration is one that does not contain access lists.
•
The more system:running-config command displays the running configuration.
These commands show the version number of the software used when you last changed the configuration file.
You can also display the contents of files on remote systems using the more command. For example, you could display a saved running configuration file on an FTP server using
more ftp://username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the copy command for more information on file-system prefixes available in the Cisco IOS CLI.
Options for filtering and redirecting the output of this command are available by appending a pipe character (|). See the Related Commands table for a list of more <url> command extensions.
Examples
The following partial sample output displays the configuration file named startup-config in NVRAM:
Router# more nvram:startup-config
! No configuration change since last restart
! NVRAM config last updated at 02:03:26 PDT Thu Oct 2 1997
service timestamps debug uptime
service timestamps log uptime
service password-encryption
service udp-small-servers
service tcp-small-servers
The following is partial sample output from the more nvram:startup-config command when the configuration file has been compressed:
Router# more nvram:startup-config
Using 21542 out of 65536 bytes, uncompressed size = 142085 bytes
The following partial sample output displays the running configuration:
Router2# more system:running-config
Building configuration...
no service udp-small-servers
no service tcp-small-servers
Related Commands
Command
|
Description
|
boot config
|
Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup).
|
more <url> begin
|
Begins the output of any more command from a matched string.
|
more <url> exclude
|
Filters the output of any more command to exclude a matched string.
|
more <url> include
|
Filters the output of any more command to display only the lines that match the specified string.
|
service compress-config
|
Compresses startup configuration files.
|
show bootvar
|
Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting.
|
more <url> begin
To search the output of any more command, use the more url | begin command in EXEC mode. This command begins unfiltered output of the more command with the first line that contains the regular expression you specify.
more url | begin regular-expression
Syntax Description
url
|
The Universal Resource Locator (RLl) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
-
|
Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression.
|
+
|
Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression.
|
Command Modes
User EXEC
Privileged EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt.
To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
To filter the remaining output of the more command, use one of the following commands at the --More-- prompt:
-regular-expression
+regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Note
Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | begin command that begins unfiltered output with the first line that contain the regular expression "ip." At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression "ip."
router# more nvram:startup-config | begin ip
ip name-server 198.92.30.32
ip name-server 171.69.2.132
isdn switch-type primary-5ess
ip address 5.5.5.99 255.255.255.0
encapsulation frame-relay
isdn switch-type primary-5ess
Related Commands
Command
|
Description
|
more <url> exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
more <url> include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show <command> begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show <command> exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show <command> include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
more <url> exclude
To filter more command output so that it excludes lines that contain a particular regular expression, use the more exclude command in EXEC mode.
more url | exclude regular-expression
Syntax Description
url
|
The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include:
prefix:[directory/]filename
Prefixes can be local file systems or file locations, such as nvram: or system:. Alternatively, you can specify network locations using the following syntax:
ftp:[[//[username[:password]@]location]/directory]/filename
tftp:[[//location]/directory]/filename
rcp:[[//[username@]location]/directory]/filename
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | exclude command. The use of | exclude service in the command specifies a filter that excludes lines that contain the regular expression "service." At the --More-- prompt, the user searches for the regular expression "Dialer1," which continues filtered output with the first line that contains "Dialer1."
router# more nvram:startup-config | exclude service
Related Commands
Command
|
Description
|
more <url> begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more <url> include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show <command> begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show <command> exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show <command> include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
more <url> include
To filter more command output so that it displays only lines that contain a particular regular expression, use the more include command in EXEC mode.
more url | include regular-expression
Syntax Description
url
|
The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | include command. It only displays lines that contain the regular expression "ip."
router# more nvram:startup-config | include ip
ip name-server 198.92.30.32
ip name-server 171.69.2.132
description ip address 172.21.53.199 255.255.255.0
ip address 172.21.53.199 255.255.255.0
Related Commands
Command
|
Description
|
more <url> begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more <url> exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
show <command> begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show <command> exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show <command> include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
motd-banner
To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the motd-banner command in line configuration mode. To suppress the MOTD banners on the specified line or lines, use the no form of this command.
motd-banner
no motd-banner
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled on all lines.
Command Modes
Line configuration
Command History
Release
|
Modification
|
11.1
|
This command was introduced.
|
Usage Guidelines
This command determines whether the router will display the MOTD banner when an EXEC session is created on the specified line or lines. The MOTD banner is defined with the banner motd global configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner on specific lines using the no motd-banner line configuration command.
The MOTD banners can also be disabled by the no exec-banner line configuration command, which disables both MOTD banners and EXEC banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-banner command is enabled or disabled. Table 48 summarizes the effects of the exec-banner command and the motd-banner command.
Table 48 Banners Displayed Based On exec-banner and motd-banner Combinations
| |
exec-banner (default)
|
no exec-banner
|
motd-banner (default)
|
MOTD banner
EXEC banner
|
None
|
no motd-banner
|
EXEC banner
|
None
|
For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. Table 49 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections.
Table 49 Banners Displayed Based On exec-banner and motd-banner Combinations
for Reverse Telnet Sessions to Async Lines
| |
exec-banner (default)
|
no exec-banner
|
motd-banner (default)
|
MOTD banner
Incoming banner
|
Incoming banner
|
no motd-banner
|
Incoming banner
|
Incoming banner
|
Examples
The following example suppresses the MOTD banner on vty lines 0 through 4:
Related Commands
Command
|
Description
|
banner exec
|
Defines and enables a customized banner to be displayed whenever the EXEC process is initiated.
|
banner incoming
|
Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network.
|
banner motd
|
Defines and enables a customized message-of-the-day banner.
|
motd-banner
|
Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines.
|
name-connection
To assign a logical name to a connection, use the name-connection command in user EXEC mode.
name-connection
Syntax Description
This command has no arguments or keywords.
Defaults
No logical name is defined.
Command Modes
User EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command can be useful for keeping track of multiple connections.
You are prompted for the connection number and name to assign. The where command displays a list of the assigned logical connection names.
Examples
The following example assigns the logical name blue to the connection:
Conn Host Address Byte Idle Conn Name
* 1 doc-2509 172.30.162.131 0 0 doc-2509
Connection 1 to doc-2509 will be named "BLUE" [confirm]
Related Commands
Command
|
Description
|
where
|
Lists open sessions associated with the current terminal line.
|
no menu
To delete a user menu from the configuration file, use the no menu command in global configuration mode.
no menu menu-name
Syntax Description
menu-name
|
Name of the menu to delete from the configuration file.
|
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to remove any menu commands for a particular menu from the configuration file.
As with all global configuration commands, this command will only effect the startup configuration file when you save the running configuration using the copy running-config startup-config EXEC command.
Examples
The following example deletes the menu named Access1:
Related Commands
Command
|
Description
|
menu (EXEC)
|
Invokes a user menu.
|
menu command
|
Specifies underlying commands for user menus.
|
menu prompt
|
Specifies the prompt for a user menu.
|
menu text
|
Specifies the text of a menu item in a user menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
no snmp-server
To disable Simple Network Management Protocol (SNMP) agent operation, use the no snmp-server command in global configuration mode.
no snmp-server
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command disables all running versions of SNMP (SNMPv1, SNMPv2C, and SNMPv3) on the device.
Examples
The following example disables the current running version of SNMP:
Router(config)# no snmp-server
notify
To enable terminal notification about pending output from other Telnet connections, use the notify command in line configuration mode. To disable notifications, use the no form of this command.
notify
no notify
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command sets a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one.
Examples
In the following example, notification of pending output from connections is enabled on virtual terminal lines 0 to 4:
Router(config)# line vty 0 4
Router(config-line)# notify
Related Commands
Command
|
Description
|
terminal notify
|
Configures a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one.
|
notify syslog
To enable the sending of notifications of configuration changes to a remote syslog, use the notify syslog command in configuration change logger configuration mode. To disable the sending of notifications of configuration changes to the syslog, use the no form of this command.
notify syslog
no notify syslog
Syntax Description
This command has no arguments or keywords.
Defaults
Notifications are not sent to the syslog.
Command Modes
Configuration change logger configuration
Command History
Release
|
Modification
|
12.3(4)T
|
This command was introduced.
|
12.2(25)S
|
This command was integrated into Cisco IOS Release 12.2(25)S.
|
Usage Guidelines
Enable the notify syslog command if you use the syslog to monitor your router. Syslog monitoring prevents the need to gather configuration log information manually.
Examples
The following example shows how to enable the router to send notifications to the syslog:
Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)# notify syslog
Related Commands
Command
|
Description
|
archive
|
Enters archive configuration mode.
|
hidekeys
|
Suppresses the display of password information in configuration log files.
|
log config
|
Enters configuration change logger configuration mode.
|
logging enable
|
Enables the logging of configuration changes.
|
logging size
|
Specifies the maximum number of entries retained in the configuration log.
|
show archive log config
|
Displays entries from the configuration log.
|
ntp access-group
To control access to the Network Time Protocol (NTP) services on the system, use the ntp access-group command in global configuration mode. To remove access control to the NTP services, use the no form of this command.
ntp access-group {query-only | serve-only | serve | peer} access-list-number
no ntp [access-group {query-only | serve-only | serve | peer}
Syntax Description
query-only
|
Allows only NTP control queries. See RFC 1305 (NTP version 3).
|
serve-only
|
Allows only time requests.
Note You must configure the ntp server ip-address command before you can use the serve-only keyword.
|
serve
|
Allows time requests and NTP control queries, but does not allow the system to synchronize to the remote system.
|
peer
|
Allows time requests and NTP control queries and allows the system to synchronize to the remote system.
|
access-list-number
|
Number (from 1 to 99) of a standard IP access list.
|
Defaults
No access control (full access granted to all systems)
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The access group options are scanned in the following order from least restrictive to most restrictive:
1.
peer
2.
serve
3.
serve-only
4.
query-only
Access is granted for the first match that is found. If no access groups are specified, all access is granted to all sources. If any access groups are specified, only the specified access is granted. This facility provides minimal security for the time services of the system. However, it can be circumvented by a determined programmer. If tighter security is desired, use the NTP authentication facility.
The NTP service can be activated by entering any ntp command. When you use the ntp access-group command, the NTP service is activated (if it has not already been activated) and access control to NTP services is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp access-control command, only access control to NTP services is removed. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp access-group command and you now want to remove not only the access group, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure a system to allow itself to be synchronized by a peer from access list 99. However, the system restricts access to allow only time requests from access list 42.
Router(config)# ntp access-group peer 99
Router(config)# ntp access-group serve-only 42
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
access-list
|
Configures the access list mechanism for filtering frames by protocol type or vendor code.
|
ntp authenticate
To enable Network Time Protocol (NTP) authentication, use the ntp authenticate command in global configuration mode. To disable the function, use the no form of this command.
ntp authenticate
no ntp [authenticate]
Syntax Description
This command has no arguments or keywords.
Defaults
No authentication
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command if you want authentication. If this command is specified, the system will not synchronize to a system unless it carries one of the authentication keys specified in the ntp trusted-key global configuration command.
The NTP service can be activated by entering any ntp command. When you use the ntp authenticate command, the NTP service is activated (if it has not already been activated) and NTP authentication is enabled simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp authenticate command, only the NTP authentication is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp authenticate command and you now want to disable not only the authentication, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure the system to synchronize only to systems that provide authentication key 42 in their NTP packets:
Router(config)# ntp authenticate
Router(config)# ntp authentication-key 42 md5 aNiceKey
Router(config)# ntp trusted-key 42
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp authentication-key
|
Defines an authentication key for NTP.
|
ntp trusted-key
|
Authenticates the identity of a system to which NTP will synchronize.
|
ntp authentication-key
To define an authentication key for Network Time Protocol (NTP), use the ntp authentication-key command in global configuration mode. To remove the authentication key for NTP, use the no form of this command.
ntp authentication-key number md5 value
no ntp [authentication-key]
Syntax Description
number
|
Key number from 1 to 4294967295.
|
md5
|
Authentication key. Message authentication support is provided using the Message Digest 5 Algorithm (MD5). The key type md5 is currently the only key type supported.
|
value
|
Character string of up to eight characters that is the value of the MD5 key.
|
Defaults
No authentication key is defined for NTP.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to define authentication keys for use with other NTP commands in order to provide a higher degree of security.
Note
When this command is written to NVRAM, the key is encrypted so that it is not displayed when the configuration is viewed.
The NTP service can be activated by entering any ntp command. When you use the ntp authentication-key command, the NTP service is activated (if it has not already been activated) and the NTP authentication key is defined simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp authentication-key command, only the NTP authentication key is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp authentication-key command and you now want to remove not only the authentication key, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure the system to synchronize only to systems providing authentication key 42 in their NTP packets:
Router(config)# ntp authenticate
Router(config)# ntp authentication-key 42 md5 aNiceKey
Router(config)# ntp trusted-key 42
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp authenticate
|
Enables NTP authentication.
|
ntp peer
|
Configures the software clock to synchronize a peer or to be synchronized by a peer.
|
ntp server
|
Allows the software clock to be synchronized by a time server.
|
ntp trusted-key
|
Authenticates the identity of a system to which NTP will synchronize.
|
ntp broadcast client
To configure a device to receive Network Time Protocol (NTP) broadcast messages on a specified interface, use the ntp broadcast client command in interface configuration mode. To disable this capability, use the no form of this command.
ntp broadcast client
no ntp broadcast [client]
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command to allow the system to listen to broadcast packets on an interface-by-interface basis.
The NTP service can be activated by entering any ntp command. When you use the ntp broadcast client command, the NTP service is activated (if it has not already been activated) and the device is configured to receive NTP broadcast packets on a specified interface simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp broadcast client command, only the broadcast client configuration is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp broadcast client command and you now want to remove not only the broadcast client capability, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
In the following example, the system is configured to receive (listen to) NTP broadcasts on Ethernet interface 1:
Router(config)# interface ethernet 1
Router(config-if)# ntp broadcast client
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp broadcast
|
Configures the specified interface to send NTP broadcast packets.
|
ntp broadcastdelay
|
Sets the estimated round-trip delay between the system and an NTP broadcast server.
|
ntp broadcast
To configure the options for broadcasting Network Time Protocol (NTP) traffic, use the ntp broadcast command in interface configuration mode. To disable this capability, use the no form of this command.
ntp broadcast [client] [destination {ip-address | hostname}] [key broadcast-key] [version
number]
no ntp [broadcast]
Syntax Description
client
|
(Optional) Configures a device to listen to NTP broadcast messages.
|
destination
|
(Optional) Configures a device to receive broadcast messages.
|
ip-address | hostname
|
(Optional) IP address or hostname of the device to send NTP broadcast messages to.
|
key
|
(Optional) Configures a broadcast authentication key.
|
broadcast key
|
(Optional) Integer from 0 to 4294967295 that is the key number.
|
version
|
(Optional) Indicates that an NTP version is configured.
|
number
|
(Optional) Integer from 1 to 3 indicating the NTP version.
|
Defaults
Disabled
Command Modes
Interface configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The NTP service can be activated by entering any ntp command. When you use the ntp broadcast command, the NTP service is activated (if it has not already been activated) and the options are configured for sending NTP traffic simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp broadcast command, only the configuration to send NTP broadcast packets on a specified interface is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp broadcast command and you now want to remove not only the broadcast capability, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configures Ethernet interface 0 to send NTP version 2 broadcasts:
Router(config)# interface ethernet 0
Router(config-if)# ntp broadcast version 2
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp broadcast client
|
Allows the system to receive NTP broadcast packets on an interface.
|
ntp broadcastdelay
|
Sets the estimated round-trip delay between the Cisco IOS software and an NTP broadcast server.
|
ntp broadcastdelay
To set the estimated round-trip delay between the Cisco IOS software and a Network Time Protocol (NTP) broadcast server, use the ntp broadcastdelay command in global configuration mode. To revert to the default value, use the no form of this command.
ntp broadcastdelay microseconds
no ntp [broadcastdelay]
Syntax Description
microseconds
|
Estimated round-trip time (in microseconds) for NTP broadcasts. The range is from 1 to 999999.
|
Defaults
3000 microseconds
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command when the router is configured as a broadcast client and the round-trip delay on the network is other than 3000 microseconds.
The NTP service can be activated by entering any ntp command. When you use the ntp broadcastdelay command, the NTP service is activated (if it has not already been activated) and the estimated round-trip delay between the Cisco IOS software and an NTP broadcast server is set simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp broadcastdelay command, only the estimated round-trip delay between the Cisco IOS software and an NTP broadcast server is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp broadcastdelay command and you now want to remove not only the delay setting, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to set the estimated round-trip delay between a router and the broadcast client to 5000 microseconds:
Router(config)# ntp broadcastdelay 5000
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp broadcast
|
Configures the specified interface to send NTP broadcast packets.
|
ntp broadcast client
|
Configures the specified interface to receive NTP broadcast packets.
|
ntp clock-period
Caution 
Do not enter this command; it is documented for informational purposes only. The system automatically generates this command as Network Time Protocol (NTP) determines the clock error and compensates.
As NTP compensates for the error in the software clock, it keeps track of the correction factor for this error. When the value for the clock period needs to be adjusted, the system automatically enters the correct value into the running configuration. To remove the automatically generated value for the clock period, use the no form of this command.
ntp clock-period value
no ntp [clock-period value]
Syntax Description
value
|
Amount of time to add to the software clock for each clock hardware tick (this value is multiplied by 2-32).
|
Defaults
17179869 2-32 seconds (4 milliseconds)
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Do not manually set a value for the NTP clock-period.
If the system has automatically entered a value for the clock period into the running configuration, NTP synchronizes faster after the system is restarted when the copy running-config startup-config command has been entered to save the configuration to NVRAM.
The NTP service can be activated by entering any ntp command. When you use the ntp clock-period command, the NTP service is activated (if it has not already been activated) and the system automatically saves the correct value into the running configuration simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp clock-period command, only the automatically generated value is removed. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you want to remove not only the clock period, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows a typical difference between the values of the NTP clock-period setting in the running configuration and in the startup configuration:
Router# show startup-config | include clock-period
ntp clock-period 17180239
Router# show running-config | include clock-period
ntp clock-period 17180255
The following example shows how to remove the automatically generated value for the clock period from the running configuration:
Router(config)# no ntp clock-period
The following example shows how to remove all the configured NTP options and disable the ntp server:
ntp disable
To prevent an interface from receiving Network Time Protocol (NTP) packets, use the ntp disable command in interface configuration mode. To enable receipt of NTP packets on an interface, use the no form of this command.
ntp disable
no ntp [disable]
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Interface configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command provides a simple method of access control.
The NTP service can be activated by entering any ntp command. When you use the ntp disable command, the NTP service is activated (if it has not already been activated) and the interface is configured to reject NTP packets simultaneously.
In the no form of any ntp command, all the keywords are optional. However, you must remove all NTP commands from the interface before you can enter the ntp disable command on that interface.
When you enter the no ntp disable command, the interface that was configured to reject NTP packets is enabled to receive NTP packets. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp disable command and you now want to remove not only this restriction, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to prevent Ethernet interface 0 from receiving NTP packets:
Router(config)# interface ethernet 0
Router(config-if)# ntp disable
The following example shows the display after trying to execute ntp disable on an interface with other NTP commands configured on it:
Router(config-if)# ntp disable
%NTP: Unconfigure other NTP commands on this interface before executing `ntp disable'
The following example shows how to remove all the configured NTP options and disable the ntp server:
ntp logging
To enable Network Time Protocol (NTP) message logging, use the ntp logging command in global configuration mode. To disable NTP logging, use the no form of this command.
ntp logging
no ntp [logging]
Syntax Description
This command has no arguments or keywords.
Defaults
NTP message logging is disabled.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(7)T
|
This command was introduced.
|
Usage Guidelines
Use the ntp logging command to control the display of NTP logging messages.
The NTP service can be activated by entering any ntp command. When you use the ntp logging command, the NTP service is activated (if it has not already been activated) and message logging is enabled simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp logging command, only the message logging is disabled in the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp logging command and you now want to disable not only the message logging, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to enable NTP message logging and verify that it is enabled:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# ntp logging
Router# show running-config | include ntp
ntp clock-period 17180152
In the preceding example, the "ntp logging" entry in the configuration file verifies that NTP message logging is enabled.
The following example shows how to disable NTP message logging and verify that it is disabled:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# no ntp logging
Router(config)# show running-config | include ntp
ntp clock-period 17180152
The "ntp logging" entry no longer appears in the configuration file, which verifies that NTP message logging is disabled.
The following example shows how to remove all the configured NTP options and disable the ntp server:
Router(config)# no ntp
Related Commands
Command
|
Description
|
ntp peer
|
Configures the software clock to synchronize a peer or to be synchronized by a peer.
|
ntp server
|
Allows the software clock to be synchronized by an NTP time server.
|
ntp master
To configure the Cisco IOS software as a Network Time Protocol (NTP) master clock to which peers synchronize themselves when an external NTP source is not available, use the ntp master command in global configuration mode. To disable the master clock function, use the no form of this command.
ntp master [stratum]
no ntp [master]
Caution 
Use this command with caution. It is very easy to override valid time sources using this command, especially if a low stratum number is configured. Configuring multiple devices in the same network with the
ntp master command can cause instability in keeping time if the devices do not agree on the time.
Syntax Description
stratum
|
(Optional) Number from 1 to 15. Indicates the NTP stratum number that the system will claim.
|
Defaults
By default, the master clock function is disabled. When enabled, the default stratum is 8.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Because the Cisco implementation of NTP does not support directly attached radio or atomic clocks, the router is normally synchronized, directly or indirectly, to an external system that has such a clock. In a network without Internet connectivity, such a time source may not be available. The ntp master command is used in such cases.
If the system has ntp master configured, and it cannot reach any clock with a lower stratum number, the system will claim to be synchronized at the configured stratum number, and other systems will be willing to synchronize to it via NTP.
Note
The software clock must have been set from some source, including manually, before the ntp master command will have any effect. This protects against distributing erroneous time after the system is restarted.
The NTP service can be activated by entering any ntp command. When you use the ntp master command, the NTP service is activated (if it has not already been activated) and the Cisco IOS software is configured as an NTP master clock simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp master command, only the NTP master clock configuration is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp master command and you now want to remove not only the master clock function, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure a router as an NTP master clock to which peers may synchronize:
Router(config)# ntp master 10
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
clock calendar-valid
|
Configures the system hardware clock an authoritative time source for the network.
|
ntp max-associations
To configure the maximum number of Network Time Protocol (NTP) peers and clients for a routing device, use the ntp max-associations command in global configuration mode. To return the maximum associations value to the default, use the no form of this command.
ntp max-associations number
no ntp [max-associations]
Syntax Description
number
|
Specifies the number of NTP associations. The range is 0 to 4294967295. The default is 100.
|
Defaults
100 maximum associations.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0
|
This command was introduced.
|
Usage Guidelines
The router can be configured to define the maximum number of NTP peer and client associations that the router will serve. The ntp max-associations command is used to set this limit.
For a router, this command is useful for ensuring that the router is not overwhelmed by NTP synchronization requests. For an NTP master server, this command is useful for allowing numerous devices to synchronize to a router.
The NTP service can be activated by entering any ntp command. When you use the ntp max-associations command, the NTP service is activated (if it has not already been activated) and the maximum number of NTP peers and clients is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp max-associations command, only the maximum number value is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp max-associations command and you now want to remove not only that maximum value, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
In the following example, the router is configured to act as an NTP server to 200 clients:
Router(config)# ntp max-associations 200
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
show ntp associations
|
Shows all current NTP associations for the device.
|
ntp multicast client
To configure the system to receive Network Time Protocol (NTP) multicast packets on a specified interface, use the ntp multicast client interface configuration command. To disable this capability, use the no form of this command.
ntp multicast client [ip-address]
no ntp [multicast client [ip-address]]
Syntax Description
ip-address
|
(Optional) IP address of the multicast group. Default address is 224.0.1.1.
|
Defaults
Disabled
Command Modes
Interface configuration
Command History
Release
|
Modification
|
12.1
|
This command was introduced.
|
Usage Guidelines
Use this command to allow the system to listen to multicast packets on an interface-by-interface basis.
The NTP service can be activated by entering any ntp command. When you use the ntp multicast client command, the NTP service is activated (if it has not already been activated) and the interface on which to receive multicast packets is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp multicast client command, only the multicast client capability is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp multicast client command and you now want to remove not only the multicast client capability, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
In the following example, the system is configured to receive (listen to) NTP multicast packets on Ethernet interface 1:
Router(config)# interface ethernet 1
Router(config-if)# ntp multicast client
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp multicast
|
Configures the specified interface to send NTP multicast packets.
|
ntp multicast
To configure a system to send Network Time Protocol (NTP) multicast packets on a specified interface, use the ntp multicast interface configuration command. To disable this capability, use the no form of this command.
ntp multicast [ip-address] [key key-id] [ttl value] [version number]
no ntp [multicast]
Syntax Description
ip-address
|
(Optional) IP address of the multicast group. Default address is 224.0.1.1.
|
key
|
(Optional) Defines a multicast authentication key.
|
key-id
|
(Optional) Authentication key number in the range from 1 to 4294967295.
|
ttl
|
(Optional) Defines the time-to-live (TTL) value of a multicast NTP packet.
|
value
|
(Optional) TTL value in the range from 1 to 255. Default TTL value is 16.
|
version
|
(Optional) Defines the NTP version number.
|
number
|
(Optional) NTP version number in the range from 1 to 3. Default version number is 3.
|
Defaults
Disabled
Command Modes
Interface configuration
Command History
Release
|
Modification
|
12.1
|
This command was introduced.
|
Usage Guidelines
The TTL value is used to limit the scope of an audience for multicast routing.
The NTP service can be activated by entering any ntp command. When you use the ntp multicast command, the NTP service is activated (if it has not already been activated) and the interface on which to send multicast packets is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp multicast command, only the multicast capability is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp multicast command and you now want to remove not only the multicast capability, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure Ethernet interface 0 to send NTP version 2 broadcasts:
Router(config)# interface ethernet 0
Router(config-if)# ntp multicast version 2
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp authentication-key
|
Defines an authentication key for NTP.
|
ntp multicast client
|
Allows the system to receive NTP multicast packets on an interface.
|
ntp peer
To configure the software clock to synchronize a peer or to be synchronized by a peer, use the ntp peer command in global configuration mode. To disable this capability, use the no form of this command.
ntp peer {{[vrf vrf-name] ip-address | hostname}[normal-sync][version number] [key key-id]
[source interface] [prefer]}
no ntp {[vrf vrf-name] ip-address | hostname}
Syntax Description
vrf
|
(Optional) Specifies that the peer should use a named virtual private network (VPN) routing forwarding instance (VRF) for routing to the destination instead of to the global routing table.
|
vrf-name
|
(Optional) Name of the VRF.
|
ip-address | hostname
|
IP address or hostname of the peer providing or being provided the clock synchronization.
|
normal-sync
|
(Optional) Disables the rapid synchronization at startup.
|
version
|
(Optional) Defines the Network Time Protocol (NTP) version number.
|
number
|
(Optional) NTP version number (1 to 3).
|
key
|
(Optional) Defines the authentication key.
|
keyid
|
(Optional) Authentication key to use when sending packets to this peer.
|
source
|
(Optional) Names the interface.
|
interface
|
(Optional) Name of the interface from which to pick the IP source address.
|
prefer
|
(Optional) Makes this peer the preferred peer that provides synchronization.
|
Command Default
No peers are configured.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
12.3(14)T
|
The normal-sync keyword was added.
|
Usage Guidelines
When a peer is configured, the default NTP version number is 3, no authentication key is used, and the source IP address is taken from the outgoing interface.
Use this command to allow a device to synchronize with a peer, or vice versa. Using the prefer keyword reduces switching between peers.
Tip
If you are using the default version of 3 and NTP synchronization does not occur, try using NTP version 2 (NTPv2).
The NTP service can be activated by entering any ntp command. When you use the ntp peer command, the NTP service is activated (if it has not already been activated) and the peer is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp peer command, only the NTP peer configuration is removed from NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp peer command and you now want to remove not only the peer, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure a router to allow its software clock to be synchronized with the clock of the peer (or vice versa) at IP address 192.168.22.33 using NTP version 2. The source IP address is the address of Ethernet 0.
Router(config)# ntp peer 192.168.22.33 version 2 source ethernet 0
The following example shows how to disable rapid synchronization at startup:
Router(config)# ntp peer 192.168.22.33 normal-sync
The following example shows how to keep a peer configured but re-enable rapid synchronization at startup after previously disabling it:
Router(config)# ntp peer 192.168.22.33
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp authentication-key
|
Defines an authentication key for NTP.
|
ntp server
|
Allows the software clock to be synchronized by a time server.
|
ntp source
|
Uses a particular source address in NTP packets.
|
ntp refclock
To configure an external clock source for use with Network Time Protocol (NTP) services, use the ntp refclock command in line configuration mode. To disable support of the external time source, use the no form of this command.
ntp refclock {trimble | telecom-solutions} pps {cts | ri | none} [inverted] [pps-offset number]
[stratum number] [timestamp-offset number]
no ntp [refclock]
Syntax Description
trimble
|
Enables the reference clock driver for the Trimble Palisade NTP Synchronization Kit (Cisco 7200 series routers only).
|
telecom-solutions
|
Enables the reference clock driver for a Telecom Solutions GPS device.
|
pps
|
Pulse per second (PPS) signal line. Indicate PPS pulse reference clock support. Choices are cts, ri, or none.
|
cts
|
Pulse per second on CTS.
|
ri
|
Pulse per second on RI.
|
none
|
No PPS signal available.
|
inverted
|
(Optional) PPS signal is inverted.
|
pps-offset number
|
(Optional) Offset of PPS pulse. The number is the offset (in milliseconds).
|
stratum number
|
(Optional) Number from 0 to 14. Indicates the NTP stratum number that the system will claim.
|
timestamp-offset number
|
(Optional) Offset of time stamp. The number is the offset (in milliseconds).
|
Defaults
This command is disabled by default.
Command Modes
Line configuration (for auxilary 0 only)
Command History
Release
|
Modification
|
12.1
|
The trimble keyword was added to provide driver activation for a Trimble GPS time source on the Cisco 7200 series router.
|
Usage Guidelines
To configure a PPS signal as the source for NTP synchronization, use the following form of the ntp refclock command:
ntp refclock pps {cts | ri} [inverted] [pps-offset number] [stratum number] [timestamp-offset number]
To configure a Trimble Palisade NTP Synchronization Kit as the GPS clock source connected to the auxiliary port of a Cisco 7200 router, use the following form of the ntp refclock command:
ntp refclock trimble pps none [stratum number]
To configure a Telecom Solutions product as the GPS clock source, use the ntp refclock telecom-solutions form of the command:
ntp refclock telecom-solutions pps cts [stratum number]
The NTP service can be activated by entering any ntp command. When you use the ntp refclock command, the NTP service is activated (if it has not already been activated) and the external clock source is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp refclock command, only the external clock source is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp refclock command and you now want to remove not only the external clock source, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows configuration of a Trimble Palisade GPS time source on a Cisco 7200 router:
Router(config)# ntp master
Router(config)# ntp update-calendar
Router(config)# line aux 0
Router(config-line)# ntp refclock trimble pps none
The following example shows configuration of a Telecom Solutions GPS time source on a Catalyst switch platform:
Router(config)# ntp master
Router(config)# ntp update-calendar
Router(config)# line aux 0
Router(config-line)# ntp refclock telecom-solutions pps cts stratum 1
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
show ntp associations
|
Displays the status of NTP associations configured for your system.
|
ntp server
To allow the software clock to be synchronized by a Network Time Protocol (NTP) time server, use the ntp server command in global configuration mode. To disable this capability, use the no form of this command.
ntp server {{[vrf vrf-name] ip-address | hostname} [version number] [key key-id] [source
interface] [prefer]}
no ntp server {[vrf vrf-name] ip-address | hostname}
Syntax Description
vrf
|
(Optional) Specifies that the server should use a named virtual private network (VPN) routing forwarding instance (VRF) for routing to the destination instead of to the global routing table.
|
vrf-name
|
(Optional) Name of the VRF.
|
ip-address | hostname
|
IP address or hostname of the server providing or being provided the clock synchronization.
|
version
|
(Optional) Defines the NTP version number.
|
number
|
(Optional) NTP version number (1 to 3).
|
key
|
(Optional) Defines the authentication key.
|
key-id
|
(Optional) Authentication key to use when sending packets to this server.
|
source
|
(Optional) Identifies the interface from which to pick the IP source address.
|
interface
|
(Optional) Name of the interface from which to pick the IP source address.
|
prefer
|
(Optional) Specifies that the server referenced in this command is preferred over other configured NTP servers.
|
Defaults
No servers are configured by default. If a server is configured, the default NTP version number is 3, no authentication key is used, and the source IP address is taken from the outgoing interface.
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use this command if you want to allow the system to synchronize with the specified server. The server will not synchronize to this machine.
When you use the hostname option, the router does a domain name server (DNS) lookup on that name, and stores the IP address in the configuration. For example, if you enter the command ntp server host1 and then check the running configuration, the output shows "ntp server 172.16.0.4," assuming that the router is correctly configured as a DNS client.
Use the prefer keyword if you use this command multiple times, and you want to set a preferred server. Using the prefer keyword reduces switching between servers.
If you are using the default version of 3 and NTP synchronization does not occur, try NTP version 2. Some NTP servers on the Internet run version 2.
The NTP service can be activated by entering any ntp command. When you use the ntp server command, the NTP service is activated (if it has not already been activated) and software clock synchronization is configured simultaneously.
In the no form of any ntp command, all the keywords are optional. When you enter the no ntp server command, only the server synchronization capability is removed from the NTP service. The NTP service itself remains active, along with any other functions you previously configured.
To terminate NTP service on a device, you must enter the no ntp command without keywords. For example, if you previously issued the ntp server command and you now want to remove not only the server synchronization capability, but all NTP functions from the device, use the no ntp command without any keywords. This ensures that all NTP functions are removed and that the NTP service is also terminated.
Examples
The following example shows how to configure a router to allow its software clock to be synchronized with the clock by the device at IP address 172.16.22.44 using NTP version 2:
Router(config)# ntp server 172.16.22.44 version 2
The following example shows how to remove all the configured NTP options and disable the ntp server:
Related Commands
Command
|
Description
|
ntp authentication-key
|
Defines an authentication key for NTP.
|
ntp peer
|
Configures the software clock to synchronize a peer or to be synchronized by a peer.
|
ntp source
|
Uses a particular source address in NTP packets.
|
ntp source
To use a particular source address in Network Time Protocol (NTP) packets, use the ntp source command in global configuration mode. To remove the specified source address, use the no form of this command.
ntp source type number
no ntp [source]
Syntax Description