manualshive.com logo in svg

Cisco ASR 9000 Serie, Configuration Manuals

Share
Download
Cisco ASR 9000 Serie Configuration Manuals Download Page 208

action_syslog msg "context_retrieve failed: $errmsg"

} else {

action_syslog msg "context_retrieve succeeded"

}
if {[info exists testvar]} {

action_syslog msg "testvar exists and is [array get testvar]"

} else {

action_syslog msg "testvar does not exist"

}

Example 4: Save

If var is specified, saves the value of var even if it is an array.

::cisco::eem::event_register_none

namespace import ::cisco::eem::*
namespace import ::cisco::lib::*

array set testvar

“

testvar1 ok testvar2 not_ok

”

if {[catch {context_save TESTCTX testvar} errmsg]} {

action_syslog msg "context_save failed: $errmsg"

} else {

action_syslog msg "context_save succeeded"

}

Example 4: Retrieve

If var is specified, and index_if_array is specified, and var is an array variable, retrieves the specified array
element value.

::cisco::eem::event_register_none

namespace import ::cisco::eem::*
namespace import ::cisco::lib::*

if {[catch {set testvar [context_retrieve TESTCTX testvar testvar1]} errmsg]} {

action_syslog msg "context_retrieve failed: $errmsg"

} else {

action_syslog msg "context_retrieve succeeded"

}
if {[info exists testvar]} {

action_syslog msg "testvar exists and is $testvar"

} else {

action_syslog msg "testvar doesn't exist"

}

context_save

Saves Tcl variables that match a given pattern in current and global namespaces with the given context name
as identification. Use this Tcl command extension to save information outside of a policy. Saved information
can be retrieved by a different policy using the

context_retrieve

command extension.

Once saved information is retrieved, it is automatically deleted. If that information is needed by another
policy, the policy that retrieves it (using the

context_retrieve

command extension) should also save it

again (using the

context_save

command extension).

Note

   Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide, Release 4.2.x

192

Configuring and Managing Embedded Event Manager Policies

Tcl Context Library Command Extensions

Summary of Contents for ASR 9000 Serie

Page 1: ... 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 USA http www cisco com Tel 408 526 4000 800 553 NETS 6387 Fax 408 527 0883 ...

Page 2: ... IMPLIED INCLUDING WITHOUT LIMITATION THOSE OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING USAGE OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTIAL OR INCIDENTAL DAMAGES INCLUDING WITHOUT LIMITATION LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE T...

Page 3: ...r 3 System Logging Process 4 Alarm Logger 4 Logging Correlation 4 Correlation Rules 4 Types of Correlation 5 Application of Rules and Rule Sets 5 Root Message and Correlated Messages 5 Alarm Severity Level and Filtering 6 Bistate Alarms 6 Capacity Threshold Setting for Alarms 7 Hierarchical Correlation 7 Context Correlation Flag 7 Duration Timeout Flags 8 Reparent Flag 8 Reissue Nonbistate Flag 8 ...

Page 4: ...ining SNMP Correlation Buffer Size 30 Defining SNMP Rulesets 31 Configuring SNMP Correlation Rules 31 Applying SNMP Correlation Rules 32 Applying SNMP Correlation Ruleset 33 Configuration Examples for Alarm Management and Logging Correlation 34 Increasing the Severity Level for Alarm Filtering to Display Fewer Events and Modifying the Alarm Buffer Size and Capacity Threshold Example 34 Configuring...

Page 5: ...nt Detector 51 Syslog Event Detector 51 None Event Detector 51 Watchdog System Monitor Event Detector 52 Distributed Event Detectors 53 Embedded Event Manager Event Scheduling and Notification 53 Reliability Statistics 53 Hardware Card Reliability Metric Data 53 Process Reliability Metric Data 54 How to Configure and Manage Embedded Event Manager Policies 55 Configuring Environmental Variables 55 ...

Page 6: ...Policies Using Tcl 82 EEM Event Detector Demo Example 82 EEM Sample Policy Descriptions 82 Event Manager Environment Variables for the Sample Policies 82 Registration of Some EEM Policies 84 Basic Configuration Details for All Sample Policies 85 Using the Sample Policies 85 Running the sl_intf_down tcl Sample Policy 85 Running the tm_cli_cmd tcl Sample Policy 86 Running the tm_crash_reporter tcl S...

Page 7: ...Extension 129 event_reqinfo 129 event_reqinfo_multi 145 Embedded Event Manager Event Publish Tcl Command Extension 145 event_publish appl 145 Embedded Event Manager Multiple Event Support Tcl Command Extensions 148 Attribute 148 Correlate 148 Trigger 149 Embedded Event Manager Action Tcl Command Extensions 150 action_process 150 action_program 152 action_script 153 action_setver_prior 153 action_s...

Page 8: ...ersion 173 sys_reqinfo_routername 174 sys_reqinfo_syslog_freq 174 sys_reqinfo_syslog_history 175 sys_reqinfo_stat 176 sys_reqinfo_snmp 177 sys_reqinfo_snmp_trap 178 sys_reqinfo_snmp_trapvar 178 SMTP Library Command Extensions 178 smtp_send_email 179 smtp_subst 180 CLI Library Command Extensions 181 cli_close 181 cli_exec 182 cli_get_ttyname 182 cli_open 183 cli_read 183 cli_read_drain 184 cli_read...

Page 9: ...IP SLA Threshold Monitoring and Notifications 205 MPLS LSP Monitoring 205 How MPLS LSP Monitoring Works 206 BGP Next hop Neighbor Discovery 206 IP SLA LSP Ping and LSP Traceroute Operations 207 Proactive Threshold Monitoring for MPLS LSP Monitoring 208 Multi operation Scheduling for the LSP Health Monitor 208 LSP Path Discovery 208 How to Implement IP Service Level Agreements 209 Configuring IP Se...

Page 10: ...dditional Parameters 242 Configuring IP SLA MPLS LSP Ping and Trace Operations 246 Configuring and Scheduling an MPLS LSP Ping Operation 246 Configuring and Scheduling an MPLS LSP Trace Operation 250 Configuring IP SLA Reactions and Threshold Monitoring 254 Configuring Monitored Elements for IP SLA Reactions 254 Configuring Triggers for Connection Loss Violations 254 Configuring Triggers for Jitte...

Page 11: ...uisites for Implementing Logging Services 285 Information About Implementing Logging Services 286 System Logging Process 286 Format of System Logging Messages 286 Duplicate Message Suppression 287 Interruption of Message Suppression 287 Syslog Message Destinations 288 Guidelines for Sending Syslog Messages to Destinations Other Than the Console 289 Logging for the Current Terminal Session 289 Sysl...

Page 12: ...onsole Terminal and the Logging Buffer Example 306 Setting Up Destinations for Syslog Messages Example 307 Configuring the Settings for the Logging History Table Example 307 Modifying Time Stamps Example 307 Configuring a Logging Archive Example 307 Where to Go Next 308 Additional References 308 C H A P T E R 5 Onboard Failure Logging 311 Prerequisites 312 Information About Implementing OBFL 312 D...

Page 13: ...ounter Names 329 Filenaming Convention Applied to Binary Files 333 PM Entity Instance Monitoring Overview 333 PM Threshold Monitoring Overview 337 Guidelines for Creating PM Threshold Monitoring Templates 337 Guidelines for Enabling and Disabling PM Threshold Monitoring Templates 350 How to Implement Performance Management 351 Configuring an External TFTP Server for PM Statistic Collections 351 Co...

Page 14: ...llection Templates Example 359 Creating and Enabling PM Threshold Monitoring Templates Example 360 Additional References 360 Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x xiv Contents ...

Page 15: ...age xv Changes to This Document This table lists the technical changes made to this document since it was first printed Table 1 Changes to This Document Change Summary Date Revision Republished for Cisco IOS XR Release 4 2 1 June 2012 OL 26513 02 Initial release of this document December 2011 OL 26513 01 Obtaining Documentation and Submitting a Service Request For information on obtaining document...

Page 16: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x xvi Preface Obtaining Documentation and Submitting a Service Request ...

Page 17: ... module see the Related Documents on page 37 section of this module To locate documentation for other commands that might appear in the course of performing a configuration task search online in the Cisco ASR 9000 Series Aggregation Services Router Commands Master List Note Feature History for Implementing and Monitoring Alarms and Alarm Log Correlation Modification Release This feature was introd...

Page 18: ...DEMS is used to monitor and store alarm messages that are forwarded by system servers and applications In addition ALDEMS correlates alarm messages forwarded due to a single root cause 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 t...

Page 19: ...esponds to the timeout interval specified in the rule The correlator continues searching for a match to messages in the rule until the timer expires If the root case message was received then a correlation occurs otherwise all captured messages are forwarded to the syslog When a correlation occurs the correlated messages are stored in the logging correlation buffer The correlator tags each set of ...

Page 20: ...enerated each time the logging events buffer reaches the capacity threshold Messages stored in the logging events buffer can be queried by clients to locate records matching specific criteria The alarm logging mechanism assigns a sequential unique ID to each alarm message Logging Correlation Logging correlation can be used to isolate the most significant root messages for events affecting system p...

Page 21: ...n can change after it has occurred if the bistate root cause alarm clears When the alarm clears all the correlated non root cause alarms are sent to syslog and are removed from the correlation buffer Stateful correlations are useful to detect non root cause conditions that continue to exist even if the suspected root cause no longer exists Application of Rules and Rule Sets If a correlation rule i...

Page 22: ...ion Severity Level Emergencies 0 Alerts 1 Critical 2 Errors 3 Warnings 4 Notifications 5 Informational 6 Bistate Alarms Bistate alarms are generated by state changes associated with system hardware such as a change of interface state from active to inactive the online insertion and removal OIR of a card or a change in component temperature Bistate alarm events are reported to the logging events bu...

Page 23: ...ted for Cause 1 2 and 3 with all alarms arriving within their respective correlation timeout periods then the hierarchical correlation appears like this Cause 1 Cause 2 Cause 3 The correlation buffers show two separate correlations one for Cause 1 and Cause 2 and the second for Cause 2 and Cause 3 However the hierarchical relationship is implicitly defined Stateful behavior such as reparenting and...

Page 24: ... and therefore releases the hold on the non root cause alarms sooner Reparent Flag The reparent flag specifies what happens to non root cause alarms in a hierarchical correlation when their immediate root cause clears The following example illustrates context correlation behavior Rule 1 has a root cause A and an associated non root cause B Context correlation flag is not set on Rule 1 Rule 1 is ap...

Page 25: ...mentandMonitorAlarmManagementandLogging Correlation Configuring Logging Correlation Rules This task explains how to configure logging correlation rules The purpose of configuring logging correlation rules is to define the root cause and non root cause alarm messages with message category group and code combinations for logging correlation The originating root cause alarm message is forwarded to th...

Page 26: ...tion time for the logging correlator rule message timeout milliseconds Example RP 0 RSP0 CPU0 router config corr rule st timeout 60000 Step 3 Timeout begins when the first alarm message identified by the correlation rule is logged commit Step 4 Optional Displays defined correlation rules show logging correlator rule all correlation rule1 correlation rule14 context context1 context 6 Step 5 The out...

Page 27: ... rulename stateful_rule Step 3 commit Step 4 Optional Displays defined correlation rule sets show logging correlator ruleset all correlation ruleset1 correlation ruleset14 detail summary Example RP 0 RSP0 CPU0 router show logging correlator ruleset all Step 5 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...

Page 28: ...e correlations cannot change All non root cause alarms remain in the correlation buffers Configures a root cause alarm message rootcause msg category group name msg code Step 3 Example RP 0 RSP0 CPU0 router config corr rule st rootcause CAT_BI_1 GROUP_BI_1 CODE_BI_1 This example specifies a root cause alarm under stateful configuration mode Enters the non root cause configuration mode nonrootcause...

Page 29: ...ment flags such as reparenting and reissuing of nonbistate alarms This task explains how to implement these flags See the Reparent Flag on page 8 and Reissue Nonbistate Flag on page 8 sections for detailed information about these flags SUMMARY STEPS 1 configure 2 logging correlator rule correlation rule type stateful nonstateful 3 reissue nonbistate 4 reparent 5 commit 6 show logging correlator ru...

Page 30: ...e nonstateful stateful summary detail Example RP 0 RSP0 CPU0 router show logging correlator rule all What to Do Next To activate a defined correlation rule and rule set you must apply them by using the logging correlator apply rule and logging correlator apply ruleset commands Applying Logging Correlation Rules This task explains how to apply logging correlation rules Applying a correlation rule a...

Page 31: ...on rule and enters correlation apply rule configuration mode logging correlator apply rule correlation rule Example RP 0 RSP0 CPU0 router config logging correlator apply rule rule1 Step 2 Do one of the following Step 3 Applies a logging correlation rule to all nodes on the router all of router Applies a logging correlation rule to a specific node on the router location node id context name The loc...

Page 32: ...d gives a scope When applied a single rule set configuration immediately effects the rules that are part of that given rule set Rule definitions that were previously applied singly or as part of another rule set cannot be modified until that rule or rule set is unapplied Use the no form of the command to negate usage and then try to reapply rule set Note SUMMARY STEPS 1 configure 2 logging correla...

Page 33: ...r ruleset location 0 2 CPU0 or RP 0 RSP0 CPU0 router config corr ruleset context commit Step 4 Optional Displays the correlator rules that are defined show logging correlator ruleset all correlation ruleset1 correlation ruleset14 detail summary Example RP 0 RSP0 CPU0 router show logging correlator ruleset all Step 5 Modifying Logging Events Buffer Settings Logging events buffer settings can be adj...

Page 34: ...nts info Example RP 0 RSP0 CPU0 router show logging events info Step 1 threshold for reporting alarms total number of records in the buffer and severity filter if any configure Step 2 Specifies the size of the alarm record buffer logging events buffer size bytes Step 3 Example RP 0 RSP0 CPU0 router config logging events buffer size 50000 In this example the buffer size is set to 50000 bytes Specif...

Page 35: ... number of records in the buffer and severity filter if any This command is used to verify that all settings have been modified and that the changes have been accepted by the system Modifying Logging Correlator Buffer Settings This task explains how to modify the logging correlator buffer settings The size of the logging correlator buffer can be adjusted to accommodate the anticipated volume of in...

Page 36: ...e of correlation IDs can also be specified for removal up to 32 correlation IDs separated by a space Optional Clears all correlated event messages from the logging correlator buffer clear logging correlator delete all in buffer Example RP 0 RSP0 CPU0 router clear logging correlator delete all in buffer Step 6 Optional Displays the contents of the correlated event record show logging correlator buf...

Page 37: ...o limit keyword and the severity argument to specify the severity level description not the numeric value assigned to that severity level Note Optional Displays logging events with a severity at or above the numeric value specified severity level show logging events buffer severity hi limit severity Step 2 Example RP 0 RSP0 CPU0 router show logging events buffer severity hi limit critical In this ...

Page 38: ...larms according to a time stamp range The commands can be entered in any order Note SUMMARY STEPS 1 show logging events buffer timestamp lo limit hh mm ss month day year 2 show logging events buffer timestamp hi limit hh mm ss month day year 3 show logging events buffer timestamp hi limit hh mm ss month day year timestamp lo limit hh mm ss month day year DETAILED STEPS Purpose Command or Action Op...

