-
Cisco IOS Configuration Fundamentals and Network Management Command Reference, Release 12.3 T
-
Introduction
-
CFR Commands: absolute through clock timezone
-
CFR Commands: clock update-calendar through escape-character
-
CFR Commands: event application through ip ftp passive
-
CFR Commands: major rising through periodic
-
CFR Commands: ping through service sequence-numbers
-
CFR Commands: service slave-log through show
tee -
CFR Commands: show context through show ip sla monitor total-statistics
-
CFR Commands [12.3T]: 'show kron schedule' through 'show rtr collection-statistics'
-
CFR Commands: show rtr configuration through snmp-server enable informs
-
CFR Commands: snmp-server enable traps through statistics-distribution-interval
-
CFR Commands: stopbits through ttl ip
-
CFR Commands: type dhcp through xsm vdm
-
Appendix: ASCII Character Set and Hex Values (12.3T CF CR)
-
Table Of Contents
event manager scheduler policy suspend
event manager scheduler script
event manager session cli username
exception crashinfo buffersize
exception crashinfo maximum files
exception memory ignore overflow
ip director default priorities
ip director server availability
ip director server port availability
event application
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of an event raised through the EEM Event Publish application programming interface (API), use the event application command in applet configuration mode. To remove the application event criteria, use the no form of this command.
event application sub-system sub-system-id type event-type
no event application sub-system sub-system-id type event-type
Syntax Description
Defaults
No EEM event criteria are specified.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
An EEM event is triggered when an application calls the EEM Event Publish API with an event specification that matches the subsystem ID and application event type.
Examples
The following example shows how a policy named EventPublish_A runs every 20 seconds and publishes an event to a well-known EEM event type numbered 1. A second policy named EventPublish_B is registered to run when the well-known EEM event type of 1 occurs. When policy EventPublish_B runs, it outputs a message to syslog containing data passed as an argument from EventPublish_A.
Router(config)# event manager applet EventPublish_ARouter(config-applet)# event timer watchdog time 20.0Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_A"Router(config-applet)# action 2.0 publish-event sub-system 798 type 1 arg1 twentyRouter(config-applet)# exitRouter(config)# event manager applet EventPublish_BRouter(config-applet)# event application sub-system 798 type 1Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_B arg1 $_application_data1"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event cli
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run by matching a Cisco IOS command-line interface (CLI) command, use the event cli command in applet configuration mode. To remove the CLI command event criteria, use the no form of this command.
event cli pattern regular-expression sync {yes | no {skip {yes | no}}} [occurs num-occurrences] [period period-value]
no event cli pattern regular-expression sync {yes | no {skip {yes | no}}} [occurs num-occurrences] [period period-value]
Syntax Description
Defaults
No EEM events are triggered on the basis of a match with a Cisco IOS CLI command.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the event cli command to set up event criteria against which CLI commands are matched. CLI commands are compared against a specified regular expression. After a specified number of matches occurs within a specified time period, an EEM event is triggered. If multiple conditions exist, the EEM event is triggered when all the conditions are met.
Examples
The following example shows how to specify an EEM applet to run when the Cisco IOS interface loopback CLI command is configured three times. The applet runs the no shutdown command to ensure that the loopback interfaces are operational.
Router(config)# event manager applet cli-matchRouter(config-applet)# event cli pattern {.*interface loopback*} sync yes occurs 3Router(config-applet)# action 1.0 cli command "no shutdown"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event counter
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a named counter crossing a threshold, use the event counter command in applet configuration mode. To remove the counter event criteria, use the no form of this command.
event counter name counter-name entry-op operator entry-val entry-value [exit-op operator] [exit-val exit-value]
no event counter name counter-name entry-op operator entry-val entry-value [exit-op operator] [exit-val exit-value]
Syntax Description
Defaults
No EEM events are triggered on the basis of a named counter crossing a threshold.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
An EEM event is triggered when the value of a specified counter crosses a defined threshold. Depending on the operator, the threshold may be crossed when the value is greater than the threshold or when the value is less than the threshold.
Use the event counter command with the action counter command when an event occurs periodically and you want an action to be implemented after a specified number of occurrences of the event.
Exit criteria are optional. If exit criteria are not specified, event monitoring will be reenabled immediately. If exit criteria are specified, event monitoring is not reenabled until the criteria are met.
Examples
The following example shows a policy—EventCounter_A—that is configured to run once a minute and to increment a well-known counter called critical_errors. A second policy—EventCounter_B—is registered to be triggered when the well-known counter called critical_errors exceeds a threshold of 3. When policy EventCounter_B runs, it resets the counter back to 0.
Router(config)# event manager applet EventCounter_ARouter(config-applet)# event timer watchdog time 60.0Router(config-applet)# action 1.0 syslog msg "EventCounter_A"Router(config-applet)# action 2.0 counter name critical_errors value 1 op incRouter(config-applet)# exitRouter(config)# event manager applet EventCounter_BRouter(config-applet)# event counter name critical_errors entry-op gt entry-val 3 exit-op lt exit-val 3Router(config-applet)# action 1.0 syslog msg "EventCounter_B"Router(config-applet)# action 2.0 counter name critical_errors value 0 op setRelated Commands
event interface
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a generic interface counter crossing a threshold or reaching exit criteria, use the event interface command in applet configuration mode. To remove the interface event criteria, use the no form of this command.
event interface name interface-type interface-number parameter counter-name entry-op operator entry-val entry-value entry-val-is-increment {true | false} [exit-comb {or | and}] [exit-op operator exit-val exit-value] [exit-val-is-increment {true | false}] [exit-time exit-time-value] poll-interval poll-int-value
no event interface name interface-type interface-number parameter counter-name entry-op operator entry-val entry-value entry-val-is-increment {true | false} [exit-comb {or | and}] [exit-op operator exit-val exit-value] [exit-val-is-increment {true | false}] [exit-time exit-time-value] poll-interval poll-int-value
Syntax Description
Defaults
No EEM events are triggered on the basis of a generic interface counter crossing a threshold or reaching exit criteria.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
An EEM event is triggered when one of the fields specified by an interface counter crosses a defined threshold.
Exit criteria are optional. If exit criteria are not specified, event monitoring will be reenabled immediately. If exit criteria are specified—on the basis of values or time periods—event monitoring is not reenabled until the criteria are met.
Examples
The following example shows how a policy named EventInterface is triggered every time the receive_throttle counter for the FastEthernet0/0 interface in incremented by 5. The polling interval to check the counter is specified to run once every 10 seconds.
Router(config)# event manager applet EventInterfaceRouter(config-applet)# event interface name FastEthernet0/0 parameter receive_throttle entry-op ge entry-val 5 entry-val-is-increment true poll-interval 10Router(config-applet)# action 1.0 syslog msg "Applet EventInterface"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event ioswdsysmon
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of Cisco IOS system monitor counters crossing a threshold, use the event ioswdsysmon command in applet configuration mode. To remove the event criteria, use the no form of this command.
event ioswdsysmon sub1 subevent1 [timewin timewin-value] [sub12-op {and | or | andnot} sub2 subevent2]
no event ioswdsysmon sub1 subevent1 [timewin timewin-value] [sub12-op {and | or | andnot} sub2 subevent2]
Subevent Syntax (for the subevent1 and subevent2 Arguments)
cpu-proc taskname process-name op operator val value [period period-value]
mem-proc taskname process-name op operator val value [is-percent {true | false}] [period period-value]
Syntax Description
Defaults
No EEM events are triggered on the basis of Cisco IOS system monitor counters.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
An EEM event is triggered when one of the Cisco IOS system monitor counters crosses a defined threshold. Depending on the operator, the threshold may be crossed when the value exceeds the threshold or when the value is less than the threshold.
Examples
The following example shows how to configure a policy to trigger an applet when the total amount of memory used by the process named "IP RIB Update" has increased by more than 50 percent over the sample period of 60 seconds:
Router(config)# event manager applet IOSWD_Sample3Router(config-applet)# event ioswdsysmon sub1 mem-proc taskname "IP RIB Update" op gt val 50 is-percent true period 60Router(config-applet)# action 1 syslog msg "IOSWD_Sample3 Policy Triggered"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event manager applet
To register an applet with the Embedded Event Manager (EEM) and to enter applet configuration mode, use the event manager applet command in global configuration mode. To remove the applet command from the configuration file, use the no form of this command.
event manager applet applet-name
no event manager applet applet-name
Syntax Description
Defaults
No EEM applets are registered.
Command Modes
Global configuration
Command History
Usage Guidelines
An EEM applet is a concise method for defining event screening criteria and the actions to be taken when that event occurs.
Only one event configuration command is allowed within an applet configuration. When applet configuration submode is exited and no event command is present, a warning is displayed stating that no event is associated with this applet. If no event is specified, this applet is not considered registered and the applet is not displayed. When no action is associated with this applet, events are still triggered but no actions are performed. Multiple action applet configuration commands are allowed within an applet configuration. Use the show event manager policy registered command to display a list of registered applets.
Before modifying an EEM applet, use the no form of this command to unregister the applet because the existing applet is not replaced until you exit applet configuration mode. While you are in applet configuration mode modifying the applet, the existing applet may be executing. When you exit applet configuration mode, the old applet is unregistered and the new version is registered.
Action configuration commands are uniquely identified using the label argument, which can be any string value. Actions are sorted in ascending alphanumeric key sequence using the label argument as the sort key and are run using this sequence.
The EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When applet configuration mode is exited, EEM examines the event and action commands that are entered and registers the applet to be run when a specified event occurs.
Examples
The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message saying that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incRelated Commands
show event manager policy registered
Displays registered Embedded Event Manager policies.
event manager directory user
To specify a directory to use for storing user library files or user-defined Embedded Event Manager (EEM) policies, use the event manager directory user command in global configuration command. To disable use of a directory for storing user library files or user-defined EEM policies, use the no form of this command.
event manager directory user {library path | policy path}
no event manager directory user {library path | policy path}
Syntax Description
Defaults
No directory is specified for storing user library files or user-defined EEM policies.
Command Modes
Global configuration
Command History
Usage Guidelines
The user library directory is needed to store user library files associated with authoring EEM policies. If you have no plans to author EEM policies, you need not create a user library directory.
Modular Cisco IOS software supports policy files created by using the Tool Command Language (Tcl) scripting language. Tcl is provided in the Modular Cisco IOS software image when the EEM is installed on the network device. Files with the .tcl extension can be EEM policies, Tcl library files, or a special Tcl library index file named "tclindex." The tclindex file contains a list of user function names and the library files that contain the user functions. The EEM searches the user library directory when Tcl starts up to process the tclindex file.
To create the user library directory before identifying it to the EEM, use the mkdir command in privileged EXEC mode. After creating the user library directory, you can use the copy command to copy .tcl library files into the user library directory.
The user policy directory is needed to store user-defined policy files. If you have no plans to author EEM policies, you need not create a user policy directory. The EEM searches the user policy directory when you enter the event manager policy policy-filename type user command.
To create the user policy directory before identifying it to the EEM, use the mkdir command in privileged EXEC mode. After creating the user policy directory, you can use the copy command to copy policy files into the user policy directory.
Examples
The following example shows how to specify disk0:/user_library as the directory to use for storing user library files:
Router(config)# event manager directory user library disk0:/user_libraryRelated Commands
copy
Copies any file from a source to a destination.
event manager policy
Registers an EEM policy with the EEM.
mkdir
Creates a new directory in a Class C flash file system.
event manager environment
To set an Embedded Event Manager (EEM) environment variable, use the event manager environment command in global configuration mode. To disable an EEM environment variable, use the no form of this command.
event manager environment variable-name string
no event manager environment variable-name
Syntax Description
variable-name
Name assigned to the EEM environment variable.
string
Series of characters, including embedded spaces, to be placed in the environment variable variable-name.
Defaults
No EEM environment variables are set.
Command Modes
Global configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
By convention, the names of all environment variables defined by Cisco begin with an underscore character to set them apart: for example, _show_cmd.
To support embedded white spaces in the string argument, the current implementation of this command interprets everything after the variable-name argument to the end of the line to be part of the string argument.
To display the name and value of all EEM environment variables after you have configured them, use the show event manager environment command.
Examples
The following example of the event manager environment command defines a set of EEM environment variables:
Router(config)# event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7Router(config)# event manager environment _show_cmd show versionRelated Commands
show event manager environment
Displays the name and value of all EEM environment variables.
event manager history size
To change the size of Embedded Event Manager (EEM) history tables, use the event manager history size command in global configuration mode. To restore the default history table size, use the no form of this command.
event manager history size {events | traps} [size]
no event manager history size {events | traps}
Syntax Description
Defaults
The size of the history table is 50 entries.
Command Modes
Global configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Examples
The following example of the event manager history size command changes the size of the SNMP trap history table to 30 entries:
Router(config)# event manager history size traps 30Related Commands
show event manager history events
Displays the EEM events that have been triggered.
show event manager history traps
Displays the EEM SNMP traps that have been sent.
event manager policy
To register an Embedded Event Manager (EEM) policy with the EEM, use the event manager policy command in global configuration mode. To remove the event manager policy command from the configuration file, use the no form of this command.
event manager policy policy-filename [type {system | user}] [trap]
no event manager policy policy-filename
Syntax Description
Defaults
No EEM policies are registered.
Command Modes
Global configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
The user keyword was added, and this command was integrated into
Cisco IOS Release 12.3(14)T.
Usage Guidelines
The EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When the event manager policy command is invoked, the EEM examines the policy and registers it to be run when the specified event occurs.
If you enter the event manager policy command without specifying the optional type keyword, the EEM first tries to locate the specified policy file in the system policy directory. If the EEM finds the file in the system policy directory, it registers the policy as a system policy. If the EEM does not find the specified policy file in the system policy directory, it looks in the user policy directory. If the EEM locates the specified file in the user policy directory, it registers the policy file as a user policy. If the EEM finds policy files with the same name in both the system policy directory and the user policy directory, the policy file in the system policy directory takes precedence and is registered as a system policy.
Examples
The following example of the event manager policy command registers a system-defined policy named tm_countdown_ios.tcl located in the system policy directory:
Router(config)# event manager policy tm_countdown_ios.tcl type systemThe following example of the event manager policy command registers a user-defined policy named cron.tcl located in the user policy directory:
Router(config)# event manager policy cron.tcl type userRelated Commands
event manager run
To manually run a registered Embedded Event Manager (EEM) policy, use the event manager run command in global configuration mode.
event manager run policy-filename
Syntax Description
Defaults
No registered EEM policies are run.
Command Modes
Global configuration
Command History
Usage Guidelines
EEM usually schedules and runs policies on the basis of an event specification that is contained within the policy itself. The event manager run command allows policies to be run manually. Before this command is used, the event none command must be configured in applet configuration for the specified policy to indicate to EEM that the policy is to be run manually.
This command does not have a no form.
Examples
The following example of the event manager run command manually runs an EEM policy named policy_manual.tcl:
Router(config)# event manager run policy-manual.tclRelated Commands
event manager scheduler policy suspend
To immediately suspend Embedded Event Manager (EEM) policy scheduling execution, use the event manager scheduler policy suspend command in global configuration mode. To resume EEM policy scheduling, use the no form of this command.
event manager scheduler policy suspend
no event manager scheduler policy suspend
Syntax Description
This command has no arguments or keywords.
Defaults
Policy scheduling is active.
Command Modes
Global configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
Use the event manager scheduler policy suspend command to suspend all policy scheduling requests and do no scheduling until you enter the no form of the command. The no form of the command resumes policy scheduling and executes any pending policies.
You might want to suspend policy execution immediately instead of unregistering policies one by one for the following reasons:
•
For security—if you think the security of your system has been compromised.
•
Examples
The following example of the event manager scheduler suspend command disables policy scheduling:
Router(config)# event manager scheduler policy suspendMay 19 14:31:22.439: fm_server[12330]: %HA_EM-6-FMS_POLICY_EXEC: fh_io_msg: Policy execution has been suspendedThe following example of the event manager scheduler suspend command enables policy scheduling:
Router(config)# no event manager scheduler policy suspendMay 19 14:31:40.449: fm_server[12330]: %HA_EM-6-FMS_POLICY_EXEC: fh_io_msg: Policy execution has been resumedRelated Commands
event manager scheduler script
To set the Embedded Event Manager (EEM) script scheduling options, use the event manager scheduler script command in global configuration mode. To remove the EEM script scheduling options and restore the default value, use the no form of this command.
event manager scheduler script thread class default default-number
no event manager scheduler script thread class default default-number
Syntax Description
Defaults
Only one EEM policy can be run at a time.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the event manager scheduler script command if you want more than one EEM policy to run concurrently.
Examples
The following example shows how to specify two script execution threads to run concurrently:
Router(config)# event manager scheduler script thread class default 2event manager session cli username
To associate a username with Embedded Event Manager (EEM) policies that use the command-line interface (CLI) library, use the event manager session cli username command in global configuration mode. To remove the username association with EEM policies that use the CLI library, use the no form of this command.
event manager session cli username username
no event manager session cli username username
Syntax Description
Defaults
No username is associated with EEM CLI sessions.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the event manager session cli username command to assign a username for EEM policy CLI sessions when TACACS+ is used for command authorization.
If you are using authentication, authorization, and accounting (AAA) security and implement authorization on a command basis, you should use the event manager session cli username command to set a username to be associated with a Tool Command Language (Tcl) session. The username is used when a Tcl policy executes a CLI command. TACACS+ verifies each CLI command using the username associated with the Tcl session that is running the policy. Commands from Tcl policies are not usually verified because the router must be in privileged EXEC mode to register the policy.
Examples
The following example of the event manager session cli username command associates the username eemuser with EEM CLI sessions initiated by EEM policies:
Router(config)# event manager session cli username finance1Related Commands
show event manager session cli username
Displays the username associated with CLI sessions initiated by EEM policies that use the EEM CLI library.
event none
To specify that an Embedded Event Manager (EEM) policy is to be registered with the EEM and can be run manually, use the event none command in applet configuration mode. To remove the event none command from the configuration file, use the no form of this command.
event none policy-filename
no event none policy-filename
Syntax Description
Defaults
No EEM policies are specified to be run manually.
Command Modes
Applet configuration
Command History
Usage Guidelines
EEM usually schedules and runs policies on the basis of an event specification that is contained within the policy itself. The event none command allows EEM to identify an EEM policy that can either be run manually or be run when an EEM applet is triggered. To run the policy, use either the action policy command in applet configuration mode or the event manager run command in global configuration mode.
Examples
The following example shows how to register a policy named manual-policy to be run manually and then how to execute the policy:
Router(config)# event manager applet manual-policyRouter(config-applet)# event none manual-policyRouter(config-applet)# exitRouter(config)# event manager run manual-policyRelated Commands
event oir
To specify that an Embedded Event Manager (EEM) applet be run on the basis of an event raised when a hardware card online insertion and removal (OIR) occurs, use the event oir command in applet configuration mode. To remove the event oir command from the configuration, use the no form of this command.
event oir
no event oir
Syntax Description
This command has no arguments or keywords.
Defaults
No EEM applets are run on the basis of an OIR event.
Command Modes
Applet configuration
Command History
Examples
The following example shows how to configure an EEM applet to be run on the basis of an OIR event:
Router(config)# event manager applet oir-eventRouter(config-applet)# event oirRouter(config-applet)# exitRelated Commands
event manager applet
Registers an EEM applet with EEM and enters applet configuration mode.
event snmp
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run by sampling Simple Network Management Protocol (SNMP) object identifier values, use the event snmp command in applet configuration mode. To remove the SNMP event criteria, use the no form of this command.
event snmp oid oid-value get-type {exact | next} entry-op operator entry-val entry-value [entry-type {value | increment | rate}] [exit-comb {or | and}] [exit-op operator] [exit-val exit-value] [exit-type {value | increment | rate}] [exit-time exit-time-value] [exit-event
{true | false}] [average-factor average-factor-value] poll-interval poll-int-valueno event snmp oid oid-value get-type {exact | next} entry-op operator entry-val entry-value [entry-type {value | increment | rate}] [exit-comb {or | and}] [exit-op operator] [exit-val exit-value] [exit-type {value | increment | rate}] [exit-time exit-time-value] [exit-event
{true | false}] [average-factor average-factor-value] poll-interval poll-int-valueSyntax Description
Defaults
No EEM events are triggered on the basis of SNMP object identifier values.
Command Modes
Applet configuration
Command History
Usage Guidelines
An EEM event is triggered when one of the fields specified by an SNMP object ID crosses a defined threshold. If multiple conditions exist, the SNMP event will be triggered when all the conditions are met.
Exit criteria are optional. If exit criteria are not specified, event monitoring will be reenabled immediately. If exit criteria are specified—on the basis of values or time periods—event monitoring is not reenabled until the criteria are met.
Examples
The following example shows how an EEM applet called memory-fail will run when there is an exact match on the value of a specified SNMP object ID that represents the amount of current process memory. A message saying that process memory is exhausted and noting the current available memory will be sent to syslog.
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 1.0 syslog msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message saying that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incRelated Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event syslog
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run by matching syslog messages, use the event syslog command in applet configuration mode. To remove the syslog message event criteria, use the no form of this command.
event syslog pattern regular-expression [occurs num-occurrences] [period period-value] [priority priority-level] [severity-level]
no event syslog pattern regular-expression [occurs num-occurrences] [period period-value] [priority priority-level] [severity-level]
Syntax Description
Defaults
No EEM events are triggered on the basis of matches with syslog messages.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the event syslog command to set up event criteria against which syslog messages are matched. Syslog messages are compared against a specified regular expression. After a specified number of matches occurs within a specified time period, an EEM event is triggered. If multiple conditions exist, the EEM event is triggered when all the conditions are met.
Examples
The following example shows how to specify an EEM applet to run when syslog identifies that Ethernet interface 1/0 is down. The applet sends a message about the interface to syslog.
Router(config)# event manager applet interface-downRouter(config-applet)# event syslog pattern {.*UPDOWN.*Ethernet1/0.*} occurs 4Router(config-applet)# action 1.0 syslog msg "Ethernet interface 1/0 is down"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
event timer
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of time-specific events, use the event timer command in applet configuration mode. To remove the time-specific event criteria, use the no form of this command.
event timer {absolute time time-value | countdown time time-value | cron cron-entry cron-entry | watchdog time time-value} [name timer-name]
no event timer {absolute time time-value | countdown time time-value | cron cron-entry cron-entry | watchdog time time-value} [name timer-name]
Syntax Description
Defaults
No EEM events are triggered on the basis of time-specific events.
Command Modes
Applet configuration
Command History
12.2(25)S
This command was introduced.
12.3(14)T
This command was integrated into Cisco IOS Release 12.3(14)T.
Usage Guidelines
Instead of the five fields of a UNIX crontab entry as described in the syntax description table for the cron-entry argument, one of the following seven special strings can be entered:
•
•
•
•
•
•
•
A CRON timer may not produce the intended result if the time-of-day clock is not set to the correct time. Network Time Protocol (NTP) services can be used to facilitate keeping an accurate time-of-day clock setting. For more details on NTP configuration, see the "Performing Basic System Management" chapter of the Cisco IOS Configuration Fundamentals and Network Management Configuration Guide,
Release 12.3.Examples
The following example shows how to specify that an event is triggered one time after five hours:
Router(config)# event manager applet timer-absoluteRouter(config-applet)# event timer absolute time 18000The following example shows how to specify that an event is triggered once after six minutes and six milliseconds:
Router(config)# event manager applet timer-setRouter(config-applet)# event timer countdown time 360.006 name six-minutesThe following example shows how to specify that an event is triggered at 1:01 a.m. on January 1 each year:
Router(config)# event manager applet timer-cron1Router(config-applet)# event timer cron cron-entry 1 1 1 1 * name Jan1The following example shows how to specify that an event is triggered at noon on Monday through Friday of every week:
Router(config)# event manager applet timer-cron2Router(config-applet)# event timer cron cron-entry 0 12 * * 1-5 name MonFriThe following example shows how to specify that an event is triggered at midnight on Sunday every week:
Router(config)# event manager applet timer-cron3Router(config-applet)# event timer cron cron-entry @weekly name SundayThe following example shows how to specify that an event is triggered every five hours:
Router(config)# event manager applet timer-watchRouter(config-applet)# event timer watchdog time 18000Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
exception core-file
To specify the name of the core dump file, use the exception core-file command in global configuration mode. To return to the default core filename, use the no form of this command.
exception core-file filename
no exception core-file
Syntax Description
Defaults
The core file is named hostname-core, where hostname is the name of the router.
Command Modes
Global configuration
Command History
Usage Guidelines
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core file. If the router's memory is larger than 16 MB, the whole core file will not be copied to the server. Therefore, use rcp or FTP to dump the core file.
Caution
Examples
In the following example, the router is configured to use FTP to dump a core file named dumpfile to the FTP server at 172.17.92.2 when it crashes:
Router(config)# ip ftp username redRouter(config)# ip ftp password blueRouter(config)# exception protocol ftpRouter(config)# exception dump 172.17.92.2Router(config)# exception core-file dumpfileRelated Commands
exception crashinfo buffersize
To change the size of the buffer used for crashinfo files, use the exception crashinfo buffersize command in global configuration mode. To revert to the default buffer size, use the no form of this command.
exception crashinfo buffersize kilobytes
no exception crashinfo buffersize kilobytes
Syntax Description
kilobytes
Sets the size of the buffersize to the specified value within the range of 32 to 100 kilobytes. The default is 32KB.
Defaults
Crashinfo buffer is 32KB.
Command Modes
Global configuration
Command History
12.2(4)T, 12.2(11)
This command was introduced for the Cisco 3600 series only (3620, 2640, and 3660 platforms).
12.2(13)T
This command was implemented in 6400-NSP images.
Usage Guidelines
The crashinfo file saves information that helps Cisco technical support representatives to debug problems that caused the Cisco IOS image to fail (crash). The switch writes the crash information to the console at the time of the failure, and the file is created the next time you boot the Cisco IOS image after the failure (instead of while the system is failing).
Examples
In the following example, the crashinfo buffer is set to 100 KB:
Router(config)# exception crashinfo buffersize 100Related Commands
exception crashinfo file
Enables the creation of a diagnostic file at the time of unexpected system shutdowns.
exception crashinfo dump
To specify the type of output information to be written to the crashinfo file, use the exception crashinfo dump command in global configuration mode. To remove this information from the crashinfo file, use the no form of this command.
exception crashinfo dump {command cli | garbage-detector}
no exception crashinfo dump {command cli | garbage-detector}
Syntax Description
Defaults
This command is disabled by default.
If a router crashes due to low memory, the output from the following Cisco IOS commands is written to the crashinfo file by default:
•
•
•
•
If the exception crashinfo dump garbage-detector command is enabled, the output from the show memory debug leaks summary command is also written to the crashinfo file by default.
Command Modes
Global configuration
Command History
Usage Guidelines
A benefit for using the exception crashinfo dump command is that it allows users to customize the crashinfo file to contain information that is relevant to their troubleshooting situation.
Examples
The following example shows how to specify that the output from the show interfaces command should be written to the crashinfo file:
exception crashinfo dump command show interfacesRelated Commands
exception crashinfo file
To enable the creation of a diagnostic file at the time of unexpected system shutdowns, use the exception crashinfo file command in global configuration mode. To disable the creation of crashinfo files, use the no form of this command.
exception crashinfo file device:filename
no exception crashinfo file device:filename
Syntax Description
device:filename
Specifies the flash device and file name to be used for storing the diagnostic information. The colon is required.
Defaults
Enabled
Command Modes
Global configuration
Command History
12.2(4)T, 12.2(11)
This command was introduced for the Cisco 3600 series only.
12.2(13)T
This command was implemented in 6400-NSP images.
Usage Guidelines
The "crashinfo" file saves information that helps Cisco technical support representatives to debug problems that caused the Cisco IOS image to fail (crash). The switch writes the crash information to the console at the time of the failure, and the file is created the next time you boot the IOS image after the failure (instead of while the system is failing). The filename will be filename_yyyymmdd-hhmmss, where y is year, m is month, d is date, h is hour, and s is seconds.
Examples
In the following example, a crashinfo file called "crashdata" will be created in the default flash memory device if a system crash occurs:
Router(config)# exception crashinfo file flash:crashinfoRelated Commands
exception crashinfo maximum files
To enable a Cisco IOS device to automatically delete old crashinfo files to help create space for writing new crashinfo files when a system crashes, use the exception crashinfo maximum files command in global configuration mode. To disable automatic deletion of crashinfo files, use the no form of this command.
exception crashinfo maximum files file-numbers
no exception crashinfo maximum files file-numbers
Syntax Description
file-numbers
The number of most recent crashinfo files across all file systems in the device to be preserved when crashinfo files are being deleted automatically. The value ranges from 0 to 32.
Defaults
This command is disabled by default.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is effective only when a device crashes. If the value of the file-number argument is given as zero (0), none of the old crashinfo files will be preserved and all the old crashinfo files will be deleted across all file systems when the crashinfo files are being deleted automatically.
While booting a device, the default file is bootflash. If the file system does not have free space equivalent to or more than 250 KB, the system will display a warning. You can verify the available disk space and create free space for writing the crashinfo files.
Examples
The following example shows how to enable a Cisco IOS device this feature to automatically delete old crashinfo files to help create space for writing new crashinfo files when a system crashes. In this example, the device is configured to preserve the 22 most recent crashinfo files from previous crashinfo collections.
Router(config)# exception crashinfo maximum files 22Related Commands
exception crashinfo buffersize
Changes the size of the crashinfo buffer.
exception crashinfo file
Creates a diagnostic file at the time of unexpected system shutdown.
exception dump
To configure the router to dump a core file to a particular server when the router crashes, use the exception dump command in global configuration mode. To disable core dumps, use the no form of this command.
exception dump ip-address
no exception dump
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Caution
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core file. If the router's memory is larger than 16 MB, the whole core file will not be copied to the server. Therefore, use rcp or FTP to dump the core file.
The core dump is written to a file named hostname-core on your server, where hostname is the name of the router. You can change the name of the core file by configuring the exception core-file command.
This procedure can fail for certain types of system crashes. However, if successful, the core dump file will be the size of the memory available on the processor (for example, 16 MB for a CSC/4).
Examples
In the following example, a user configures a router to use FTP to dump a core file to the FTP server at 172.17.92.2 when it crashes:
Router(config)# ip ftp username redRouter(config)# ip ftp password blueRouter(config)# exception protocol ftpRouter(config)# exception dump 172.17.92.2Router(config)# exception core-file dumpfileRelated Commands
exception linecard
To enable storing of crash information for a line card and optionally specify the type and amount of information stored, use the exception linecard command in global configuration mode. To disable the storing of crash information for the line card, use the no form of this command.
exception linecard {all | slot slot-number} [corefile filename | main-memory size [k | m] | queue-ram size [k | m] | rx-buffer size [k | m] | sqe-register-rx | sqe-register-tx | tx-buffer size [k | m]]
no exception linecard
Syntax Description
Defaults
No crash information is stored for the line card.
If enabled with no options, the default is to store 256 MB of main memory.
Command Modes
Global configuration
Command History
11.2 GS
This command was introduced for Cisco 12000 series Gigabit Switch Routers (GSRs).
Usage Guidelines
Use caution when enabling the exception linecard global configuration command. Enabling all options could cause a large amount (150 to 250 MB) of crash information to be sent to the server.
Caution
Examples
In the following example, the user enables the storing of crash information for line card 8. By default, 256 MB of main memory is stored.
Router(config)# exception linecard slot 8exception memory
To set free memory and memory block size threshold parameters, use the exception memory command in global configuration mode. To disable this functionality, use the no form of this command.
exception memory {fragment [processor | io] size [interval 1] [reboot] | minimum [processor | io] size [reboot]}
no exception memory {fragment [processor | io] size [interval 1] [reboot] | minimum [processor | io] size [reboot]}
Syntax Description
Defaults
This command is disabled by default.
Command Modes
Global configuration
Command History
10.3
This command was introduced.
12.3(11)T
The following keywords were added:
•
•
•
•
Usage Guidelines
This command is used to troubleshoot memory leaks and memory fragmentation issues.
The free memory size is checked for every memory allocation. The largest memory block size is checked every 60 seconds by default. If the interval 1 keyword is configured, the largest memory block size is checked every 1 second.
When a memory size threshold is violated, the router will display an error message and create a crashinfo file. A core dump file will also be created if the exception dump command is configured. The router will not reload unless the reboot keyword is configured.
Caution
Examples
In the following example, the user configures the router to monitor the free memory. If the amount of free memory falls below 250,000 bytes, the router will create a crashinfo file and core dump file and reload.
Router(config)# exception dump 131.108.92.2Router(config)# exception core-file memory.overrunRouter(config)# exception memory minimum 250000 rebootRelated Commands
exception memory ignore overflow
To configure the Cisco IOS software to correct corruption in memory block headers and allow a router to continue its normal operation, use the exception memory ignore overflow command in global configuration mode. To disable memory overflow correction, use the no form of this command.
exception memory ignore overflow {io | processor} [frequency time-gap] [maxcount corrections]
no exception memory ignore overflow {io | processor} [frequency time-gap] [maxcount corrections]
Syntax Description
Defaults
The default is to allow the memory overflow correction once every 10 seconds, and for memory overflow corrections to happen an unlimited number of times.
Command Modes
Global configuration
Command History
12.3(7)T
This command was introduced.
12.2(25)S
This feature was integrated into Cisco IOS Release 12.2(25)S.
Usage Guidelines
Use this command to improve device availability when software faults are detected in the network. You can configure the frequency and the maximum number of memory overflow corrections. If overflow correction is required more often than the configured value, a software forced reload is triggered because a severe system problem is indicated.
Examples
The following example shows how to set a maximum of five processor memory block header corruption corrections to occur every 30 seconds:
exception memory ignore overflow processor frequency 30 maxcount 5Related Commands
show memory overflow
Displays the details of a memory block header corruption correction.
exception protocol
To configure the protocol used for core dumps, use the exception protocol command in global configuration mode. To configure the router to use the default protocol, use the no form of this command.
exception protocol {ftp | rcp | tftp}
no exception protocol
Syntax Description
ftp
Uses FTP for core dumps.
rcp
Uses rcp for core dumps.
tftp
Uses TFTP for core dumps. This is the default.
Defaults
TFTP
Command Modes
Global configuration
Command History
Usage Guidelines
Caution
If you use TFTP to dump the core file to a server, the router will only dump the first 16 MB of the core file. If the router's memory is larger than 16 MB, the whole core file will not be copied to the server. Therefore, use rcp or FTP to dump the core file.
Examples
In the following example, the user configures a router to use FTP to dump a core file to the FTP server at 172.17.92.2 when it crashes:
Router(config)# ip ftp username redRouter(config)# ip ftp password blueRouter(config)# exception protocol ftpRouter(config)# exception dump 172.17.92.2Related Commands
exception region-size
To specify the size of the region for the exception-time memory pool, use the exception region-size command in global configuration mode. To use the default region size, use the no form of this command.
exception region-size size
no exception region-size
Syntax Description
Defaults
16,384 bytes
Command Modes
Global configuration
Command History
Usage Guidelines
Caution
The exception region-size command is used to define a small amount of memory to serve as a fallback pool when the processor memory pool is marked corrupt. The exception memory command must be used to allocate memory to perform a core dump.
Examples
In the following example, the region size is set at 1024:
Router(config)# exception region-size 1024Related Commands
exception spurious-interrupt
To configure the router to create a core dump and reload after a specified number of spurious interrupts, use the exception spurious-interrupt command in global configuration mode. To disable the core dump and reload, use the no form of this command.
exception spurious-interrupt [number]
no exception spurious-interrupt
Syntax Description
number
(Optional) A number from 1 to 4294967295 that indicates the maximum number of spurious interrupts to include in the core dump before reloading.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Caution
If you use TFTP to dump the core dump file to a server, the router will only dump the first 16 MB of the file. If the router's memory is larger than 16 MB, the whole core file will not be copied to the server. Therefore, use rcp or FTP to dump the core file.
Examples
In the following example, the user configures a router to create a core dump with a limit of two spurious interrupts:
Router(config)# exception spurious-interrupt 2Related Commands
exec
To allow an EXEC process on a line, use the exec command in line configuration mode. To turn off the EXEC process for the specified line, use the no form of this command.
exec
no exec
Syntax Description
This command has no arguments or keywords.
Defaults
The EXEC processes is enabled on all lines.
Command Modes
Line configuration
Command History
Usage Guidelines
When you want to allow only an outgoing connection on a line, use the no exec command.
The no exec command allows you to disable the EXEC process for connections which may attempt to send unsolicited data to the router. (For example, the control port of a rack of modems attached to an auxiliary port of router.) When certain types of data are sent to a line connection, an EXEC process can start, which makes the line unavailable.
When a user tries to Telnet to a line with the EXEC process disabled, the user will get no response when attempting to log on.
Examples
The following example disables the EXEC process on line 7.
Router(config)# line 7Router(config-line)# no execexec-banner
To reenable the display of EXEC and message-of-the-day (MOTD) banners on the specified line or lines, use the exec-banner command in line configuration mode. To suppress the banners on the specified line or lines, use the no form of this command.
exec-banner
no exec-banner
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled on all lines
Command Modes
Line configuration
Command History
Usage Guidelines
This command determines whether the router will display the EXEC banner and the message-of-the-day (MOTD) banner when an EXEC session is created. These banners are defined with the banner exec and banner motd global configuration commands. By default, these banner are enabled on all lines. Disable the EXEC and MOTD banners using the no exec-banner command.
This command has no effect on the incoming banner, which is controlled by the banner incoming command.
The MOTD banners can also be disabled by the no motd-banner line configuration command, which disables MOTD 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 30 summarizes the effects of the exec-banner command and the motd-banner command.
Table 30 Banners Displayed Based On exec-banner and motd-banner Combinations
MOTD banner
EXEC banner
None
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 31 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections.
Examples
The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4:
Router(config)# line vty 0 4Router(config-line)# no exec-bannerRelated Commands
exec-character-bits
To configure the character widths of EXEC and configuration command characters, use the exec-character-bits command in line configuration mode. To restore the default value, use the no form of this command.
exec-character-bits {7 | 8}
no exec-character-bits
Syntax Description
7
Selects the 7-bit character set. This is the default.
8
Selects the full 8-bit character set for use of international and graphical characters in banner messages, prompts, and so on.
Defaults
7-bit ASCII character set
Command Modes
Line configuration
Command History
Usage Guidelines
Setting the EXEC character width to 8 allows you to use special graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can cause failures. If a user on a terminal that is sending parity enters the help command, an "unrecognized command" message appears because the system is reading all 8 bits, and the eighth bit is not needed for the help command.
Note
Examples
The following example enables full 8-bit international character sets, except for the console, which is an ASCII terminal. It illustrates use of the default-value exec-character-bits global configuration command and the exec-character-bits line configuration command.
Router(config)# default-value exec-character-bits 8Router(config)# line 0Router(config-line)# exec-character-bits 7Related Commands
exec-timeout
To set the interval that the EXEC command interpreter waits until user input is detected, use the exec-timeout command in line configuration mode. To remove the timeout definition, use the no form of this command.
exec-timeout minutes [seconds]
no exec-timeout
Syntax Description
minutes
Integer that specifies the number of minutes. The default is 10 minutes.
seconds
(Optional) Additional time intervals in seconds.
Defaults
10 minutes
Command Modes
Line configuration
Command History
Usage Guidelines
If no input is detected during the interval, the EXEC facility resumes the current connection. If no connections exist, the EXEC facility returns the terminal to the idle state and disconnects the incoming session.
To specify no timeout, enter the exec-timeout 0 0 command.
Examples
The following example sets a time interval of 2 minutes, 30 seconds:
Router(config)# line consoleRouter(config-line)# exec-timeout 2 30The following example sets a time interval of 10 seconds:
Router(config)# line consoleRouter(config-line)# exec-timeout 0 10execute-on
To execute commands on a line card, use the execute-on command in privileged EXEC mode.
execute-on {slot slot-number | all | master} command
Syntax Description
Command Modes
Privileged EXEC
Command History
11.2 GS
This command was introduced to support Cisco 12000 series Gigabit Switch Routers.
11.3(2)AA
This command was implemented in images for the Cisco AS5800 series.
Usage Guidelines
Use this command to execute a command on one or all line cards to monitor and maintain information on one or more line cards (for example, a line card in a specified slot on a dial shelf). This allows you to issue commands remotely; that is, to issue commands without needing to log in to the line card directly. The all form of the command allows you to issue commands to all the line cards without having to log in to each in turn.
Though this command does not have a no form, note that it is possible to use the no form of the remotely executed commands used in this command.
Tips
Cisco 12000 GSR Guidelines and Restrictions
You can use the execute-on privileged EXEC command only from Cisco IOS software running on the GRP card.
Timesaver
Cisco AS5800 Guidelines and Restrictions
The purpose of the command is to conveniently enable certain commands to be remotely executed on the dial shelf cards from the router without connecting to each line card. This is the recommended procedure, because it avoids the possibility of adversely affecting a good configuration of a line card in the process. The execute-on command does not give access to every Cisco IOS command available on the Cisco AS5800 access server. In general, the purpose of the execute-on command is to provide access to statistical reports from line cards without directly connecting to the dial shelf line cards.
Caution
Using this command makes it possible to accumulate inputs for inclusion in the show tech-support command.
The master form of the command can run a designated command remotely on the router from the DSC card. However, using the console on the DSC is not recommended. It is used for technical support troubleshooting only.
The show tech-support command for each dial shelf card is bundled into the router shelf's show tech-support command via the execute-on facility.
The execute-on command also support interactive commands such as the following:
router: execute-on slave slot slot pingThe execute-on command has the same limitations and restrictions as a vty telnet client has; that is, it cannot reload DSC using the following command:
router: execute-on slave slot slot reloadYou can use the execute-on command to enable remote execution of the commands included in the following partial list:
•
•
•
•
•
•
•
•
Examples
In the following example, the user executes the show controllers command on the line card in slot 4 of a Cisco 12000 series GSR:
Router# execute-on slot 4 show controllers========= Line Card (Slot 4) =======Interface POS0Hardware is BFLC POSlcpos_instance struct 6033A6E0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000400SUNI rsop intr status 00CRC16 enabled, HDLC enc, int clockno loopInterface POS1Hardware is BFLC POSlcpos_instance struct 6033CEC0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000600SUNI rsop intr status 00CRC32 enabled, HDLC enc, int clockno loopInterface POS2Hardware is BFLC POSlcpos_instance struct 6033F6A0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000800SUNI rsop intr status 00CRC32 enabled, HDLC enc, int clockno loopInterface POS3Hardware is BFLC POSlcpos_instance struct 60341E80RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000A00SUNI rsop intr status 00CRC32 enabled, HDLC enc, ext clockno loopRouter#Related Commands
attach
Connects you to a specific line card for the purpose of executing commands using the Cisco IOS software image on that line card.
exit (EXEC)
To close an active terminal session by logging off the router, use the exit command in EXEC mode.
exit
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Usage Guidelines
Use the exit command in EXEC mode to exit the active session (log off the device). This command can be used in any EXEC mode (such as User EXEC mode or Privileged EXEC mode) to exit from the EXEC process.
Examples
In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the exit (EXEC) command is used to log off (exit the active session):
Router(config)# exitRouter# disableRouter> exitRelated Commands
exit (global)
To exit any configuration mode to the next highest mode in the CLI mode hierarchy, use the exit command in any configuration mode.
exit
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
All configuration modes
Command History
Usage Guidelines
The exit command is used in the Cisco IOS CLI to exit from the current command mode to the next highest command mode in the CLI mode hierarchy.
For example, use the exit command in global configuration mode to return to privileged EXEC mode. Use the exit command in interface, line, or router configuration mode to return to global configuration mode. Use the exit command in subinterface configuration mode to return to interface configuration mode. At the highest level, EXEC mode, the exit command will exit the EXEC mode and disconnect from the router interface (see the description of the exit (EXEC) command for details).
Examples
The following example shows how to exit from the subinterface configuration mode and to return to the interface configuration mode:
Router(config-subif)# exitRouter(config-if)#The following example displays an exit from the interface configuration mode to return to the global configuration mode:Router(config-if)# exitRouter(config)#Related Commands
disconnect
Disconnects a line.
end
Ends your configuration session by exiting to privileged EXEC mode.
exit (EXEC)
Closes the active terminal session by logging off the router.
file prompt
To specify the level of prompting, use the file prompt command in global configuration mode.
file prompt [alert | noisy | quiet]
Syntax Description
alert
(Optional) Prompts only for destructive file operations. This is the default.
noisy
(Optional) Confirms all file operation parameters.
quiet
(Optional) Seldom prompts for file operations.
Defaults
alert
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to change the amount of confirmation needed for different file operations.
This command affects only prompts for confirmation of operations. The router will always prompt for missing information.
Examples
The following example configures confirmation prompting for all file operations:
Router(config)# file prompt noisyfile verify auto
To enable automatic image verification, use the file verify auto command in global configuration mode. To disable automatic image verification, use the no form of this command.
file verify auto
no file verify auto
Syntax Description
This command has no arguments or keywords.
Defaults
Image verification is not automatically applied to all images that are copied or reloaded onto a router.
Command Modes
Global configuration
Command History
Usage Guidelines
Image verification allows users to automatically verify the integrity of all Cisco IOS images. Thus, users can be sure that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user.
The file verify auto command enables image verification globally; that is, all images that are to be copied (via the copy command) or reloaded (via the reload command) are automatically verified. Although both the copy and reload commands have a /verify keyword that enables image verification, you must issue the keyword each time you want to copy or reload an image. The file verify auto command enables image verification by default so you no longer have to specify image verification multiple times.
If you have enabled image verification by default but prefer to disable verification for a specific image copy or reload, the /noverify keyword along with either the copy or the reload command will override the file verify auto command.
Examples
The following example shows how to enable automatic image verification:
Router(config)# file verify autoRelated Commands
copy
Copies any file from a source to a destination.
reload
Reloads the operating system.
filter-for-history
To define the type of information kept in the history table for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the filter-for-history command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode. To return to the default value, use the no form of this command.
filter-for-history {none | all | overThreshold | failures}
no filter-for-history {none | all | overThreshold | failures}
Syntax Description
Defaults
No IP SLAs history is kept for an operation.
Command Modes
IP SLA Monitor Configuration
DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
Frame Relay configuration (config-sla-monitor-frameRelay)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
VoIP configuration (config-sla-monitor-voip)RTR Configuration
DHCP configuration (config-rtr-dhcp)
DLSw configuration (config-rtr-dlsw)
DNS configuration (config-rtr-dns)
Frame Relay configuration (config-rtr-frameRelay)
FTP configuration (config-rtr-ftp)
HTTP configuration (config-rtr-http)
ICMP echo configuration (config-rtr-echo)
ICMP path echo configuration (config-rtr-pathEcho)
ICMP path jitter configuration (config-rtr-pathJitter)
TCP connect configuration (config-rtr-tcp)
UDP echo configuration (config-rtr-udp)
Note
Command History
Usage Guidelines
Use the filter-for-history command to control what gets stored in the history table for an IP SLAs operation. To control how much history gets saved in the history table, use the lives-of-history-kept, buckets-of-history-kept, and the samples-of-history-kept commands.
Note
An IP SLAs operation can collect history and capture statistics. By default, the history for an IP SLAs operation is not collected. If history is collected, each history bucket contains one or more history entries from the operation. When the operation type is ICMP path echo, an entry is created for each hop along the path that the operation takes to reach its destination. The type of entry stored in the history table is controlled by the filter-for-history command. The total number of entries stored in the history table is controlled by the combination of the samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept commands.
Note
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 32). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the filter-for-history command varies depending on the Cisco IOS release you are running (see Table 32) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP echo operation type is configured, you would enter the filter-for-history command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.
Examples
In the following examples, only operation packets that fail are kept in the history table. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 32).
IP SLA Monitor Configuration
ip sla monitor 1type echo protocol ipIcmpEcho 172.16.161.21lives-of-history-kept 1filter-for-history failures!ip sla monitor schedule 1 life forever start-time nowRTR Configuration
rtr 1type echo protocol ipIcmpEcho 172.16.161.21lives-of-history-kept 1filter-for-history failures!rtr schedule 1 life forever start-time nowRelated Commands
format
To format a Class A, Class B, or Class C Flash file system, use the format command in EXEC mode.
Class B and Class C Flash File Systems
format filesystem1:
Class A Flash File System
format [spare spare-number] filesystem1: [[filesystem2:][monlib-filename]]
Caution
Syntax Description
Command Default
None
Command Modes
EXEC
Command History
11.0
This command was introduced.
12.3(14)T
Support for Class B Flash (USB Flash and USB eToken) File Systems was added.
Usage Guidelines
Use this command to format Class A, B, or C Flash memory file systems.
In some cases, you might need to insert a new PCMCIA Flash memory card and load images or backup configuration files onto it. Before you can use a new Flash memory card, you must format it.
Sectors in Flash memory cards can fail. Reserve certain Flash memory sectors as "spares" by using the optional spare argument on the format command to specify 0 to 16 sectors as spares. If you reserve a small number of spare sectors for emergencies, you can still use most of the Flash memory card. If you specify 0 spare sectors and some sectors fail, you must reformat the Flash memory card, thereby erasing all existing data.
The monlib file is the ROM monitor library. The ROM monitor uses this file to access files in the Flash file system. The Cisco IOS system software contains a monlib file.
In the command syntax, filesystem1: specifies the device to format and filesystem2: specifies the optional device containing the monlib file used to format filesystem1:. If you omit the optional filesystem2: and monlib-filename arguments, the system formats filesystem1: using the monlib file already bundled with the system software. If you omit only the optional filesystem2: argument, the system formats filesystem1: using the monlib file from the device you specified with the cd command. If you omit only the optional monlib-filename argument, the system formats filesystem1: using the filesystem2: monlib file. When you specify both arguments—filesystem2: and monlib-filename—the system formats filesystem1: using the monlib file from the specified device. You can specify filesystem1:'s own monlib file in this argument. If the system cannot find a monlib file, it terminates its formatting.
Note
Examples
The following example formats a Flash memory card inserted in slot 0:
Router# format slot0:Running config file on this device, proceed? [confirm]yAll sectors will be erased, proceed? [confirm]yEnter volume id (up to 31 characters): <Return>Formatting sector 1 (erasing)Format device slot0 completedWhen the console returns to the EXEC prompt, the new Flash memory card is formatted and ready for use.
Related Commands
format (bulkstat)
To specify the format to be used for the bulk statistics data file, use the format command in Bulk Statistics Transfer configuration mode. To disable a previously configured format specification and return to the default, use the no form of this command.
format {bulkBinary | bulkASCII | schemaASCII}
no format {bulkBinary | bulkASCII | schemaASCII}
Syntax Description
bulkBinary
Binary format.
bulkASCII
ASCII (human-readable) format.
schemaASCII
ASCII format with additional bulk statistics schema tags.
Defaults
The default bulk statistics transfer format is SchemaASCII.
Command Modes
Bulk Statistics Transfer configuration (config-bulk-tr)
Command History
Usage Guidelines
Note
The bulk statistics data file (VFile) contains two types of fields: tags and data. Tags are used to set-off data so as to distinguish portions (fields) of the file. All other information is in data fields.
For the BulkASCII and BulkBinary formats, data for a single data group (object list) can be collected more than once into the same bulk statistics data file (VFile) due to periodic polling. Each such instance of a data group can be treated as different "table" types.
Every object and table tag contains an additional sysUpTime field. Similarly each row tag contains the value of the sysUpTime when the data for that row was collected. This provides for a way to time-stamp the data.
For additional information on the structure of the bulk statistics data file formats, see the definitions in the CISCO-DATA-COLLECTION-MIB.
Examples
In the following example, the bulk statistics data file is set to be SchemaASCII:
Router(config)# snmp mib bulkstat transfer bulkstat1Router(config-bulk-tr)# schema ATM2/0-IFMIBRouter(config-bulk-tr)# url primary ftp://user:pswrd@host/folder/bulkstat1Router(config-bulk-tr)# format schemaASCIIRouter(config-bulk-tr)# exitRelated Commands
snmp mib bulkstat transfer
Names a bulk statistics transfer configuration and enters Bulk Statistics Transfer configuration mode.
frequency (IP SLA)
To set the rate at which a specified IP Service Level Agreements (SLAs) operation repeats, use the frequency command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode. To return to the default value, use the no form of this command.
frequency seconds
no frequency
Syntax Description
Defaults
60 seconds
Command Modes
IP SLA Monitor Configuration
DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
Frame Relay configuration (config-sla-monitor-frameRelay)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)
VoIP configuration (config-sla-monitor-voip)RTR Configuration
DHCP configuration (config-rtr-dhcp)
DLSw configuration (config-rtr-dlsw)
DNS configuration (config-rtr-dns)
Frame Relay configuration (config-rtr-frameRelay)
FTP configuration (config-rtr-ftp)
HTTP configuration (config-rtr-http)
ICMP echo configuration (config-rtr-echo)
ICMP path echo configuration (config-rtr-pathEcho)
ICMP path jitter configuration (config-rtr-pathJitter)
TCP connect configuration (config-rtr-tcp)
UDP echo configuration (config-rtr-udp)
UDP jitter configuration (config-rtr-jitter)
Note
Command History
Usage Guidelines
A single IP SLAs operation will repeat at a given frequency for the lifetime of the operation. For example, a User Datagram Protocol (UDP) jitter operation with a frequency of 60 sends a collection of data packets (simulated network traffic) once every 60 seconds, for the lifetime of the operation. The default simulated traffic for a UDP jitter operation consists of ten packets sent 20 milliseconds apart. This "payload" is sent when the operation is started, then is sent again 60 seconds later.
If an individual IP SLAs operation takes longer to execute than the specified frequency value, a statistics counter called "busy" is incremented rather than immediately repeating the operation.
The value specified for the frequency command cannot be less than the value specified for the timeout command.
Note
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 33). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the frequency command varies depending on the Cisco IOS release you are running (see Table 33) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP echo operation type is configured, you would enter the frequency command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.
Examples
The following examples show how to configure an IP SLAs ICMP echo operation (operation 10) to repeat every 90 seconds. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 33).
IP SLA Monitor Configuration
ip sla monitor 10type echo protocol ipIcmpEcho 172.16.1.175frequency 90!ip sla monitor schedule 10 life 300 start-time after 00:05:00RTR Configuration
rtr 10type echo protocol ipIcmpEcho 172.16.1.175frequency 90!rtr schedule 10 life 300 start-time after 00:05:00Related Commands
fsck
To check a File Allocation Table (FAT)-based disk or Class C filesystem for damage and to repair any problems, use the fsck command in privileged EXEC mode.
fsck [/nocrc] filesystem: [/automatic]
Syntax Description
Defaults
If the /automatic keyword is not used, CLI prompts for actions are issued.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command will perform all of the steps necessary to remove corrupted files and reclaim unused disk space. Changes include checking for incorrect file sizes, cluster loops, and so on. The default form of this command will issue multiple prompts to confirm each of the changes. However, you can skip these prompts by using the /automatic keyword when issuing the command.
When the /automatic keyword is used you will prompted to confirm that you want the automatic option. Prompts for actions will be skipped, but all actions performed will be displayed to the terminal (see the example below).
This command works with ATA PCMCIA cards formatted in DOS, or for Class C Flash file systems.
Note
Examples
The following example shows sample output from using the fsck command in automatic mode:
Router# fsck /automatic disk1:Proceed with the automatic mode? [yes] yChecking the boot sector and partition table...Checking FAT, Files and Directories...Start cluster of file disk1:/file1 is invalid, removing fileFile disk1:/file2 has a free/bad cluster, truncating...File disk1:/file2 truncated.File disk1:/file3 has a free/bad cluster, truncating...File disk1:/file3 truncated.File disk1:/file4 has a invalid cluster, truncating...File disk1:/file4 truncated.File disk1:/file5 has a invalid cluster, truncating...File disk1:/file5 truncated.File disk1:/file6 has a invalid cluster, truncating...File disk1:/file6 truncated.File size of disk1:/file7 is not correct, correcting itFile disk1:/file8 cluster chain has a loop, truncating itFile disk1:/file8 truncated.File disk1:/file9 cluster chain has a loop, truncating itFile disk1:/file9 truncated.File disk1:/file16 has a free/bad cluster, truncating...File disk1:/file16 truncated.File disk1:/file20 has a free/bad cluster, truncating...File disk1:/file20 truncated.Reclaiming unused space...Created file disk1:/fsck-4 for an unused cluster chainCreated file disk1:/fsck-41 for an unused cluster chainCreated file disk1:/fsck-73 for an unused cluster chainCreated file disk1:/fsck-106 for an unused cluster chainCreated file disk1:/fsck-121 for an unused cluster chainCreated file disk1:/fsck-132 for an unused cluster chainCreated file disk1:/fsck-140 for an unused cluster chainCreated file disk1:/fsck-156 for an unused cluster chainCreated file disk1:/fsck-171 for an unused cluster chainCreated file disk1:/fsck-186 for an unused cluster chainCreated file disk1:/fsck-196 for an unused cluster chainCreated file disk1:/fsck-235 for an unused cluster chainCreated file disk1:/fsck-239 for an unused cluster chainUpdating FAT...fsck of disk1: completefull-help
To get help for the full set of user-level commands, use the full-help command in line configuration mode.
full-help
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Usage Guidelines
The full-help command enables (or disables) an unprivileged user to see all of the help messages available. It is used with the show ? command.
Examples
In the following example, the show ? command is used first with full-help disabled. Then full-help is enabled for the line, and the show ? command is used again to demonstrate the additional help output that is displayed.
Router> show ?bootflash Boot Flash informationcalendar Display the hardware calendarclock Display the system clockcontext Show context informationdialer Dialer parameters and statisticshistory Display the session command historyhosts IP domain-name, lookup style, nameservers, and host tableisdn ISDN informationkerberos Show Kerberos Valuesmodemcap Show Modem Capabilities databaseppp PPP parameters and statisticsrmon rmon statisticssessions Information about Telnet connectionssnmp snmp statisticsterminal Display terminal configuration parametersusers Display information about terminal linesversion System hardware and software statusRouter> enablePassword:<letmein>Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# line console 0Router(config-line)# full-helpRouter(config-line)# exitRouter#%SYS-5-CONFIG_I: Configured from console by consoleRouter# disableRouter> show ?access-expression List access expressionaccess-lists List access listsaliases Display alias commandsapollo Apollo network informationappletalk AppleTalk informationarp ARP tableasync Information on terminal lines used as router interfacesbootflash Boot Flash informationbridge Bridge Forwarding/Filtering Database [verbose]bsc BSC interface informationbstun BSTUN interface informationbuffers Buffer pool statisticscalendar Display the hardware calendar...translate Protocol translation informationttycap Terminal capability tablesusers Display information about terminal linesversion System hardware and software statusvines VINES informationvlans Virtual LANs Informationwhoami Info on current tty linex25 X.25 informationxns XNS informationxremote XRemote statisticsRelated Commands
help
To display a brief description of the help system, use the help command in any command mode.
help
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
User EXEC
Privileged EXEC
All configuration modes
Command History
Usage Guidelines
The help command provides a brief description of the context-sensitive help system, which functions as follows:
•
•
•
Examples
In the following example, the help command is used to display a brief description of the help system:
Router# helpHelp may be requested at any point in a command by enteringa question mark '?'. If nothing matches, the help list willbe empty and you must backup until entering a '?' shows theavailable options.Two styles of help are provided:1. Full help is available when you are ready to enter acommand argument (e.g. 'show ?') and describes each possibleargument.2. Partial help is provided when an abbreviated argument is enteredand you want to know what arguments match the input(e.g. 'show pr?'.)The following example shows how to use word help to display all the privileged EXEC commands that begin with the letters "co." The letters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command.
Router# co?configure connect copyRouter# coThe following example shows how to use command syntax help to display the next argument of a partially complete access-list command. One option is to add a wildcard mask. The <cr> symbol indicates that the other option is to press Enter to execute the command without adding any more keywords or arguments. The characters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command or to execute that command as it is.
Router(config)# access-list 99 deny 131.108.134.234 ?A.B.C.D Mask of bits to ignore<cr>Router(config)# access-list 99 deny 131.108.134.234Related Commands
hidekeys
To suppress the display of password information in configuration log files, use the hidekeys command in configuration change logger configuration mode. To allow the display of password information in configuration log files, use the no form of this command.
hidekeys
no hidekeys
Syntax Description
This command has no arguments or keywords.
Defaults
Password information is displayed.
Command Modes
Configuration change logger configuration
Command History
12.3(4)T
This command was introduced.
12.2(25)S
This command was integrated into Cisco IOS Release 12.2(25)S.
Usage Guidelines
Enabling the hidekeys command increases security by preventing password information from being displayed in configuration log files.
Examples
The following example shows how to prevent password information from being displayed in configuration log files:
Router(config-archive-log-config)# hidekeysRelated Commands
history
To enable the command history function, use the history command in line configuration mode. To disable the command history function, use the no form of this command.
history
no history
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled with ten command lines in the buffer.
Command Modes
Line configuration
Command History
Usage Guidelines
The command history function provides a record of EXEC commands that you have entered. This function is particularly useful for recalling long or complex commands or entries, including access lists.
To change the number of command lines that the system will record in its history buffer, use the history size line configuration command.
The history command enables the history function with the last buffer size specified or, if there was not a prior setting, with the default of ten lines. The no history command disables the history function.
The show history EXEC command will list the commands you have entered, but you can also use your keyboard to display individual commands. Table 34 lists the keys you can use to recall commands from the command history buffer.
Table 34 History Keys
Ctrl-P or Up Arrow1
Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
Ctrl-N or Down Arrow1
Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands.
1 The arrow keys function only with ANSI-compatible terminals.
Examples
In the following example, the command history function is disabled on line 4:
Router(config)# line 4Router(config-line)# no historyRelated Commands
history size
To change the command history buffer size for a particular line, use the history size command in line configuration mode. To reset the command history buffer size to ten lines, use the no form of this command.
history size number-of-lines
no history size
Syntax Description
number-of-lines
Specifies the number of command lines that the system will record in its history buffer. The range is from 0 to 256. The default is 10.
Defaults
10 command lines
Command Modes
Line configuration
Command History
Usage Guidelines
The history size command should be used in conjunction with the history and show history commands. The history command enables or disables the command history function. The show history command lists the commands you have entered in the current EXEC session. The number of commands that the history buffer will show is set by the history size command.
Note
Examples
The following example displays line 4 configured with a history buffer size of 35 lines:
Router(config)# line 4Router(config-line)# history size 35Related Commands
hold-character
To define the local hold character used to pause output to the terminal screen, use the hold-character command in line configuration mode. To restore the default, use the no form of this command.
hold-character ascii-number
no hold-character
Syntax Description
Defaults
No hold character is defined.
Command Modes
Line configuration
Command History
Usage Guidelines
The Break character is represented by zero; NULL cannot be represented. To continue the output, enter any character after the hold character. To use the hold character in normal communications, precede it with the escape character. See the "ASCII Character Set" appendix for a list of ASCII characters.
Examples
The following example sets the hold character to Ctrl-S, which is ASCII decimal character 19:
Router(config)# line 8Router(config-line)# hold-character 19Related Commands
terminal hold-character
Sets or changes the hold character for the current session.
hops-of-statistics-kept
To set the number of hops for which statistics are maintained per path for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the hops-of-statistics-kept command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode. To return to the default value, use the no form of this command.
hops-of-statistics-kept size
no hops-of-statistics-kept
Syntax Description
Defaults
16 hops
Command Modes
IP SLA Monitor Configuration
ICMP path echo configuration (config-sla-monitor-pathEcho)
RTR Configuration
ICMP path echo configuration (config-rtr-pathEcho)
Note
Command History
Usage Guidelines
When the number of hops reaches the size specified, no further hop-based information is stored.
Note
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 35). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the hops-of-statistics-kept command varies depending on the Cisco IOS release you are running (see Table 35) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP path echo operation type is configured, you would enter the hops-of-statistics-kept command in ICMP path echo configuration mode (config-sla-monitor-pathEcho) within IP SLA monitor configuration mode.
Examples
The following examples show how to monitor the statistics of IP SLAs ICMP path echo operation 2 for ten hops only. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 35).
IP SLA Monitor Configuration
ip sla monitor 2type pathecho protocol ipIcmpEcho 172.16.1.177hops-of-statistics-kept 10!ip sla monitor schedule 2 life forever start-time nowRTR Configuration
rtr 2type pathecho protocol ipIcmpEcho 172.16.1.177hops-of-statistics-kept 10!rtr schedule 2 life forever start-time nowRelated Commands
hostname
To specify or modify the host name for the network server, use the hostname command in global configuration mode.
hostname name
Syntax Description
Defaults
The default host name is Router.
Command Modes
Global configuration
Command History
Usage Guidelines
The host name is used in prompts and default configuration filenames.
Do not expect case to be preserved. Uppercase and lowercase characters look the same to many internet software applications. It may seem appropriate to capitalize a name the same way you might do in English, but conventions dictate that computer names appear all lowercase. For more information, refer to RFC 1178, Choosing a Name for Your Computer.
The name must also follow the rules for ARPANET host names. They must start with a letter, end with a letter or digit, and have as interior characters only letters, digits, and hyphens. Names must be 63 characters or fewer. A host name of less than 10 characters is recommended. For more information, refer to RFC 1035, Domain Names—Implementation and Specification.
On most systems, a field of 30 characters is used for the host name and the prompt in the CLI. Note that the length of your host name may cause longer configuration mode prompts to be truncated. For example, the full prompt for service profile configuration mode is:
(config-service-profile)#However, if you are using the host-name of "Router", you will only see the following prompt (on most systems):
Router(config-service-profil)#If the hostname is longer, you will see even less of the prompt:
Basement-rtr2(config-service)#Keep this behavior in mind when assigning a name to your system (using the hostname global configuration command). If you expect that users will be relying on mode prompts as a CLI navigation aid, you should assign host names of no more than nine characters.
Examples
The following example changes the host name to "sandbox":
Router(config)# hostname sandboxsandbox(config)#Related Commands
hours-of-statistics-kept
To set the number of hours for which statistics are maintained for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the hours-of-statistics-kept command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode. To return to the default value, use the no form of this command.
hours-of-statistics-kept hours
no hours-of-statistics-kept
Syntax Description
Defaults
2 hours
Command Modes
IP SLA Monitor Configuration
DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
Frame Relay configuration (config-sla-monitor-frameRelay)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)
VoIP configuration (config-sla-monitor-voip)RTR Configuration
DHCP configuration (config-rtr-dhcp)
DLSw configuration (config-rtr-dlsw)
DNS configuration (config-rtr-dns)
Frame Relay configuration (config-rtr-frameRelay)
FTP configuration (config-rtr-ftp)
HTTP configuration (config-rtr-http)
ICMP echo configuration (config-rtr-echo)
ICMP path echo configuration (config-rtr-pathEcho)
ICMP path jitter configuration (config-rtr-pathJitter)
TCP connect configuration (config-rtr-tcp)
UDP echo configuration (config-rtr-udp)
UDP jitter configuration (config-rtr-jitter)
Note
Command History
Usage Guidelines
When the number of hours exceeds the specified value, the statistics table wraps (that is, the oldest information is replaced by newer information).
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 36). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the hours-of-statistics-kept command varies depending on the Cisco IOS release you are running (see Table 36) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP echo operation type is configured, you would enter the hours-of-statistics-kept command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.
Examples
The following examples show how to maintain 3 hours of statistics for IP SLAs ICMP path echo operation 2. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 36).
IP SLA Monitor Configuration
ip sla monitor 2type pathecho protocol ipIcmpEcho 172.16.1.177hours-of-statistics-kept 3!ip sla monitor schedule 2 life forever start-time nowRTR Configuration
rtr 2type pathecho protocol ipIcmpEcho 172.16.1.177hours-of-statistics-kept 3!rtr schedule 2 life forever start-time nowRelated Commands
http-raw-request
To explicitly specify the options for a GET request for a Cisco IOS IP Service Level Agreements (SLAs) Hypertext Transfer Protocol (HTTP) operation, use the http-raw-request command in the appropriate submode of IP SLA monitor configuration or RTR configuration mode.
http-raw-request
Syntax Description
This command has no arguments or keywords.
Defaults
No options are specified for a GET request.
Command Modes
IP SLA Monitor Configuration
HTTP configuration (config-sla-monitor-http)
RTR Configuration
HTTP configuration (config-rtr-http)
Note
Command History
Usage Guidelines
Use the http-raw-request command to explicitly specify the content of an HTTP request. Use HTTP version 1.0 commands after entering the http-raw-request command.
IP SLAs will specify the content of an HTTP request if you use the type http operation get command. IP SLAs will send the HTTP request, receive the reply, and report round-trip time (RTT) statistics (including the size of the page returned).
IP SLAs Operation Configuration Dependence on Cisco IOS Release
The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 37). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.
The configuration mode for the http-raw-request command varies depending on the Cisco IOS release you are running (see Table 37) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the HTTP operation type is configured, you would enter the http-raw-request command in HTTP configuration mode (config-sla-monitor-http) within IP SLA monitor configuration mode.
Examples
In the following examples, IP SLAs operation 6 is created and configured as an HTTP operation. The HTTP GET command is explicitly specified. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 37).
IP SLA Monitor Configuration
ip sla monitor 6type http operation raw url http://www.cisco.comhttp-raw-requestGET /index.html HTTP/1.0\r\n\r\n!ip sla monitor schedule 6 start-time nowRTR Configuration
rtr 6type http operation raw url http://www.cisco.comhttp-raw-requestGET /index.html HTTP/1.0\r\n\r\n!rtr schedule 6 start-time nowRelated Commands
insecure
To configure a line as insecure, use the insecure command in line configuration mode. To disable this function, use the no form of this command.
insecure
no insecure
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Usage Guidelines
Use this command to identify a modem line as insecure for DEC local area transport (LAT) classification.
Examples
In the following example, line 10 is configured as an insecure dialup line:
Router(config)# line 10Router(config-line)# insecureinstance
To configure the MIB object instances to be used in a bulk statistics schema, use the instance command in Bulk Statistics Schema configuration mode. To remove an SNMP bulk statistics object list, use the no form of this command.
instance {exact | wild} {interface interface-id [sub-if] | controller controller-id [sub-if] | oid OID}
no instance {exact | wild} {interface interface-id [sub-if] | controller controller-id [sub-if] | oid OID}
Syntax Description
Defaults
If the sub-if keyword is not used, the subinterfaces of the interface or controller will not be polled.
Command Modes
Bulk Statistics Schema configuration (config-bulk-sc)
Command History
Usage Guidelines
The instance command specifies the instance information for objects in the schema being configured. The specific instances of MIB objects for which data should be collected are determined by appending the value of the instance command to the objects specified in the associated object list. In other words, the schema object-list when combined with the schema instance specifies a complete MIB object identifier (OID).
The instance exact command indicates that the specified instance, when appended to the object list, is the complete OID.
The instance wild command indicates that all subindices of the specified OID belong to this schema. In other words, the wild keyword allows you to specify a partial, "wild carded" instance.
Instead of specifying an OID, you can specify a specific interface. The interface interface-id keyword and argument allow you to specify an interface name and number (for example, Ethernet 0) instead of specifying the ifIndex OID for the interface. Similarly, the controller controller-id syntax allows you to specify a controller interface.
The optional sub-if keyword, when added after specifying an interface or controller, includes the ifIndexes for all sub-interfaces of the interface you specified.
Only one instance command can be configured per schema.
Examples
In the following example, the user configures the router to collect bulk statistics for the ifInOctets object (from the IF-MIB) for the Ethernet interface 3/0. In this example, 3 is the ifIndex instance for interface Ethernet3/0. The instance (3) when combined with the object list (ifIndex; 1.3.6.1.2.1.2.2.1.1) translates to the OID 1.3.6.1.2.1.2.2.1.1.3.
Router# configure terminalRouter(config)# snmp mib bulkstat object-list E0InOctets! The following command specifies the object 1.3.6.1.2.1.2.2.1.1.3 (ifIndex)Router(config-bulk-objects)# add ifIndexRouter(config-bulk-objects)# exitRouter(config)# snmp mib bulkstat schema E0Router(config-bulk-sc)# object-list EOInOctets! The following command is equivalent to "instance exact oid 3".Router(config-bulk-sc)# instance exact interface Ethernet 3/0Router(config-bulk-sc)# exitRouter(config)# snmp mib bulkstat transfer bulkstat1Router(config-bulk-tr)# schema E0Router(config-bulk-tr)# url primary ftp://user:password@host/ftp/user/bulkstat1Router(config-bulk-tr)# url secondary tftp://user@host/tftp/user/bulkstat1Router(config-bulk-tr)# format schemaASCIIRouter(config-bulk-tr)# transfer-interval 30Router(config-bulk-tr)# retry 5Router(config-bulk-tr)# enableRouter(config-bulk-tr)# exitRouter(config)# do copy running-config startup-configRelated Commands
instance (resource group)
To add RUs to a specified resource group, use the instance command in resource group configuration mode. To disable this function, use the no form of this command.
instance instance-name
no instance instance-name
Syntax Description
instance-name
Name of the RU you want to add to the resource group (for example, http, snmp, and so on).
Command Default
Disabled
Command Modes
Resource group configuration
Command History
Usage Guidelines
Before adding RUs to a resource group, you must create a resource group using the user group resource-group-name type resource-user-type command in ERM configuration mode.
For example, say you have created a resource group with the name lowPrioUsers and iosprocess as the type. You have some low-priority RUs or tasks like HTTP and SNMP, and you want to set a threshold for all the low-priority RUs together, not separately. You must add the RUs to the resource group using the instance instance-name command and then apply a resource policy. If the resource policy you applied sets a minor rising threshold value of 10% for the resource group, then when the accumulated usage of both HTTP and SNMP RUs crosses 10%, a notification is sent to the RUs in the resource group lowPrioUsers. That is, if HTTP usage is 4% and SNMP usage is 7%, then a notification is sent to the resource group. This facility helps to set thresholds for a group of RUs, as it is difficult to set thresholds for every single RU individually.
Examples
The following example shows how to add HTTP RU to a resource group named lowPrioUsers:
Router(config-erm)# user group lowPrioUsers type iosprocessRouter(config-res-group)# instance httpRelated Commands
policy (resource group)
Applies a policy to all the RUs in the resource group.
user (ERM)
Creates a resource group.
international
If you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji) and print the Escape character as a single character instead of as the caret and bracket symbols (^[), use the international command in line configuration mode. To display characters in 7-bit format, use the no form of this command.
international
no international
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Usage Guidelines
If you are configuring a Cisco IOS platform using the Cisco web browser user interface (UI), this function is enabled automatically when you enable the Cisco web browser UI using the ip http server global configuration command.
Examples
The following example enables a Cisco IOS platform to display 8-bit and multibyte characters and print the Escape character as a single character instead of as the caret and bracket symbols (^[) when you are using Telnet to access the platform:
line vty 4internationalRelated Commands
ip address dynamic
To discover a customer premises equipment (CPE) router's IP address dynamically based on an aggregator router's IP address, use the ip address dynamic command in Frame Relay DLCI interface configuration mode. To disable this request, use the no form of this command.
ip address dynamic
no ip address dynamic
Syntax Description
This command has no arguments or keywords.
Defaults
No IP address discovery request is made.
Command Modes
Frame Relay DLCI interface configuration
Command History
12.3(2)XF
This command was introduced.
12.3(8)T
This command was integrated into Cisco IOS Release 12.3(8)T.
Usage Guidelines
When you enter the ip address dynamic command, the CPE router sends an Inverse Address Resolution Protocol (ARP) request to the aggregator router asking for the IP address of its interface. The aggregator router replies with its own subinterface's IP address. The CPE router then calculates a valid IP address and a suitable netmask for its subinterface based on the data received from the aggregator router. The aggregator router is polled at regular intervals. If the IP address on the aggregator router's interface changes, the CPE router's IP address will adjust as necessary.
You can check the assigned IP address by entering the show interface command and specifying the subinterface being configured.
Note
Examples
The following example shows how to configure serial interface 1 to run Frame Relay. Its subinterface is then configured to discover the IP address using the ip address dynamic command.
interface Serial 1encapsulation frameinterface serial 1.1 point-to-pointframe-relay interface-dlci 100ip address dynamicRelated Commands
ip bootp server
To enable the Bootstrap Protocol (BOOTP) service on your routing device, use the ip bootp server command in global configuration mode. To disable BOOTP services, use the no form of the command.
ip bootp server
no ip bootp server
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Global configuration
Command History
Usage Guidelines
By default, the BOOTP service is enabled. When disabled, the no ip bootp server command will appear in the configuration file.
The integrated Dynamic Host Configuration Protocol (DHCP) server was introduced in Cisco IOS Release 12.0(1)T. Because DHCP is based on BOOTP, both of these services share the "well-known" UDP server port of 67 (per RFC 951, RFC 1534, and RFC 2131; the client port is 68). To disable DHCP services (DHCP relay and DHCP server), use the no service dhcp command. To disable BOOTP services (in releases 12.2(8)T and later), but leave DHCP services enabled, use the ip dhcp bootp ignore command.
If both the BOOTP server and DHCP server are disabled, "ICMP port unreachable" messages will be sent in response to incoming requests on port 67, and the original incoming packet will be discarded. If DHCP is enabled, using the no ip bootp server command by itself will not stop the router from listening on UDP port 67.
Note
Any network device that has User Data Protocol (UDP), TCP, BOOTP, DHCP, or Finger services should be protected by a firewall or have the services disabled to protect against Denial of Service attacks.Examples
In the following example, BOOTP and DHCP services are disabled on the router:
Router(config)# no ip bootp serverRouter(config)# no service dhcpRelated Commands
ip director cache refresh
To enable the Distr
