Page 1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x First Published: 2011-12-01 Last Modified: 2012-06-01 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883...
Page 2 Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.
Page 3: Table Of Contents
Hierarchical Correlation Context Correlation Flag Duration Timeout Flags Reparent Flag Reissue Nonbistate Flag Internal Rules SNMP Alarm Correlation How to Implement and Monitor Alarm Management and Logging Correlation Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 4 C H A P T E R 2 Prerequisites for Configuring and Managing Embedded Event Manager Policies Information About Configuring and Managing Embedded Event Manager Policies Event Management System Event Detection Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 5 How to Write Embedded Event Manager Policies Using Tcl Registering and Defining an EEM Tcl Script Displaying EEM Registered Policies Unregistering EEM Policies Suspending EEM Policy Execution Managing EEM Policies Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 6 Sample Policy Tracing Tcl set Command Operations: Example Additional References Embedded Event Manager Policy Tcl Command Extension Reference Embedded Event Manager Event Registration Tcl Command Extensions event_register_appl Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 7 Embedded Event Manager Multiple Event Support Tcl Command Extensions Attribute Correlate Trigger Embedded Event Manager Action Tcl Command Extensions action_process action_program action_script action_setver_prior action_setnode action_syslog action_track_read Embedded Event Manager Utility Tcl Command Extensions appl_read appl_reqinfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 8 SMTP Library Command Extensions smtp_send_email smtp_subst CLI Library Command Extensions cli_close cli_exec cli_get_ttyname cli_open cli_read cli_read_drain cli_read_line cli_read_pattern cli_write Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x viii...
Page 9 Configuring and Scheduling a Basic UDP Jitter Operation on the Source Device Configuring and Scheduling a UDP Jitter Operation with Additional Characteristics Configuring the IP SLA for a UDP Echo Operation Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 10 Generating Events for Consecutive Violations Generating Events for X of Y Violations Generating Events for Averaged Violations Specifying Reaction Events Configuring the MPLS LSP Monitoring Instance on a Source PE Router Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 11 UNIX Syslog Daemon Configuration Archiving Logging Messages on a Local Storage Device Setting Archive Attributes Archive Storage Directories Severity Levels Logging History Table Syslog Message Severity Level Definitions Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 12 How to Implement OBFL Enabling or Disabling OBFL Configuring Message Severity Levels Monitoring and Maintaining OBFL Clearing OBFL Data Configuration Examples for OBFL Enabling and Disabling OBFL: Example Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 13 Enabling and Disabling PM Statistics Collection Templates Enabling PM Entity Instance Monitoring Creating PM Threshold Monitoring Templates Enabling and Disabling PM Threshold Monitoring Templates Configuration Examples for Implementing Performance Management Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x xiii...
Page 14 Contents Creating and Enabling PM Statistics Collection Templates: Example Creating and Enabling PM Threshold Monitoring Templates: Example Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 15: Obtaining Documentation And Submitting A Service Request
From Release 6.1.1 onwards, Cisco introduces support for the 64-bit Linux-based IOS XR operating system. Extensive feature parity is maintained between the 32-bit and 64-bit environments. Unless explicitly marked otherwise, the contents of this document are applicable for both the environments. For more details on Cisco IOS XR 64 bit, refer to the Release Notes for Cisco ASR 9000 Series Routers, Release 6.1.1 document.
Page 16 Preface Obtaining Documentation and Submitting a Service Request Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 17 This module describes the new and revised tasks you need to perform to implement logging correlation and monitor alarms on your network. For more information about system logging on Cisco IOS XR Software and complete descriptions of the Note alarm management and logging correlation commands listed in this module, see the...
Page 18: Prerequisites For Implementing And Monitoring Alarms And Alarm Log Correlation
ALDEMS enlarges on the basic logging and monitoring functionality of Cisco IOS XR Software, providing the level of alarm and event management necessary for a highly distributed system . Cisco IOS XR Software achieves this necessary level of alarm and event management by distributing logging applications across the nodes on the system.
Page 19: Correlator
When a correlation occurs, the correlated messages are stored in the logging correlation buffer. The correlator tags each set of correlated messages with a correlation ID. Note For more information about logging correlation, see the Logging Correlation, on page 4 section. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 20: System Logging Process
If the correlator receives a root message, the correlator stores it in the logging correlator buffer and forwards it to the syslog process on the RP. From there, the syslog process forwards the root message to the alarm Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 21: Types Of Correlation
When a correlation rule is configured and applied, the correlator starts searching for a message match as specified in the rule. After a match is found, the correlator starts a timer corresponding to the timeout interval Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 22: Alarm Severity Level And Filtering
Bistate alarm events are reported to the logging events buffer by default; informational and debug messages are not. Cisco IOS XR Software software provides the ability to reset and clear alarms. Clients interested in monitoring alarms in the system can register with the alarm logging mechanism to receive asynchronous notifications when a monitored alarm changes state.
Page 23: Capacity Threshold Setting For Alarms
This flag causes behavior change only if the rule is applied to one or more contexts. It does not go into effect if the rule is applied to the entire router or location nodes. The following is a scenario of context correlation behavior: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 24: Duration Timeout Flags
Active bistate non-root-causes are always forwarded in this situation, because the condition is still present. The reissue-nonbistate flag allows you to control whether non-bistate alarms are forwarded. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 25: Configuring Logging Correlation Rules
In large-scale systems, such as Cisco IOS XR multi-chassis system , there may be situations when you encounter many SNMP traps emitted at regular intervals of time. These traps, in turn, cause additional time in the Cisco IOS XR processing of traps.
Page 26: Configuring Logging Correlation Rule Sets
| detail ] Example: RP/0/RSP0/CPU0:router# show logging correlator rule all Configuring Logging Correlation Rule Sets This task explains how to configure logging correlation rule sets. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 27: Configuring Root-Cause And Non-Root-Cause Alarms
To correlate a root cause to one or more non-root-cause alarms and configure them to a rule, use the rootcause and nonrootcause commands specified for the correlation rule. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 28 Specifies a non-root-cause alarm message. • This command can be issued with the Example: nonrootcause command, such as RP/0/RSP0/CPU0:router(config-corr-rule-st-nonrc)# alarm CAT_BI_2 GROUP_BI_2 CODE_BI_2 nonrootcause alarm msg-category group-name msg-code Step 6 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 29: Configuring Hierarchical Correlation Rule Flags
{ type { stateful | Configures a logging correlation rule. nonstateful }} • Stateful correlations can change specifically if the root-cause alarm is bistate. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 30: Applying Logging Correlation Rules
When a rule is applied or if a rule set that contains this rule is applied, then the rule definition cannot be Note modified through the configuration until the rule or rule set is once again unapplied. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 31 ◦ The location of the node is specified in the format rack/slot/module. Example: • Applies a logging correlation rule to a specific context. RP/0/RSP0/CPU0:router(config-corr-apply-rule)# all-of-router RP/0/RSP0/CPU0:router(config-corr-apply-rule)# location 0/2/CPU0 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 32: Applying Logging Correlation Rule Sets
3. Do one of the following: • all-of-router • location node-id • context name 4. commit 5. show logging correlator ruleset { all | correlation-ruleset1 ... correlation-ruleset14 } [ detail | summary Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 33: Modifying Logging Events Buffer Settings
The appropriate settings depend on the configuration and requirements of the system. This task involves the following steps: • Modifying logging events buffer size Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 34 Example: • In this example, the alarm logger generates athreshold-crossing alarm notification when the event buffer reaches 85 percent of capacity. RP/0/RSP0/CPU0:router(config)# logging events threshold 85 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 35: Modifying Logging Correlator Buffer Settings
7. show logging correlator buffer { all-in-buffer [ ruletype [ nonstateful | stateful ]] | [ rulesource [ internal | user ]] | rule-name correlation-rule1...correlation-rule14 | correlationID correlation-id1..correlation-id14 } Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 36: Displaying Alarms By Severity And Severity Range
Example: RP/0/RSP0/CPU0:router# show logging correlator buffer all-in-buffer Displaying Alarms by Severity and Severity Range This task explains how to display alarms by severity and severity range. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 37 • In this example, alarms with a severity of critical (severity of 2) and alerts (severity of 1) are displayed. All other event severities Example: are omitted. RP/0/RSP0/CPU0:router# show logging events buffer severity-hi-limit alerts severity-lo-limit critical Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 38: Displaying Alarms According To A Time Stamp Range
: (Optional) Displays logging events with a time stamp before the mm : ss [ month ] [ day ] [ year ] specified time and date. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 39: Displaying Alarms According To Message Group And Message Code
(Optional) Displays logging events matching the specified message group. Example: • In this example, all events that contain the message group SONET are displayed. RP/0/RSP0/CPU0:router# show logging events buffer group SONET Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 40: Displaying Alarms According To A First And Last Range
• For the event-count argument, enter the number of events to be displayed. RP/0/RSP0/CPU0:router# show logging events buffer first 15 • In this example, the first 15 events in the logging events buffer are displayed. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 41: Displaying Alarms By Location
(Optional) Isolates the occurrence of the range of event IDs to a particular node. Example: • The location of the node is specified in the format rack/slot/module. RP/0/RSP0/CPU0:router# show logging events buffer 0/2/CPU0 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 42: Displaying Alarms By Event Record Id
(Optional) Narrows the range by specifying a high and low event-lo-limit event-id limit of event IDs to be displayed. Example: RP/0/RSP0/CPU0:router# show logging events buffer event-hi-limit 100 event-lo-limit 1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 43: Displaying The Logging Correlation Buffer Size, Messages, And Rules
Step 4 show logging correlator buffer rule-name correlation-rule (Optional) Displays specific messages matching a particular rule in the correlation buffer. Example: RP/0/RSP0/CPU0:router# show logging correlator buffer rule-name rule7 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 44: Clearing Alarm Event Records And Resetting Bistate Alarms
(with the show logging events buffer command). Note The commands can be entered in any order. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 45 (Optional) Deletes logging events from the logging events that have occurred on a particular node. Example: • The location of the node is specified in the format rack/slot/module. RP/0/RSP0/CPU0:router# clear logging events delete location 0/2/CPU0 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 46: Defining Snmp Correlation Buffer Size
Defining SNMP Correlation Buffer Size This task explains how to define correlation buffer size for SNMP traps. SUMMARY STEPS 1. configure 2. snmp-server correlator buffer-size bytes 3. commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 47: Defining Snmp Rulesets
1.2.3.4 host ipv4 address 2.3.4.5 port 182 Step 3 commit Configuring SNMP Correlation Rules This task explains how to configure SNMP correlation rules. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 48: Applying Snmp Correlation Rules
OIDs supported by IOS XR. Step 3 commit Applying SNMP Correlation Rules The purpose of this task is to apply the SNMP trap correlation rules to specific trap destinations. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 49: Applying Snmp Correlation Ruleset
Example: IP addresses and optional ports. RP/0/RSP0/CPU0:router# snmp-server correlator apply ruleset ruleset_1 host ipv4 address 1.2.3.4 host ipv4 address 2.3.4.5 port 182 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 50: Configuration Examples For Alarm Management And Logging Correlation
PLATFORM ALPHA_DISPLAY CHANGE logging correlator apply rule node_status all-of-router In this example, three similar messages are identified as forwarded to the syslog process simultaneously after a card boots: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 51 2 22:32:43 : invmgr[194]: %PLATFORM-INVMGR-6-NODE_STATE_CHANGE : Node: 0/1/CPU0, state: IOS XR RUN #12.2 :nodestatus:RP/0/0/CPU0:Aug 2 22:32:43 : sysldr[336]: %PLATFORM-SYSLDR-5-LC_ENABLED : LC in slot 1 is now running IOX Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 52: Example
#144 :46 :LC/0/7/CPU0:Jan 30 16:35:39 2004:ifmgr[130]: %PKT_INFRA-LINK-3-UPDOWN : Interface POS0/7/0/0, changed state to Down Only the first LINK UPDOWN root message is forwarded to the syslog process during the timeout interval. Note Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 53: Additional References
System Monitoring Command Reference Onboard Failure Logging (OBFL) configuration tasks Implementing Logging Services module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Command Reference Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 54 RFCs RFCs Title No new or modified RFCs are supported by this — feature, and support for existing RFCs has not been modified by this feature. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 55 Registered Cisco.com users can log in from this page to access even more content. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 56 Implementing and Monitoring Alarms and Alarm Log Correlation Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 57: Configuring And Managing Embedded Event Manager Policies
The Cisco IOS XR Software Embedded Event Manager (EEM) functions as the central clearing house for the events detected by any portion of the Cisco IOS XR Software processor failover services. The EEM is responsible for detection of fault events, fault recovery, and process reliability statistics in a Cisco IOS XR Software system.
Page 58: Prerequisites For Configuring And Managing Embedded Event Manager Policies
An event can be any significant occurrence (not limited to errors) that has happened within the system. The Cisco IOS XR Software EEM detects those events and implements appropriate responses. The EEM can also be used to prevent or contain faults and to assist in fault recovery.
Page 59: Policy-Based Event Response
A registered policy informs the EEM about a particular event to detect and the corrective action to take if that event is detected. When such an event is detected, the EEM runs the policy. You can disable a registered policy at any time. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 60: Embedded Event Manager Scripts And The Scripting Interface (Tcl)
{[info exists _config_cmd2]} { if [catch {cli_exec $cli1(fd) $_config_cmd2} result] { error $result $errorInfo append config_cmds "\n" append config_cmds $_config_cmd2 if [catch {cli_exec $cli1(fd) "end"} result] { error $result $errorInfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 61: Script Language
All Embedded Event Manager scripts are written in Tcl. This full Tcl implementation has been extended by Cisco, and an eem command has been added to provide the interface between Tcl scripts and the EEM. Tcl is a string-based command language that is interpreted at run time. The version of Tcl supported is Tcl version 8.3.4, plus added script support.
Page 62: Embedded Event Manager Callback Scripts
Tcl language to implement any action desired. EEM utility Tcl command extensions These Tcl command extensions are used to retrieve, save, set, or modify application information, counters, or timers. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 63: Cisco File Naming Convention For Embedded Event Manager
Cisco File Naming Convention for Embedded Event Manager All EEM policy names, policy support files (for example, e-mail template files), and library filenames are consistent with the Cisco file-naming convention. In this regard, EEM policy filenames adhere to the following specifications: •...
Page 64: Embedded Event Manager Built-In Actions
Send a short e-mail Sends the e-mail out using Simple Mail Transfer Protocol (SMTP). Set or modify a counter Modifies a counter value. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 65: Application-Specific Embedded Event Management
Application-defined events can be raised by a Cisco IOS XR Software component even when there are no subscribers. In this case, the EEM dismisses the event, which allows subscribers to receive application-defined events as needed.
Page 66: System Manager Event Detector
Occurs when a process matching the screening criteria Abnormal process termination EEM event—built in terminates abnormally. Process startup EEM event—built in Occurs when a process matching the screening criteria starts. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 67: Timer Services Event Detector
None Event Detector The None Event Detector publishes an event when the Cisco IOS XR Software event manager run CLI command executes an EEM policy. EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. An EEM policy must be identified and registered to be permitted to run manually before the event manager run command will execute.
Page 68: Watchdog System Monitor Event Detector
Cisco IOS XR Software version provides similar syntax with Cisco IOS EEM (refer to the applicable EEM Documentation for details), so scripts written using Cisco IOS EEM is run on Cisco IOS XR Software with minimum change.
Page 69: Distributed Event Detectors
Cisco IOS XR Software Modularity processes. Distributed Event Detectors Cisco IOS XR Software components that interface to EEM event detectors and that have substantially independent implementations running on a distributed hardware card should have a distributed EEM event detector.
Page 70: Process Reliability Metric Data
• Number of times started • Number of times ended normally • Number of times ended abnormally • Number of abnormal failures within the past 60 minutes Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 71: How To Configure And Manage Embedded Event Manager Policies
Recovery actions are triggered when the policy is run. Environment Variables By convention, the names of all environment variables defined by Cisco begin with an underscore character to set them apart; for example, _show_cmd. Spaces may be used in the var-value argument of the event manager environment command. The command interprets everything after the var-name argument to the end of the line to be part of the var-value argument.
Page 72: Registering Embedded Event Manager Policies
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. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 73 Tcl command arguments that make up the policy file. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 74 EEM policies can be registered. See the Configuring AAA Services module of Cisco ASR 9000 Series Aggregation Services Router System Security Configuration Guide for more information about AAA authorization configuration. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 75: How To Write Embedded Event Manager Policies Using Tcl
How to Write Embedded Event Manager Policies Using Tcl This section provides information on how to write and customize Embedded Event Manager (EEM) policies using Tool Command Language (Tcl) scripts to handle Cisco IOS XR Software faults and events. This section contains these tasks: Registering and Defining an EEM Tcl Script Perform this task to configure environment variables and register an EEM policy.
Page 76 • Use the persist-time keyword to specify the length of time the username authentication is valid. In this example, the sample EEM policy named tm_cli_cmd.tcl is registered as a system policy. Step 6 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 77: Displaying Eem Registered Policies
Displays information about currently registered policies. type ] [ system | user ] [ time-ordered | name-ordered • The event-type keyword displays the registered policies for a specific event type. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 78: Suspending Eem Policy Execution
RP/0/RSP0/CPU0:router# show event manager policy registered system • The name-ordered keyword displays the policies in alphabetical order by the policy name. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 79: Managing Eem Policies
Step 2 configure Step 3 event manager directory user {library path | policy Specifies a directory to use for storing user library files or path} user-defined EEM policies. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 80: Displaying Software Modularity Process Reliability Metrics Using Eem
The sample policies can be copied to a user directory and then modified. Tcl is currently the only scripting language supported by Cisco for policy creation. Tcl policies can be modified using a text editor such as Emacs. Policies must execute within a defined number of seconds of elapsed time, and the time variable can be configured within a policy.
Page 81 3. event manager directory user {library path | policy path} 4. event manager policy policy-name username username [persist-time [seconds | infinite] | type [system | user]] 5. commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 82: Programming Eem Policies With Tcl
Figure 2: Tcl Policy Structure and Requirements , on page 67. There are two parts of an EEM policy that are required: the event_register Tcl command extension Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 83 For a list of the available EEM event information Tcl command extensions, see the Embedded Event Manager Event Information Tcl Command Extension, on page 129. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 84: Eem Entry Status
When a policy finishes running its code, an exit value is set. The exit value is used by the EEM to determine whether or not to apply the default action for this event, if any. A value of zero means that the default action Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 85: Eem Policies And Cisco Error Number
EEM Policies and Cisco Error Number Some EEM Tcl command extensions set a Cisco Error Number Tcl global variable _cerrno. Whenever _cerrno is set, the other Tcl global variables are derived from _cerrno and are set along with it (_cerr_sub_num, _cerr_sub_err, _cerr_posix_err, and _cerr_str).
Page 86: Error Class Encodings For Xy
The first variable, XY, references the possible error class encodings shown in this table. Table 11: Error Class Encodings Error Return Value Error Class CERR_CLASS_SUCCESS CERR_CLASS_INFO CERR_CLASS_WARNING CERR_CLASS_FATAL An error return value of zero means SUCCESS. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 87 The following are valid Event Registration Tcl Command Extensions: • event_register_appl • event_register_counter • event_register_stat • event_register_wdsysmon • event_register_oir Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 88 • event_register_none Step 4 Add the appropriate namespace under Policy developers can use the new namespace ::cisco in Tcl policies to group all the ::cisco hierarchy. the extensions used by Cisco IOS XR EEM. There are two namespaces under the ::cisco hierarchy. The following are the namespaces and the EEM Tcl command extension categories that belongs under each namespace: •...
Page 89 Step 9 Set Cisco Error Number (_cerrno) Tcl Some EEM Tcl command extensions set a Cisco Error Number Tcl global variable global variables. _cerrno. Whenever _cerrno is set, four other Tcl global variables are derived from _cerrno and are set along with it (_cerr_sub_num, _cerr_sub_err, _cerr_posix_err, and _cerr_str).
Page 90: Creating An Eem User Tcl Library Index
Tcl files. This task allows you to test library support in EEM Tcl. In this task, a library directory is created to contain the Tcl library files, the files are copied into the directory, and an index tclIndex) is created that Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 91 {} { puts "In procedure test2" lib2.tcl proc test3 {} { puts "In procedure test3" Step 2 tclsh Enters the Tcl shell. Example: workstation% tclsh Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 92 "calling test1 failed result = $result $auto_path" if { [catch {test2} result]} { puts "calling test2 failed result = $result $auto_path" if { [catch {test3} result]} { Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 93: Creating An Eem User Tcl Package Index
If the index is not created, the Tcl packages are not found when an EEM policy that contains a package require Tcl command is run. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 94 Tcl files to be grouped together. Running the pkg_mkindex command in a directory determines which Tcl package file or files are indexed using a specific pkgIndex. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 95 Specifies the EEM user library directory; this is the directory to which the files in Step 4, on page 79were copied. Example: RP/0/RSP0/CPU0:router(config)# event manager directory user library disk2:/eem_library Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 96: Configuration Examples For Event Management Policies
RP/0/RSP0/CPU0:router#(config)# event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7 User-Defined Embedded Event Manager Policy Registration: Example This configuration registers a user-defined event management policy: RP/0/RSP0/CPU0:router# configure RP/0/RSP0/CPU0:router(config)# event manager policy cron.tcl username tom user Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 97: Display Available Policies: Example
1 number of times ended normally: 0 number of times ended abnormally: 0 most recent 10 process start times: -------------------------- Mon Sep 10 21:36:49 2007 -------------------------- Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 98: Configuration Examples For Writing Embedded Event Manager Policies Using Tcl
_email_to Address to which e-mail is sent. engineering@example.com _email_from Address from which e-mail is sent. devtest@example.com _email_cc Address to which the e-mail must manager@example.com be copied. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 99 Table 15: Environment Variables Used in the tm_crash_reporter.tcl Policy Environment Variable Description Example _crash_reporter_debug Value that identifies whether debug information for tm_crash_reporter.tcl will be enabled. This variable is optional and need not be specified. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 100: Registration Of Some Eem Policies
EEM environment variables, and this statement is used to establish the conditions under which the policy is run. If the environment variables are modified after the policy has been registered, the conditions Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 101: Basic Configuration Details For All Sample Policies
To allow e-mail to be sent from the Embedded Event Manager (EEM), the hostname and domain-name commands must be configured. The EEM environment variables must also be set. After a Cisco IOS XR Software image has been booted, use the following initial configuration, substituting appropriate values for your network.
Page 102: Running The Tm_Cli_Cmd.tcl Sample Policy
Another Perl CGI script, crash_report_display.cgi, has been created to display the information stored in the database created by the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 103: Running The Tm_Fsys_Usage.tcl Sample Policy
EEM Event Detector Demo: Example , on page tm_cli_cmd.tcl Sample Policy The following sample policy runs a configurable CRON entry. The policy executes a configurable Cisco IOS XR SoftwareCLI command and e-mails the results. An optional log file can be defined to which the output is appended with a time stamp.
Page 104 #_email_cc is an option, must set to empty string if not set. set _email_cc "" if {![info exists _show_cmd]} { set result \ "Policy cannot be run: variable _show_cmd has not been set" error $result $errorInfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 105 [info hostname] if {[string match "" $routername]} { error "Host name is not configured" if [catch {smtp_subst [file join $tcl_library email_template_cmd.tm]} \ result] { error $result $errorInfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 106: Sl_Intf_Down.tcl Sample Policy
$result $errorInfo if {![info exists _email_to]} { set result \ "Policy cannot be run: variable _email_to has not been set" error $result $errorInfo if {![info exists _email_cc]} { Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 107 The following e-mail template file is used with the preceding EEM sample policy: email_template_cfg.tm Mailservername: $_email_server From: $_email_from To: $_email_to Cc: $_email_cc Subject: From router $routername: Periodic $_show_cmd Output $cmd_output Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 108: Tracing Tcl Set Command Operations: Example
Getting Started Guide Information about user groups and task IDs Configuring AAA Services module in the Cisco ASR 9000 Series Aggregation Services Router System Security Configuration Guide Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 109: Embedded Event Manager Policy Tcl Command Extension Reference
Embedded Event Manager Policy Tcl Command Extension Reference This section documents the following EEM policy Tcl command extension categories: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 110: Embedded Event Manager Event Registration Tcl Command Extensions
The number is set to 798, because all other numbers are reserved for Cisco use. If this argument is not specified, all components are matched. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 111: Event_Register_Cli
CLI command. This will be implemented as a new process in IOS-XR which will be dlrsc_tracker. This ED will not do pattern match on admin commands of XR. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 112 The default action is to run the command. If this argument is not specified, the default time period is set to 30 seconds. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 113: Event_Register_Config
The queue_priority argument specifies the Note queuing priority, but not the execution priority, of the script being registered. If this argument is not specified, the default queuing priority is normal. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 114: Event_Register_Counter
(Mandatory) Value with which the current counter value should be compared, to decide if the counter event should be raised. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 115: Event_Register_Hardware
Registers for an environmental monitoring hardware device that is specified by the hardware event and condition. Syntax event_register_hardware env_device ? env_cond ? [priority normal|low|high] [maxrun_sec ?] [maxrun_nsec ?] [nice 0|1] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 116 • 0x0040 critical • 0x0100 pre-shutdown • 0x0200 shutdown priority (Optional) Priority level that the script is queued. If not specified, the default uses the normal priority. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 117: Event_Register_None
4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 118: Event_Register_Oir
1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. Result String None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 119: Event_Register_Process
Registers for a process event. Use this Tcl command extension to run a policy on the basis of an event raised when a Cisco IOS XR software modularity process starts or stops. These events are handled by the system manager event detector that screens for this event. This Tcl command extension is supported only in software modularity images.
Page 120 If an optional argument is not specified, the event matches all possible values of the argument. If multiple arguments are specified, the process event will be raised when all the conditions are matched. Result String None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 121: Event_Register_Snmp
OID is retrieved. entry_val (Mandatory) Value with which the current oid data value should be compared to decide if the SNMP event should be raised. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 122 (Optional) Value with which the current oid data value should be compared to decide if the exit criteria are met. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 123 The average-factor value is multiplied by the poll-interval value to derive the period in milliseconds. The minimum average factor value is Result string None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 124: Event_Register_Snmp_Notification
SNMP notification traps from all IP addresses. This option will not be supported in XR as src_ip_address is only for incoming trap which is not supported in EEM XR. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 125: Event_Register_Stat
• The second modifier of the data element corresponds to the modifier_2 argument. For example, input-ptks is defined as the second modifier for ifstats-generic, which further qualifies the interface statistics for the specific Ethernet interface is the number of packets received. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 126 (Mandatory) Value in which the current statistical counter value that is compared to decide if the statistical event can be raised. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 127 (Optional) When the nice argument is set to the value of 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 128: Event_Register_Syslog
(Optional) Number of occurrences before the event is raised; if not specified, the event is raised on the first occurrence. If specified, the value must be greater than 0. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 129 If multiple conditions are specified, the syslog event is raised when all the conditions are matched. Table 17: Severity Level Mapping For Syslog Events Severity Keyword Syslog Priority Description severity_fatal LOG_EMERG (0) System is unusable. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 130: Event_Register_Timer
Both the CRON and absolute time specifications work on local time. Syntax event_register_timer watchdog|countdown|absolute|cron [name ?] [cron_entry ?] [time ?] [queue_priority low|normal|high] [maxrun ?] [nice 0|1] Arguments watchdog (Mandatory) Watchdog timer. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 131 Configuring and Managing Embedded Event Manager Policies Embedded Event Manager Event Registration Tcl Command Extensions countdown (Mandatory) Countdown timer. absolute (Mandatory) Absolute timer. cron (Mandatory) CRON timer. name (Optional) Name of the timer. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 132 Configuring and Managing Embedded Event Manager Policies Embedded Event Manager Event Registration Tcl Command Extensions cron_entry Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 133 Monday. To specify days by only one field, the other field should be set to *; "0 0 * * 1" would trigger an event at midnight only on Mondays. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 134 The default value is 0. Table 18: Time and Date When CRON Events Will Be Triggered Field Allowed Values minute 0-59 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 135: Event_Register_Timer_Subscriber
The event timer depends on another policy or another process to actually manipulate the timer. For example, let policyB act as a timer subscriber policy, Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 136 The default value is 0. An EEM policy that registers for a timer event or a counter event can act as both publisher and subscriber. Note Result String None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 137 If any is specified, an event will be raised when the tracked object transitions to or from any state. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 138 The default value is 0. If an optional argument is not specified, the event matches all possible values of the argument. Result String None Set _cerrno Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 139 (Optional) Subevent 1 is specified. subevent-description (Optional) Syntax for the subevent. sub2 (Optional) Subevent 2 is specified. sub3 (Optional) Subevent 3 is specified. sub4 (Optional) Subevent 4 is specified. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 140 • For cpu_proc and cpu_tot, val must be an integer between 0 and 100, inclusive. • For mem_proc, mem_tot_avail, and mem_tot_used, if is_percent is FALSE, val must be an integer between 0 and 4294967295, inclusive. 1 deadlock procname ? Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 141 CPU usage sample percentage with the specified percentage value. If true, an event is raised. (Optional) Percentage value in which the average CPU usage during the sample period is compared. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 142 (Optional) Comparison operator that is used to compare the collected memory used with the specified value. If true, an event is raised. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 143 (Optional) If set to TRUE, the percentage value is collected and compared. Otherwise, the absolute value is collected and compared. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 144 0 and 999). If this argument is not specified, the most recent sample is used. Note This argument is mandatory if is_percent is set to TRUE; otherwise, it is optional. Result String None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 145: Embedded Event Manager Event Information Tcl Command Extension
Embedded Event Manager. sub_system Number assigned to the EEM policy that published the application event. Number is set to 798 because all other numbers are reserved for Cisco use. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 146 ASCII string that represents the name of the event for this event type. event_pub_secevent_pub_msec Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 147 Number assigned to the EEM policy that published the application-specific event. Number is set to 798 because all other numbers are reserved for Cisco use. instance Process instance ID. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 148 Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. event RF progression or status event notification that caused this event to be published. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 149 ASCII string that represents the name of the event for this event type. event_pub_secevent_pub_msec Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 150 Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event ID. event_type Type of event. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 151 "{type %s num_entries %u entries {entry 1, entry 2, ...}}" Subevent Type Description type Type of wdsysmon subevent. num_entries Number of processes and threads in the deadlock. entries Information of processes and threads in the deadlock. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 152 • STATE_SIGSUSPEND • STATE_SIGWAITINFO • STATE_STACK • STATE_STOPPED • STATE_WAITPAGE • STATE_WAITTHREAD b_node Name of the node that process B thread is on. b_procname Name of process B. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 153 For cpu_proc Subevent "{type %s node {%s} procname {%s} pid %u value %u sec %ld msec %ld}" Subevent Type Description type Type of wdsysmon subevent. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 154 If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged total CPU utilization is in the given time window. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 155 If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged process used memory utilization is in the given time window. Subevent Type Description Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 156 If the is_percent argument is TRUE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 157 Tcl command extension, the diff is the percentage difference between the oldest and latest total available memory utilization in the specified time window. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 158 • used is 0. • avail is 0. • diff is the percentage difference between the first total available memory sample ever collected and the latest total available memory sample. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 159 Tcl command extension, the diff is the percentage difference between the oldest and latest total used memory utilization in the specified time window. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 160 • used is 0. • avail is 0. • diff is the percentage difference between the first total used memory sample ever collected and the latest total used memory sample. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 161: Event_Reqinfo_Multi
Embedded Event Manager Event Publish Tcl Command Extension event_publish appl Publishes an application-specific event. Syntax event_publish sub_system ? type ? [arg1 ?] [arg2 ?] [arg3 ?] [arg4 ?] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 162 Script1 publishes a type 9999 EEM event to cause Script2 to run for the first time. Script1 is registered as a none event and is run using the Cisco IOS XR software CLI event manager run command. Script2 is registered as an EEM application event of type 9999, and this script checks to see if the application publish arg1 data (the iteration number) exceeds the EEM environment variable test_iterations value.
Page 163 {$_cerrno != 0} { set result [format \ "component=%s; subsys err=%s; posix err=%s;\n%s" \ $_cerr_sub_num $_cerr_sub_err $_cerr_posix_err $_cerr_str] error $result exit 0 set iter [expr $iter + 1] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 164: Embedded Event Manager Multiple Event Support Tcl Command Extensions
1 to 4294967295 Result String None Example: attribute tag 1 occurs 1 Correlate Builds a single complex event and allows Boolean logic to relate events. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 165: Trigger
The events are raised based on the specified parameters. Syntax trigger [occurs ?] [period ?] [period-start ?] [delay ?] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 166: Embedded Event Manager Action Tcl Command Extensions
Embedded Event Manager Action Tcl Command Extensions action_process Starts, restarts, or kills a Software Modularity process. This Tcl command extension is supported only in Software Modularity images. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 167 (_cerr_sub_num = 425, _cerr_sub_err = 2) SYSMGR_ERROR_NO_MEMORY (Could not allocate required memory) This error means that an internal SYSMGR request for memory failed. (_cerr_sub_num = 425, _cerr_sub_err = 5) SYSMGR_ERROR_NO_MATCH (This process is not known to sysmgr) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 168: Action_Program
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error. (_cerr_sub_err = 14) FH_ENOSUCHACTION (unknown action type) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 169: Action_Script
(configuration error) This error means that a configuration error has occurred. action_setver_prior Revert the process identified by the absolute path to the prior version. Syntax action_setver_prior [path ?] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 170: Action_Setnode
• sys_reqinfo_proc • sys_reqinfo_proc_all • sys_reqinfo_crash_history • sys_reqinfo_proc_version Syntax action_setnode [node ?] Arguments node (Mandatory) Name of the node. Result String None Set _cerrno action_syslog Logs a message. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 171: Action_Track_Read
? (represents a string) (Mandatory) Tracked object name. Result String name {%s} state {%s} Set _cerrno FH_ENOTRACK This error means that the tracked object name was not found. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 172: Embedded Event Manager Utility Tcl Command Extensions
Reads Embedded Event Manager (EEM) application volatile data. This Tcl command extension provides support for reading EEM application volatile data. EEM application volatile data can be published by a Cisco IOS XR software process that uses the EEM application publish API. EEM application volatile data cannot be published by an EEM policy.
Page 173: Appl_Reqinfo
Syntax appl_setinfo key ? data ? Arguments (Mandatory) String key of the data. data (Mandatory) Application string data to save. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 174 • If op is inc, this argument is the value by which to increment the counter. • If op is dec, this argument is the value by which to decrement the counter. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 175: Fts_Get_Stamp
Returns the time period elapsed since the last software boot. Use this Tcl command extension to return the number of nanoseconds since boot in an array “nsec nnnn” where nnnn is the number of nanoseconds. Syntax fts_get_stamp Arguments None Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 176: Register_Counter
FH_EBADEVENTTYPE (unknown EEM event type) This error means that the event type specified in the internal event specification was invalid. (_cerr_sub_err = FH_EMEMORY (insufficient memory for request) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 177 ID to manipulate the timer if it does not use the event_register_timer command extension to register as a publisher and subscriber. Syntax register_timer watchdog|countdown|absolute|cron name ? Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 178: Timer_Arm
This error means that an internal EEM event detector pointer was null when it should have contained a value. (_cerr_sub_err = 25) FH_ESUBSEXCEED (number of subscribers exceeded) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 179 0 and 999). An absolute expiration date is the number of seconds and milliseconds since January 1, 1970. If the date specified has already passed, the timer expires immediately. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 180 This error means that the event detector was unavailable. (_cerr_sub_err = 56) FH_EFDCONNERR (event detector connection error) This error means that the EEM event detector that handles this request is not available. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 181 This error means that the event specification ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt. (_cerr_sub_err = 12) FH_ENOSUCHEID (unknown event ID) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 182: Unregister_Counter
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error. (_cerr_sub_err = FH_EMEMORY (insufficient memory for request) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 183: Embedded Event Manager System Information Tcl Command Extensions
(Mandatory) Order used for sorting the CPU utilization of processes. cpu_used (Mandatory) Specifies that the average CPU utilization, for the specified time window, will be sorted in descending order. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 184: Sys_Reqinfo_Crash_History
Set _cerrno sys_reqinfo_crash_history Queries the crash information of all processes that have ever crashed. This Tcl command extension is supported only in Software Modularity images. Syntax sys_reqinfo_crash_history Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 185 Queries the memory usage of the top processes (both POSIX and IOS) during a specified time period and in a specified order. This Tcl command extension is supported only in Software Modularity images. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 186: Sys_Reqinfo_Mem_All
Where each process mem info string is: pid %u name {%s} delta_allocs %d initial_alloc %u current_alloc %u percent_increase %d rec_list Marks the start of the process memory usage information list. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 187: Sys_Reqinfo_Proc
{%s} is_respawn %u is_mandatory %u is_hold %u dump_option %d max_dump_count %u respawn_count %u fail_count %u dump_count %u last_respawn_sec %ld last_respawn_msec %ld inst_id %u proc_state %s level %d exit_status 0x%x exit_type %d Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 188 Sysmgr process states. One of the following: error, forced_stop, hold, init, ready_to_run, run, run_rnode, stop, waitEOltimer, wait_rnode, wait_spawntimer, wait_tpl. level Process run level. exit_status Last exit status of the process. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 189: Sys_Reqinfo_Proc_All
The integer number must be inclusively between 1 and 2147483647. Result String version_id %02d.%02d.%04d Where version_id is the version manager that is assigned the version number of the process. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 190: Sys_Reqinfo_Routername
%ld period_msec %ld pattern {%s} time_sectime_msec Seconds and milliseconds in POSIX timer units since January 1, 1970, which represent the time the last event was raised. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 191: Sys_Reqinfo_Syslog_History
(_cerr_sub_err = 54) FH_EFDUNAVAIL (connection to event detector unavailable) This error means that the event detector was unavailable. sys_reqinfo_syslog_history Queries the history of the specified syslog message. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 192: Sys_Reqinfo_Stat
This error means that the event detector was unavailable. sys_reqinfo_stat Queries the value of the statistic entity that is specified by name, and optionally the first modifier and the second modifier. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 193 "exact," the value of the specified oid is retrieved; if the get_type is "next," the value of the lexicographical successor to the specified oid is retrieved. Result String oid {%s} value {%s} SNMP OID. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 194: Smtp Library Command Extensions
1.3.6.1.4.1.9.9.41.1.2.3.1.3 int 4 SMTP Library Command Extensions All Simple Mail Transfer Protocol (SMTP) library command extensions belong to the ::cisco::lib namespace. To use this library, the user needs to provide an e-mail template file. The template file can include Tcl global variables so that the e-mail service and the e-mail text can be configured through the event manager environment Cisco IOS XR software command-line interface (CLI) configuration command.
Page 195: Smtp_Send_Email
Syntax smtp_send_email text Arguments text (Mandatory) Text of an e-mail template file with all global variables already substituted. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 196: Smtp_Subst
An example filename could be /disk0://example.template which represents a file named example.template in a top-level directory on an ATA flash disk in slot 0. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 197: Cli Library Command Extensions
Closes the exec process and releases the VTY and the specified channel handler connected to the command-line interface (CLI). Syntax cli_close fd tty_id Arguments (Mandatory) The CLI channel handler. tty_id (Mandatory) The TTY ID returned from the cli_open command extension. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 198: Cli_Exec
Returns the real and pseudo tty names for a given TTY ID. Syntax cli_get_ttyname tty_id Arguments tty_id (Mandatory) The TTY ID returned from the cli_open command extension. Result String pty %s tty %s Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 199: Cli_Open
Returns an array including the channel handler. Note Each call to cli_open initiates a Cisco IOS XR software EXEC session that allocates a Cisco IOS XR software vty. The vty remains in use until the cli_close routine is called. Vtys are allocated from the pool of vtys that are configured using the line vty vty-pool CLI configuration command.
Page 200: Cli_Read_Drain
All the contents read. Set _cerrno None cli_read_line Reads one line of the command output from the specified command-line interface (CLI) channel handler. Returns the line read. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 201: Cli_Read_Line
The pattern matching logic attempts a match by looking at the command output data as it is delivered from Note the Cisco IOS XR software command. The match is always done on the most recent 256 characters in the output buffer unless there are fewer characters available, in which case the match is done on fewer characters.
Page 202 1 if [catch {cli_exec $cli1(fd) "no shut"} result] { puts stderr $result exit 1 if [catch {cli_exec $cli1(fd) "end"} result] { puts stderr $result exit 1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 203 # Phase 2: Q&A phase # wait for prompted question: # All deleted files will be removed. Continue? [confirm] if [catch {cli_read_pattern $cli1(fd) "All deleted"} result] { error $result $errorInfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 204 $result if [catch {cli_write $cli1(fd) "y"} result] { error $result $errorInfo } else { set cmd_output $result if [catch {cli_close $cli1(fd) $cli1(tty_id)} result] { error $result $errorInfo Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 205: Tcl Context Library Command Extensions
If var is specified, and index_if_array is specified, and var is an array variable, retrieves the value of the specified array element. Result String Resets the Tcl global variables to the state that they were in when the save was performed. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 206 "testvarb does not exist" if {[info exists testvarc]} { action_syslog msg "testvarc exists and is $testvarc" } else { action_syslog msg "testvarc does not exist" Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 207 If var is specified, and index_if_array is not specified, and var is an array variable, retrieves the entire array. ::cisco::eem::event_register_none namespace import ::cisco::eem::* namespace import ::cisco::lib::* if {[catch {array set testvar [context_retrieve TESTCTX testvar]} errmsg]} { Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 208: Context_Save
Once saved information is retrieved, it is automatically deleted. If that information is needed by another Note policy, the policy that retrieves it (using the context_retrieve command extension) should also save it again (using the context_save command extension). Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 209 Sample Usage For examples showing how to use the context_save and context_retrieve command extension functionality to save and retrieve data, see the Sample Usage, on page 190. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 210 Configuring and Managing Embedded Event Manager Policies Tcl Context Library Command Extensions Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 211: Implementing Ip Service Level Agreements
IP Service Level Agreements (IP SLAs) is a portfolio of technology embedded in most devices that run Cisco IOS XR Software, which allows you to analyze IP service levels for IP applications and services, increase productivity, lower operational costs, and reduce the frequency of network outages.
Page 212: Prerequisites For Implementing Ip Service Level Agreements
Restrictions for Implementing IP Service Level Agreements • The maximum number of IP SLA operations that is supported by Cisco IOS XR Software is 2048. • We do not recommend scheduling all the operations at the same time as this could negatively affect your performance.
Page 213 Implementing IP Service Level Agreements Restrictions for Implementing IP Service Level Agreements • The maximum number of IP SLA configurable operations that is supported by Cisco IOS XR Software is 2000. • The current validated scale numbers for scheduling operations are as follows: ◦...
Page 214: Information About Implementing Ip Service Level Agreements
Network Management System (NMS) applications and the IP SLA operations that are running on Cisco devices. For a complete description of the object variables that are referenced by IP SLA, see the text of the CISCO-RTTMON-MIB.my file that is available from the Cisco MIB Locator.
Page 215 IP SLA support exists in Cisco networking devices ranging from low-end to high-end routers and switches. This wide range of deployment gives IP SLA more flexibility over traditional service level agreements. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 216: Benefits Of Ip Service Level Agreements
IP SLA component at the receiving end (for example, IP SLA Responder), the reply packet includes information about the delay at the target device. The source device uses this information to improve the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 217 Operations are divided into two classes, which depend on whether they rely on the IP SLA Responder component to be running at the target device or not. The former is used only with Cisco devices; whereas, the latter is used with any device that has IP connectivity. Operations that are based on Internet Control Message Protocol (ICMP) are examples of the second class;...
Page 218: Operation Types For Ip Service Level Agreements
Implementing IP Service Level Agreements Operation Types for IP Service Level Agreements 6 Display and interpret the results of the operation using Cisco IOS XR Software CLI, XML, or an NMS system with SNMP. Operation Types for IP Service Level Agreements IP SLA configures various types of operations to measure response times, jitter, throughput, and packet loss.
Page 219: Ip Sla Responder And Ip Sla Control Protocol
ICMP-based measurements. The patented IP SLA Control Protocol is used by the IP SLA Responder, providing a mechanism through which the responder is notified on which port it should listen and respond. Only a Cisco IOS XR Software device or other Cisco platforms can be a source for a destination IP SLA Responder.
Page 220: Response Time Computation For Ip Sla
If services that are already provided by the target router are chosen, the IP SLA Responder need not be enabled. For devices that are not Cisco devices, the IP SLA Responder cannot be configured, and the IP SLA can send operational packets only to services native to those devices.
Page 221: Ip Sla Operation Scheduling
The MPLS LSP monitor feature also allows you to perform multi-operation scheduling of IP SLA operations and supports proactive threshold violation monitoring through SNMP trap notifications and syslog messages. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 222: How Mpls Lsp Monitoring Works
BGP next-hop neighbor discovery is used to find the BGP next-hop neighbors in use by any VRF associated with the source provider edge (PE) router. In most cases, these neighbors are PE routers. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 223: Ip Sla Lsp Ping And Lsp Traceroute Operations
For more information about how to configure IP SLA LSP ping or LSP traceroute operations using MPLS LSP monitoring, see the Configuring an MPLS LSP Monitoring Ping Instance, on page 265 and the Configuring an MPLS LSP Monitoring Trace Instance, on page 269. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 224: Proactive Threshold Monitoring For Mpls Lsp Monitoring
LPD is configured using the path discover command. Note LPD functionality may create considerable CPU demands when large numbers of path discovery requests are received by the LSPV server at one time. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 225: How To Implement Ip Service Level Agreements
If you do not use permanent ports, you have to configure only the ipsla responder command. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 226: Configuring And Scheduling A Udp Jitter Operation On The Source Device
The IP SLA operations function by generating synthetic (simulated) network traffic. A single IP SLA operation (for example, IP SLA operation 10) repeats at a given frequency for the lifetime of the operation. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 227 Elapsed time before the operation 60 seconds • ipsla operation command repeats, in seconds (F) with the operation-number argument • type udp jitter command • frequency command with the seconds argument Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 228: Prerequisites For Configuring A Udp Jitter Operation On The Source Device
Prerequisites for Configuring a UDP Jitter Operation on the Source Device Use of the UDP jitter operation requires that the IP SLA Responder be enabled on the target Cisco device. To enable the IP SLA Responder, perform the task in the...
Page 229 RP/0/RSP0/CPU0:router(config)# Step 10 ipsla schedule operation op-num Schedules the start time of the operation. You can configure a basic schedule. Example: RP/0/RSP0/CPU0:router(config)# ipsla schedule operation 432 RP/0/RSP0/CPU0:router(config-ipsla-sched)# Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 230: Configuring And Scheduling A Udp Jitter Operation With Additional Characteristics
Step 15 commit Configuring and Scheduling a UDP Jitter Operation with Additional Characteristics You can configure and schedule a UDP jitter operation. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 231 RP/0/RSP0/CPU0:router(config)# ipsla operation Step 3 type udp jitter Configures the operation as a UDP jitter operation, and configures characteristics for the operation. Example: RP/0/RSP0/CPU0:router(config-ipsla-op)# type udp jitter Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 232 IP SLA operation. The range is 1 to 20. The default value is 1 distribution. Example: RP/0/RSP0/CPU0:router(config-ipsla-op-stats)# distribution count 15 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 233 RP/0/RSP0/CPU0:router(config)# Step 17 ipsla schedule operation op-num Schedules the start time of the operation. You can configure a basic schedule. Example: RP/0/RSP0/CPU0:router(config)# ipsla schedule operation 432 RP/0/RSP0/CPU0:router(config-ipsla-sched)# Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 234 Example: The UDP jitter operation provides the following hourly statistics: RP/0/RSP0/CPU0:router # show ipsla statistics aggregated 432 • Jitter statistics—Interprets telephony and multimedia conferencing requirements. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 235: Configuring The Ip Sla For A Udp Echo Operation
Cisco devices and devices that are not Cisco devices. The results of a UDP echo operation can be useful in troubleshooting issues with business-critical applications. The UDP echo operation requires a Cisco device that is running the IP SLA Responder or a non-Cisco Note device that is running the UDP echo service.
Page 236 Example: RP/0/RSP0/CPU0:router(config-ipsla-udp-echo)# destination address 12.25.26.10 Step 5 destination port port Specifies the destination port number, in the range from 1 to 65535. Example: RP/0/RSP0/CPU0:router(config-ipsla-udp-echo)# destination port 11111 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 237 If the start-time command is not RP/0/RSP0/CPU0:router(config-ipsla-sched)# start-time 01:00:00 specified, no information is collected until the start time is configured or a trigger occurs that performs an immediate start. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 238: Configuring And Scheduling A Udp Echo Operation With Optional Parameters On The Source Device
You can enable a UDP echo operation on the source device and configure some optional IP SLA parameters. The source device is the location at which the measurement statistics are stored. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 239 (Optional) Enables the monitoring of a VPN (using a nondefault routing table) in a UDP echo operation. Maximum length is 32 alphanumeric characters. Example: RP/0/RSP0/CPU0:router(config-ipsla-udp-echo)# vrf VPN-A Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 240 RP/0/RSP0/CPU0:router(config-ipsla-udp-echo)# timeout 10000 Step 11 tag text (Optional) Creates a user-specified identifier for an IP SLA operation. Example: RP/0/RSP0/CPU0:router(config-ipsla-udp-echo)# type udp echo tag ipsla Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 241 • (Optional) Use the now keyword to indicate that the operation should start immediately. • (Optional) Use the after keyword and associated arguments to specify the time after which the operation starts collecting information. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 242: Configuring An Icmp Echo Operation
Configuring an ICMP Echo Operation To monitor IP connections on a device, use the IP SLA ICMP echo operation. An ICMP echo operation measures end-to-end response times between a Cisco router and devices using IP. ICMP echo is used to troubleshoot network connectivity issues.
Page 243 IP SLA operations. Valid RP/0/RSP0/CPU0:router(config-ipsla-icmp-echo) frequency 300 values are in the range from 1 to 12604800 seconds. The default is 60 seconds. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 244 • (Optional) Use the now keyword to indicate that the operation should start immediately. • (Optional) Use the after keyword and associated arguments to specify the time after which the operation starts collecting information. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 245: The Source Device
16. start-time [hh:mm:ss {day | month day} | now | pending | after hh:mm:ss] 17. commit 18. show ipsla statistics [operation-number] DETAILED STEPS Command or Action Purpose Step 1 configure Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 246 DSCP value directly. To use a DSCP value, tos 1 multiply it by 4 and enter the result as the value of the number argument. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 247 Step 16 start-time [hh:mm:ss {day | month day} | now | Specifies a time for the operation to start. The following keywords are described: pending | after hh:mm:ss] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 248: Configuring The Icmp Path-Echo Operation
The ICMP path-echo operation determines the hop-by-hop response time between a Cisco router and any IP device on the network by discovering the path using the traceroute facility. The source IP SLA device uses traceroute to discover the path to the destination IP device. A ping is then used to measure the response time between the source IP SLA device and each subsequent hop in the path to the destination IP device.
Page 249 IP SLA operations. RP/0/RSP0/CPU0:router(config-ipsla-icmp-path-echo)# frequency 300 Valid values are in the range from 1 to 12604800 seconds. The default is 60 seconds. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 250 • (Optional) Use the after keyword and associated arguments to specify the time after which the operation starts collecting information. Step 12 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 251: On The Source Device
18. start-time [hh:mm:ss {day | month day} | now | pending | after hh:mm:ss] 19. commit 20. show ipsla statistics [operation-number] DETAILED STEPS Command or Action Purpose Step 1 configure Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 252 • Use the bytes argument to specify the protocol data size in bytes. The range is from 0 to 16384. The RP/0/RSP0/CPU0:router(config-ipsla-icmp-path-echo)# datasize request 512 default is 36 bytes. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 253 The seconds argument schedules the lifetime of the operation, in seconds. The default lifetime of an Example: operation is 3600 seconds (one hour). RP/0/RSP0/CPU0:router(config-ipsla-sched)# life 1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 254: Configuring The Icmp Path-Jitter Operation
UDP jitter operation can indicate unexpected delays or high jitter values; the ICMP path-jitter operation can then be used to troubleshoot the network path and determine if traffic is bottlenecking in a particular segment along the transmission path. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 255: Configuring And Scheduling A Basic Icmp Path-Jitter Operation
ICMP jitter operation with additional parameters, perform one of the following procedures: Configuring and Scheduling a Basic ICMP Path-jitter Operation You can configure and schedule an ICMP path-jitter operation using the general default characteristics for the operation. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 256 1 to 60000. For ICMP path-jitter operation, Example: the range is 1 to 100. RP/0/RSP0/CPU0:router(config-ipsla-icmp-path-jitter)# The default number of packets sent is 10. packet count 30 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 257 [hh:mm:ss {day | month day} | now | pending | after (Optional) Specifies a time for the operation to start. hh:mm:ss] The following keywords are described: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 258: Parameters
Configuring and Scheduling an ICMP Path-jitter Operation with Additional Parameters You can enable an ICMP path-echo operation on the source device and configure some optional IP SLA parameters. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 259 Specifies the operation number. The range is from 1 to 2048. Example: RP/0/RSP0/CPU0:router(config)# ipsla operation 432 Step 3 type icmp path-jitter Defines an ICMP path-jitter operation type. Example: RP/0/RSP0/CPU0:router(config-ipsla-op)# type icmp path-jitter Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 260 • Use the size argument to specify the protocol data size in bytes. The default for jitter is 36 bytes. The RP/0/RSP0/CPU0:router(config-ipsla-icmp-path-jitter)# datasize request 512 range is 0 to 16384 bytes. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 261 The default value of 0 seconds means that Example: the operation never times out. RP/0/RSP0/CPU0:router(config-ipsla-sched)# ageout 3600 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 262: Configuring Ip Sla Mpls Lsp Ping And Trace Operations
An MPLS LSP ping operation tests connectivity between routers along an LSP path in an MPLS network by sending an echo request (User Datagram Protocol (UDP) packet) to the end of the LSP, and receiving an echo reply back that contains diagnostic data. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 263 14. start-time [hh:mm:ss {day | month day} | now | pending | after hh:mm:ss] 15. commit 16. show ipsla statistics [operation-number] DETAILED STEPS Command or Action Purpose Step 1 configure Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 264 Step 7 force explicit-null (Optional) Adds an explicit null label to the label stack of an LSP when an echo request is sent. Example: RP/0/RSP0/CPU0:router(config-ipsla-mpls-lsp-ping)# force explicit-null Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 265 Step 14 start-time [hh:mm:ss {day | month day} | now | pending | Specifies a time for the operation to start. The following after hh:mm:ss] keywords are described: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 266: Configuring And Scheduling An Mpls Lsp Trace Operation
MPLS LSP trace operation: • LDP IPv4 prefixes (configured with the target ipv4 command) • MPLS TE tunnels (configured with the target traffic-eng tunnel command) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 267 Step 4 output interface type interface-path-id (Optional) Configures the echo request output interface to be used for LSP trace operations. Example: RP/0/RSP0/CPU0:router(config-ipsla-mpls-lsp-ping)# output interface pos 0/1/0/0 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 268 (Optional) Specifies the MPLS experimental field (EXP) value to be used in the header of echo reply packets. Valid values are from 0 to 7. Example: RP/0/RSP0/CPU0:router(config-ipsla-mpls-lsp-trace)# exp 5 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 269 Step 15 commit Step 16 show ipsla statistics [operation-number] Displays the current IP SLA statistics for the trace operation. Example: RP/0/RSP0/CPU0:router # show ipsla statistics 432 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 270: Configuring Ip Sla Reactions And Threshold Monitoring
Use the connection-loss keyword to specify a reaction that Example: occurs if there is a connection-loss for the monitored operation. RP/0/RSP0/CPU0:router(config-ipsla-react)# react connection-loss RP/0/RSP0/CPU0:router(config-ipsla-react-cond)# Step 4 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 271: Configuring Triggers For Jitter Violations
Perform this task to configure packet-loss as a monitored element. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 272: Configuring Triggers For Round-Trip Violations
You can configure rtt as a monitored element. SUMMARY STEPS 1. configure 2. ipsla reaction operation operation-number 3. react [rtt] 4. commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 273: Configuring Triggers For Timeout Violations
The range is from 1 to 2048. RP/0/RSP0/CPU0:router(config)# ipsla reaction operation 432 Step 3 react [timeout] Specifies an element to be monitored for a reaction. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 274: Configuring Triggers For Verify Error Violations
Specifies an element to be monitored for a reaction. Use the verify-error keyword to specify a reaction that Example: occurs if there is an error verification violation. RP/0/RSP0/CPU0:router(config-ipsla-react)# react verify-error RP/0/RSP0/CPU0:router(config-ipsla-react-cond)# Step 4 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 275: Configuring Threshold Violation Types For Ip Sla Reactions
X number of probe operations exceeds the specified upper-threshold value or falls below the lower-threshold value. For more information, see Generating Events for Averaged Violations, on page 262. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 276: Generating Events For Each Violation
Step 5 commit Generating Events for Consecutive Violations You can generate a trap or trigger another operation after a certain number of consecutive violations. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 277: Generating Events For X Of Y Violations
You can generate a trap or trigger another operation after some number (X) of violations within some other number (Y) of probe operations (X of Y). The react command with the rtt keyword is used as an example. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 278: Generating Events For Averaged Violations
Generating Events for Averaged Violations You can generate a trap or trigger another operation when the averaged totals of X number of probe operations violate a falling threshold or rising threshold. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 279: Specifying Reaction Events
The following types of actions are configured: • logging—When the logging keyword is configured, a message is generated to the console to indicate that a reaction has occurred. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 280 A target operation continues until its life expires, as specified by lifetime value of the target Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 281: Configuring The Mpls Lsp Monitoring Instance On A Source Pe Router
To configure an MPLS LSP monitor ping or trace instance, perform one of the following tasks: Configuring an MPLS LSP Monitoring Ping Instance Before You Begin Note MPLS LSP monitoring is configured on a PE router. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 282 Enters IP SLA configuration mode and configures IP service level agreements. Example: RP/0/RSP0/CPU0:router(config)# ipsla Step 3 mpls discovery vpn (Optional) Enters MPLS VPN BGP next-hop neighbor discovery configuration mode. Example: RP/0/RSP0/CPU0:router(config-ipsla)# mpls discovery vpn Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 283 At each interval, a new IP SLA operation is scan interval 300 automatically created for each newly discovered BGP next-hop neighbor listed in the MPLS LSP monitor instance scan queue. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 284 (Optional) Enables the use of the router alert option in MPLS LSP echo reply packets. This is disabled by default. Example: RP/0/RSP0/CPU0:router(config-ipsla-mplslm-lsp-ping)# reply mode router-alert Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 285: Configuring An Mpls Lsp Monitoring Trace Instance
• Schedule the MPLS LSP monitoring instance operations. Configuring an MPLS LSP Monitoring Trace Instance Before You Begin Note MPLS LSP monitoring is configured on a PE router. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 286 Enters IP SLA configuration mode and configures IP ipsla service level agreements. Example: RP/0/RSP0/CPU0:router(config)# ipsla Step 3 mpls discovery vpn (Optional) Enables MPLS VPN BGP next-hop neighbor discovery. Example: RP/0/RSP0/CPU0:router(config-ipsla)# mpls discovery vpn Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 287 At each interval, a new IP SLA operation is scan interval 300 automatically created for each newly discovered BGP next-hop neighbor listed in the MPLS LSP monitor instance scan queue. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 288 (Optional) Specifies the maximum hop count for an echo request packet to be used for MPLS LSP operations. The default value is 30. Example: RP/0/RSP0/CPU0:router(config-ipsla-mplslm-lsp-trace)# ttl 40 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 289: Router
Perform this task to configure the reaction conditions for an MPLS LSP monitoring instance. Before You Begin The MPLS LSP monitoring instance should be defined before you configure the reaction conditions. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 290 RP/0/RSP0/CPU0:router(config-ipsla-mplslm-react)# react operations. connection-loss Step 6 action logging Specifies that an event be logged as a result of the reaction condition and threshold. Example: RP/0/RSP0/CPU0:router(config-ipsla-mplslm-react-cond)# action logging Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 291: Scheduling An Mpls Lsp Monitoring Instance On A Source Pe Router
Enters MPLS LSP monitor mode. From this mode you can configure an LSP monitor instance, configure a reaction for an LSP monitor instance, or schedule an LSP monitor Example: instance. RP/0/RSP0/CPU0:router(config-ipsla)# mpls Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 292: Lsp Path Discovery
11:45:00 July 4 Step 8 commit LSP Path Discovery Perform this task to configure the LSP Path Discovery (LPD) and its required parameters, including echo interval, path, and scan. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 293 Verifies the end-to-end connectivity of a label switched path (LSP) and the integrity of an MPLS network. Example: RP/0/RSP0/CPU0:router(config-ipsla-mplslm-def)# type mpls lsp ping Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 294 {both | connection-loss | timeout} Enables secondary frequency for: value} • Both timeout and connection loss • Only connection loss Example: • Only timeout RP/0/RSP0/CPU0:router(config-ipsla-mplslm-lsp-lpd)# path secondary frequency both 600 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 295: Configuring Tracking Type (Rtr)
Step 3 type rtr ipsla operation id reachability Sets the ipsla operation id which needs to be tracked for reachability. Example: RP/0/RSP0/CPU0:routertype rtr 100 reachability Step 4 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 296: Configuration Examples For Implementing Ip Service Level Agreements
PacketSkipped: 0 Errors Busies InvalidTimestamp Jitter Values : MinOfPositivesSD: 1 MaxOfPositivesSD: 1 NumOfPositivesSD: 2 SumOfPositivesSD: 2 Sum2PositivesSD : 2 MinOfNegativesSD: 1 MaxOfNegativesSD: 1 NumOfNegativesSD: 1 SumOfNegativesSD: 1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 297: Configuring Ip Sla Reactions And Threshold Monitoring: Example
If operation 1 generates a trigger event, operation 2 is started. The following example shows how to configure a reaction trigger operation by using the ipsla reaction trigger command: configure ipsla reaction trigger 1 2 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 298: Configuring Ip Sla Mpls Lsp Monitoring: Example
12 path secondary frequency both 12 Additional References The following sections provide references related to IP Service Level Agreements. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 299 Registered Cisco.com users can log in from this page to access even more content. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 300 Implementing IP Service Level Agreements Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 301: Implementing Logging Services
This module describes the new and revised tasks you need to implement logging services on the router. The Cisco IOS XR Software provides basic logging services. Logging services provide a means to gather logging information for monitoring and troubleshooting, to select the type of logging information captured, and to specify the destinations of captured system logging (syslog) messages.
Page 302: Information About Implementing Logging Services
The syslog process also sends messages to the console terminal by default. Format of System Logging Messages By default, the general format of syslog messages generated by the syslog process on the Cisco IOS XR software is as follows:...
Page 303: Duplicate Message Suppression
3 12:30:26.346 UTC logging archive device harddisk severity debugging file-size 4 archive-size 100 logging console disable logging 223.255.254.248 logging 223.255.254.249 logging suppress duplicates RP/0/RSP0/CPU0:router# RP/0/RSP0/CPU0:router# RP/0/RSP0/CPU0:router# RP/0/RSP0/CPU0:router# RP/0/RSP0/CPU0:router#run Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 304: Syslog Message Destinations
To clear the current contents of the logging buffer, use the clear logging command. To disable logging to the logging buffer, use the no logging buffered command in global configuration mode. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 305: Guidelines For Sending Syslog Messages To Destinations Other Than The Console
Note effect after the terminal session is ended. Syslog Messages Sent to Syslog Servers The Cisco IOS XR Software provides these features to help manage syslog messages sent to syslog servers: • UNIX system facilities • Hostname prefix logging • Source interface logging UNIX System Logging Facilities You can configure the syslog facility in which syslog messages are sent by using the logging facility command.
Page 306: Hostname Prefix Logging
Indicates UNIX-to-UNIX copy system. Hostname Prefix Logging To help manage system logging messages sent to syslog servers, Cisco IOS XR Software supports hostname prefix logging. When enabled, hostname prefix logging appends a hostname prefix to syslog messages being sent from the router to syslog servers. You can use hostname prefixes to sort the messages being sent to a given syslog server from different networking devices.
Page 307: Syslog Source Address Logging
Specifies the maximum total size of the syslog archives on a storage device. If the size is exceeded then the oldest file in the archive is deleted to make space for new logs. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 308: Archive Storage Directories
Limits the syslog messages sent to the logging buffer based on severity. logging console [severity] Limits the syslog messages sent to the console terminal based on severity. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 309: Logging History Table
SNMP server. logging history size number Changes the number of syslog messages that can be stored in the history table. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 310: Syslog Message Severity Level Definitions
This table lists the default severity level settings for the commands that support the severity argument. Table 33: Severity Level Command Defaults Command Default Severity Keyword Level logging buffered debugging logging console informational logging history warnings debugging logging monitor Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 311: How To Implement Logging Services
Example: • Keyword options for the severity argument are emergencies, alerts, critical, errors, warnings, notifications, informational, and debugging. RP/0/RSP0/CPU0:router(config)# logging monitor critical Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 312: Configuring Logging To A Remote Server
3. logging trap [severity] 4. logging facility [type] 5. logging hostnameprefix hostname 6. logging source-interface type interface-path-id 7. commit DETAILED STEPS Command or Action Purpose Step 1 configure Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 313: Configuring The Settings For The Logging History Table
Logging of messages to an SNMP NMS is enabled by the snmp-server enable traps syslog command. For more information about SNMP, see the Related Documents, on page 308 section. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 314: Modifying Logging To The Console Terminal And The Logging Buffer
Modifying Logging to the Console Terminal and the Logging Buffer This task explains how to modify logging configuration for the console terminal and the logging buffer. Logging is enabled by default. Note Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 315: Modifying The Format Of Time Stamps
Step 4 commit Modifying the Format of Time Stamps This task explains how to modify the time-stamp format for syslog and debugging messages. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 316 Modifies the time-stamp format for debugging messages. • service timestamps debug datetime • By default, time-stamps are enabled. The default time stamp format is [localtime] [msec] [show-timezone] month day HH:MM:SS. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 317: Disabling Time Stamps
3. commit DETAILED STEPS Command or Action Purpose Step 1 configure Step 2 Do one of the following: Disables the inclusion of time stamps in syslog messages. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 318: Suppressing Duplicate Syslog Messages
When the logging of link-status messages is enabled, the router can generate a high volume of link-status updown syslog messages. Disabling the logging of link-status syslog messages reduces the number of messages logged. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 319: Displaying System Logging Messages
2. show logging location node-id 3. show logging process name 4. show logging string string 5. show logging start month day hh:mm:ss 6. show logging end month day hh:mm:ss Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 320: Archiving System Logging Messages To A Local Storage Device
The local storage device must have enough space available to store the archive files. We recommend that Note syslogs be archived to the harddisk because it has more capacity than flash disks. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 321: Alerts
All syslog messages greater than or equal to this configured level are archived while those lesser than this are filtered out. The Example: severity levels are: RP/0/RSP0/CPU0:router(config-logging-arch)# severity warnings • emergencies • alerts • critical Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 322: Configuration Examples For Implementing Logging Services
60,000 bytes. logging console critical logging buffered 60000 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 323: Setting Up Destinations For Syslog Messages: Example
Configuring a Logging Archive: Example This example shows how to configure a logging archive, and define the archive attributes: RP/0/RSP0/CPU0:router# configure RP/0/RSP0/CPU0:router(config)# logging archive RP/0/RSP0/CPU0:router(config-logging-arch)# device disk1 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 324: Where To Go Next
To configure alarm log correlation, see the Implementing and Monitoring Alarms and Logging Correlation module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide. Additional References The following sections provide references related to implementing logging services on Cisco IOS XR software Related Documents Related Topic...
Page 325 Registered Cisco.com users can log in from this page to access even more content. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 326 Implementing Logging Services Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 327 Release 5.2.2 Generic string logging feature was introduced. • Prerequisites , page 312 • Information About Implementing OBFL, page 312 • How to Implement OBFL, page 314 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 328: Prerequisites
Chassis name and slot number are stored at initial boot and for the most recent nine boots. Temperature Inlet and hotpoint temperatures are recorded 10 minutes after boot. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 329: Event-Driven Data Collection
On reboot, these environmental readings are consolidated into a single environmental history record that shows the duration and extent out of normal range for a consecutive set of environmental readings. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 330: Supported Cards And Platforms
OBFL is enabled for the new node. If a card is removed from a router and inserted into a different router, the card assumes the OBFL configuration for the new router. This section contains these procedures: Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 331: Enabling Or Disabling Obfl
The default is the alerts alerts keyword. • Use the emergencies keyword to specify only the emergency syslog messages are logged. Step 4 commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 332: Configuring Message Severity Levels
Use the commands described in this section to display the status of OBFL, and the data collected by OBFL. Enter these commands in EXEC or administration EXEC mode. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 333: Clearing Obfl Data
[all | cbc {dump-all | dump-range {start-address | end-address | most-recent {fans fan-tray-slot | [location node-id]} | corrupted-files | diagnostic | environment | error | poweron-time | temperature | uptime | voltage] [location node-id] Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 334: Configuration Examples For Obfl
OBFL should always be disabled before this command is issued. For more information, see the Onboard Failure Logging Commands module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Command Reference.
Page 335: Clearing Obfl Messages: Example
To configure alarm log correlation, see the Implementing and Monitoring Alarms and Logging Correlation module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide. Additional References The following sections provide references related to implementing logging services on Cisco IOS XR software Related Documents Related Topic...
Page 336 To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu: http://cisco.com/public/ sw-center/netmgmt/cmtk/mibs.shtml Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 337 Registered Cisco.com users can log in from this page to access even more content. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 338 Onboard Failure Logging Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 339: Chapter 6 Implementing Performance Management
The PM system collects data that is useful for graphing or charting system resource utilization, for capacity planning, for traffic engineering, and for trend analysis. For more information about PM on the Cisco IOS XR Software and complete descriptions of the PM Note...
Page 340: Prerequisites For Implementing Performance Management
• You must install and activate the Package Installation Envelope (PIE) for the manageability software. For detailed information about optional PIE installation, refer to the Cisco ASR 9000 Series Aggregation Services Router Getting Started Guide. • You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command.
Page 341: Pm Benefits
• Efficient transfer of statistical data in the binary format via TFTP • Entity instance monitoring support • Threshold monitoring support • Data persistency across process restarts and processor failovers Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 342: Pm Statistics Collection Overview
TFTP server. When a PM statistics collection template is enabled, the PM statistics collection gathers statistics for all attributes from all instances associated with the entity configured in the template. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 343: Guidelines For Creating Pm Statistics Collection Templates
• Use the performance-mgmt apply statistics command to enable a PM statistics collection template. • Only one PM statistics collection template for a given entity can be enabled at a time. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 344: Exporting Statistics Data
: 1 Byte (e.g NODE=1,Interface=2,BGP=3) Options :2 Bytes NoOf SubEntities :1 Byte SubEntity Identifier :1 Byte (e.g BGP-PEERS ) Time Stamp 4 Bytes (Reference Time : Start Ref Time) Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 345: Binary File Id Assignments For Entity, Subentity, And Statscounter Names
Peer Key <IpAddress> MPLS (4) Reserved (1) — Reserved (2) — LDP (4) Session <IpAddress> OSPF (5) v2protocol (1) I n s t a n c e <process_instance> Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 346 Table 37: Supported StatsCounters for Entities and Subentites Entity Subentity StatsCounters Node (1) CPU (1) AverageCPUUsed, NoProcesses Memory (2) CurrMemory, PeakMemory Process (3) PeakMemory, AverageCPUUsed, NoThreads Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 347 OutputPeakPkts, Bandwidth Basic Counters (3) InPackets, InOctets, OutPackets, OutOctets, InputTotalDrops, InputQueueDrops, InputTotalErrors, OutputTotalErrors, OutputQueueDrops, OutputTotalErrors BGP (3) Peer (1) InputMessages, OutputMessages, InputUpdateMessages, OutputUpdateMessages, ConnEstablished, ConnDropped, ErrorsReceived, ErrorsSent Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 348 KeepAliveMsgsSent, KeepAliveMsgsRcvd OSPF (5) v2protocol (1) InputPackets, OutputPackets, InputHelloPackets, OutputHelloPackets, InputDBDs, InputDBDsLSA, OutputDBDs, OutputDBDsLSA, InputLSRequests, InputLSRequestsLSA, OutputLSRequests, OutputLSRequestsLSA, InputLSAUpdates, InputLSAUpdatesLSA, OutputLSAUpdates, OutputLSAUpdatesLSA, InputLSAAcks, InputLSAAcksLSA, OutputLSAAcks, OutputLSAAcksLSA, ChecksumErrors Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 349: Filenaming Convention Applied To Binary Files
The data from entity instance monitoring can be retrieved through only a XML interface. Note This table describes the command used to enable entity instance monitoring for the BGP entity instance. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 350 Syntax: performance-mgmt apply monitor interface data-rates type interface-path-id template-name default RP/0/RSP0/CPU0:router(config)# performance-mgmt apply monitor interface data-rates gigabitethernet 0/2/0/0 default Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 351 MPLS LDP entity instance. Syntax: performance-mgmt apply monitor mpls ip-address template-name default RP/0/RSP0/CPU0:router(config)# performance-mgmt apply monitor mpls ldp 10.34.64.154 default Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 352 Syntax: performance-mgmt apply monitor node process location node-id template-name default RP/0/RSP0/CPU0:router(config)# performance-mgmt apply monitor node process location p 0/RP1/CPU0 275 default Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 353: Pm Threshold Monitoring Overview
• Specify the operation to be performed in the threshold condition. The supported operations are as follows: ◦EQ —Equal to ◦GE —Greater than or equal to Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 354 Table 42: How the PM System Determines if a Threshold Condition Is Met, on page 338. This table describes how the PM system determines whether a threshold condition is met. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 355 • If no instances of the attribute match the threshold condition, system logging messages are not generated for that sample interval. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 356 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 357 Range is from 0 to messages received. 4294967295. OutputMessages Number of messages Range is from 0 to sent. 4294967295. OutputUpdateMessages Number of update Range is from 0 to messages sent. 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 358 Range is from 0 to 4294967295. InputTotalDrops Inbound correct packets Range is from 0 to discarded. 4294967295. InputQueueDrops Input queue drops. Range is from 0 to 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 359 Range is from 0 to packets discarded. 4294967295. OutputQueueDrops Output queue drops. Range is from 0 to 4294967295. OutputTotalErrors Outbound incorrect Range is from 0 to packets discarded. 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 360 Multicast packets sent. Range is from 0 to 4294967295. OutOctets Bytes sent. Range is from 0 to 4294967295. OutPackets Packets sent. Range is from 0 to 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 361 Range is from 0 to packets discarded. 4294967295. OutUcastPkts Unicast packets sent. Range is from 0 to 4294967295. OutputUnderrun Output underruns. Range is from 0 to 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 362 Range is from 0 to messages sent. 4294967295. NotificationMsgsRcvd Notification messages Range is from 0 to received. 4294967295. NotificationMsgsSent Notification messages Range is from 0 to sent. 4294967295. TotalMsgsRcvd Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 363 4294967295. InputDBDs Number of DBD packets Range is from 0 to received. 4294967295. InputDBDsLSA Number of LSA Range is from 0 to received in DBD 4294967295. packets. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 364 OutputLSAAcksLSA Number of LSA sent in Range is from 0 to 4294967295. acknowledgements. ChecksumErrors Number of packets Range is from 0 to received with checksum 4294967295. errors. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 365 4294967295. OutputLSAUpdates Number of LSA updates Range is from 0 to sent. 4294967295. OutputLSAUpdatesLSA Number of LSA sent in Range is from 0 to LSA updates. 4294967295. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 366: Guidelines For Enabling And Disabling Pm Threshold Monitoring Templates
• Because only one PM threshold monitoring template for an entity at any given time, you are not required to specify the template name with the default keyword or template keyword and template-name argument when disabling a PM statistics collection. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 367: How To Implement Performance Management
Step 3 commit Configuring Local Disk Dump for PM Statistics Collections This task explains how to configure local disk or external TFTP server for PM statistic collections. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 368: Configuring Instance Filtering By Regular-Expression
• You can enhance the performance by applying regular expressions, which has OR conditions. SUMMARY STEPS 1. configure 2. performance-mgmt regular-expression regular-expression name 3. index index-number regular-expression-string 4. commit DETAILED STEPS Command or Action Purpose Step 1 configure Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 369: Creating Pm Statistics Collection Templates
10 minutes and a default sample size of 5 sampling RP/0/RSP0/CPU0:router(config)# operations. performance-mgmt statistics interface data-rates default • Use the template keyword and template-name argument to designate a unique name for a template. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 370: Enabling And Disabling Pm Statistics Collection Templates
} [ location {all | node-id}] {template-name | default} • no performance-mgmt apply statistics {entity | interface {basic-counters | data-rates | generic-counters} type interface-path-id } [location {all | node-id}] 3. commit Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 371 • Because only one PM statistics collection can be enabled for any given entity at any given time, you are not required to specify the template name Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 372: Enabling Pm Entity Instance Monitoring
0/RSP1/CPU0 default Step 3 commit Creating PM Threshold Monitoring Templates This task explains how to create a PM threshold monitoring template. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 373: Enabling And Disabling Pm Threshold Monitoring Templates
Before You Begin You must create a PM threshold template before performing this task. Refer to Creating PM Threshold Monitoring Templates, on page 356 tasks for more information. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 374 • You must specify either a location with the location keyword and node-id argument or the location all keywords when disabling a PM threshold monitoring template for these entities: ◦ Node CPU Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 375: Configuration Examples For Implementing Performance Management
10 sample-interval 5 performance-mgmt statistics node memory template template2 sample-size 30 sample-interval 2 performance-mgmt statistics node process template template3 sample-size 10 sample-interval 5 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 376: Creating And Enabling Pm Threshold Monitoring Templates: Example
Configuration Guide Standards Standards Title No new or modified standards are supported by this — feature, and support for existing standards has not been modified by this feature. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 377 Registered Cisco.com users can log in from this page to access even more content. Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...
Page 378 Implementing Performance Management Additional References Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x...

Cisco ASR 9000 Serie Configuration Manuals

CHAPTER 1 Implementingandmonitoringalarmsandalarmlogcorrelation

CHAPTER 2 Configuring and Managing Embedded Event Manager Policies

CHAPTER 3 Implementing IP Service Level Agreements

CHAPTER 4 Implementing Logging Services

Chapter 5 Onboard Failure Logging

Quick Links

Related Manuals for Cisco ASR 9000 Serie

Summary of Contents for Cisco ASR 9000 Serie