Page 39: ... 03 Displaying Alarms According to Message Group and Message Code This task explains how to display alarms in the logging events buffer according to message code and message group Displaying alarms by message group and message code can be useful in isolating related events The commands can be entered in any order Note SUMMARY STEPS 1 show logging events buffer group message group 2 show logging ev...

Page 40: ...arms in the logging events buffer Alarms can be displayed according to a range beginning with the first or last alarm in the logging events buffer The commands can be entered in any order Note SUMMARY STEPS 1 show logging events buffer first event count 2 show logging events buffer last event count 3 show logging events buffer first event count last event count DETAILED STEPS Purpose Command or Ac...

Page 41: ...his example both the first 20 and last 20 events in the logging events buffer are displayed Displaying Alarms by Location This task explains how to display alarms by location The commands can be entered in any order Note SUMMARY STEPS 1 show logging events buffer location node id 2 show logging events buffer location node id event hi limit event id event lo limit event id DETAILED STEPS Purpose Co...

Page 42: ... 2 show logging events buffer event hi limit event id event lo limit event id DETAILED STEPS Purpose Command or Action Optional Displays all messages in the logging events buffer show logging events buffer all in buffer Example RP 0 RSP0 CPU0 router show logging events buffer all in buffer Step 1 Depending on the alarm severity settings use of this command can create a large amount of output Cauti...

Page 43: ...show logging correlator info Example RP 0 RSP0 CPU0 router show logging correlator info Step 1 Optional Displays all messages in the logging correlation buffer show logging correlator buffer all in buffer Example RP 0 RSP0 CPU0 router show logging correlator buffer all in buffer Step 2 Optional Displays specific messages matching a particular correlation ID in the correlation buffer show logging c...

Page 44: ...logging correlator ruleset ruleset_static Step 8 Clearing Alarm Event Records and Resetting Bistate Alarms This task explains how to clear alarm event records and bistate alarms Unnecessary and obsolete messages can be cleared to reduce the size of the event logging buffer and make it more searchable and thus more navigable The filtering capabilities available for clearing events in the logging ev...

Page 45: ...amp The timestamp lo limit specifies the clear logging events delete timestamp lo limit hh mm ss month day year Step 2 lower time limit Similarly timestamp hi limit specifies the higher Example RP 0 RSP0 CPU0 router clear logging events time limit of a time window All events within this time window will be deleted The default value of the timestamp lo limit is the timestamp of the earliest event i...

Page 46: ...ts buffer Optional Deletes logging events that contain the specified message group clear logging events delete group message group Example RP 0 RSP0 CPU0 router clear logging events delete group config_i Step 8 In this example all events that contain the message group CONFIG_I are deleted from the logging events buffer Optional Clears all bistate alarms in the SET state from the logging events buf...

Page 47: ... set of hosts or all of them SUMMARY STEPS 1 configure 2 snmp server correlator ruleset name rulename name 3 commit DETAILED STEPS Purpose Command or Action configure Step 1 Specifies a ruleset that allows you to group two or more rules into a group and apply that group to a set of hosts snmp server correlator ruleset name rulename name Example RP 0 RSP0 CPU0 router config snmp server correlator S...

Page 48: ...ion that the value that the vbind index or value must match Specifies a numeric rootcause trap OID and optionally one or more numeric varbinds specific to the rootcause trap that must snmp server correlator rule test rootcause A varbind A1 value regex RA1 ALL also be matched to have found a valid rootcause for this rule varbind A2 index regex RA2 The POSIX regexp specifies a regular expression tha...

Page 49: ...n rules or more rules as a group to specific trap destinations SUMMARY STEPS 1 configure 2 snmp server correlator apply ruleset ruleset name all hosts host ipv4 address address port 3 commit DETAILED STEPS Purpose Command or Action configure Step 1 Applies the SNMP trap correlation ruleset to specific trap destinations You have an option of applying the set of two snmp server correlator apply rule...

Page 50: ...ogging events buffer thus does not generate a threshold crossing alarm until it reaches 90 percent capacity Reducing the size of the logging events buffer to 10 000 bytes decreases the number of alarms that are displayed in the logging events buffer and reduces the memory requirements for the component Configuring a Nonstateful Correlation Rule to Permanently Suppress Node Status Messages Example ...

Page 51: ... node 0 1 CPU0 changed to IOX RUN in state default the correlator forwards the PLATFORM INVMGR 6 NODE_STATE_CHANGE message to the syslog process while the remaining two messages are held in the logging correlator buffer In this example the show sample output from the show logging events buffer all in buffer command displays the alarms stored in the logging events buffer after the 4 second time per...

Page 52: ...d all messages in the logging correlator buffer received during the timeout interval are forwarded to the syslog process In this example the correlation rule named updown is configured to correlate the PKT_INFRA LINK UPDOWN alarm the root message and L2 SONET ALARM alarms leaf messages associated with PKT_INFRA LINK UPDOWN alarms logging correlator rule updown type stateful timeout 10000 rootcause...

Page 53: ... The output displays the alarms assigned to correlation IDs 46 and 47 the correlation IDs associated with the PKT_INFRA LINK UPDOWN and L2 SONET ALARM root cause messages RP 0 RSP0 CPU0 router show logging correlator buffer correlationID 46 NO records matching query found Additional References The following sections provide references related to implementing and monitoring alarm logs and logging c...

Page 54: ... and task IDs Standards Title Standards No new or modified standards are supported by this feature and support for existing standards has not been modified by this feature MIBs MIBs Link MIBs 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 ...

Page 55: ...e technical content including links to products technologies solutions technical tips and tools 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 39 Implementing and Monitoring Alarms and Alarm Log Correlation Additional References ...

Page 56: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 40 Implementing and Monitoring Alarms and Alarm Log Correlation Additional References ...

Page 57: ...icies Policies must be registered before an action can be applied to collected events No action occurs unless a policy is registered A registered policy informs the EEM about a particular event that is to be detected and the corrective action to be taken if that event is detected When such an event is detected the EEM enables the corresponding policy You can disable a registered policy at any time...

Page 58: ...anaging Embedded Event Manager Policies Event Management Embedded Event Management EEM in the Cisco IOS XR Software system essentially involves system event management 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 cont...

Page 59: ...g Notifies the processes that have subscribed for event notification A difference exists between scripts with policy actions and scripts that subscribe to receive events Scripts with policy actions are expected to implement a policy They are bound by a rule to prevent recursion Scripts that subscribe to notifications are not bound by such a rule Note Records reliability metric data for each proces...

Page 60: ...log occurs 1 pattern _syslog_pattern maxrun 90 namespace import cisco eem namespace import cisco lib set errorInfo 1 query the information of latest triggered fm event array set arr_einfo event_reqinfo if _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 set msg arr_einfo msg set config_cmds 2 execute the user de...

Page 61: ...s using Tcl Writing an EEM script involves Selecting the event Tcl command extension that establishes the criteria used to determine when the policy is run Defining the event detector options associated with detecting the event Choosing the actions to implement recovery or respond to the detected event Regular Embedded Event Manager Scripts Regular EEM scripts are used to implement policies when a...

Page 62: ...ed in later sections in this document Note Table 3 Embedded Event Manager Tcl Command Extension Categories Definition Category These Tcl command extensions are represented by the event_register_xxx family of event specific commands There is a separate event information Tcl command extension in this category as well event_reqinfo This is the command used in policies to query the EEM for information...

Page 63: ...tcl A filename body part containing a two character abbreviation see table below for the first event specified an underscore part and a descriptive field part that further identifies the policy A filename suffix part defined as tcl EEM e mail template files consist of a filename prefix of email_template followed by an abbreviation that identifies the usage of the e mail template EEM library filena...

Page 64: ...yslog Tcl command extension Generate a syslog message Runs an EEM policy within a policy while the event manager run command is running a policy in EXEC mode Manually run an EEM policy Publishes an application specific event by using the event_publish appl Tcl command extension Publish an application specific event Causes a router to be reloaded by using the EEM action_reload command Reload the Ci...

Page 65: ...terface between other Cisco IOS XR Software components and the EEM They process information that can be used to publish events if necessary These event detectors are supported An EEM event is defined as a notification that something significant has happened within the system Two categories of events exist System EEM events Application defined events System EEM events are built into the EEM and are...

Page 66: ...ation notifications The interfacing is made through a private API available to the System Manager To minimize overhead a portion of the API resides within the System Manager process space When a process terminates the System Manager invokes a helper process if specified in the process startup file before calling the Event Detector API Processes can be identified by component ID System Manager assi...

Page 67: ...s This routine interfaces with the syslog daemon through a private API To minimize overhead a portion of the API resides within the syslog daemon process Screening is provided for the message severity code or the message text fields POSIX regular expression pattern support is provided for the message text field The Syslog Event Detector handles EEM event monitoring requests for the events are show...

Page 68: ...IOS XR Software Watchdog System Monitor Event Detector handles the events as shown in this table Table 8 Watchdog System Monitor Event Detector Requests Description Embedded Event Manager Event Occurs when the CPU time for a specified process is either greater than or equal to a specified maximum percentage of available CPU time or is less than or equal to a specified minimum percentage of availab...

Page 69: ...nager Fault Detector Wdsysmon Fault Detector Counter Event Detector OIR Event Detector Statistic Event Detector Embedded Event Manager Event Scheduling and Notification When an EEM handler is scheduled it runs under the context of the process that creates the event request or for EEM scripts under the Tcl shell process context For events that occur for a process running an EEM handler event schedu...

Page 70: ...al termination Process exits with an exit value equal to 0 Abnormal termination by process Process exits with an exit value not equal to 0 Abnormal termination by QNX Neutrino operating system aborts the process Abnormal termination by kill process API API kill process terminates the process Data to be maintained by process is as follows Most recent process start time Most recent normal process en...

Page 71: ...ent 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 Use the show event manager environment command to display the name and value of all EEM environment variables after they have been set using the event manager environment command SUMMARY STEPS 1 show event manager environment 2 confi...

Page 72: ...U0 router show event manager environment Step 6 What to Do Next After setting up EEM environment variables find out what policies are available to be registered and then register those policies as described in the Registering Embedded Event Manager Policies on page 56 Registering Embedded Event Manager Policies Register an EEM policy to run a policy when an event is triggered Embedded Event Manage...

Page 73: ...persist time to 1 hour Enter 0 to stop the username authentication from being cached If the AAA server is down the username will not authenticate and the script will not run Enter infinite to stop the username from being marked as invalid The username authentication held in the cache will not expire If the AAA server is down the username will be authenticated from the cache System or user keywords...

Page 74: ...RP 0 RSP0 CPU0 router config event Enter the required username keyword and argument where username is the username that runs the script manager policy cron tcl username tom type user Enter the optional persist time keyword to determine how long the username authentication is held in memory Enter the number of seconds for the persist time keyword Enter the infinite keyword to make the authenticatio...

Page 75: ...n that is contained within the policy itself When an EEM policy is registered the software examines the policy and registers it to be run when the specified event occurs Before You Begin A policy must be available that is written in the Tcl scripting language Sample policies are provided in the Sample EEM Policies on page 64 Sample policies are stored in the system policy directory SUMMARY STEPS 1...

Page 76: ...Spaces may be used in the var value argument The command interprets everything after the var name argument to the end of the line to be part of the var value argument Repeat Step 3 on page 60 to configure all the environment variables required by the policy to be registered in Step 5 on page 60 Step 4 Registers the EEM policy to be run when the specified event defined within the policy occurs even...

Page 77: ...phabetical order by the policy name Unregistering EEM Policies Perform this task to remove an EEM policy from the running configuration file Execution of the policy is canceled SUMMARY STEPS 1 show event manager policy registered event type type system user time ordered name ordered 2 configure 3 no event manager policy policy name 4 commit 5 Repeat Step 1 on page 61to ensure that the policy has b...

Page 78: ...ry for reasons of temporary performance or security SUMMARY STEPS 1 show event manager policy registered event type type system user time ordered name ordered 2 configure 3 event manager scheduler suspend 4 commit DETAILED STEPS Purpose Command or Action Displays information about currently registered policies show event manager policy registered event type type system user time ordered name order...

Page 79: ...PS Purpose Command or Action Displays the directory to use for storing EEM user library or policy files show event manager directory user library policy Step 1 Example RP 0 RSP0 CPU0 router show event manager directory user library The optional library keyword displays the directory to use for user library files The optional policy keyword displays the directory to use for user defined EEM policie...

Page 80: ...ntain the EEM Developers of EEM policies may modify these policies by customizing the event for which the policy is to be run and the options associated with logging and responding to the event In addition developers may select the actions to be implemented when the policy runs The Cisco IOS XR Software includes a set of sample policies see Sample EEM Policy Descriptions table The sample policies ...

Page 81: ...iggered when the script looks for the sysdb timeout ios_msgs and obtains the output of the show commands The output is written to a file named after the blocking process sl_sysdb_timeout tcl This policy runs using a configurable CRON entry It executes a configurable CLI command and e mails the results tm_cli_cmd tcl This policy runs at midnight each day and e mails a process crash history report t...

Page 82: ... manager policy test tcl username user_a type user Step 4 commit Step 5 Programming EEM Policies with Tcl Perform this task to help you program a policy using Tcl command extensions We recommend that you copy an existing policy and modify it There are two required parts that must exist in an EEM Tcl policy the event_register Tcl command extension and the body All other sections shown in the Tcl Po...

Page 83: ...il_server set result Policy cannot be run variable _email_server has not been set error result errorInfo if info exists _email_from set result Policy cannot be run variable _email_from has not been set error result errorInfo if info exists _email_to set result Policy cannot be run variable _email_to has not been set error result errorInfo The namespace import section is optional and defines code l...

Page 84: ...s n s _cerr_sub_num _cerr_sub_err _cerr_posix_err _cerr_str error result global timer_type timer_time_sec set timer_type arr_einfo timer_type set timer_time_sec arr_einfo timer_time_sec Log a message set msg format timer event timer type s time expired s timer_type clock format timer_time_sec action_syslog priority info msg msg if _cerrno 0 set result format component s subsys err s posix err s n ...

Page 85: ...e following form XYSSSSSSSSSSSSSEEEEEEEEPPPPPPPPP For example the following error return value might be returned from an EEM Tcl command extension 862439AE This number is interpreted as the following 32 bit value 10000110001001000011100110101110 This 32 bit integer is divided up into the five variables shown in this table Table 10 _cerrno 32 Bit Error Return Value Variables Description Variable Th...

Page 86: ...de is contained in _cerr_posix_err PPPPPPPP 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 Class Error Return Value CERR_CLASS_SUCCESS 00 CERR_CLASS_INFO 01 CERR_CLASS_WARNING 10 CERR_CLASS_FATAL 11 An error return value of zero means SUCCESS Cisco ASR 9000 Series Aggregation Services Router ...

Page 87: ... persist time seconds infinite type system user 14 commit 15 Cause the policy to execute and observe the policy 16 Use debugging techniques if the policy does not execute correctly DETAILED STEPS Purpose Command or Action Displays EEM policies that are available to be registered show event manager policy available system user Step 1 Example RP 0 RSP0 CPU0 router show event manager policy available...

Page 88: ...hether any EEM environment variables that are required by the policy are defined before Program the must defines section to check for each environment variable that is used in this policy Step 5 the recovery actions are taken The must defines section is not required if the policy does not use any EEM environment variables EEM environment variables for EEM scripts are Tcl global variables that are ...

Page 89: ...f the SMTP library to send e mail notifications or the CLI library to run CLI commands from a policy If the prior policy is successful the current policy may or may not require execution Entry status designations may use one of three possible values 0 Check the entry status to determine if a policy has previously run for this event Step 7 previous policy was successful Not 0 previous policy failed...

Page 90: ...anager directory user library disk0 user_library Registers the EEM policy to be run when the specified event defined within the policy occurs event manager policy policy name username username persist time seconds infinite type system user Step 13 Example RP 0 RSP0 CPU0 router config event manager policy test tcl username user_a type user commit Step 14 Cause the policy to execute and observe the ...

Page 91: ...ger directory user library path 8 event manager directory user policy path 9 event manager policy policy name username username persist time seconds infinite type system user 10 event manager run policy argument 11 commit DETAILED STEPS Purpose Command or Action The following example files can be used to create a tclIndex on a workstation running the Tcl shell On your workstation UNIX Linux PC or ...

Page 92: ... is a script that loads the command set auto_index test1 list source file join dir lib1 tcl set auto_index test2 list source file join dir lib1 tcl set auto_index test3 list source file join dir lib2 tcl Copy the Tcl library files from Step 1 on page 75and the tclIndex file from Step 3 on page 76to Step 4 the directory used for storing user library files on the target router The directory can be t...

Page 93: ...1 Creating an EEM User Tcl Package Index Perform this task to create a Tcl package index file that contains a directory of all the Tcl packages and version information contained in a library of Tcl package files Tcl packages are supported using the Tcl package keyword Tcl packages are located in either the EEM system library directory or the EEM user library directory When a package require Tcl co...

Page 94: ...sist time seconds infinite type system user 10 event manager run policy argument 11 commit DETAILED STEPS Purpose Command or Action On your workstation UNIX Linux PC or Mac create a library directory and copy the Tcl package files into the directory Step 1 Enters the Tcl shell tclsh Example workstation tclsh Step 2 Use the pkg_mkindex command to create the pkgIndex file The pkgIndex file contains ...

Page 95: ...ter Step 4 The directory can be the same directory used in Step 4 on page 79 Copy a user defined EEM policy file written in Tcl to the directory used for storing user defined EEM policies on the target router Step 5 The following example user defined EEM policy can be used to test the Tcl library support in EEM packagetest tcl cisco eem event_register_none maxrun 1000000 000 test if xmlrpc availab...

Page 96: ...er config event manager run packagetest tcl Step 10 commit Step 11 Configuration Examples for Event Management Policies Environmental Variables Configuration Example This configuration sets the environment variable cron_entry RP 0 RSP0 CPU0 router configure 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 E...

Page 97: ...rocess name wd critical mon instance 1 last event type process start recent start time Mon Sep 10 21 36 49 2007 recent normal end time n a recent abnormal end time n a number of times started 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 most recent 10 process end times and types cumulative process available time 5...

Page 98: ...nvironment Variables for the Sample Policies Event manager environment variables are Tcl global variables that are defined external to the EEM policy before the policy is registered and run The sample policies require three of the e mail environment variables to be set only _email_cc is optional Other required and optional variable settings are outlined in the following tables This table describes...

Page 99: ...ple policy is run Table 14 Environment Variables Used in the tm_cli_cmd tcl Policy Example Description Environment Variable 0 59 1 0 23 1 0 7 CRON specification that determines when the policy will run _cron_entry show version CLI command to be executed when the policy is run _show_cmd This table describes the EEM environment variables that must be set before the tm_crash_reporter tcl sample polic...

Page 100: ... a given value a warning is displayed This variable is optional and need not be specified _tm_fsys_usage_freebytes nvram 25 disk2 5 Disk usage percentage thresholds for systems or specific prefixes If the disk usage percentage exceeds a given percentage a warning is displayed If unspecified the default disk usage percentage is 80 percent for all systems This variable is optional and need not be sp...

Page 101: ...ration scenarios to demonstrate how to use the four sample Tcl policies Running the sl_intf_down tcl Sample Policy This sample policy demonstrates the ability to modify the configuration when a syslog message with a specific pattern is logged The policy gathers detailed information about the event and uses the CLI library to run the configuration commands specified in the EEM environment variables...

Page 102: ...EM environment variable _cron_entry The EEM server is notified and the server runs the policy that is registered to handle this event tm_cli_cmd tcl enable show event manager policy registered show event manager policy available configure terminal event manager policy tm_cli_cmd tcl end show event manager policy registered Running the tm_crash_reporter tcl Sample Policy This sample policy demonstr...

Page 103: ...d to verify that no policies are currently registered Next enter the show event manager policy available command to display which policies are available to be installed After you enter the configure command to reach global configuration mode you can register the tm_fsys_usage tcl policy with EEM using the event manager policy command Exit from global configuration mode and enter the show event man...

Page 104: ...ngineering example com _email_cc optional The address to which the e mail must be copied Example _email_cc manager example com _show_cmd mandatory The CLI command to be executed when the policy is run Example _show_cmd show version check if all required environment variables exist If any required environment variable does not exist print out an error msg and quit if info exists _log_file if info e...

Page 105: ... result dummy cmd_output if catch cli_close cli1 fd cli1 tty_id result error result errorInfo 2 log the success of the CLI command set msg format Command s executed successfully _show_cmd action_syslog priority info msg msg if _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 3 if _log_file is defined then attach...

Page 106: ...ich e mail is sent Example _email_from devtest example com _email_to mandatory The address to which e mail is sent Example _email_to engineering example com _email_cc optional The address to which the e mail must be copied Example _email_cc manager example com _config_cmd1 optional The first configuration command that is executed Example _config_cmd1 interface Ethernet1 0 _config_cmd2 optional The...

Page 107: ...fig_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 if catch cli_close cli1 fd cli1 tty_id result error result errorInfo after 60000 3 send the notification email set routername info hostname if string match routername error Host name is not configured if catch smtp_subst file join tcl_library email...

Page 108: ...Manager policies Related Documents Document Title Related Topic Embedded Event Manager Commands module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Command Reference Embedded Event Manager commands Hardware Redundancy and Node Administration Commands module in the Cisco ASR 9000 Series Aggregation Services Router Interface and Hardware Component Command Reference Rout...

Page 109: ...d by this feature Technical Assistance Link Description http www cisco com cisco web support index html The Cisco Technical Support website contains thousands of pages of searchable technical content including links to products technologies solutions technical tips and tools Registered Cisco com users can log in from this page to access even more content Embedded Event Manager Policy Tcl Command E...

Page 110: ...hen an application event is triggered following another policy s execution of an event_publish Tcl command extension the event_publish command extension publishes an application event To register for an application event a subsystem must be specified Either a Tcl policy or the internal EEM API can publish an application event If the event is being published by a policy the sub_system argument that...

Page 111: ...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 maxrun Optional Policy run time priority setting When the nice argument is set to 1 the policy is run at a run time priority that is less than the default priority The default value is 0 nice If multiple conditions exist th...

Page 112: ...e must be satisfied in order for an event to be published specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295 inclusive and where MMM must be an integer representing milliseconds between 0 and 999 If this argument is not specified the most recent event is used period Mandatory Specifies the regular expression used to perform the CLI ...

Page 113: ...Specifies that the script is to be queued at a priority level greater than low priority but less than high priority queue_priority high Specifies that the script is to be queued at the highest of the three priority levels queue_priority last Specifies that the script is to be queued at the lowest priority level If more than one script is registered with the queue_priority_last argument set these s...

Page 114: ...nter to which it wants to subscribe and depends on another policy or another process to actually manipulate the counter For example let policyB act as a counter policy whereas policyA although it does not need to be a counter policy uses register_counter counter_modify or unregister_counter Tcl command extensions to manipulate the counter defined in policyB Syntax event_register_counter name entry...

Page 115: ... between 0 and 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 maxrun Optional Policy run time priority setting When the nice argument is set to 1 the policy is run at a run time priority that is less than the default priority The default value is 0 nice Result String No...

Page 116: ...mental condition that is used to monitor This is a bit mask that monitors multiple kinds of environmental conditions The following supported environmental conditions and their corresponding bitmasks are listed 0x0001 low warning 0x0002 high warning 0x0004 warning 0x0010 low critical 0x0020 high critical 0x0040 critical 0x0100 pre shutdown 0x0200 shutdown env_cond Optional Priority level that the s...

Page 117: ...riority low normal high maxrun nice 0 1 Arguments Optional Priority level at which the script will be queued normal priority is greater than low priority but less than high priority The priority here is not execution priority but queuing priority If this argument is not specified the default priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM forma...

Page 118: ...e priority here is not execution priority but queuing priority If this argument is not specified the default priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295 inclusive and where MMM must be an integer representing milliseconds between 0 and 999 If this argum...

Page 119: ...g with a nonzero exit status receiving a kernel generated signal or receiving a SIGTERM or SIGKILL signal that is not sent because of user request abort Mandatory Normal process termination term Mandatory Process start start Optional Number assigned to the EEM policy that published the process event Number is set to 798 because all other numbers are reserved for Cisco use job_id Optional Process i...

Page 120: ...e of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 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 maxrun Optional Policy run time priority setting When the nice argument is set to 1 the policy is run...

Page 121: ...tional String identifying a tag that can be used with the trigger Tcl command extension to support multiple event statements within a Tcl script tag Mandatory Entry comparison operator used to compare the current OID data value with the entry value if true an event will be raised and event monitoring will be disabled until exit criteria are met entry_op Mandatory Type of SNMP get operation that ne...

Page 122: ...he rate of change entry type Optional Exit combination operator used to indicate the combination of exit condition tests required to decide if the exit criteria are met so that the event monitoring can be reenabled If it is and both exit value and exit time tests must be passed to meet the exit criteria If it is or either exit value or exit time tests can be passed to meet the exit criteria When e...

Page 123: ...er units after an event is raised when event monitoring will be enabled again Specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer number representing seconds between 0 and 4294967295 inclusive MMM represents milliseconds and must be an integer number between 0 and 999 exit_time Mandatory Interval between consecutive polls in POSIX timer units Currently the interval is forced to ...

Page 124: ... dot notation for example 1 3 6 1 2 1 2 1 0 If the specified OID ends with a dot then all OIDs that start with the OID number before the dot are matched It supports all OID supported by SNMP in XR oid Mandatory OID value with which the current OID data value should be compared to decide if the SNMP event should be raised oid_val Mandatory Comparison operator used to compare the current OID data va...

Page 125: ...g_op Result String None Set _cerrno No event_register_stat Registers for a statistics event Use this Tcl command extension to run a policy when a given statistical counter crosses a defined threshold The following three fields are listed to uniquely identify the statistics counter that the EEM keyword monitors Data element name corresponds to the argument name For example the ifstats generic name ...

Page 126: ...istics but optional for others For interface statistics this variable is the interface statistic name To get the interface statistic name use the show event manager statistics table command with the all keyword to list all the classes of statistics Then use the show event manager statistics table command with the name argument to get the specific statistics name for modifier_2 modifier_2 Mandatory...

Page 127: ...n The integer number must be between 0 and 2147483647 inclusive exit_time_sec exit_time_nse Either the poll_interval_sec or poll_interval_nsec arguments must be specified The interval must be between the consecutive polls in POSIX time units Currently it is forced to be at least one second The integer number must be between 0 and 2147483647 inclusive poll_interval_sec poll_interval_nsec Optional P...

Page 128: ...logged after a certain number of occurrences during a certain period of time Syntax event_register_syslog occurs period pattern priority all emergencies alerts critical errors warnings notifications informational debugging 0 1 2 3 4 5 6 7 queue_priority low normal high severity_fatal severity_critical severity_major severity_minor severity_warning severity_notification severity_normal severity_deb...

Page 129: ...ority The priority here is not execution priority but queuing priority If this argument is not specified the default priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295 inclusive and where MMM must be an integer representing milliseconds between 0 and 999 If th...

Page 130: ...this Tcl command extension when there is a need to trigger a policy that is time specific or timer based This event timer is both an event publisher and a subscriber The publisher part indicates the conditions under which the named timer is to go off The subscriber part identifies the name of the timer to which the event is subscribing Both the CRON and absolute time specifications work on local t...

Page 131: ...ory CRON timer cron Optional Name of the timer name Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 115 Configuring and Managing Embedded Event Manager Policies Embedded Event Manager Event Registration Tcl Command Extensions ...

Page 132: ...SR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 116 Configuring and Managing Embedded Event Manager Policies Embedded Event Manager Event Registration Tcl Command Extensions ...

Page 133: ...riggered every other hour Steps are also permitted after an asterisk so if you want to say every two hours use 2 Names can also be used for the month and the day of week fields Use the first three letters of the particular day or month case does not matter Ranges or lists of names are not allowed The day on which a timer event is triggered can be specified by two fields day of month and day of wee...

Page 134: ... time Optional Priority level at which the script will be queued normal priority is greater than low priority but less than high priority The priority here is not execution priority but queuing priority If this argument is not specified the default priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer repres...

Page 135: ... 0 hourly Result String None Set _cerrno No See Also event_register_timer_subscriber on page 119 event_register_timer_subscriber Registers for a timer event as a subscriber Use this Tcl command extension to identify the name of the timer to which the event timer as a subscriber wants to subscribe The event timer depends on another policy or another process to actually manipulate the timer For exam...

Page 136: ...ult priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 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 maxrun Optional Policy run time priorit...

Page 137: ...string Optional String identifying a tag that can be used with the trigger Tcl command extension to support multiple event statements within a Tcl script tag Optional Specifies that the tracked object transition will cause an event to be raised If up is specified an event will be raised when the tracked object transitions from a down state to an up state If down is specified an event will be raise...

Page 138: ...tered Note If this argument is not specified the default queuing priority is normal queue_priority Optional Maximum run time of the script specified in SSSSSSSSSS MMM format where SSSSSSSSSS must be an integer representing seconds between 0 and 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 r...

Page 139: ...axrun nice 0 1 Arguments Optional Time window within which all of the subevents have to occur in order for an event to be generated and is specified in SSSSSSSSSS MMM format SSSSSSSSSS format must be an integer representing seconds between 0 and 4294967295 inclusive MMM format must be an integer representing milliseconds between 0 and 999 timewin Optional Combination operator for comparison betwee...

Page 140: ...at is specified in SSSSSSSSSS MMM format SSSSSSSSSS format must be an integer representing seconds between 0 and 4294967295 inclusive MMM format 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 maxrun Optional Policy run time priority setting When the nice argument is set to 1 the policy is run at a run ti...

Page 141: ...SSSSSSS format must be an integer representing seconds between 0 and 4294967295 inclusive MMM format must be an integer representing milliseconds between 0 and 999 If this argument is not specified the most recent sample is used period 1 cpu_proc procname op gt ge eq ne lt le val period Arguments Optional Regular expression that specifies the process name that you want to monitor for CPU utilizati...

Page 142: ...eriod for averaging the collection of samples and is specified in SSSSSSSSSS MMM format SSSSSSSSSS format must be an integer representing seconds between 0 and 4294967295 inclusive MMM format must be an integer representing milliseconds between 0 and 999 If this argument is not specified the most recent sample is used period 1 mem_proc procname op gt ge eq ne lt le val is_percent TRUE FALSE period...

Page 143: ...ween 0 and 999 If this argument is not specified the most recent sample is used period 1 mem_tot_avail op gt ge eq ne lt le val is_percent TRUE FALSE period Arguments Optional Comparison operator that is used to compare the collected available memory with the specified value If true an event is raised op Optional Percentage or an absolute value that is specified in kilobytes A percentage represent...

Page 144: ...as increased from 150 KB to 300 KB within the time period the percentage increase is 100 This is the value in which the measured value is compared val Optional If set to TRUE the percentage value is collected and compared Otherwise the absolute value is collected and compared is_percent Optional If is_percent is set to TRUE the time period for the percentage is computed Otherwise the time period f...

Page 145: ...ub_system 0x x type u data1 s data2 s data3 s data4 s Description Event Type 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_id Type of event event_type ASCII string that represents the name of the event for this event type event_type_string The time in seconds and milliseconds when the e...

Page 146: ...ime in seconds and milliseconds when the event was published to the Embedded Event Manager event_pub_secevent_pub_msec Counter name name For EEM_EVENT_NONE event_id u event_type u event_type_string s event_pub_sec u event_pub_msec u Description Event Type 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 ...

Page 147: ...c u sub_system 0x x instance u process_name s path s exit_status 0x x respawn_count u last_respawn_sec ld last_respawn_msec ld fail_count u dump_count u node_name s Description Event Type 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_id Type of event event_type ASCII string that represe...

Page 148: ... hardware slot number The cpu number is the hardware CPU number node_name For EEM_EVENT_RF event_id u event_type u event_type_string s u event_pub_sec u event_pub_msec u event s Description Event Type 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_id Type of event event_type ASCII string...

Page 149: ...M_EVENT_TIMER_WATCHDOG event_id u event_type u event_type_string s event_pub_sec u event_pub_msec u timer_type s timer_time_sec ld timer_time_msec ld timer_remain_sec ld timer_remain_msec ld Description Event Type 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_id Type of event event_type...

Page 150: ...s the name of the event for this event type event_type_string Time in seconds and milliseconds when the event was published to the Embedded Event Manager event_pub_secevent_pub_msec Type of the timer timer_type Time when the timer expired timer_time_sectimer_time_msec For EEM_EVENT_TRACK event_id u event_type u event_type_string s u event_pub_sec u event_pub_msec u track_number u track_state s Des...

Page 151: ...for the same event and each policy will have the same event_id event_id Type of event event_type ASCII string that represents the name of the event for this event type event_type_string Time in seconds and milliseconds when the event was published to the Embedded Event Manager event_pub_secevent_pub_msec Subevent number num_subs Where the subevent info string is for a deadlock subevent type s num_...

Page 152: ...s A thread m Can be one of the following STATE_CONDVAR STATE_DEAD STATE_INTR STATE_JOIN STATE_MUTEX STATE_NANOSLEEP STATE_READY STATE_RECEIVE STATE_REPLY STATE_RUNNING STATE_SEM STATE_SEND STATE_SIGSUSPEND STATE_SIGWAITINFO STATE_STACK STATE_STOPPED STATE_WAITPAGE STATE_WAITTHREAD state Name of the node that process B thread is on b_node Name of process B b_procname Cisco ASR 9000 Series Aggregati...

Page 153: ...e window is specified and is greater than zero in the event registration Tcl command extension the total number of events processed by this dispatch manager is in the given time window value If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension they are both 0 If a time window is specified and is greater than zero in the event registrat...

Page 154: ...is greater than zero in the event registration Tcl command extension the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window secmsec For cpu_tot Subevent type s node s value u sec ld msec ld Description Subevent Type Type of wdsysmon subevent type Name of the node on which the total CPU utilization is being monitored no...

Page 155: ... for this subevent The three preceding fields describe the process whose memory usage is being monitored Note pid Can be either TRUE or FALSE TRUE means that the value is a percentage value FALSE means that the value is an absolute value may be an averaged value is_percent If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension the proces...

Page 156: ... extension value is the process used memory in the latest sample diff is 0 sec and msec are both 0 If the is_percent argument is FALSE and a time window is specified as greater than zero in the event registration Tcl command extension value is the averaged process used memory sample value in the specified time window diff is 0 sec and msec are both the actual time difference between the time stamp...

Page 157: ...the averaged total used memory utilization is in the given time window used If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension the avail is in the latest total available memory sample If a time window is specified and is greater than zero in the event registration Tcl command extension the avail is the total available memory utilizat...

Page 158: ...0 sec and msec are both the actual time difference between the time stamps of the oldest and latest total available memory samples in this time window If the is_percent argument is TRUE and a time window is specified as greater than zero in the event registration Tcl command extension used is 0 avail is 0 diff is the percentage difference between the oldest and latest total available memory sample...

Page 159: ...me window used If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension the avail is in the latest total used memory sample If a time window is specified and is greater than zero in the event registration Tcl command extension the avail is the total used memory utilization in the specified time window avail If the sec and msec variables ar...

Page 160: ...w avail is 0 diff is 0 sec and msec are both the actual time difference between the time stamps of the oldest and latest total used memory samples in this time window If the is_percent argument is TRUE and a time window is specified as greater than zero in the event registration Tcl command extension used is 0 avail is 0 diff is the percentage difference between the oldest and latest total used me...

Page 161: ...b_sec ld event_pub_msec ld oid s val s delta_val s exit_event s Typical usage for a multi event consisting of both a timer event and an SNMP event might be array set arr_minfo event_reqinfo_multi if _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 array set arr_einfo arr_minfo ev tag for timer event spec global ...

Page 162: ... 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 If the test_iterations value is exceeded the script writes a message and exits otherwise the script executes the remaining statements and resch...

Page 163: ...ment variable does not exist print out an error msg and quit if info exists test_iterations set result Policy cannot be run variable test_iterations has not been set error result errorInfo namespace import cisco eem namespace import cisco lib Query the event info array set arr_einfo event_reqinfo if _cerrno 0 set result format component s subsys err s posix err s n s _cerr_sub_num _cerr_sub_err _c...

Page 164: ...ultiple Event Support Tcl Command Extensions Attribute Specifies a complex event used for Multi Event Support Syntax attribute tag occurs Arguments Specifies a tag using the event tag argument that can be used with the attribute command to associate an event tag Optional Specifies the number of occurrences before an EEM event is triggered If not specified an EEM event is triggered on the first occ...

Page 165: ...he action is executed and Optional Specifies that if event 1 occurs the action is executed or else if event 2 and event 3 occur together the action is executed or Result String None Example correlate event 1 or event 2 and event 3 Trigger Specifies the multiple event configuration ability of Embedded Event Manager EEM events A multiple event is one that can involve one or more event occurrences an...

Page 166: ...the first CRON period occurs period start Optional Specifies the number of seconds and optional milliseconds after which an event will be raised if all the conditions are true specified in the format ssssssssss mmm where ssssssssss must be an integer number representing seconds between 0 and 4294967295 inclusive and mmm represents milliseconds and must be an integer number between 0 to 999 delay R...

Page 167: ... between 1 and 4294967295 inclusive instance Result String None Set _cerrno Yes _cerr_sub_err 14 FH_ENOSUCHACTION unknown action type This error means that the action command requested was unknown _cerr_sub_num 425 _cerr_sub_err 1 SYSMGR_ERROR_INVALID_ARGS Invalid arguments passed This error means that the arguments passed in were invalid _cerr_sub_num 425 _cerr_sub_err 2 SYSMGR_ERROR_NO_MEMORY Co...

Page 168: ...action_program path argv envp stdin stdout stderr Arguments Mandatory Pathname of a program to run path Optional Argument string of the program argv Optional Environment string of the program envp Optional Pathname for stdin stdin Optional Pathname for stdout stdout Optional Pathname for stderr stderr Result String None Set _cerrno Yes _cerr_sub_err 2 FH_ESYSERR generic unknown error from OS syste...

Page 169: ...err 2 FH_ESYSERR generic unknown error from OS system 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 This error means that the action command requested was unknown _cerr_sub_err 52 FH_ECONFIG configuration erro...

Page 170: ...t node action_process sys_reqinfo_proc sys_reqinfo_proc_all sys_reqinfo_crash_history sys_reqinfo_proc_version Syntax action_setnode node Arguments Mandatory Name of the node node Result String None Set _cerrno Yes action_syslog Logs a message Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 154 Configuring and Managing Embedded Event Manager Po...

Page 171: ...action command requested was unknown action_track_read Reads the state of a tracked object when an Embedded Event Manager EEM script is triggered Syntax action_track_read Arguments Mandatory Tracked object name represents a string Result String name s state s Set _cerrno Yes FH_ENOTRACK This error means that the tracked object name was not found Cisco ASR 9000 Series Aggregation Services Router Sy...

Page 172: ...er between 1 and 4294967295 inclusive length Result String data s Where data is the application published string data to be read Set _cerrno Yes _cerr_sub_err 2 FH_ESYSERR generic unknown error from OS system 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_su...

Page 173: ...or 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 7 FH_ENOSUCHKEY could not find key This error means that the application event detector info key or other ID was not found appl_setinfo Saves information in the EEM This Tcl command extension provides support for saving information in the EEM that can be retrie...

Page 174: ...ngth or number exceeded the maximum _cerr_sub_err 43 FH_EBADLENGTH bad API length This error means that the API message length was invalid counter_modify Modifies a counter value Syntax counter_modify event_id val op nop set inc dec Arguments Mandatory Counter event ID returned by the register_counter Tcl command extension Must be an integer between 0 and 4294967295 inclusive event_id Mandatory If...

Page 175: ... the event was being registered or that an event detector internal event structure is corrupt _cerr_sub_err 22 FH_ENULLPTR event detector internal error ptr is null This error means that an internal EEM event detector pointer was null when it should have contained a value _cerr_sub_err 30 FH_ECTBADOPER bad counter threshold operator This error means that the counter event detector set or modify op...

Page 176: ...et _cerrno Yes _cerr_sub_err 2 FH_ESYSERR generic unknown error from OS system 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 4 FH_EINITONCE Init is not yet done or done twice This error means that the request to register the specific event was made ...

Page 177: ...ror 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 This error means that the number of timer or counter subscribers exceeded the maximum _cerr_sub_err 26 FH_ESUBSIDXINV invalid subscriber index This error means that the subscriber index was invalid _cerr_sub_err 54 FH_EFDUNAVAIL connect...

Page 178: ...st for memory failed _cerr_sub_err 10 FH_ECORRUPT internal EEM API context is corrupt This error means that the internal EEM API context structure is corrupt _cerr_sub_err 11 FH_ENOSUCHESID unknown event specification ID 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_e...

Page 179: ...timer type is CRON Must not exist for other types of timer CRON timer specification uses the format of the CRON table entry cron_entry Mandatory Must exist if the timer type is not CRON Must not exist if the timer type is CRON For watchdog and countdown timers the number of seconds and milliseconds until the timer expires for an absolute timer the calendar time of the expiration time specified in ...

Page 180: ...detector internal event structure is corrupt _cerr_sub_err 12 FH_ENOSUCHEID unknown event ID This error means that the event ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt _cerr_sub_err 22 FH_ENULLPTR event detector internal error ptr is null This error means that an internal EEM event detector pointer was null when it shou...

Page 181: ... used to determine the cause of the operating system error _cerr_sub_err 6 FH_EBADEVENTTYPE unknown EEM event type This error means that the event type specified in the internal event specification was invalid _cerr_sub_err 7 FH_ENOSUCHKEY could not find key This error means that the application event detector info key or other ID was not found _cerr_sub_err 11 FH_ENOSUCHESID unknown event specifi...

Page 182: ...gister_counter Tcl command extension Syntax unregister_counter event_id event_spec_id Arguments Mandatory Counter event ID returned by the register_counter command extension Must be an integer between 0 and 4294967295 inclusive event_id Mandatory Counter event specification ID for the specified counter returned by the register_counter command extension Must be an integer between 0 and 4294967295 i...

Page 183: ...his error means that the EEM event detector that handles this request is not available Embedded Event Manager System Information Tcl Command Extensions All EEM system information commands sys_reqinfo _xxx have the Set _cerrno section set to yes Note sys_reqinfo_cpu_all Queries the CPU utilization of the top processes both POSIX processes and IOS processes during a specified time period and in a sp...

Page 184: ...ec_list Process ID pid Process name name Specifies that if sec and msec are specified with a number greater than zero the average percentage is calculated from the process CPU utilization during the specified time period If sec and msec are both zero or not specified the average percentage is calculated from the process CPU utilization in the latest sample cpu_used Set _cerrno Yes sys_reqinfo_cras...

Page 185: ..._status Last exit type exit_type 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 proc_state Version manager assigned component ID for the component to which the process belongs component_id Seconds and milliseconds since January 1 1970 which represent the last time the process crashed crash_time...

Page 186: ... and latest samples collected in the time period The percentage is calculated as the the percentage difference between the memory used in the oldest and latest samples collected in the time period If not specified or if both sec and msec are specified as 0 the first sample ever collected is used as the oldest sample that is the time period is set to be the time from startup until the current momen...

Page 187: ... sys_reqinfo_proc Queries the information about a single POSIX process This Tcl command extension is supported only in Software Modularity images Syntax sys_reqinfo_proc job_id Arguments Mandatory System manager assigned job ID for the process Must be an integer between 1 and 4294967295 inclusive job_id Result String job_id u component_id 0x x name s helper_name s helper_path s path s node_name s ...

Page 188: ...ing permitted max_dump_count Total number of restarts for the process respawn_count Number of restart attempts of the process This count is reset to zero when the process is successfully restarted fail_count Number of core dumps performed dump_count Seconds and milliseconds in POSIX timer units since January 1 1970 which represent the last time the process was started last_respawn_seclast_respawn_...

Page 189: ..._cerrno Yes sys_reqinfo_proc_version Queries the version of the given process Syntax sys_reqinfo_proc_version job_id Arguments Mandatory System manager assigned job ID for the process The integer number must be inclusively between 1 and 2147483647 job_id 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 Se...

Page 190: ... event frequency string 0 log freq str 1 Where each event frequency string is time_sec ld time_msec ld match_count u raise_count u occurs u period_sec ld period_msec ld pattern s Seconds and milliseconds in POSIX timer units since January 1 1970 which represent the time the last event was raised time_sectime_msec Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Gui...

Page 191: ... system error _cerr_sub_err 9 FH_EMEMORY insufficient memory for request This error means that an internal EEM request for memory failed _cerr_sub_err 22 FH_ENULLPTR event detector internal error ptr is null This error means that an internal EEM event detector pointer was null when it should have contained a value _cerr_sub_err 45 FH_ESEQNUM sequence or workset number out of sync This error means ...

Page 192: ...means that an internal EEM event detector pointer was null when it should have contained a value _cerr_sub_err 44 FH_EHISTEMPTY history list is empty This error means that the history list was empty _cerr_sub_err 45 FH_ESEQNUM sequence or workset number out of sync This error means that the event detector sequence or workset number was invalid _cerr_sub_err 54 FH_EFDUNAVAIL connection to event det...

Page 193: ..._reqinfo_snmp oid get_type exact next Arguments Mandatory SNMP OID in dot notation for example 1 3 6 1 2 1 2 1 0 oid Mandatory Type of SNMP get operation that needs to be applied to the specified oid If the get_type is 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 get_type Result String oid s v...

Page 194: ...trap variable can contain a list of 10 multiple oids and values Syntax sys_reqinfo_snmp_trapvar var varname oid oid int uint counter gauge octet string ipv4 value Use the var argument to specify the trap variable name Use the oid argument to specify the oid of the trap Example sys_reqinfo_snmp_trapvar var var1 oid 1 3 6 1 4 1 9 9 41 1 2 3 1 3 int 4 SMTP Library Command Extensions All Simple Mail T...

Page 195: ... name process_name subsystem sub_system exit status exit_status respawn count respawn_count Exported Tcl Command Extensions smtp_send_email Given the text of an e mail template file with all global variables already substituted sends the e mail out using Simple Mail Transfer Protocol SMTP The e mail template specifies the candidate mail server addresses To addresses CC addresses From address subje...

Page 196: ...mple Scripts After all needed global variables in the e mail template are defined if catch smtp_subst file join tcl_library email_template_sm result puts stderr result exit 1 if catch smtp_send_email result result puts stderr result exit 1 smtp_subst Given an e mail template file e mail_template substitutes each global variable in the file by its user defined value Returns the text of the file aft...

Page 197: ...ser is supposed to enter the answer for each question Only after all the questions have been answered properly will the command run according to the user s options until completion For noninteractive commands once the command is entered the command will run to completion To run different types of commands using an EEM script different CLI library command sequences should be used which are document...

Page 198: ... CLI command to execute cmd Result String The output of the CLI command executed Set _cerrno Error reading the channel cli_get_ttyname Returns the real and pseudo tty names for a given TTY ID Syntax cli_get_ttyname tty_id Arguments Mandatory The TTY ID returned from the cli_open command extension tty_id Result String pty s tty s Cisco ASR 9000 Series Aggregation Services Router System Monitoring C...

Page 199: ...re available preserving the remaining vtys for Telnet use Note Syntax cli_open Arguments None Result String tty_id s pty d tty d fd d Description Event Type TTY ID tty_id PTY device name pty TTY device name tty CLI channel handler fd Set _cerrno Cannot get pty for EXEC Cannot create an EXEC CLI session Error reading the first prompt cli_read Reads the command output from the specified command line...

Page 200: ...e interface CLI channel handler Returns all the contents read Syntax cli_read_drain fd Arguments Mandatory The CLI channel handler fd Result String 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 Configurat...

Page 201: ...ered from 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 If more than 256 characters in the output buffer are required for the match to succeed the pattern will not match Note Syntax cli_read_pattern fd ptn Arguments Mandatory CLI channe...

Page 202: ...example use configuration CLI commands to bring up Ethernet interface 1 0 if catch cli_open result puts stderr result exit 1 else array set cli1 result if catch cli_exec cli1 fd config t result puts stderr result exit 1 if catch cli_exec cli1 fd interface Ethernet1 0 result puts stderr result exit 1 if catch cli_exec cli1 fd no shut result puts stderr result exit 1 if catch cli_exec cli1 fd end re...

Page 203: ...and extension Phase 2 Q A Phase Use the cli_read_pattern command extension to read the question the regular pattern that is specified to match the question text and the cli_write command extension to write back the answers alternately Phase 3 Noninteractive phase All questions have been answered and the command will run to completion Use the cli_read command extension to wait for the complete outp...

Page 204: ...to illustrate the flexibility of the CLI library for interactive command execution 1 execute the reload command if catch cli_open result error result errorInfo else array set cli1 result if catch cli_write cli1 fd reload result error result errorInfo else set cmd_output result if catch cli_read_pattern cli1 fd System configuration has been modified Save yes no result error result errorInfo else se...

Page 205: ...nal Scalar variable name or array variable name Defaults to a null string if this argument is not specified var Optional Array index index_if_array The index_if_array argument is ignored when the var argument is a scalar variable Note If var is unspecified retrieves the whole variable table saved in the context If var is specified and index_if_array is not specified or if index_if_array is specifi...

Page 206: ...succeeded Example 1 Retrieve If var is unspecified retrieves multiple variables from the context cisco eem event_register_none namespace import cisco eem namespace import cisco lib if catch foreach var value context_retrieve TESTCTX set var value errmsg action_syslog msg context_retrieve failed errmsg else action_syslog msg context_retrieve succeeded if info exists testvara action_syslog msg testv...

Page 207: ...r action_syslog msg testvar exists and is testvar else action_syslog msg testvar does not exist Example 3 Save If var is specified saves the value of var even if it is an array cisco eem event_register_none namespace import cisco eem namespace import cisco lib array set testvar testvar1 ok testvar2 not_ok if catch context_save TESTCTX testvar errmsg action_syslog msg context_save failed errmsg els...

Page 208: ...t_retrieve TESTCTX testvar testvar1 errmsg action_syslog msg context_retrieve failed errmsg else action_syslog msg context_retrieve succeeded if info exists testvar action_syslog msg testvar exists and is testvar else action_syslog msg testvar doesn t exist context_save Saves Tcl variables that match a given pattern in current and global namespaces with the given context name as identification Use...

Page 209: ... pattern Result String None Set _cerrno A string displaying _cerrno _cerr_sub_num _cerr_sub_err _cerr_posix_err _cerr_str due to appl_setinfo error 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 Configurat...

Page 210: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 194 Configuring and Managing Embedded Event Manager Policies Tcl Context Library Command Extensions ...

Page 211: ... this chapter refer to the IP Service Level Agreement Commands on the Cisco ASR 9000 Series Router module of Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference Note Feature History for Implementing IP Service Level Agreements Modification Release This feature was introduced Release 3 7 2 The TWAMP accuracy enhancement was introduced Release 6 0 1 Prerequisites fo...

Page 212: ... validated scale numbers for scheduling of an operation at a same time are as follows The maximum number of UDP echo operations is 400 operations with default frequency The maximum number of UDP echo operations when measuring reachability only is 2000 operations with default frequency The maximum number of UDP jitter operations is 400 operations with default frequency The maximum number of UDP jit...

Page 213: ... operations at the same start time as this may affect the performance At the same start time not more than 10 operations per second should be scheduled We recommend using the start after configuration Setting the frequency to less than 60 seconds will increase the number of packets sent But this could negatively impact the performance of IP SLA operation when scheduled operations have same start t...

Page 214: ...d by and stored in the router and provided through command line interface CLI Extensive Markup Language XML and SNMP MIBs IP SLA uses the Cisco RTTMON MIB to interact between external 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...

Page 215: ...bandwidth of a Layer 2 link Sophistication Applications that are sensitive to slight changes in network performance require the precision of the submillisecond measurement of IP SLA Accuracy Leveraging the existing Cisco devices in a large network makes IP SLA easier to implement than the physical operations that are often required with traditional service level agreements Ease of deployment IP SL...

Page 216: ...ves troubleshooting time Troubleshooting of network operation Measuring Network Performance with IP Service Level Agreements IP SLA uses generated traffic to measure network performance between two networking devices such as routers Figure 4 IP SLA Operations on page 201 shows how IP SLA starts when the IP SLA device sends a generated packet to the destination device After the destination device r...

Page 217: ...ration but it is required for the UDP jitter operation If no IP SLA Responder is used the target device should support the UDP echo operation In ICMP operations the source IP SLA device sends several ICMP packets to the destination The destination device which is any IP device echoes with replies The source IP SLA device uses the sent and received time stamps to calculate the response time The ICM...

Page 218: ... jitter Measures round trip delay for the full path ICMP echo Calculates the hop by hop response time between the router and any IP device on the network The path is discovered using the traceroute algorithm and then by measuring the response time between the source router and each intermediate hop in the path If there are multiple equal cost routes between source and destination devices the ICMP ...

Page 219: ...nder is a component embedded in the destination Cisco routing device that allows the system to anticipate and respond to IP SLA request packets The IP SLA Responder provides enhanced accuracy for measurements Additional statistics are also provided which are not otherwise available through standard ICMP based measurements The patented IP SLA Control Protocol is used by the IP SLA Responder providi...

Page 220: ...the packet arrives on the interface and again just as it is leaving and accounts for it when calculating the statistics This time stamping is made with a granularity of submilliseconds At times of high network activity an ICMP ping test often shows a long and inaccurate response time while an IP SLA based responder shows an accurate response time Figure 4 IP SLA Operations on page 201 shows how th...

Page 221: ...res too much jitter on a connection IP SLA can generate a notification to a network management application or trigger another IP SLA operation to gather more data IP SLA reaction configuration is performed by using the ipsla reaction operation command IP SLA Threshold Monitoring and Notifications IP SLA supports threshold monitoring for performance parameters such as jitter average bidirectional r...

Page 222: ...be running on a particular PE router at the same time For more details see the note at the end of this section 5 Each IP SLA LSP ping or LSP traceroute operation measures network connectivity between the source PE router and the discovered destination PE router More than one MPLS LSP monitor instance can be running on a particular PE router at the same time For example one MPLS LSP monitor instanc...

Page 223: ... which next hop routers belong within which particular VRF For each next hop router entry the IPv4 Forward Equivalence Class FEC of the BGP next hop router in the global routing table is provided so that it can be used by the MPLS LSP ping operation Figure 6 BGP Next hop Neighbor Discovery for a Simple VPN IP SLA LSP Ping and LSP Traceroute Operations This feature introduces support for the IP SLA...

Page 224: ...d IP SLA operations for newly discovered BGP next hop neighbors are added to the same schedule period as the operations that are currently running To prevent too many operations from starting at the same time the multioperation scheduling feature schedules the operations to begin at random intervals uniformly distributed over the schedule period Note LSP Path Discovery LSP Path Discovery LPD is an...

Page 225: ...rce Per direction packet loss Per direction delay one way delay Round trip delay average round trip time As the paths for the sending and receiving of data may be different asymmetric the per direction data allows you to more readily identify where congestion or other problems are occurring in the network The UDP jitter operation functions by generating synthetic simulated UDP traffic By default t...

Page 226: ...s the IP SLA Responder for UDP echo or jitter operations ipsla responder Example RP 0 RSP0 CPU0 router config ipsla responder RP 0 RSP0 CPU0 router config ipsla resp Step 2 Enables the permanent address and port on the IP SLA Responder type udp ipv4 address ip address port port Example RP 0 RSP0 CPU0 router config ipsla resp type udp ipv4 address 12 25 26 10 port 10001 Step 3 commit Step 4 What to...

Page 227: ... command with the count argument 10 packets Number of packets N ipsla operation command with the operation number argument type udp jitter command datasize request command with the size argument 32 bytes Payload size per packet S ipsla operation command with the operation number argument type udp jitter command packet interval command with the interval argument 20 ms Time between packets in millis...

Page 228: ...erval interval 8 frequency seconds 9 exit 10 ipsla schedule operation op num 11 life forever seconds 12 ageout seconds 13 recurring 14 start time hh mm ss day month day now pending after hh mm ss 15 commit DETAILED STEPS Purpose Command or Action configure Step 1 Specifies the operation number The range is from 1 to 2048 ipsla operation operation number Example RP 0 RSP0 CPU0 router config ipsla o...

Page 229: ...nterval 30 Step 7 Optional Sets the rate at which a specified IP SLA operation is sent into the network frequency seconds Example RP 0 RSP0 CPU0 router config ipsla udp jitter frequency 300 Step 8 Optional Use the seconds argument to specify the number of seconds between the IP SLA operations Valid values are in the range from 1 to 12604800 seconds The default is 60 seconds Exits from IP SLA confi...

Page 230: ...he following keywords are described start time hh mm ss day month day now pending after hh mm ss Step 14 Example RP 0 RSP0 CPU0 router config ipsla sched start time 01 00 00 Optional Use the pending keyword to configure the operation to remain in a pending unstarted state The default is inactive If the start time command is not specified no information is collected until the start time is configur...

Page 231: ...m ss 22 commit 23 show ipsla statistics operation number 24 show ipsla statistics aggregated operation number DETAILED STEPS Purpose Command or Action configure Step 1 Specifies the operation number The range is from 1 to 2048 ipsla operation operation number Example RP 0 RSP0 CPU0 router config ipsla operation 432 Step 2 Configures the operation as a UDP jitter operation and configures characteri...

Page 232: ...es are in the range from 1 to 12604800 seconds The default is 60 seconds Optional Specifies the statistics collection parameters for UDP jitter operation statistics hourly interval seconds Example RP 0 RSP0 CPU0 router config ipsla udp jitter Step 8 statistics hourly RP 0 RSP0 CPU0 router config ipsla op stats Optional Sets the number of hours in which statistics are maintained for the IP SLA oper...

Page 233: ...meout 10000 Step 14 Optional Use the milliseconds argument to specify the number of milliseconds that the operation waits to receive a response Specifies the type of service number tos number Example RP 0 RSP0 CPU0 router config ipsla udp jitter tos 255 Step 15 Exits from IP SLA configuration mode and operational mode and returns the CLI to global configuration mode exit Example RP 0 RSP0 CPU0 rou...

Page 234: ... 00 Optional Use the pending keyword to configure the operation to remain in a pending unstarted state The default is inactive If the start time command is not specified no information is collected until the start time is configured or a trigger occurs that performs an immediate start Optional Use the now keyword to indicate that the operation should start immediately Optional Use the after keywor...

Page 235: ...P echo operation requires a Cisco device that is running the IP SLA Responder or a non Cisco device that is running the UDP echo service Note Depending on whether you want to configure a basic UDP echo operation or to configure a UDP echo operation with optional parameters perform one of the following tasks Prerequisites for Configuring a UDP Echo Operation on the Source Device If you are using th...

Page 236: ...nfigures the operation as a UDP echo operation and configures characteristics for the operation type udp echo Example RP 0 RSP0 CPU0 router config ipsla op type udp echo Step 3 Specifies the IP address of the destination for the proper operation type You can configure a permanent port on the IP SLA Responder side or you can use an UDP echo server destination address ipv4address Example RP 0 RSP0 C...

Page 237: ...ipsla sched life 1 Step 9 in seconds The default lifetime of an operation is 3600 seconds one hour Optional Specifies the number of seconds to keep the operation in memory when it is not actively collecting information The ageout seconds Example RP 0 RSP0 CPU0 router config ipsla sched ageout 3600 Step 10 default value of 0 seconds means that the operation never times out Optional Specifies that t...

Page 238: ...stics for all the IP SLA operations or specified operation show ipsla statistics aggregated operation number Example RP 0 RSP0 CPU0 router show ipsla statistics aggregated 1 Step 15 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 ...

Page 239: ...ion configure Step 1 Specifies the operation number The range is from 1 to 2048 ipsla operation operation number Example RP 0 RSP0 CPU0 router config ipsla operation 432 Step 2 Configures the operation as a UDP echo operation and configures characteristics for the operation type udp echo Example RP 0 RSP0 CPU0 router config ipsla op type udp echo Step 3 Optional Enables the monitoring of a VPN usi...

Page 240: ... argument to specify the protocol data size in bytes The range is from 0 to the maximum of the protocol The default is 1 byte Defines a type of service ToS byte in the IP header of IP SLA operations tos number Example RP 0 RSP0 CPU0 router config ipsla udp echo tos 255 Step 9 The ToS byte is converted to a Differentiated Services Code Point DSCP value but you cannot enter the DSCP value directly T...

Page 241: ... CPU0 router config ipsla sched ageout 3600 Step 15 default value of 0 seconds means that the operation never times out Optional Specifies that the operation starts automatically at the specified time and for the specified duration every day recurring Example RP 0 RSP0 CPU0 router config ipsla sched recurring Step 16 Specifies a time for the operation to start The following keywords are described ...

Page 242: ...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 The ICMP echo operation does not require the IP SLA Responder to be enabled Note Depending on whether you want to configure and schedule a basic ICMP echo operation or configure and schedule an ICMP echo operation with optional parameters perfo...

Page 243: ...o Example RP 0 RSP0 CPU0 router config ipsla op type icmp echo Step 3 Specifies the IP address of the destination for the proper operation type destination address ipv4address Example RP 0 RSP0 CPU0 router config ipsla icmp echo destination address 12 25 26 10 Step 4 Optional Sets the rate at which a specified IP SLA operation is sent into the network frequency seconds Example RP 0 RSP0 CPU0 route...

Page 244: ...t 3600 Step 9 information The default value of 0 seconds means that the operation never times out Optional Specifies that the operation starts automatically at the specified time and for the specified duration every day recurring Example RP 0 RSP0 CPU0 router config ipsla sched recurring Step 10 Specifies a time for the operation to start The following keywords are described start time hh mm ss da...

Page 245: ...ration number 3 type icmp echo 4 vrf vrf name 5 destination address ipv4address 6 frequency seconds 7 datasize request size 8 tos number 9 timeout milliseconds 10 tag text 11 exit 12 ipsla schedule operation op num 13 life forever seconds 14 ageout seconds 15 recurring 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...

Page 246: ... Step 6 Optional Use the seconds argument to specify the number of seconds between the IP SLA operations Valid values are in the range from 1 to 12604800 seconds The default is 60 seconds Optional Sets the protocol data size in the payload of the request packet for the specified IP SLA operation datasize request size Example RP 0 RSP0 CPU0 router config ipsla icmp echo datasize request 512 Step 7 ...

Page 247: ...ion 432 RP 0 RSP0 CPU0 router config ipsla sched The forever keyword schedules the operation to run indefinitely The seconds argument schedules the lifetime of life forever seconds Example RP 0 RSP0 CPU0 router config ipsla sched life 30 Step 13 the operation in seconds The default lifetime of an operation is 3600 seconds one hour Optional Specifies the number of seconds to keep the operation in m...

Page 248: ...n takes to reach its destination 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 subseq...

Page 249: ...ter config ipsla op type icmp Step 3 path echo RP 0 RSP0 CPU0 router config ipsla icmp path echo Specifies the IP address of the destination for the proper operation type destination address ipv4address Example RP 0 RSP0 CPU0 router config ipsla icmp path echo destination address 12 25 26 10 Step 4 Optional Sets the rate at which a specified IP SLA operation is sent into the network frequency seco...

Page 250: ...tep 9 information The default value of 0 seconds means that the operation never times out Optional Specifies that the operation starts automatically at the specified time and for the specified duration every day recurring Example RP 0 RSP0 CPU0 router config ipsla sched recurring Step 10 Specifies a time for the operation to start The following keywords are described start time hh mm ss day month ...

Page 251: ...vrf name 5 lsr path ip address 6 destination address ipv4address 7 frequency seconds 8 datasize request size 9 tos number 10 timeout milliseconds 11 tag text 12 lsr path ipaddress1 ipaddress2 ipaddress8 13 exit 14 ipsla schedule operation op num 15 life forever seconds 16 ageout seconds 17 recurring 18 start time hh mm ss day month day now pending after hh mm ss 19 commit 20 show ipsla statistics ...

Page 252: ...eration type destination address ipv4address Example RP 0 RSP0 CPU0 router config ipsla icmp path echo destination address 12 25 26 10 Step 6 Optional Sets the rate at which a specified IP SLA operation is sent into the network frequency seconds Example RP 0 RSP0 CPU0 router config ipsla icmp path echo frequency 300 Step 7 Optional Use the seconds argument to specify the number of seconds between ...

Page 253: ...P 0 RSP0 CPU0 router config ipsla icmp path echo lsr path 20 25 22 1 Step 12 Optional Use the ip address argument of the intermediate node or nodes in a path to the destination Exits IP SLA operation configuration mode and IP SLA configuration mode Returns to global configuration mode exit Example RP 0 RSP0 CPU0 router config ipsla icmp path echo Step 13 exit RP 0 RSP0 CPU0 router config ipsla op ...

Page 254: ...w 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 commit Step 19 Displays the current statistics show ipsla statistics operation number Example RP 0 RSP0 CPU0 router show ipsla statistics 432 Step 20 Configuring the ICMP Path jitter Operation The IP SL...

Page 255: ...n Parameter ipsla operation command with the operation number argument packet count command with the count argument 10 echoes Number of echo probes N ipsla operation command with the operation number argument packet interval command with the interval argument 20 ms Time between Echo probes in milliseconds T ipsla operation command with the operation number argument frequency command with the secon...

Page 256: ...h jitter operation type type icmp path jitter Example RP 0 RSP0 CPU0 router config ipsla op type icmp path jitter Step 3 Specifies the IP address of the destination for the proper operation type destination address ipv4address Example RP 0 RSP0 CPU0 router config ipsla icmp path jitter destination address 12 25 26 10 Step 4 Optional Specifies the number of packets to be transmitted during a probe ...

Page 257: ...le RP 0 RSP0 CPU0 router config ipsla schedule Step 9 operation 432 RP 0 RSP0 CPU0 router config ipsla sched The forever keyword schedules the operation to run indefinitely The seconds argument schedules the life forever seconds Example RP 0 RSP0 CPU0 router config ipsla sched life 30 Step 10 lifetime of the operation in seconds The default lifetime of an operation is 3600 seconds one hour Optiona...

Page 258: ...y Optional Use the after keyword and associated arguments to specify the time after which the operation starts collecting information commit Step 14 Displays the current statistics show ipsla statistics operation number Example RP 0 RSP0 CPU0 router show ipsla statistics 432 Step 15 Configuring and Scheduling an ICMP Path jitter Operation with Additional Parameters You can enable an ICMP path echo...

Page 259: ...th day now pending after hh mm ss 20 commit 21 show ipsla statistics operation number DETAILED STEPS Purpose Command or Action configure Step 1 Specifies the operation number The range is from 1 to 2048 ipsla operation operation number Example RP 0 RSP0 CPU0 router config ipsla operation 432 Step 2 Defines an ICMP path jitter operation type type icmp path jitter Example RP 0 RSP0 CPU0 router confi...

Page 260: ...f packets sent is 10 Optional Specifies the time between packets The default interval between packets is 20 milliseconds packet interval interval Example RP 0 RSP0 CPU0 router config ipsla icmp path jitter packet interval 30 Step 8 Optional Sets the rate at which a specified IP SLA operation is sent into the network frequency seconds Example RP 0 RSP0 CPU0 router config ipsla icmp path jitter freq...

Page 261: ... exit Example RP 0 RSP0 CPU0 router config ipsla icmp path jitter Step 14 exit RP 0 RSP0 CPU0 router config ipsla op exit RP 0 RSP0 CPU0 router config ipsla exit RP 0 RSP0 CPU0 router config Schedules the start time of the operation You can configure a basic schedule ipsla schedule operation op num Example RP 0 RSP0 CPU0 router config ipsla schedule Step 15 operation 432 RP 0 RSP0 CPU0 router conf...

Page 262: ... Step 20 Displays the current statistics show ipsla statistics operation number Example RP 0 RSP0 CPU0 router show ipsla statistics 432 Step 21 Configuring IP SLA MPLS LSP Ping and Trace Operations The MPLS LSP ping and trace operations allow service providers to monitor label switched paths LSPs and quickly isolate MPLS forwarding problems Use these IP SLA operations to troubleshoot network conne...

Page 263: ...connectivity by using one of the supported Forwarding Equivalence Class FEC entities between the ping origin and egress node of each FEC The following FEC types are supported for an MPLS LSP ping operation LDP IPv4 prefixes configured with the target ipv4 command MPLS TE tunnels configured with the target traffic eng tunnel command Pseudowire configured with the target pseudowire command SUMMARY S...

Page 264: ...pv4 destination address destination mask traffic eng tunnel tunnel interface pseudowire destination address circuit id Example RP 0 RSP0 CPU0 router config ipsla mpls lsp ping target ipv4 10 25 26 10 255 255 255 255 Step 5 or RP 0 RSP0 CPU0 router config ipsla mpls lsp ping target ipv4 10 25 26 10 32 or RP 0 RSP0 CPU0 router config ipsla mpls lsp ping target traffic eng tunnel 12 or RP 0 RSP0 CPU0...

Page 265: ... value to be used in the header of echo reply packets Valid values are from 0 to 7 exp exp bits Example RP 0 RSP0 CPU0 router config ipsla mpls lsp ping exp 5 Step 10 Optional Specifies the time to live TTL value used in the MPLS label of echo request packets Valid values are from 1 to 255 ttl time to live Example RP 0 RSP0 CPU0 router config ipsla mpls lsp ping ttl 200 Step 11 Exits IP SLA MPLS L...

Page 266: ... the LSP path A trace operation allows you to troubleshoot network connectivity and localize faults hop by hop Echo request and reply packets validate the LSP The success of an MPLS LSP trace operation depends on the transit router processing the MPLS echo request when it receives a labeled packet The transit router returns an MPLS echo reply containing information about the transit hop in respons...

Page 267: ...tep 1 Configures an IP SLA operation and specifies the operation number The range is from 1 to 2048 ipsla operation operation number Example RP 0 RSP0 CPU0 router config ipsla operation 432 Step 2 Configures an MPLS LSP trace operation and enters IP SLA MPLS LSP Trace configuration mode type mpls lsp trace Example RP 0 RSP0 CPU0 router config ipsla op type mpls lsp trace Step 3 Optional Configures...

Page 268: ...Step 7 Optional Specifies the differentiated services codepoint DSCP value to be used in echo reply packets Valid values are from 0 to 63 reply dscp dscp bits Example RP 0 RSP0 CPU0 router config ipsla mpls lsp trace reply dscp 2 Step 8 Reserved keywords such as EF expedited forwarding and AF11 assured forwarding class AF11 can be specified instead of numeric values Optional Sets echo requests to ...

Page 269: ...ds are described start time hh mm ss day month day now pending after hh mm ss Step 14 Example RP 0 RSP0 CPU0 router config ipsla sched start time 01 00 00 Optional Use the pending keyword to configure the operation to remain in a pending unstarted state The default value is inactive If the start time command is not specified no information is collected until the start time is configured or a trigg...

Page 270: ...nnection loss for the monitored operation SUMMARY STEPS 1 configure 2 ipsla reaction operation operation number 3 react connection loss 4 commit DETAILED STEPS Purpose Command or Action configure Step 1 Configures certain actions that are based on events under the control of the IP SLA agent The operation number ipsla reaction operation operation number Example RP 0 RSP0 CPU0 router config ipsla r...

Page 271: ...an element to be monitored for a reaction react jitter average dest to source source to dest Step 3 Example RP 0 RSP0 CPU0 router config ipsla react react A reaction occurs if the average round trip jitter value violates the upper threshold or lower threshold The following options are listed for the jitter average keyword jitter average dest to source Specifies the jitter average destination to so...

Page 272: ...oss value violation is specified The following options are listed for the packet loss keyword dest to source Specifies the packet loss destination to source DS violation packet loss dest to source RP 0 RSP0 CPU0 router config ipsla react cond source to dest Specifies the packet loss source to destination SD violation commit Step 4 Configuring Triggers for Round Trip Violations Round trip time RTT ...

Page 273: ...a react cond commit Step 4 Configuring Triggers for Timeout Violations You can configure triggers for timeout violations SUMMARY STEPS 1 configure 2 ipsla reaction operation operation number 3 react timeout 4 commit DETAILED STEPS Purpose Command or Action configure Step 1 Configures certain actions that are based on events under the control of the IP SLA agent The operation number ipsla reaction ...

Page 274: ...the control of the IP SLA agent The operation number ipsla reaction operation operation number Example RP 0 RSP0 CPU0 router config ipsla reaction operation 432 Step 2 argument is the number of the IP SLA operations for the reactions that are configured The range is from 1 to 2048 Specifies an element to be monitored for a reaction react verify error Step 3 Example RP 0 RSP0 CPU0 router config ips...

Page 275: ...imeout occurs five times in a row or when the round trip time exceeds the upper threshold value five times in a row For more information see Generating Events for Consecutive Violations on page 260 consecutive Triggers an event immediately when the value for a reaction type such as response time exceeds the upper threshold value or falls below the lower threshold value or when a timeout connection...

Page 276: ...igured The range is from 1 to 2048 Specifies an element to be monitored for a reaction react connection loss jitter average dest to source source to dest packet loss dest to source source to dest rtt timeout verify error Step 3 A reaction is specified if there is a timeout for the monitored operation Example RP 0 RSP0 CPU0 router config ipsla react react timeout RP 0 RSP0 CPU0 router config ipsla ...

Page 277: ...tion is specified if there is a connection loss for the monitored operation Example RP 0 RSP0 CPU0 router config ipsla react react connection loss RP 0 RSP0 CPU0 router config ipsla react cond Takes action after a number of consecutive violations When the reaction condition is set for a consecutive number of threshold type consecutive occurrences Example RP 0 RSP0 CPU0 router config ipsla react co...

Page 278: ... source to dest rtt timeout verify error Step 3 Example RP 0 RSP0 CPU0 router config ipsla react react rtt RP 0 RSP0 CPU0 router config ipsla react cond When the reaction condition such as threshold violations are met for the monitored element after some x number of threshold type xofy X value Y value Example RP 0 RSP0 CPU0 router config ipsla react cond threshold type xofy 7 7 Step 4 violations w...

Page 279: ...value violation is specified The following options are listed for the packet loss keyword Example RP 0 RSP0 CPU0 router config ipsla react react dest to source Specifies the packet loss destination to source DS violation source to dest Specifies the packet loss source to destination SD violation packet loss dest to source RP 0 RSP0 CPU0 router config ipsla react cond Takes action on average values...

Page 280: ...ored operation react connection loss jitter average dest to source source to dest packet loss dest to source source to dest rtt timeout verify error Step 3 Example RP 0 RSP0 CPU0 router config ipsla react react connection loss RP 0 RSP0 CPU0 router config ipsla react cond Specifies what action or combination of actions the operation performs when you configure the react command or when threshold e...

Page 281: ...e The IP SLA measurement statistics are stored on the 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 MPLS LSP monitoring is configured on a PE router Note Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 265 Implementing...

Page 282: ...xp bits 21 statistics hourly buckets hours 22 commit DETAILED STEPS Purpose Command or Action configure Step 1 Enters IP SLA configuration mode and configures IP service level agreements ipsla Example RP 0 RSP0 CPU0 router config ipsla Step 2 Optional Enters MPLS VPN BGP next hop neighbor discovery configuration mode mpls discovery vpn Example RP 0 RSP0 CPU0 router config ipsla mpls discovery vpn ...

Page 283: ...LSP ping operation for each discovered BGP next hop address and enters type mpls lsp ping Example RP 0 RSP0 CPU0 router config ipsla mplslm def type mpls lsp ping Step 8 the corresponding configuration mode to configure the parameters Optional Enables the monitoring of a specific Virtual Private Network VPN routing and forwarding VRF vrf vrf name Example RP 0 RSP0 CPU0 router config ipsla mplslm l...

Page 284: ...g ipsla mplslm lsp ping datasize request 512 Step 13 This command is available in MPLS LSP ping mode only Note Optional Specifies a local host IP address 127 x x x that is used to select the label switched path LSP lsp selector ipv4 ip address Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp ping lsp selector ipv4 127 10 10 1 Step 14 from among multiple LSPs The default value is 127 0 0 1 Opt...

Page 285: ...0 router config ipsla mplslm lsp ping exp 7 Step 20 Optional Specifies the statistics collection parameters for the operations in the MPLS LSP monitoring instance The default number of hours is 2 statistics hourly buckets hours Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp ping statistics hourly buckets 2 Step 21 commit Step 22 What to Do Next Configure the reaction conditions Schedule the...

Page 286: ...bits 20 statistics hourly buckets hours 21 commit DETAILED STEPS Purpose Command or Action configure Step 1 Enters IP SLA configuration mode and configures IP service level agreements ipsla Example RP 0 RSP0 CPU0 router config ipsla Step 2 Optional Enables MPLS VPN BGP next hop neighbor discovery mpls discovery vpn Example RP 0 RSP0 CPU0 router config ipsla mpls discovery vpn Step 3 Cisco ASR 9000...

Page 287: ...race operation for each discovered BGP next hop address and enters type mpls lsp trace Example RP 0 RSP0 CPU0 router config ipsla mplsm def type mpls lsp trace Step 8 the corresponding configuration mode to configure the parameters Optional Enables the monitoring of a specific Virtual Private Network VPN routing and forwarding VRF vrf vrf name Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp ...

Page 288: ...ample RP 0 RSP0 CPU0 router config ipsla mplslm lsp trace lsp selector ipv4 127 10 10 1 Step 13 from among multiple LSPs The default value is 127 0 0 1 Optional Specifies whether an explicit null label is added to the label stack of MPLS LSP echo request packets This is disabled by default force explicit null Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp trace force explicit null Step 14 O...

Page 289: ...ly buckets hours Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp trace statistics hourly buckets 2 Step 20 commit Step 21 What to Do Next Configure the reaction conditions Schedule the MPLS LSP monitoring instance operations Configuring the Reaction Conditions for an MPLS LSP Monitoring Instance on a Source PE Router Perform this task to configure the reaction conditions for an MPLS LSP moni...

Page 290: ...A MPLS LSP monitor reaction configuration mode reaction monitor monitor id Example RP 0 RSP0 CPU0 router config ipsla mplslm reaction Step 4 monitor 2 RP 0 RSP0 CPU0 router config ipsla mplslm react Specifies that a reaction occurs if there is a one way connection loss or timeout for the monitored react connection loss timeout Example RP 0 RSP0 CPU0 router config ipsla mplslm react react connectio...

Page 291: ...la 3 mpls lsp monitor 4 schedule monitor monitor id 5 frequency seconds 6 schedule period seconds 7 start time hh mm ss day month day 8 commit DETAILED STEPS Purpose Command or Action configure Step 1 Enters IP SLA configuration mode and configures IP service level agreements ipsla Example RP 0 RSP0 CPU0 router config ipsla Step 2 Enters MPLS LSP monitor mode From this mode you can configure an LS...

Page 292: ...heduled equally spaced throughout the schedule period schedule period seconds Example RP 0 RSP0 CPU0 router config ipsla mplslm sched schedule period 300 Step 6 Use the frequency command to specify how often the entire set of operations is performed The frequency value must be greater than or equal to the schedule period You must specify this value before scheduling an MPLS LSP monitor instance st...

Page 293: ...tep 2 Enters MPLS LSP monitor mode From this mode you can configure an LSP monitor instance configure a mpls lsp monitor Example RP 0 RSP0 CPU0 router config ipsla mpls lsp monitor Step 3 reaction for an LSP monitor instance or schedule an LSP monitor instance Configures an MPLS LSP monitor instance monitor monitor id Example RP 0 RSP0 CPU0 router config ipsla mplslm monitor 2 Step 4 Verifies the ...

Page 294: ...tep 9 request during path discovery Range is 1 to 256 Default is 32 Configures the number of timeout retry attempts for MPLS LSP echo requests sent during path discovery Range is 0 to 10 Default is 3 echo retry count Example RP 0 RSP0 CPU0 router config ipsla mplslm lsp lpd echo retry 3 Step 10 Configures the timeout value for echo requests during path discovery Range is 0 to 3600 in milliseconds ...

Page 295: ...name 3 type rtr ipsla operation id reachability 4 commit DETAILED STEPS Purpose Command or Action Enters global configuration mode configure Example RP 0 RSP0 CPU0 router configure Step 1 Enters track configuration mode track track name Example RP 0 RSP0 CPU0 router config track t1 Step 2 Sets the ipsla operation id which needs to be tracked for reachability type rtr ipsla operation id reachabilit...

Page 296: ...left in Life Forever Operational state of entry Active Operational frequency seconds 60 Connection loss occurred FALSE Timeout occurred FALSE Latest RTT milliseconds 3 Latest operation start time 16 48 37 653 GMT Fri Nov 28 2014 Next operation start time 16 49 37 653 GMT Fri Nov 28 2014 Latest operation return code OK RTT Values RTTAvg 3 RTTMin 3 RTTMax 4 NumOfRTT 10 RTTSum 33 RTTSum2 111 Packet L...

Page 297: ...g or triggering of action types configure ipsla operation 1 type icmp echo timeout 5000 destination address 223 255 254 254 frequency 10 statistics interval 30 buckets 3 end configure ipsla operation 2 type icmp path echo destination address 223 255 254 254 frequency 5 end configure ipsla reaction operation 1 react timeout action trigger threshold type immediate exit exit react rtt action logging ...

Page 298: ...oss action logging threshold type immediate schedule monitor 1 frequency 300 schedule period 120 start time 11 45 00 July 4 mpls discovery vpn interval 600 Configuring LSP Path Discovery Example The following example illustrates how to configure LSP Path Discovery configure ipsla mpls lsp monitor monitor 1 type mpls lsp ping path discover path retry 12 path secondary frequency both 12 Additional R...

Page 299: ... 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 RFCs Title RFCs No new or modified RFCs are supported by this feature and support for existing RFCs has not been modified by this feature Technical Assistance Link Description http www cisco com cisco web support index html The Cisco T...

Page 300: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 284 Implementing IP Service Level Agreements Additional References ...

Page 301: ... commands listed in this module see the Related Documents on page 308 section of this module Note Feature History for Implementing Logging Services Modification Release This feature was introduced Release 3 7 2 Prerequisites for Implementing Logging Services page 285 Information About Implementing Logging Services page 286 How to Implement Logging Services page 295 Configuration Examples for Imple...

Page 302: ...isco IOS XR software is as follows node id timestamp process name pid message group severity message code message text This is a sample syslog message RP 0 RSP0 CPU0 router Nov 28 23 56 53 826 config 65710 SYS 5 CONFIG_I Configured from console by console This table describes the general format of syslog messages on Cisco IOS XR software Table 26 General Syslog Message Format Description Field Nod...

Page 303: ...aborts the current suppression interval This clears the message queue so another message from the previous sequence is then treated as a new event and the suppression sequence starts over The repeated message summary is generated only at an interval of 0 30 120 and 600 secs and not on the occurrence of a new event At every interval it is checked if currently any number of messages are suppressed I...

Page 304: ...disable command in global configuration mode To reenable logging to the console terminal use the logging console command in global configuration mode Syslog messages can be sent to destinations other than the console such as the logging buffer syslog servers and terminal lines other than the console such as vtys This table lists the commands used to specify syslog destinations Table 27 Commands Us...

Page 305: ...y syslog messages during a terminal session To disable the logging of syslog messages to a terminal during a terminal session use the terminal monitor disable command in EXEC mode The terminal monitor disable command disables logging for only the current terminal session To reenable the logging of syslog messages for the current terminal session use the terminal monitor command in EXEC mode The te...

Page 306: ...r process user Indicates UNIX to UNIX copy system uucp 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 sysl...

Page 307: ...s can also be saved to an archive on a local storage device such as the hard disk or a flash disk Messages can be saved based on severity level and you can specify attributes such as the size of the archive how often messages are added daily or weekly and how many total weeks of messages the archive will hold Setting Archive Attributes To create a logging archive and specify how the logging messag...

Page 308: ...rity severity Archive Storage Directories By default syslog archives are stored in the directory device var log Individual archive files are saved to sub directories based on the year month and day the archive was created For example archive files created on February 26 2006 are stored in this directory harddisk var log 2006 02 26 Severity Levels You can limit the number of messages sent to a logg...

Page 309: ...S with the snmp server enable traps syslog command you can change the level of messages sent and stored in a history table on the router You can also change the number of messages that get stored in the history table Messages are stored in the history table because SNMP traps are not guaranteed to reach their destination By default one message of the level warning and above see Table 32 Syslog Mes...

Page 310: ... Immediate action needed 1 alerts LOG_CRIT Critical conditions 2 critical LOG_ERR Error conditions 3 errors LOG_WARNING Warning conditions 4 warnings LOG_NOTICE Normal but significant condition 5 notifications LOG_INFO Informational messages only 6 informational LOG_DEBUG Debugging messages 7 debugging Syslog Severity Level Command Defaults This table lists the default severity level settings for ...

Page 311: ...ogging buffered severity warnings The default value for the severity argument is debugging Keyword options for the severity argument are emergencies alerts critical errors warnings notifications informational and debugging By default entering this command without specifying a severity level for the severity argument or specifying the size of the buffer for the size argument sets the severity level...

Page 312: ...command Because this command is an EXEC mode command it is set locally and will not remain in effect after the current session is ended Note Configuring Logging to a Remote Server This task explains how to configure logging to remote syslog servers Before You Begin You must have connectivity with syslog servers to configure syslog server hosts as the recipients for syslog messages SUMMARY STEPS 1 ...

Page 313: ...tnameprefix 123 12 35 7 Step 5 Hostname prefix logging can be useful for sorting syslog messages received by syslog servers Tip Optional Sets the syslog source address logging source interface type interface path id Step 6 By default a syslog message sent to a syslog server contains the IP address IPv4 and IPv6 are supported of the interface it uses to leave the router Example RP 0 RSP0 CPU0 route...

Page 314: ...tory size 200 Step 3 By default one syslog message is stored in the history table When the history table is full that is when it contains the maximum number of messages specified with this command the oldest message is deleted from the table to allow the new message to be stored Note commit Step 4 Optional Displays information about the state of the syslog history table show logging history Exampl...

Page 315: ...t sets the severity level to debugging and the buffer size to 4096 bytes Limits messages sent to the console terminal based on severity logging console severity Step 3 Example RP 0 RSP0 CPU0 router config logging console alerts Syslog messages are logged to the console terminal at the informational severity level by default Keyword options for the severity argument are emergencies alerts critical ...

Page 316: ...des the local time zone in time stamps The optional msec keyword includes milliseconds in time stamps timestamps log datetime localtime msec The optional show timezone keyword includes time zone information in time stamps or RP 0 RSP0 CPU0 router config service timestamps log uptime Issuing the service timestamps log uptime command configures syslog messages to be time stamped with the time that h...

Page 317: ...ages to be time stamped with the time that has elapsed since the networking device last rebooted Entering the service timestamps command without any keywords or arguments is equivalent to entering the service timestamps debug uptime command Tip commit Step 4 Disabling Time Stamps This tasks explains how to disable the inclusion of time stamps in syslog messages SUMMARY STEPS 1 configure 2 Do one o...

Page 318: ...plicate syslog messages logging suppress duplicates Step 2 Example RP 0 RSP0 CPU0 router config logging suppress duplicates If this command is enabled during debugging sessions you could miss important information related to problems that you are attempting to isolate and resolve In such a case you might consider disabling this command Caution commit Step 3 Disabling the Logging of Link Status Sys...

Page 319: ...ogging events link status software interfaces command Use the no logging events link status command to enable link status syslog messages on physical links only commit Step 3 Displaying System Logging Messages This task explains how to display the syslog messages stored in the logging buffer The commands can be entered in any order Note SUMMARY STEPS 1 show logging 2 show logging location node id ...

Page 320: ... specified date and time show logging start month day hh mm ss Example RP 0 RSP0 CPU0 router show logging start december 1 10 30 00 Step 5 Displays syslog messages in the logging buffer that were generated on or before the specified date and time show logging end month day hh mm ss Example RP 0 RSP0 CPU0 router show logging end december 2 22 16 00 Step 6 Archiving System Logging Messages to a Loca...

Page 321: ... to the harddisk because it has more capacity than flash disks By default the logs are created under the directory device var log Optional Specifies if logs are collected on a daily or weekly basis Logs are collected daily by default frequency daily weekly Example RP 0 RSP0 CPU0 router config logging arch frequency weekly Step 4 Optional Specifies the minimum severity of log messages to archive Al...

Page 322: ...file size in megabytes that a single log file in the archive can grow to Once this limit is reached a new file is automatically created with an increasing serial number file size size Example RP 0 RSP0 CPU0 router config logging arch file size 10 Step 8 By default the maximum file size is 1 megabyte commit Step 9 Configuration Examples for Implementing Logging Services This section provides these ...

Page 323: ...ize of the logging history table is to 200 entries and the severity of level of syslog messages sent to the logging history table is limited to messages at or below the errors severity level logging history size 200 logging history errors Modifying Time Stamps Example This example shows a time stamp configuration in which time stamps are configured to follow the format month date HH MM SS time zon...

Page 324: ...ggregation Services Router System Monitoring Configuration Guide Onboard Failure Logging OBFL configuration Onboard Failure Logging Commands module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Command Reference Onboard Failure Logging OBFL commands Alarm Management and Logging Correlation Commands module in the Cisco ASR 9000 Series Aggregation Services Router System ...

Page 325: ... at the following URL and choose a platform under the Cisco Access Products menu http cisco com public sw center netmgmt cmtk mibs shtml RFCs Title RFCs No new or modified RFCs are supported by this feature and support for existing RFCs has not been modified by this feature Technical Assistance Link Description http www cisco com cisco web support index html The Cisco Technical Support website con...

Page 326: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 310 Implementing Logging Services Additional References ...

Page 327: ...l conditions uptime downtime errors and other operating conditions The Onboard Failure Logging OBFL functionality is enhanced to provide a generic library that can be used by different clients to log string messages OBFL is activated by default in all cards Do not deactivate OBFL without specific reasons because the OBFL data is used to diagnose and resolve problems in FRUs Caution For information...

Page 328: ...card where OBFL is enabled The data collected includes these FRU part serial number OS version Boot time Total run time hours in use Boot status Temperature and voltage at boot Temperature and voltage history Other board specific errors This data is collected in two different ways as baseline data and event driven data Baseline Data Collection Baseline data is stored independent of hardware or sof...

Page 329: ... files Temperature Value Environmental Factors 5 and MBUS 5 3 3 and 2 2 voltage value Voltage Value An environmental reading is logged when the following temperature or voltage events occur Exceed the normal range Change more than 10 Return within range for more than five minutes On reboot these environmental readings are consolidated into a single environmental history record that shows the durat...

Page 330: ... OBFL For example the processor supports the OBFL Table 34 OBFL Support by Card Type Cisco ASR 9000 Series Router Card Type Supported Route switch processor RSP Not Supported Power supply cards AC rectifier modules and DC power entry modules PEMs Supported Fan controller cards Not Supported Shared port adapters SPA How to Implement OBFL OBFL logging is configured for the router If a new node is in...

Page 331: ...0 RSP0 CPU0 router admin configure RP 0 RSP0 CPU0 router admin config Step 2 Configures the severity level for the syslog messages that are logged into the OBFL storage device hw module all subslot node id logging onboard disable severity alerts emergencies Step 3 Example RP 0 RSP0 CPU0 router admin config Use the severity keyword to specify the severity for the syslog message that is logged into ...

Page 332: ...sable severity alerts emergencies Step 3 Example RP 0 RSP0 CPU0 router admin config Use the severity keyword to specify the severity for the syslog message that is logged into the OBFL storage device Use the alerts keyword to specify that both emergency and alert syslog messages are logged The default is the alerts keyword hw module all logging onboard severity alerts Use the emergencies keyword t...

Page 333: ...erature uptime verbose voltage continuous historical static data detail raw summary location node id Services Router System Monitoring Command Reference Example RP 0 RSP0 CPU0 router admin show logging onboard uptime Confirms that the OBFL environmental monitor process is operating show processes include obfl Example RP 0 RSP0 CPU0 router show processes include obfl Step 3 Displays the status of O...

Page 334: ...hw module all logging onboard disable The following example shows how to enable OBFL again RP 0 RSP0 CPU0 router admin config no hw module all logging onboard disable The following example shows that OBFL is enabled and message severity level is reset to the default RP 0 RSP0 CPU0 router admin config no hw module all logging onboard Configuring Message Severity Levels Example The following example...

Page 335: ...quest 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 Document Title Related To...

Page 336: ...NMP module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide SNMP configuration tasks Cisco ASR 9000 Series Aggregation Services Router Getting Started Guide Cisco IOS XR getting started material Configuring AAA Services module in the Cisco ASR 9000 Series Aggregation Services Router System Security Command Reference Information about user groups and ta...

Page 337: ...index html The Cisco Technical Support website contains thousands of pages of searchable technical content including links to products technologies solutions technical tips and tools 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 321 Onboard Failure Logging Additi...

Page 338: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 322 Onboard Failure Logging Additional References ...

Page 339: ...are and complete descriptions of the PM commands listed in this module you can refer to the Related Documents on page 360 section of this module Note Feature History for Implementing Performance Management Modification Release This feature was introduced Release 3 7 2 Support for interface basic counters keyword was added Configuring local disk dump for PM statistics collections and configuring in...

Page 340: ...onal Overview The Performance Management PM frameworks consists of two major components PM statistics server PM statistics collectors PM Statistics Server The PM statistics server is the front end for statistic collections entity instance monitoring collections and threshold monitoring All PM statistic collections and threshold conditions configured through the command line interface CLI or throug...

Page 341: ...these benefits Configurable data collection policies 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 325 Implementing Performance Management PM Bene...

Page 342: ...ric Counters LDP Sessions MPLS LDP Nodes Node CPU Nodes Node Memory Processes Node Process Processes OSPFv2 Processes OSPFv3 For a list of all attributes associated with the entities that constitute the PM system see Table 43 Attributes and Values on page 341 Note PM Statistics Collection Templates PM statistics collections are configured through PM statistics collection templates A PM statistics ...

Page 343: ... 60 samples The default is five samples The export cycle determines how often PM statistics collection data is exported to the TFTP server The export cycle can be calculated by multiplying the sample interval and sample size sample interval x sample size export cycle For example suppose that the sample interval is set at a frequency of 10 minutes and the sample size is set to five sampling operati...

Page 344: ...eyword and template name argument when disabling a PM statistics collection Exporting Statistics Data The current PM supports exporting of data onto the following performance mgmt resource tftp server ip address directory directory name performance mgmt resource dump local You can dump PM statistics collections onto local filesystem for example disk0 or harddisk By default this location is not con...

Page 345: ... binary file Table 36 Binary Format Values and Keys StatsCounters Key Subentity Entity See Table 37 Supported StatsCounters for Entities and Subentites on page 330 CPU Key Node ID CPU 1 Node 1 Memory Key Node ID Memory 2 Node Process Key NodeProcessID Process 3 Generic Counters Key ifName Generic Counters 1 Interface 2 Data Rate Counters Key ifName Data Rate Counters 2 Basic Counters Key ifName Ba...

Page 346: ...ID string that is a process name Note The numbers in parenthesis the numbers that are associated with each entity and subentity in Table 36 Binary Format Values and Keys on page 329 denote the entity and subEntity IDs that are displayed in the TFTP File Note This table describes the supported statistics counters that are collected in the binary file for entities and subentities Table 37 Supported ...

Page 347: ...aRate OutputPacketRate InputPeakRate InputPeakPkts OutputPeakRate OutputPeakPkts Bandwidth Data Rate Counters 2 InPackets InOctets OutPackets OutOctets InputTotalDrops InputQueueDrops InputTotalErrors OutputTotalErrors OutputQueueDrops OutputTotalErrors Basic Counters 3 InputMessages OutputMessages InputUpdateMessages OutputUpdateMessages ConnEstablished ConnDropped ErrorsReceived ErrorsSent Peer ...

Page 348: ...eepAliveMsgsRcvd LDP 4 MPLS 4 InputPackets OutputPackets InputHelloPackets OutputHelloPackets InputDBDs InputDBDsLSA OutputDBDs OutputDBDsLSA InputLSRequests InputLSRequestsLSA OutputLSRequests OutputLSRequestsLSA InputLSAUpdates InputLSAUpdatesLSA OutputLSAUpdates OutputLSAUpdatesLSA InputLSAAcks InputLSAAcksLSA OutputLSAAcks OutputLSAAcksLSA ChecksumErrors v2protocol 1 OSPF 5 Cisco ASR 9000 Seri...

Page 349: ...ing the PM system gathers statistics from only attributes associated with the specified entity instance The PM system uses the sampling cycle that is configured in the PM statistics collection template for the entity being monitored Entity instance monitoring however is a separate process from that of the PM statistics collection therefore it does not interfere with PM statistics collection Furthe...

Page 350: ...y instances Table 39 Interface Entity Instance Monitoring Command Descriptions Entity Use the performance mgmt apply monitor data rates command in global configuration mode to enable entity instance monitoring for an interface data rates entity instance Syntax performance mgmt apply monitor interface data rates type interface path id template name default RP 0 RSP0 CPU0 router config performance m...

Page 351: ...ace generic counters type interface path id template name default RP 0 RSP0 CPU0 router config performance mgmt apply monitor interface generic counters gigabitethernet 0 2 0 0 default Interface Generic Counters This table describes the command used to enable entity instance monitoring for the MPLS entity instances Table 40 MPLS Entity Instance Monitoring Command Descriptions Entity Use the perfor...

Page 352: ...ty instance monitoring for a node memory entity instance Syntax performance mgmt apply monitor node memory location node id template name default RP 0 RSP0 CPU0 router config performance mgmt apply monitor node memory location 0 RP1 CPU0 default Node Memory Use the performance mgmt apply monitor node process command in global configuration mode to enable an entity instance monitoring collection fo...

Page 353: ...ument The default setting for the default template is a sample interval of 10 minutes Specify the attribute associated with the entity to be monitored for threshold violations for the attribute argument For a list of the attributes associated with each entity refer to Table 43 Attributes and Values on page 341 Note Configure the sample interval for PM threshold monitoring with the sample interval ...

Page 354: ...e keywords or the optional rearm window keywords and window size argument rearm toggle Suppresses system logging messages for an instance of an attribute when an instance of the attribute matches the threshold condition System logging messages for that instance of the attribute are suppressed in successive sample intervals until that instance of the attribute does not match the threshold condition...

Page 355: ...00 After the sample interval elapses the PM system accordingly determines whether any instance of the attribute matches the condition The PM system generates a system logging message for each instance of the attribute that matches the threshold condition after the sample interval elapses If no instances of the attribute match the threshold condition system logging messages are not generated for th...

Page 356: ...dition is relative to the value of each instance of the attribute Note The PM system generates a system logging message for each instance of the attribute that matches the threshold condition after the sample interval elapses If no instances of the attribute match the threshold condition system logging messages are not generated for that sample interval an attribute an operation and a value expres...

Page 357: ...ription Attributes Entity Range is from 0 to 4294967295 Number of times the connection was dropped ConnDropped bgp Range is from 0 to 4294967295 Number of times the connection was established ConnEstablished Range is from 0 to 4294967295 Number of error notifications received on the connection ErrorsReceived Range is from 0 to 4294967295 Number of error notifications sent on the connection ErrorsS...

Page 358: ... OutputPacketRate Range is from 0 to 4294967295 Peak output packet rate OutputPeakPkts Range is from 0 to 4294967295 Peak output data rate OutputPeakRate Range is from 0 to 4294967295 Packets received InPackets interface basic counters Range is from 0 to 4294967295 Bytes received InOctets Range is from 0 to 4294967295 Packets sent OutPackets Range is from 0 to 4294967295 Bytes sent OutOctets Range...

Page 359: ...ect packets discarded OutputTotalDrops Range is from 0 to 4294967295 Output queue drops OutputQueueDrops Range is from 0 to 4294967295 Outbound incorrect packets discarded OutputTotalErrors Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 343 Implementing Performance Management PM Threshold Monitoring Overview ...

Page 360: ...e drops InputQueueDrops Range is from 0 to 4294967295 Inbound correct packets discarded InputTotalDrops Range is from 0 to 4294967295 Inbound incorrect packets discarded InputTotalErrors Range is from 0 to 4294967295 Unicast packets received InUcastPkts Range is from 0 to 4294967295 Inbound packets discarded with unknown protocol InputUnknownProto Range is from 0 to 4294967295 Broadcast packets se...

Page 361: ...tbound incorrect packets discarded OutputTotalErrors Range is from 0 to 4294967295 Unicast packets sent OutUcastPkts Range is from 0 to 4294967295 Output underruns OutputUnderrun Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 345 Implementing Performance Management PM Threshold Monitoring Overview ...

Page 362: ...t Range is from 0 to 4294967295 Label mapping messages received LabelMappingMsgsRcvd Range is from 0 to 4294967295 Label mapping messages sent LabelMappingMsgsSent Range is from 0 to 4294967295 Label release messages received LabelReleaseMsgsRcvd Range is from 0 to 4294967295 Label release messages sent LabelReleaseMsgsSent Range is from 0 to 4294967295 Label withdraw messages received LabelWithdr...

Page 363: ...is from 0 to 4294967295 Number of threads NoThreads Range is from 0 to 4194304 Maximum dynamic memory in KB used since startup time PeakMemory Range is from 0 to 4294967295 Total number of packets received InputPackets ospf v2protocol Range is from 0 to 4294967295 Total number of packets sent OutputPackets Range is from 0 to 4294967295 Number of Hello packets received InputHelloPackets Range is fr...

Page 364: ...of LSA received in LSA updates InputLSAUpdatesLSA Range is from 0 to 4294967295 Number of LSA updates sent OutputLSAUpdates Range is from 0 to 4294967295 Number of LSA sent in LSA updates OutputLSAUpdatesLSA Range is from 0 to 4294967295 Number of LSA acknowledgements received InputLSAAcks Range is from 0 to 4294967295 Number of LSA received in LSA acknowledgements InputLSAAcksLSA Range is from 0 ...

Page 365: ...ackets OutputDBDsLSA Range is from 0 to 4294967295 Number of LS requests received InputLSRequests Range is from 0 to 4294967295 Number of LSA received in LS requests InputLSRequestsLSA Range is from 0 to 4294967295 Number of LS requests sent OutputLSRequests Range is from 0 to 4294967295 Number of LSA sent in LS requests OutputLSRequestsLSA Range is from 0 to 4294967295 Number of LSA updates recei...

Page 366: ...and Only one PM threshold template for an entity can be enabled at a time You must specify either a location with the location keyword and node id argument or with location all keywords when enabling or disabling a PM threshold monitoring template for these entities Node CPU Node memory Node process The location keyword and node id argument enables or disables PM statistic collections for the spec...

Page 367: ...address and the directory path for PM data collection performance mgmt resources tftp server ip address directory dir name Step 2 Include the entire directory path name for the dir name argument Example RP 0 RSP0 CPU0 router config Files copied to the TFTP server contain a timestamp in their name which makes them unique For that reason the TFTP server used should support creation of files as data ...

Page 368: ...e statistics or threshold templates You can also define a regular expression group that includes multiple regular expression indices The benefits of instance filtering using the regular expression group is You can use the same regular expression group that can be applied to multiple templates You can enhance flexibility by assigning the same index values You can enhance the performance by applying...

Page 369: ...onfigure 2 performance mgmt statistics entity default template template name sample size size sample interval minutes 3 commit DETAILED STEPS Purpose Command or Action configure Step 1 Creates a PM statistics collection template for the specified entity performance mgmt statistics entity default template template name Step 2 Use the entity argument to specify the entity for which you want to creat...

Page 370: ...tion Templates This task explains how to enable and disable PM statistics collection templates Before You Begin You must create a PM statistics collection template before performing this task or you can use a predefined template default You must configure a TFTP server resource or local dump resource if you want to export statistics data onto a remote TFTP server or local disk Refer to the Configu...

Page 371: ...rformance mgmt apply statistics mpls ldp default with the default keyword or template keyword and template name argument when disabling a PM statistics collection or Data collection will begin one sampling cycle after you enable the PM statistics collection template with the performance mgmt apply statistics command Note RP 0 RSP0 CPU0 router config no performance mgmt apply statistics mpls ldp Wh...

Page 372: ... for the specified instance performance mgmt apply monitor entity instance interface basic counters data rates Step 2 Use the entity and instance arguments to specify the name of the entity and the instance to be monitored respectively generic counters type interface path id template name default Example RP 0 RSP0 CPU0 router config performance mgmt apply monitor node cpu 0 RSP1 CPU0 default Use e...

Page 373: ...performance mgmt thresholds node cpu template cpu_thresh1 RP 0 RSP0 CPU0 router config threshold bgp AverageCPUUsed GT 25 percent commit Step 3 What to Do Next After creating a PM threshold monitoring template you must enable the template to start PM threshold monitoring Refer to the Enabling and Disabling PM Threshold Monitoring Templates on page 357 task for more information about enabling PM st...

Page 374: ...erface path id location all node id The location keyword with the node id argument enables the PM threshold monitoring template for the specified node The node id argument is Example RP 0 RSP0 CPU0 router config expressed in the rack slot module notation The location all keywords enable the PM threshold monitoring template for all nodes performance mgmt enable thresholds node cpu location all temp...

Page 375: ...n this example the following PM template collection templates are created and enabled A template named template1 with a sample size of 10 and a sample interval of 5 for the interface generic counters entity A template named template2 with a sample size of 30 and a sample interval of 2 for the node memory entity The template is enabled globally A template name template3 with a sample size of 10 and...

Page 376: ...he following sections provide references related to implementing performance management Related Documents Document Title Related Topic Performance Management Commands on the Cisco ASR 9000 Series Router module in the Cisco ASR 9000 Series Aggregation Services Router System Monitoring Command Reference Performance management commands Cisco IOS XR XML API Guide Cisco IOS XR Software XML API material...

Page 377: ...Cs has not been modified by this feature Technical Assistance Link Description http www cisco com cisco web support index html The Cisco Technical Support website contains thousands of pages of searchable technical content including links to products technologies solutions technical tips and tools Registered Cisco com users can log in from this page to access even more content Cisco ASR 9000 Serie...

Page 378: ...Cisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration Guide Release 4 2 x 362 Implementing Performance Management Additional References ...

Reviews:

No comments

Brands by name

Popular brands

Load more brands