advertisement
Cisco IOS XR System Monitoring Command Reference for the Cisco
CRS Router, Release 4.2.x
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
Text Part Number: OL-26517-02
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR 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 THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http:// www.cisco.com/go/trademarks
. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
© 2016 Cisco Systems, Inc. All rights reserved.
C O N T E N T S
P r e f a c e
C H A P T E R 1
OL-26517-02
Obtaining Documentation and Submitting a Service Request xii
Alarm Management and Logging Correlation Commands 1
clear logging correlator delete 7
logging correlator apply rule 17
logging correlator apply ruleset 20
logging correlator buffer-size 23
logging events display-location 32
logging suppress apply rule 39
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x iii
Contents
C H A P T E R 2
C H A P T E R 3
show logging correlator buffer 51
show logging correlator info 54
show logging correlator rule 56
show logging correlator ruleset 59
show snmp correlator buffer 71
show snmp correlator ruleset 75
Embedded Event Manager Commands 83
event manager directory user 85
event manager scheduler suspend 97
show event manager directory user 99
show event manager environment 101
show event manager metric hardware 103
show event manager metric process 105
show event manager policy available 109
show event manager policy registered 111
show event manager refresh-time 115
show event manager statistics-table 117
show event manager scheduler thread 120
IP Service Level Agreement Commands 123
iv
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Contents
OL-26517-02
buckets (statistics hourly) 136
buckets (statistics interval) 138
destination address (IP SLA) 145
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x v
Contents
show ipsla mpls discovery vpn 247
show ipsla mpls lsp-monitor lpd 249
show ipsla mpls lsp-monitor scan-queue 251
show ipsla mpls lsp-monitor summary 253
show ipsla responder statistics 256
show ipsla statistics aggregated 262
show ipsla statistics enhanced aggregated 272
show ipsla twamp connection 276
show ipsla twamp standards 278
vi
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Contents
C H A P T E R 4
OL-26517-02
threshold type consecutive 301
vrf (IP SLA MPLS LSP monitor) 333
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x vii
Contents
C H A P T E R 5
C H A P T E R 6
logging events link-status 355
logging events link-status (interface) 357
logging suppress deprecated 378
logging suppress duplicates 379
Onboard Failure Logging Commands 397
hw-module logging onboard disable 405
Performance Management Commands 409
performance-mgmt apply monitor 421
performance-mgmt apply statistics 424
performance-mgmt apply thresholds 428
performance-mgmt regular-expression 431
viii
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Contents
C H A P T E R 7
C H A P T E R 8
OL-26517-02
performance-mgmt resources dump local 432
performance-mgmt resources memory 433
performance-mgmt resources tftp-server 435
performance-mgmt statistics 437
performance-mgmt thresholds 440
show performance-mgmt interface 454
show performance-mgmt mpls 458
show performance-mgmt node 460
show performance-mgmt ospf 462
show running performance-mgmt 464
Statistics Service Commands 467
diagnostic monitor interval 478
diagnostic monitor threshold 481
diagnostic ondemand action-on-failure 483
diagnostic ondemand iterations 485
diagnostic test-parameters 494
ping (administration EXEC) 498
show diagnostic bootup level 513
show diagnostic ondemand settings 520
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x ix
Contents
show run diagnostic monitor 533
x
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Preface
From Release 6.1.1 onwards, Cisco introduces support for the 64-bit Linux-based IOS XR operating system.
Extensive feature parity is maintained between the 32-bit and 64-bit environments. Unless explicitly marked otherwise, the contents of this document are applicable for both the environments. For more details on Cisco
IOS XR 64 bit, refer to the Release Notes for Cisco XR 12000 Series RoutersCisco CRS
RoutersCisco ASR 9000 Series RoutersCisco NCS 6000 Series RoutersCisco NCS 4000 Series Router,
Release 6.1.1 document.
The Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series
RouterCisco IOS XR System Monitoring Command Reference for the Cisco CRS RouterCisco ASR 9000
Series Aggregation Services Router System Monitoring Command ReferenceSystem Monitoring Command
Reference for Cisco NCS 6000 Series Routers preface contains these sections:
•
Changes to This Document, page xi
•
Obtaining Documentation and Submitting a Service Request, page xii
Changes to This Document
This table lists the technical changes made to this document since it was first published.
Table 1: Changes to this Document
Data
January 2015
April 2016
August 2016
Change Summary
Initial release of the cumulative command reference document that covers all updates from Rel. 4.3.0
onwards.
Republished with the required documentation updates.
Republished with documentation updates for Release
6.1.1 features.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x xi OL-26517-02
Preface
Obtaining Documentation and Submitting a Service Request
Data
January 2015
August 2016
Data
January 2015
August 2016
Data
January 2015
Change Summary
Initial release of the cumulative command reference document that covers all updates from Rel. 4.3.0
onwards.
Republished with documentation updates for Release
6.1.1 features.
Change Summary
Initial release of the cumulative command reference document that covers all updates from Rel. 4.3.0
onwards.
Republished with documentation updates for Release
6.1.1 features.
Change Summary
Initial release of the cumulative command reference document that covers all updates from Rel. 4.3.0
onwards.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation .
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's
New in Cisco Product Documentation RSS feed . RSS feeds are a free service.
xii
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Alarm Management and Logging Correlation
Commands
This module describes the commands used to manage alarms and configure logging correlation rules for system monitoring on the router.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
For detailed information about alarm management and logging correlation concepts, configuration tasks, and examples, see the Implementing and Monitoring Alarms and Logging Correlation module in the
Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000 Series RouterCisco IOS XR
System Monitoring Configuration Guide for the Cisco CRS RouterCisco ASR 9000 Series Aggregation
Services Router System Monitoring Configuration GuideSystem Monitoring Configuration Guide for Cisco
NCS 6000 Series Routers.
For system logging commands, see the Logging Services Commands module.
For system logging concepts, see the Implementing Logging Services module in the Cisco IOS XR System
Monitoring Configuration Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Monitoring
Configuration Guide for the Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System
Monitoring Configuration GuideSystem Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
•
•
•
clear logging correlator delete, page 7
•
clear logging events delete, page 9
•
clear logging events reset, page 13
•
•
logging correlator apply rule, page 17
•
logging correlator apply ruleset, page 20
•
logging correlator buffer-size, page 23
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
1
•
logging correlator rule, page 25
•
logging correlator ruleset, page 28
•
logging events buffer-size, page 30
•
logging events display-location, page 32
•
•
logging events threshold, page 37
•
logging suppress apply rule, page 39
•
logging suppress rule, page 41
•
•
•
•
•
show logging correlator buffer, page 51
•
show logging correlator info, page 54
•
show logging correlator rule, page 56
•
show logging correlator ruleset, page 59
•
show logging events buffer, page 62
•
show logging events info, page 67
•
show logging suppress rule, page 69
•
show snmp correlator buffer, page 71
•
show snmp correlator info, page 73
•
show snmp correlator rule, page 74
•
show snmp correlator ruleset, page 75
•
•
•
Alarm Management and Logging Correlation Commands
2
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands alarm
alarm
To specify a type of alarm to be suppressed by a logging suppression rule, use the alarm command in logging suppression rule configuration mode.
alarm msg-category group-name msg-code
Syntax Description msg-category group-name msg-code
Message category of the root message.
Group name of the root message.
Message code of the root message.
Command Default No alarm types are configured by default.
Command Modes Logging suppression rule configuration
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to configure the logging suppression rule “commit” to suppress alarms whose root message are “MBGL”, with group name “commit” and message code “succeeded”:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress rule commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-rule)# alarm MBGL COMMIT SUCCEEDED
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
3 OL-26517-02
Alarm Management and Logging Correlation Commands alarm
Related Commands
Command
logging suppress rule, on page 41
Description
Creates a logging suppression rule.
4
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands all-alarms
all-alarms
To configure a logging suppression rule to suppress all types of alarms, use the all-alarms command in logging suppression rule configuration mode.
all-alarms
Syntax Description This command has no keywords or arguments.
Command Default No alarm types are configured by default.
Command Modes Logging suppression rule configuration
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to configure the logging suppression rule commit to suppress all alarms:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress rule commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-rule)# all-alarms
Related Commands
Command
logging suppress rule, on page 41
Description
Creates a logging suppression rule.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
5 OL-26517-02
Alarm Management and Logging Correlation Commands all-of-router
all-of-router
To apply a logging suppression rule to alarms originating from all locations on the router, use the all-of-router command in logging suppression apply rule configuration mode.
all-of-router
Syntax Description This command has no keywords or arguments.
Command Default No scope is configured by default.
Command Modes Logging suppression apply rule configuration
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations execute
Examples This example shows how to apply the logging suppression rule “commit” to all locations on the router:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress apply rule commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-apply-rule)# all-of-router
Related Commands
Command
logging suppress apply rule, on page 39
Description
Applies and activates a logging suppression rule.
6
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands clear logging correlator delete
clear logging correlator delete
To delete all messages or messages specified by a correlation ID from the logging correlator buffer, use the
clear logging correlator delete command in EXEC modeXR EXEC mode.
clear logging correlator delete {all-in-buffer| correlation-id}
Syntax Description all-in-buffer correlation-id
Clears all messages in the logging correlator buffer.
Correlation event record ID. Up to 14 correlation IDs can be specified, separated by a space. Range is 0 to 4294967294.
Command Default No messages are automatically deleted unless buffer capacity is reached.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the
show logging correlator buffer, on page 51
command to confirm that records have been cleared.
Use the
logging correlator buffer-size, on page 23
command to configure the capacity of the logging correlator buffer.
Task ID
Task ID logging
Operations execute
Examples This example shows how to clear all records from the logging correlator buffer:
RP/0/0RP0RSP0/CPU0:router:hostname# clear logging correlator delete all-in-buffer
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
7 OL-26517-02
Alarm Management and Logging Correlation Commands clear logging correlator delete
Related Commands
Command
show logging correlator buffer, on page 51
Description
Displays messages in the logging correlator buffer.
8
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands clear logging events delete
clear logging events delete
To delete messages from the logging events buffer, use the clear logging events delete command in EXEC modeXR EXEC mode.
clear logging events delete
Syntax Description admin-level-only all-in-buffer bistate-alarms-set
category name
context name
event-hi-limit event-id
event-lo-limit event-id
first event-count
group message-group
last event-count
location node-id
message message-code severity-hi-limit
Deletes only events at the administrative level.
Deletes all event IDs from the logging events buffer.
Deletes bi-state alarms in the SET state.
Deletes events from a specified category.
Deletes events from a specified context.
Deletes events with an event ID equal to or lower than the event ID specified with the event-id argument. Range is 0 to 4294967294.
Deletes events with an event ID equal to or higher than the event ID specified with the event-id argument. Range is 0 to 4294967294.
Deletes events, beginning with the first event in the logging events buffer. For the event-count argument, enter the number of events to be deleted.
Deletes events from a specified message group.
Deletes events, beginning with the last event in the logging events buffer. For the event-count argument, enter the number of events to be deleted.
Deletes messages from the logging events buffer for the specified location.
The node-id argument is entered in the rack/slot/module notation.
Deletes events with the specified message code.
Deletes events with a severity level equal to or lower than the severity level specified with the severity argument.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
9
Alarm Management and Logging Correlation Commands clear logging events delete severity severity-lo-limit timestamp-hi-limit
Severity level. Valid values are:
• alerts
• critical
• emergencies
• errors
• informational
• notifications
• warnings
Note Settings for the severity levels and their respective system conditions are listed under the “Usage Guidelines” section for the logging events
level command. Events of lower severity level represent events of higher importance.
Deletes events with a severity level equal to or higher than the severity level specified with the severity argument.
Deletes events with a time stamp equal to or lower than the specified time stamp.
10
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands clear logging events delete
hh : mm : ss [month] [day]
[year]
Time stamp for the timestamp-hi-limit or timestamp-lo-limit keyword. The
month, day, and year arguments default to the current month, day, and year, if not specified.
Ranges for the hh : mm : ss month day year arguments are as follows:
• hh :—Hours. Range is 00 to 23. You must insert a colon after the hh argument.
• mm :—Minutes. Range is 00 to 59. You must insert a colon after the mm argument.
• ss—Seconds. Range is 00 to 59.
• month—(Optional) The month of the year. The values for the month argument are:
◦january
◦february
◦march
◦april
◦may
◦june
◦july
◦august
◦september
◦october
◦november
◦december
• day—(Optional) Day of the month. Range is 01 to 31.
◦year—(Optional) Year. Enter the last two digits of the year (for example, 04 for 2004). Range is 01 to 37.
timestamp-lo-limit Deletes events with a time stamp equal to or higher than the specified time stamp.
Command Default No messages are automatically deleted unless buffer capacity is reached.
Command Modes EXEC modeXR EXEC mode
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
11
Alarm Management and Logging Correlation Commands clear logging events delete
Command History
Release
Release 2.0
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Support was introduced for the admin-level-only keyword option.
This command was introduced.
This command was introduced.
Usage Guidelines This command is used to delete messages from the logging events buffer that match the keywords and arguments that you specify. The description is matched if all of the conditions are met.
Use the
show logging events buffer, on page 62
command to verify that events have been cleared from the logging events buffer.
Use the
logging events buffer-size, on page 30
command to configure the capacity of the logging events buffer.
Task ID
Task ID logging
Operations execute
Examples This example shows how to delete all messages from the logging events buffer:
RP/0/0RP0RSP0/CPU0:router:hostname# clear logging events delete all-in-buffer
Related Commands
Command
clear logging events reset, on page 13
show logging events buffer, on page 62
Description
Resets bi-state alarms.
Displays messages in the logging events buffer.
12
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands clear logging events reset
clear logging events reset
To reset bi-state alarms, use the clear logging events reset command in EXEC modeXR EXEC mode.
clear logging events reset {all-in-buffer| event-id}
Syntax Description all-in-buffer event-id
Resets all bi-state alarm messages in the event logging buffer.
Event ID. Resets the bi-state alarm for an event or events. Up to 32 event IDs can be specified, separated by a space. Range is 0 to 4294967294.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command clears bi-state alarms messages from the logging events buffer. Bi-state alarms are generated by state changes associated with system hardware, such as a change of interface state from active to inactive, or the online insertion and removal (OIR) of a Modular Service Card (MSC), or a change in component temperature.
Use the
show logging events buffer, on page 62
command to display messages in the logging events buffer.
Task ID
Task ID logging
Operations execute
Examples This example shows how to reset all bi-alarms in the logging events buffer:
RP/0/0RP0RSP0/CPU0:router:hostname# clear logging events reset all-in-buffer
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
13 OL-26517-02
Alarm Management and Logging Correlation Commands clear logging events reset
Related Commands
Command
clear logging events delete, on page 9
show logging events buffer, on page 62
Description
Deletes all bi-state alarm messages, or messages specified by correlation ID, from the logging events buffer.
Displays messages in the logging events buffer.
14
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands context-correlation
context-correlation
To enable context-specific correlation, use the context-correlation command in either stateful or nonstateful correlation rule configuration mode. To disable correlation on context, use the no form of this command.
context-correlation no context-correlation
Syntax Description This command has no keywords or arguments.
Command Default Correlation on context is not enabled.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command enables context-specific correlation for each of the contexts in which a given rule is applied.
For example, if the rule is applied to two contexts (context1 and context2), messages that have context
“context1” are correlated separately from those messages with context “context2”.
Use the
show logging correlator rule, on page 56
command to show the current setting for the context-correlation flag.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to enable correlation on context for a stateful correlation rule:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule stateful_rule type
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
15 OL-26517-02
Alarm Management and Logging Correlation Commands context-correlation stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# context-correlation
Related Commands
Command
logging correlator rule, on page 25
show logging correlator rule, on page 56
Description
Defines the rules for correlating messages.
Displays one or more predefined logging correlator rules.
16
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator apply rule
logging correlator apply rule
To apply and activate a correlation rule and enter correlation apply rule configuration mode, use the logging
correlator apply rule command in Global Configuration modeXR Config mode. To deactivate a correlation rule, use the no form of this command.
logging correlator apply rule correlation-rule [all-of-router| context name| location node-id]
no logging correlator apply rule correlation-rule [all-of-router| context name| location node-id]
Syntax Description correlation-rule all-of-router
context name
location node-id
Name of the correlation rule to be applied.
(Optional) Applies the correlation rule to the entire router.
(Optional) Applies the correlation rule to the specified context. Unlimited number of contexts. The name string is limited to 32 characters.
(Optional) Applies the correlation rule to the specified node. The node-id argument is entered in the rack/slot/module notation. Unlimited number of locations.
Command Default No correlation rules are applied.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging correlator apply rule command is used to either add or remove apply settings for a given rule.
These settings then determine which messages are correlated for the affected rules.
If the rule is applied to all-of-router, then correlation occurs for only those messages that match the configured cause values for the rule to be correlated, regardless of the context or location setting of that message.
If a rule is applied to a specific set of contexts or locations, then correlation occurs for only those messages that match both the configured cause values for the rule and at least one of those contexts or locations.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
17 OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator apply rule
Task ID
Use the
show logging correlator rule, on page 56
command to show the current apply settings for a given rule.
Tip When a rule is applied (or if a rule set that contains this rule is applied), then the rule definition cannot be modified through the configuration until the rule or rule set is once again unapplied.
Tip It is possible to configure apply settings at the same time for both a rule and zero or more rule sets that contain the rule. In this case, the apply settings for the rule are the union of all the apply configurations.
The logging correlator apply rule command allows you to enter submode (config-corr-apply-rule) to apply and activate rules:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator apply rule stateful1
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)#?
all-of-router Apply the rule to all of the router clear clear commit
Clear the uncommitted configuration
Clear the configuration
Commit the configuration changes to running context describe do exit
Apply rule to specified context
Describe a command without taking real actions
Run an exec command
Exit from this submode location no pwd
Apply rule to specified location
Negate a command or set its defaults
Commands used to reach current submode root show
Exit to the global configurationXR Config mode
Show contents of configuration
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)#
While in the submode, you can negate keyword options:
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)# no all-of-router
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)# no context
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)# no location
Task ID logging
Operations read, write
Examples This example shows how to apply a predefined correlator rule to a location:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator apply rule rule1
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)# location 0/2/CPU0
Related Commands
Command
logging correlator rule, on page 25
show logging correlator rule, on page 56
Description
Defines the rules for correlating messages.
Displays one or more predefined logging correlator rules.
18
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator apply rule
Command
show logging correlator ruleset, on page 59
Description
Displays one or more predefined logging correlator rule sets.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
19
Alarm Management and Logging Correlation Commands logging correlator apply ruleset
logging correlator apply ruleset
To apply and activate a correlation rule set and enter correlation apply rule set configuration mode, use the
logging correlator apply ruleset command in Global Configuration modeXR Config mode. To deactivate a correlation rule set, use the no form of this command.
logging correlator apply ruleset correlation-ruleset [all-of-router| context name| location node-id]
no logging correlator apply ruleset correlation-ruleset [all-of-router| context name| location node-id]
Syntax Description correlation-ruleset all-of-router
context name
location node-id
Name of the correlation rule set to be applied.
(Optional) Applies the correlation rule set to the entire router.
(Optional) Applies the correlation rule set to the specified context. Unlimited number of contexts. The name string is limited to 32 characters.
(Optional) Applies the correlation rule to the specified node. The node-id argument is entered in the rack/slot/module notation. Unlimited number of locations.
Command Default No correlation rule sets are applied.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging correlator apply ruleset command is used to either add or remove apply settings for a given rule set. These settings then determine which messages are correlated for the affected rules.
If the rule set is applied to all-of-router, then correlation occurs for only those messages that match the configured cause values for the rule to be correlated, regardless of the context or location setting of that message.
20
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator apply ruleset
Task ID
If a rule set is applied to a specific set of contexts or locations, then correlation occurs for only those messages that match both the configured cause values for the rule and at least one of those contexts or locations.
Use the
show logging correlator ruleset, on page 59
command to show the current apply settings for a given rule set.
Tip When a rule is applied (or if a rule set that contains this rule is applied), then the rule definition cannot be modified through the configuration until the rule or rule set is once again unapplied.
Tip It is possible to configure apply settings at the same time for both a rule and zero or more rule sets that contain the rule. In this case, the apply settings for the rule are the union of all the apply configurations.
The logging correlator apply ruleset command allows you to enter the submode (config-corr-apply-ruleset) to apply and activate rule sets:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator apply ruleset ruleset1
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-ruleset)#?
all-of-router Apply the rule to all of the router clear Clear the uncommitted configuration clear Clear the configuration commit context describe do exit location
Commit the configuration changes to running
Apply rule to specified context
Describe a command without taking real actions
Run an exec command
Exit from this submode
Apply rule to specified location no pwd
Negate a command or set its defaults
Commands used to reach current submode root show
Exit to the global configurationXR Config mode
Show contents of configuration
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-ruleset)#
While in the submode, you can negate keyword options:
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-ruleset)# no all-of-router
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-ruleset)# no context
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-ruleset)# no location
Task ID logging
Operations read, write
Examples This example shows how to apply a predefined correlator rule set to the entire router:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator apply ruleset ruleset1
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-apply-rule)# all-of-router
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
21
Alarm Management and Logging Correlation Commands logging correlator apply ruleset
Related Commands
Command
show logging correlator ruleset, on page 59
Description
Displays one or more predefined logging correlator rule sets.
22
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator buffer-size
logging correlator buffer-size
To configure the logging correlator buffer size, use the logging correlator buffer-size command in Global
Configuration modeXR Config mode. To return the buffer size to its default setting, use the no form of this command.
logging correlator buffer-size bytes
no logging correlator buffer-size bytes
Syntax Description bytes The size, in bytes, of the circular logging correlator buffer. Range is 1024 to 52428800 bytes.
Command Default bytes: 81920 bytes
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging correlator buffer-size command configures the size of the correlation buffer. This buffer holds all the correlation records as well as the associated correlated messages. When the size of this buffer is exceeded, older correlations in the buffer are replaced with the newer incoming correlations. The criteria that are used to recycle these buffers are:
• First, remove the oldest nonstateful correlation records from the buffer.
• Then, if there are no more nonstateful correlations present; remove the oldest stateful correlation records.
Use the
show logging correlator info, on page 54
command to confirm the size of the buffer and the percentage of buffer space that is currently used. The
show logging events buffer, on page 62
all-in-buffer command can be used to show the details of the buffer contents.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
23 OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator buffer-size
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the logging correlator buffer size to 90000 bytes:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator buffer-size 90000
Related Commands
Command
show logging correlator info, on page 54
Description
Displays the logging correlator buffer size and the percentage of the buffer occupied by correlated messages.
24
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator rule
logging correlator rule
To define the rules for correlating messages, use the logging correlator rule command in Global Configuration modeXR Config mode. To delete the correlation rule, use the no form of this command.
logging correlator rule correlation-rule type {stateful| nonstateful}
no logging correlator rule correlation-rule
Syntax Description correlation-rule type stateful nonstateful
Name of the correlation rule to be applied.
Specifies the type of rule.
Enters stateful correlation rule configuration mode.
Enters nonstateful correlation rule configuration mode.
Command Default No rules are defined.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging correlator rule command defines the correlation rules used by the correlator to store messages in the logging correlator buffer. A rule must, at a minimum, consist of three elements: a root-cause message, one or more non-root-cause messages, and a timeout.
When the root-cause message, or a non-root-cause message is received, the timer is started. Any non-root-cause messages are temporarily held, while the root-cause is sent to syslog. If, after the timer has expired, the root-cause and at least one non-root-cause message was received, a correlation is created and stored in the correlation buffer.
A rule can be of type stateful or nonstateful. Stateful rules allow non-root-cause messages to be sent from the correlation buffer if the bi-state root-cause alarm clears at a later time. Nonstateful rules result in correlations that are fixed and immutable after the correlation occurs.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
25 OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator rule
Below are the rule parameters that are available while in stateful correlation rule configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# ?
context-correlation Specify enable correlation on context nonrootcause nonrootcause alarm reissue-nonbistate Specify reissue of non-bistate alarms on parent clear reparent Specify reparent of alarm on parent clear rootcause timeout timeout-rootcause
Specify root cause alarm: Category/Group/Code combos
Specify timeout
Specify timeout for root-cause
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)#
Below are the rule parameters that are available while in nonstateful correlation rule configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-nonst)# ?
context-correlation Specify enable correlation on context nonrootcause rootcause timeout nonrootcause alarm
Specify root cause alarm: Category/Group/Code combos
Specify timeout timeout-rootcause Specify timeout for root-cause
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-nonst)#
Note A rule cannot be deleted or modified while it is applied, so the no logging correlator apply command must be used to unapply the rule before it can be changed.
Task ID
Note The name of the correlation rule must be unique across all rule types and is limited to a maximum length of 32 characters.
Use the
show logging correlator buffer, on page 51
to display messages stored in the logging correlator buffer.
Use the
show logging correlator rule, on page 56
command to verify correlation rule settings.
Task ID logging
Operations read, write
Examples This example shows how to enter stateful correlation rule configuration mode to specify a collection duration period time for correlator messages sent to the logging events buffer:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# timeout 50000
Related Commands
Command
logging correlator apply rule, on page 17
Description
Applies and activates correlation rules.
26
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator rule
Command
reissue-nonbistate, on page 45
show logging correlator buffer, on page 51
show logging correlator rule, on page 56
Description
Enters non-root-cause configuration mode and specifies a non-root-cause alarm.
Reissues non-bistate alarm messages (events) from the correlator log after its root-cause alarm clears.
Reparents non-root-cause messages to the next highest active root-cause in a hierarchical correlation when their immediate parent clears.
Specifies a root-cause message alarm.
Displays messages in the logging correlator buffer.
Displays one or more predefined logging correlator rules.
Specifies the collection period duration time for the logging correlator rule message.
Specifies an optional parameter for an applied correlation rule.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
27
Alarm Management and Logging Correlation Commands logging correlator ruleset
logging correlator ruleset
To enter correlation rule set configuration mode and define a correlation rule set, use the logging correlator
ruleset command in Global Configuration modeXR Config mode. To delete the correlation rule set, use the
no form of this command.
logging correlator ruleset correlation-ruleset rulename correlation-rulename
no logging correlator ruleset correlation-ruleset
Syntax Description correlation-ruleset rulename correlation-rulename
Name of the correlation rule set to be applied.
Specifies the correlation rule name.
Name of the correlation rule name to be applied.
Command Default No rule sets are defined.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging correlator ruleset command defines a specific correlation rule set. A rule set name must be unique and is limited to a maximum length of 32 characters.
To apply a logging correlator rule set, use the
logging correlator apply ruleset, on page 20
command.
Examples This example shows how to specify a logging correlator rule set:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator ruleset ruleset_1
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-ruleset)# rulename state_rule
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-ruleset)# rulename state_rule2
28
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging correlator ruleset
Related Commands
Command
logging correlator apply ruleset, on page 20
show logging correlator buffer, on page 51
show logging correlator ruleset, on page 59
Description
Applies and activates a correlation rule set and enters correlation apply rule set configuration mode.
Displays messages in the logging correlator buffer.
Displays defined correlation rule set names.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
29
Alarm Management and Logging Correlation Commands logging events buffer-size
logging events buffer-size
To configure the size of the logging events buffer, use the logging events buffer-size command in Global
Configuration modeXR Config mode. To restore the buffer size to the default value, use the no form of this command.
logging events buffer-size bytes
no logging events buffer-size bytes
Syntax Description bytes The size, in bytes, of the logging events buffer. Range is 1024 to 1024000 bytes. The default is 43200 bytes.
Command Default bytes: 43200
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines
Note The logging events buffer automatically adjusts to a multiple of the record size that is lower than or equal to the value configured for the bytes argument.
Use the
show logging events info, on page 67
command to confirm the size of the logging events buffer.
Task ID
Task ID logging
Operations read, write
30
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging events buffer-size
Examples This example shows how to increase the logging events buffer size to 50000 bytes:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging events buffer-size 50000
Related Commands
Command
logging events level, on page 35
logging events threshold, on page 37
show logging correlator info, on page 54
show logging events buffer, on page 62
show logging events info, on page 67
Description
Specifies a severity level for logging alarm messages.
Specifies the event logging buffer capacity threshold that, when surpassed, will generate an alarm.
Displays information about the size of the logging correlator buffer and available capacity.
Displays messages in the logging events buffer.
Displays configuration and operational messages about the logging events buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
31
Alarm Management and Logging Correlation Commands logging events display-location
logging events display-location
To enable the alarm source location display field for bistate alarms in the output of the show logging and
show logging events buffer command, use the logging events display-location command in Global
Configuration modeXR Config mode.
logging events display-location no logging events display-location
Syntax Description This command has no keywords or arguments.
Command Default The alarm source location display field in show logging output is not enabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The output of the show logging command for bistate alarms has been enhanced. Previously, the alarm source field in the output displayed the location of the process that logged the alarm. Use the logging events
display-location command to configure the output of the show logging command to include an additional source field that displays the actual source of the alarm. The alarm source is displayed in a format that is consistent with alarm source identification in other platforms and equipment. The new alarm source display field aids accurate identification and isolation of the source of a fault.
By default, the output of the show logging command does not include the new alarm source identification field. If you enable the alarm source location display field in the show logging output, the same naming conventions are also used to display hardware locations in the show diag and show inventory command output.
Note Customer OSS tools may rely on the default output to parse and interpret the alarm output.
32
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging events display-location
Task ID
Task ID logging
Operations read, write
Examples This example shows the show logging command output for bistate alarms before and after enabling the alarm source location display field:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging | inc Interface
Wed Aug 13 01:30:58.461 UTC
LC/0/2/CPU0:Aug 12 01:20:54.073 : ifmgr[159]: %PKT_INFRA-LINK-5-CHANGED : Interface
GigabitEthernet0/2/0/0, changed state to Administratively Down
LC/0/2/CPU0:Aug 12 01:20:59.450 : ifmgr[159]: %PKT_INFRA-LINK-3-UPDOWN : Interface
GigabitEthernet0/2/0/0, changed state to Down
LC/0/2/CPU0:Aug 12 01:20:59.451 : ifmgr[159]: %PKT_INFRA-LINEPROTO-5-UPDOWN : Line protocol on Interface GigabitEthernet0/2/0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:22:11.496 : ifmgr[202]: %PKT_INFRA-LINK-5-CHANGED : Interface
MgmtEth0/5/CPU0/0, changed state to Administratively Down
RP/0/5/CPU0:Aug 12 01:23:23.842 : ifmgr[202]: %PKT_INFRA-LINK-3-UPDOWN : Interface
MgmtEth0/5/CPU0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:23:23.843 : ifmgr[202]: %PKT_INFRA-LINEPROTO-5-UPDOWN : Line protocol on Interface MgmtEth0/5/CPU0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:23:23.850 : ifmgr[202]: %PKT_INFRA-LINK-3-UPDOWN : Interface
MgmtEth0/5/CPU0/0, changed state to Up
RP/0/5/CPU0:Aug 12 01:23:23.856 : ifmgr[202]: %PKT_INFRA-LINEPROTO-5-UPDOWN : Line protocol on Interface MgmtEth0/5/CPU0/0, changed state to Up
RP/0/0RP0RSP0/CPU0:router:hostname# config
Wed Aug 13 01:31:32.517 UTC
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging events display-location
RP/0/0RP0RSP0/CPU0:router:hostname(config)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config)# exit
RP/0/0RP0RSP0/CPU0:router:hostname# show logging | inc Interface
Wed Aug 13 01:31:48.141 UTC
LC/0/2/CPU0:Aug 12 01:20:54.073 : ifmgr[159]: %PKT_INFRA-LINK-5-CHANGED : Interface
GigabitEthernet0/2/0/0, changed state to Administratively Down
LC/0/2/CPU0:Aug 12 01:20:59.450 : ifmgr[159]: %PKT_INFRA-LINK-3-UPDOWN : interface
GigabitEthernet0/2/0/0: Interface GigabitEthernet0/2/0/0, changed state to Down
LC/0/2/CPU0:Aug 12 01:20:59.451 : ifmgr[159]: %PKT_INFRA-LINEPROTO-5-UPDOWN : interface
GigabitEthernet0/2/0/0: Line protocol on Interface GigabitEthernet0/2/0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:22:11.496 : ifmgr[202]: %PKT_INFRA-LINK-5-CHANGED : Interface
MgmtEth0/5/CPU0/0, changed state to Administratively Down
RP/0/5/CPU0:Aug 12 01:23:23.842 : ifmgr[202]: %PKT_INFRA-LINK-3-UPDOWN : interface
MgmtEth0/5/CPU0/0: Interface MgmtEth0/5/CPU0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:23:23.843 : ifmgr[202]: %PKT_INFRA-LINEPROTO-5-UPDOWN : interface
MgmtEth0/5/CPU0/0: Line protocol on Interface MgmtEth0/5/CPU0/0, changed state to Down
RP/0/5/CPU0:Aug 12 01:23:23.850 : ifmgr[202]: %PKT_INFRA-LINK-3-UPDOWN : interface
MgmtEth0/5/CPU0/0: Interface MgmtEth0/5/CPU0/0, changed state to Up
RP/0/5/CPU0:Aug 12 01:23:23.856 : ifmgr[202]: %PKT_INFRA-LINEPROTO-5-UPDOWN : interface
MgmtEth0/5/CPU0/0: Line protocol on Interface MgmtEth0/5/CPU0/0, changed state to Up
Related Commands
Command
show logging events buffer, on page 62
Description
Displays messages in the logging events buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
33
logging events display-location
Alarm Management and Logging Correlation Commands
34
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging events level
logging events level
To specify a severity level for logging alarm messages, use the logging events level command in Global
Configuration modeXR Config mode. To return to the default value, use the no form of this command.
logging events level severity no logging events level
Syntax Description severity Severity level of events to be logged in the logging events buffer, including events of a higher severity level (numerically lower).
Table 2: Alarm Severity Levels for Event
lists severity levels and their respective system conditions.
Command Default All severity levels (from 0 to 6) are logged.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command specifies the event severity necessary for alarm messages to be logged. Severity levels can be specified by the severity level description (for example, warnings). When a severity level is specified, events of equal or lower severity level are also written to the logging events buffer.
Note Events of lower severity level represent events of higher importance.
This table lists the system severity levels and their corresponding numeric values, and describes the corresponding system condition.
Table 2: Alarm Severity Levels for Event Logging
Severity Level Keyword emergencies
Numeric Value
0
Logged System Messages
System is unusable.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
35 OL-26517-02
Alarm Management and Logging Correlation Commands logging events level
Severity Level Keyword alerts critical errors warnings notifications informational
Numeric Value
1
2
3
4
5
6
Logged System Messages
Critical system condition exists requiring immediate action.
Critical system condition exists.
Noncritical errors.
Warning conditions.
Notifications of changes to system configuration.
Information about changes to system state.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the severity level for notification to warnings (level 4):
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging events level warnings
Related Commands
Command
logging events buffer-size, on page 30
logging events threshold, on page 37
Description
Specifies the logging events buffer size.
Specifies the logging events buffer capacity threshold that, when surpassed, will generate an alarm.
36
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging events threshold
logging events threshold
To specify the logging events buffer threshold that, when surpassed, generates an alarm, use the logging
events threshold command in Global Configuration modeXR Config mode. To return to the default value, use the no form of this command.
logging events threshold percent no logging events threshold
Syntax Description percent Minimum percentage of buffer capacity that must be allocated to messages before an alarm is generated. Range is 10 to 100. The default is 80 percent.
Command Default percent: 80 percent
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command can be configured to generate an alarm when 10 percent or more of the event buffer capacity is available.
The logging events buffer is circular; that is, when full it overwrites the oldest messages in the buffer. Once the logging events buffer reaches full capacity, the next threshold alarm is generated when the number of overwritten events surpasses the percentage of buffer capacity allocated to messages.
Use the
show logging events info, on page 67
command to display the current threshold setting.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
37 OL-26517-02
Alarm Management and Logging Correlation Commands logging events threshold
Examples This example shows how to configure the threshold setting to 95 percent of buffer capacity:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging events threshold 95
Related Commands
Command
logging events buffer-size, on page 30
logging events level, on page 35
show logging events info, on page 67
Description
Specifies the logging correlator buffer size.
Specifies a severity level for logging alarm messages.
Displays configuration and operational messages about the logging events buffer.
38
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging suppress apply rule
logging suppress apply rule
To apply and activate a logging suppression rule, use the logging suppress apply rule command in Global
Configuration modeXR Config mode. To deactivate a logging suppression rule, use the no form of this command.
logging suppress apply rule rule-name [all-of-router| source location node-id]
no logging suppress apply rule rule-name [all-of-router| source location node-id]
Syntax Description rule-name all-of-router
source location node-id
Name of the logging suppression rule to activate.
(Optional) Applies the specified logging suppression rule to alarms originating from all locations on the router.
(Optional) Applies the specified logging suppression rule to alarms originating from the specified node. The node-id argument is entered in the
rack/slot/module notation.
Command Default No logging suppression rules are applied.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
39 OL-26517-02
Alarm Management and Logging Correlation Commands logging suppress apply rule
Examples This example shows how to apply a predefined logging suppression rule to the entire router:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress apply rule infobistate
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-apply-rule)# all-of-router
Related Commands
Command
Description
Applies a logging suppression rule to suppress alarms originating from all sources on the router.
Applies a logging suppression rule to alarms originating from a specific node on the router.
40
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands logging suppress rule
logging suppress rule
To create a logging suppression rule and enter the configuration mode for the rule, use the logging suppress
rule command in the Global Configuration modeXR Config mode. To remove a logging suppression rule, use the no form of this command.
logging suppress rule rule-name [alarm msg-category group-name msg-code| all-alarms]
no logging suppress rule rule-name
Syntax Description rule-name alarm msg-category group-name msg-code all-alarms
Name of the rule.
(Optional) Specifies a type of alarm to be suppressed by the logging suppression rule.
Message category of the root message.
Group name of the root message.
Message code of the root message.
(Optional) Specifies that the logging suppression rule suppresses all types of alarms.
Command Default No logging suppression rules exist by default.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines If you use the logging suppress rule command without specifying a non-root-cause alarm, you can do so afterwards, by entering the alarm keyword at the prompt.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
41 OL-26517-02
Alarm Management and Logging Correlation Commands logging suppress rule
Task ID
Task ID logging
Operations read, write
Examples This example shows how to create a logging suppression rule called infobistate:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress rule infobistate
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-rule)#
Related Commands
Command
Description
Specifies a type of alarm to be suppressed by a logging suppression rule.
Configures a logging suppression rule to suppress all types of alarms.
42
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands nonrootcause
nonrootcause
To enter the non-root-cause configuration mode and specify a non-root-cause alarm, use the nonrootcause command in stateful or nonstateful correlation rule configuration modes.
nonrootcause alarm msg-category group-name msg-code no nonrootcause
Syntax Description alarm msg-category group-name msg-code
Non-root-cause alarm.
(Optional) Message category assigned to the message. Unlimited messages
(identified by message category, group, and code) can be specified, separated by a space.
(Optional) Message group assigned to the message. Unlimited messages (identified by message category, group, and code) can be specified, separated by a space.
(Optional) Message code assigned to the message. Unlimited messages (identified by message category, group, and code) can be specified, separated by a space.
Command Default Non-root-cause configuration mode and alarm are not specified.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command is used to enter the non-root-cause configuration mode to configure one or more non-root-cause alarms associated with a particular correlation rule.
Use the
show logging events info, on page 67
command to display the current threshold setting.
If you use the nonrootcause command without specifying a non-root-cause alarm, you can do so afterwards, by entering the alarm keyword at the prompt.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
43 OL-26517-02
Alarm Management and Logging Correlation Commands nonrootcause
Task ID
Task ID logging
Operations read, write
Examples This example shows how to enter non-root-cause configuration mode and display the commands that are available under this mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# nonrootcause
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st-nonrc)# ?
alarm Specify non-root cause alarm: Category/Group/Code combos clear clear commit
Clear the uncommitted configuration
Clear the configuration
Commit the configuration changes to running describe Describe a command without taking real actions do exit no pwd root show
Run an exec command
Exit from this submode
Negate a command or set its defaults
Commands used to reach current submode
Exit to the global configurationXR Config mode
Show contents of configuration
This example shows how to specify a non-root-cause alarm for Layer 2 local SONET messages with an alarm severity of 4. The non-root-cause alarm is associated with the correlation rule named state_rule.
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st-nonrc)# alarm L2 SONET_LOCAL ALARM
Related Commands
Command
logging events buffer-size, on page 30
logging events level, on page 35
logging events threshold, on page 37
show logging events info, on page 67
Description
Specifies the logging correlator buffer size.
Specifies a severity level for logging alarm messages.
Specifies the logging events buffer capacity threshold that, when surpassed, will generate an alarm.
Displays configuration and operational messages about the logging events buffer.
44
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands reissue-nonbistate
reissue-nonbistate
To reissue non-bistate alarm messages (events) from the correlator log after the root-cause alarm of a stateful rule clears, use the reissue-nonbistate command in stateful or nonstateful correlation rule configuration modes. To disable the reissue-nonbistate flag, use the no form of this command.
reissue-nonbistate no reissue-nonbistate
Syntax Description This command has no keywords or arguments.
Command Default Non-bistate alarm messages are not reissued after their root-cause alarm clears.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines By default, when the root-cause alarm of a stateful correlation is cleared, any non-root-cause, bistate messages being held for that correlation are silently deleted and are not sent to syslog. If the non-bistate messages should be sent, use the reissue-nonbistate command for the rules where this behavior is required.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to reissue nonbistate alarm messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# reissue-nonbistate
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
45 OL-26517-02
Alarm Management and Logging Correlation Commands reissue-nonbistate
Related Commands
Command
show logging correlator buffer, on page 51
show logging events buffer, on page 62
Description
Displays messages in the logging correlator buffer.
Displays messages in the logging events buffer.
46
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands reparent
reparent
To reparent non-root-cause messages to the next highest active rootcause in a hierarchical correlation when their immediate parent clears, use the reparent command in stateful correlation rule configuration mode. To disable the reparent flag, use the no form of this command.
reparent no reparent
Syntax Description This command has no keywords or arguments.
Command Default A non-root-cause alarm is sent to syslog after a root-cause parent clears.
Command Modes Stateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the reparent command to specify what happens to non-root-cause alarms in a hierarchical correlation after their root-cause alarm clears. The following scenario illustrates why you may want to set the reparent flag.
Rule 1 with rootcause A and non-rootcause B
Rule 2 with rootcause B and non-rootcause C
(Alarm B is a non-rootcause for Rule 1 and a rootcause for Rule 2. For the purpose of this example, all the messages are bistate alarms.)
If both Rule 1 and Rule 2 each trigger a successful correlation, then a hierarchy is constructed that links these two correlations. When alarm B clears, alarm C would normally be sent to syslog, but the operator may choose to continue suppression of alarm C (hold it in the correlation buffer); because the rootcause that is higher in the hierarchy (alarm A) is still active.
The reparent flag allows you to specify non-root-cause behavior—if the flag is set, then alarm C becomes a child of rootcause alarm A; otherwise, alarm C is sent to syslog.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
47 OL-26517-02
Alarm Management and Logging Correlation Commands reparent
Task ID
Note Stateful behavior, such as reparenting, is supported only for bistate alarms. Bistate alarms are associated with system hardware, such as a change of interface state from active to inactive.
Task ID logging
Operations read, write
Examples This example shows how to set the reparent flag for a stateful rule:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# reparent
Related Commands
Command
logging correlator rule, on page 25
show logging correlator buffer, on page 51
show logging events info, on page 67
Description
Defines the rules for correlating messages.
Displays messages in the logging correlator buffer.
Displays configuration and operational messages about the logging events buffer.
48
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands rootcause
rootcause
To specify the root-cause alarm message, use the rootcause command in stateful or nonstateful correlation rule configuration modes.
rootcause msg-category group-name msg-code no rootcause
Syntax Description msg-category group-name msg-code
Message category of the root message.
Group name of the root message.
Message code of the root message.
Command Default Root-cause alarm is not specified.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command is used to configure the root-cause message for a particular correlation rule. Messages are identified by their message category, group, and code. The category, group, and code each can contain up to
32 characters. The root-cause message for a stateful correlation rule should be a bi-state alarm.
Use the
show logging events info, on page 67
command to display the root-cause and non-root-cause alarms for a correlation rule.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
49 OL-26517-02
Alarm Management and Logging Correlation Commands rootcause
Examples This example shows how to configure a root-cause alarm for a stateful correlation rule:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# rootcause L2 SONET_LOCAL ALARM
Related Commands
Command
logging events buffer-size, on page 30
logging events level, on page 35
logging events threshold, on page 37
show logging events info, on page 67
Description
Specifies the logging correlator buffer size.
Specifies a severity level for logging alarm messages.
Specifies the logging events buffer capacity threshold that, when surpassed, will generate an alarm.
Specifies an optional parameter for an applied correlation rule.
Displays configuration and operational messages about the logging events buffer.
50
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator buffer
show logging correlator buffer
To display messages in the logging correlator buffer, use the show logging correlator buffer command in
EXEC modeXR EXEC mode.
show logging correlator buffer {all-in-buffer [ruletype [nonstateful| stateful]]| [rulesource [internal|
user]]| rule-name correlation-rule1 ... correlation-rule14| correlationID correlation-id1 .. correlation-id14}
Syntax Description all-in-buffer ruletype
Displays all messages in the correlation buffer.
(Optional) Displays the ruletype filter.
nonstateful stateful
(Optional) Displays the nonstateful rules.
(Optional) Displays the stateful rules.
(Optional) Displays the rulesource filter.
rulesource internal (Optional) Displays the internally defined rules from the rulesource filter.
(Optional) Displays the user-defined rules from the rulesource filter.
user rule-name
correlation-rule1...correlation-rule14
Displays a messages associated with a correlation rule name. Up to
14 correlation rules can be specified, separated by a space.
correlationID
correlation-id1..correlation-id14
Displays a message identified by correlation ID. Up to 14 correlation
IDs can be specified, separated by a space. Range is 0 to 4294967294.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.2
Modification
This command was introduced.
This command was introduced.
The output was modified to include message category information.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
51 OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator buffer
Release
Release 3.6.0
Usage Guidelines This command displays messages from the logging correlator buffer that match the correlation ID or correlation rule name specified. When the all-in-buffer keyword is entered, all messages in the logging correlator buffer are displayed.
If the ruletype is not specified, then both stateful and nonstateful rules are displayed.
if the rulesource is not specified, then both user and internal rules are displayed.
Task ID
Task ID logging
Operations read
Examples
Release 3.7.2
Release 5.0.0
Modification
The following keywords were added:
• internal
• nonstateful
• rulesource
• ruletype
• stateful
• user
Range changed from 32 to 14 for correlationID and rule-name keywords.
This command was introduced.
This command was introduced.
This is the sample output from the show logging correlator buffer command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator buffer all-in-buffer
#C_id.id:Rule Name:Source :Context: Time : Text
#14.1 :Rule1:RP/0/5/CPU0: :Aug 22 13:39:13.693 2007:ifmgr[196]: %PKT_INFRA-LINK-3-UPDOWN :
Interface MgmtEth0/5/CPU0/0, changed state to Down
#14.2 :Rule1:RP/0/5/CPU0: :Aug 22 13:39:13.693 2007:ifmgr[196]: %PKT_INFRA-LINEPROTO-3-UPDOWN
: Line protocol on Interface MgmtEth0/5/CPU0/0, changed state to Down
This table describes the significant fields shown in the display.
52
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator buffer
Table 3: show logging correlator buffer Field Descriptions
Field
C_id.
id
Rule Name
Source
Time
Text
Description
Correlation ID assigned to a event that matches a logging correlation rule.
An ID number assigned to each event matching a particular correlation rule. This event number serves as index to identify each individual event that has been matched for a logging correlation rule.
Name of the logging correlation rule that filters messages defined in a logging correlation rule to the logging correlator buffer.
Node from which the event is generated.
Date and time at which the event occurred.
Message string that delineates the event.
Related Commands
Command
show logging correlator info, on page 54
show logging correlator rule, on page 56
Description
Displays the logging correlator buffer size and the percentage of the buffer occupied by correlated messages.
Displays one or more predefined logging correlator rules.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
53
Alarm Management and Logging Correlation Commands show logging correlator info
show logging correlator info
To display the logging correlator buffer size and the percentage of the buffer occupied by correlated messages, use the show correlator info command in EXEC modeXR EXEC mode.
show logging correlator info
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
The output was modified to include message category information.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command displays the size of the logging correlator buffer and the percentage of the buffer allocated to correlated messages.
Use the
logging correlator buffer-size, on page 23
command to set the size of the buffer.
Task ID
Task ID logging
Operations read
Examples In this example, the show logging correlator info command is used to display remaining buffer size and percentage allocated to correlated messages:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator info
Buffer-Size
81920
Percentage-Occupied
0.00
54
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator info
Related Commands
Command
logging correlator buffer-size, on page 23
show logging correlator buffer, on page 51
show logging correlator rule, on page 56
Description
Specifies the logging correlator buffer size.
Displays messages in the logging correlator buffer.
Displays one or more predefined logging correlator rules.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
55
Alarm Management and Logging Correlation Commands show logging correlator rule
show logging correlator rule
To display defined correlation rules, use the show logging correlator rule command in EXEC modeXR
EXEC mode.
show logging correlator rule {all| correlation-rule1...correlation-rule14} [context context1...context 6]
[location node-id1...node-id6] [rulesource {internal| user}] [ruletype {nonstateful| stateful}] [summary|
detail]
Syntax Description all Displays all rule sets.
correlation-rule1...correlation-rule14 Rule set name to be displayed. Up to 14 predefined correlation rules can be specified, separated by a space.
context context1...context 6
location node-id1...node-id6 rulesource
(Optional) Displays a list of context rules.
(Optional) Displays the location of the list of rules filter from the designated node. The node-id argument is entered in the
rack/slot/module notation.
(Optional) Displays the rulesource filter.
internal user ruletype
(Optional) Displays the internally defined rules from the rulesource filter.
(Optional) Displays the user defined rules from the rulesource filter.
(Optional) Displays the ruletype filter.
(Optional) Displays the nonstateful rules.
nonstateful stateful summary detail
(Optional) Displays the stateful rules.
(Optional) Displays the summary information.
(Optional) Displays detailed information.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Modification
This command was introduced.
56
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator rule
Release
Release 3.2
Release 3.2
Release 3.6.0
Modification
The output was modified to include message category information.
This command was introduced.
The following keyword and argument pairs were added:
• context context
• detail
• location node-id
• rulesource { internal | user }
• ruletype { nonstateful | stateful }
• summary
This command was introduced.
This command was introduced.
Usage Guidelines If the ruletype is not specified, then both stateful and nonstateful rules are displayed as the default.
If the rulesource is not specified, then both user and internally defined rules are displayed as the default.
If the summary or detail keywords are not specified, then detailed information is displayed as the default.
Task ID
Task ID logging
Operations read
Examples
Release 3.7.2
Release 5.0.0
This is sample output from the show logging correlator rule command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator rule test
Rule Name : test
Type : Non Stateful
Source : User
Timeout : 30000 Rule State: RULE_APPLIED_ALL
Rootcause Timeout : None
Context Correlation : disabled
Reissue Non Bistate : N/A
Reparent : N/A
Alarms :
Code Type: Category Group Message
Root: MGBL CONFIG DB_COMMIT
Leaf: L2 SONET ALARM
Apply Locations: None
Apply Contexts: None
Number of buffered alarms : 0
This table describes the significant fields shown in the display.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
57
Alarm Management and Logging Correlation Commands show logging correlator rule
Table 4: show logging correlator rule Field Descriptions
Field
Rule Name
Time out
Rule State
Code Type
Root
Leaf
Apply Locations
Apply Contexts
Description
Name of defined correlation rule.
Configured timeout for the correlation rule.
Indicates whether or not the rule has been applied. If the rule applies to the entire router, this field will display “RULE_APPLIED_ALL.”
Message category, group, and code.
Message category, group and code of the root message configured in the logging correlation rule.
Message category, group and code of a non-root-cause message configured in the logging correlation rule.
Node or nodes where the rule is applied. If the logging correlation rule applies to the entire router, this field will display “None.”
Context or contexts to which the rule is applied. If the logging correlation rule is not configured to apply to a context, this field will display “None.”
Related Commands
Command
logging correlator apply rule, on page 17
logging correlator rule, on page 25
show logging correlator buffer, on page 51
show logging correlator info, on page 54
Description
Applies and activates correlation rules.
Defines the rules for correlating messages.
Displays messages in the logging correlator buffer.
Displays the logging correlator buffer size and the percentage of the buffer occupied by correlated messages.
58
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator ruleset
show logging correlator ruleset
To display defined correlation rule set names, use the show logging correlator ruleset command in EXEC modeXR EXEC mode.
show logging correlator ruleset {all| correlation-ruleset1 ... correlation-ruleset14} [detail| summary]
Syntax Description all summary
Displays all rule set names.
correlation-rule1...correlation-rule14 Rule set name to be displayed. Up to 14 predefined rule set names can be specified, separated by a space.
detail (Optional) Displays detailed information.
(Optional) Displays the summary information.
Command Default Detail is the default, if nothing is specified.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines If the ruletype is not specified, then both stateful and nonstateful rules are displayed as the default.
If the rulesource is not specified, then both user and internally defined rules are displayed as the default.
If the summary or detail options are not specified, then detailed information is displayed as the default.
Task ID
Task ID logging
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
59 OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator ruleset
Examples This is the sample output from the show logging correlator ruleset command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator RuleSetOne RuleSetTwo
Rule Set Name : RuleSetOne
Rules: Rule1 : Applied
Rule2 : Applied
Rule3 : Applied
Rule Set Name : RuleSetTwo
Rules: Rule1 : Applied
Rule5 : Not Applied
This is the sample output from the show logging correlator ruleset command when the all option is specified:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator ruleset all
Rule Set Name : RuleSetOne
Rules: Rule1 : Applied
Rule2 : Applied
Rule3 : Applied
Rule Set Name : RuleSetTwo
Rules: Rule1 : Applied
Rule5 : Not Applied
Rule Set Name : RuleSetThree
Rules: Rule2 : Applied
Rule3 : Applied
This is sample output from the show logging correlator ruleset command when the all and summary options are specified:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging correlator ruleset all summary
RuleSetOne
RuleSetTwo
RuleSetThree
This table describes the significant fields shown in the display.
Table 5: show logging correlator ruleset Field Descriptions
Field
Rule Set Name
Rules
Applied
Not Applied
Description
Name of the ruleset.
All rules contained in the ruleset are listed.
The rule is applied.
The rule is not applied.
Related Commands
Command
logging correlator apply rule, on page 17
logging correlator rule, on page 25
show logging correlator buffer, on page 51
Description
Applies and activates correlation rules.
Defines the rules for correlating messages.
Displays messages in the logging correlator buffer.
60
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging correlator ruleset
Command
show logging correlator info, on page 54
show logging correlator rule, on page 56
Description
Displays the logging correlator buffer size and the percentage of the buffer occupied by correlated messages.
Displays defined correlation rules.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
61
Alarm Management and Logging Correlation Commands show logging events buffer
show logging events buffer
To display messages in the logging events buffer, use the show logging events buffer command in EXEC modeXR EXEC mode.
show logging events buffer [admin-level-only] [all-in-buffer] [bistate-alarms-set] [category name]
[context name] [event-hi-limit event-id] [event-lo-limit event-id] [first event-count] [group message-group]
[last event-count] [location node-id] [message message-code] [severity-hi-limit severity] [severity-lo-limit
severity] [timestamp-hi-limit hh:mm:ss [month] [day] [year] timestamp-lo-limit hh:mm:ss [month] [day]
[year]]
Syntax Description admin-level-only all-in-buffer bistate-alarms-set
category name
context name
event-hi-limit event-id
event-lo-limit event-id
first event-count
group message-group
last event-count
location node-id
message message-code severity-hi-limit
Displays only the events that are at the adminstrative level.
Displays all event IDs in the events buffer.
Displays bi-state alarms in the SET state.
Displays events from a specified category.
Displays events from a specified context.
Displays events with an event ID equal to or lower than the event ID specified with the event-id argument. Range is 0 to 4294967294.
Displays events with an event ID equal to or higher than the event ID specified with event-id argument. Range is 0 to 4294967294.
Displays events in the logging events buffer, beginning with the first event.
For the event-count argument, enter the number of events to be displayed.
Displays events from a specified message group.
Displays events, beginning with the last event in the logging events buffer.
For the event-count argument, enter the number of events to be displayed.
Displays events for the specified location. The node-id argument is entered in the rack/slot/module notation.
Displays events with the specified message code.
Displays events with a severity level equal to or lower than the specified severity level.
62
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging events buffer severity severity-lo-limit timestamp-hi-limit
Severity level. Valid values are:
• emergencies
• alerts
• critical
• errors
• warnings
• notifications
• informational
Note Settings for the severity levels and their respective system conditions are listed under the “Usage Guidelines” section for the logging events
level command. Events of lower severity level represent events of higher importance.
Displays events with a severity level equal to or higher than the specified severity level.
Displays events with a time stamp equal to or lower than the specified time stamp.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
63
Alarm Management and Logging Correlation Commands show logging events buffer
hh : mm : ss [month] [day]
[year]
Time stamp for the timestamp-hi-limit or timestamp-lo-limit keyword. The
month, day, and year arguments default to the current month, day, and year if not specified.
Ranges for the hh : mm : ss month day year arguments are as follows:
• hh :—Hours. Range is 00 to 23. You must insert a colon after the hh argument.
• mm :—Minutes. Range is 00 to 59. You must insert a colon after the mm argument.
• ss—Seconds. Range is 00 to 59.
• month—(Optional) The month of the year. The values for the month argument are:
◦january
◦february
◦march
◦april
◦may
◦june
◦july
◦august
◦september
◦october
◦november
◦december
• day—(Optional) Day of the month. Range is 01 to 31.
• year—(Optional) Year. Enter the last two digits of the year (for example,
04 for 2004). Range is 01 to 37.
timestamp-lo-limit Displays events with a time stamp equal to or higher than the specified time stamp.
Command Default None
Command Modes EXEC modeXR EXEC mode
64
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging events buffer
Command History
Release
Release 2.0
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Usage Guidelines This command displays messages from the logging events buffer matching the description. The description is matched when all of the conditions are met.
Task ID
Task ID logging
Operations read
Examples
Modification
This command was introduced.
This command was introduced.
The output was modified to include message category information.
The admin-level-only optional keyword was introduced.
This command was introduced.
This command was introduced.
This is the sample output from the show logging events buffer all-in-buffer command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging events buffer all-in-buffer
#ID :C_id:Source :Time :%CATEGORY-GROUP-SEVERITY-MESSAGECODE: Text
#1 : :RP/0/RSP0RP00/CPU0:Jan 9 08:57:54 2004:nvram[66]: %MEDIA-NVRAM_PLATFORM-3-BAD_N
VRAM_VAR : ROMMON variable-value pair: '^['[19~CONFIG_FILE = disk0:config/startup, contains illegal (non-printable)characters
#2
: Card
: :RP/0/RSP0RP00/CPU0:Jan 9 08:58:21 2004:psarb[238]: %PLATFORM-PSARB-5-GO_BID is going to bid state.
#3 : :RP/0/RSP0RP00/CPU0:Jan 9 08:58:22 2004:psarb[238]: %PLATFORM-PSARB-5-GO_ACTIVE
: Card is becoming active.
#4 : :RP/0/RSP0RP00/CPU0:Jan 9 08:58:22 2004:psarb[238]:
%PLATFORM-PSARB-6-RESET_ALL_LC_
CARDS : RP going active; resetting all linecards in chassis
#5 : :RP/0/RSP0RP00/CPU0:Jan 9 08:58:22 2004:redcon[245]: %HA-REDCON-6-GO_ACTIVE : this card going active
#6 : :RP/0/RSP0RP00/CPU0:Jan 9 08:58:22 2004:redcon[245]:
%HA-REDCON-6-FAILOVER_ENABLED : Failover has been enabled by config
This table describes the significant fields shown in the display.
Table 6: show logging correlator buffer Field Descriptions
Field
#ID
Description
Integer assigned to each event in the logging events buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
65
Alarm Management and Logging Correlation Commands show logging events buffer
Field
C_id.
Description
Correlation ID assigned to a event that has matched a logging correlation rule.
Node from which the event is generated.
Source
Time
Text
Date and time at which the event occurred.
%CATEGORY-GROUP-SEVERITY-MESSAGECODE The category, group name, severity level, and message code associated with the event.
Message string that delineates the event.
Related Commands
Command
show logging events info, on page 67
Description
Displays configuration and operational messages about the logging events buffer.
66
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging events info
show logging events info
To display configuration and operational information about the logging events buffer, use the show logging
events info command in EXEC modeXR EXEC mode.
show logging events info
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This command displays information about the size of the logging events buffer, the maximum size of the buffer, the number of records being stored, the maximum allowable number of records threshold for circular filing, and message filtering.
Task ID
Task ID logging
Operations read
Examples This is the sample output from the show logging events info command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging events info
Size (Current/Max)
16960 /42400
#Records
37
Thresh
90
Filter
Not Set
This table describes the significant fields shown in the display.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
67 OL-26517-02
Alarm Management and Logging Correlation Commands show logging events info
Table 7: show logging events info Field Descriptions
Field
Size (Current/Max)
#Records
Thresh
Filter
Description
The current and maximum size of the logging events buffer. The maximum size of the buffer is controlled by the
logging events buffer-size, on page 30
command.
The number of event records stored in the logging events buffer.
The configured logging events threshold value. This field is controlled by the
on page 37 command.
The lowest severity level for events that will be displayed. This field is controlled by the
logging events level, on page 35
command.
Related Commands
Command
logging events buffer-size, on page 30
logging events level, on page 35
logging events threshold, on page 37
show logging events buffer, on page 62
Description
Specifies the logging correlator buffer size.
Specifies a severity level for logging alarm messages.
Specifies the logging events buffer capacity threshold that, when surpassed, will generate an alarm.
Displays information about messages in the logging events buffer according to type, time, or severity level.
68
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show logging suppress rule
show logging suppress rule
To display defined logging suppression rules, use the show logging suppression rule command in EXEC modeXR EXEC mode.
show logging suppress rule [rule-name1 [... [ rule-name14 ]]| all [detail] [summary] [source location
node-id]]
Syntax Description
rule-name1 [...[rule-name14]] all
source location node-id detail summary
Specifies up to 14 logging suppression rules to display.
Displays all logging suppression rules.
(Optional) Displays the location of the list of rules filter from the designated node. The node-id argument is entered in the rack/slot/module notation.
(Optional) Displays detailed information.
(Optional) Displays the summary information.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
69 OL-26517-02
Alarm Management and Logging Correlation Commands show logging suppress rule
Examples This example displays information about a logging suppression rule that has been configured but has not been activated:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging suppression rule test_suppression
Rule Name : test_suppression
Rule State: RULE_UNAPPLIED
Severities : informational, critical
Alarms :
Category
CAT_C
CAT_D
Group
GROUP_C
GROUP_D
Message
CODE_C
CODE_D
Apply Alarm-Locations: PLIM-0/2, PowerSupply-0/A/A0
Apply Sources: 0/RP0/CPU0, 1/6/SP
Number of suppressed alarms : 0
This example displays information about all logging suppression rules applied to a specific source location on the router:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging suppress rule all source location 0/RP0/CPU0
Rule Name : test_suppression
Rule State: RULE_APPLIED_ALL
Severities : N/A
Alarms :
Category
CAT_E
Group
GROUP_F
Apply Alarm-Locations: None
Apply Sources: 0/RP0/CPU0
Message
CODE_G
Number of suppressed alarms : 0
This example shows summary information about all logging suppression rules:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging suppression rule all summmary
Rule Name :Number of Suppressed Alarms
Mike1
Mike2
0
0
Mike3
Real1
0
4
Related Commands
Command
logging suppress apply rule, on page 39
logging suppress rule, on page 41
Description
Applies and activates a logging suppression rule.
Creates a logging suppression rule.
70
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show snmp correlator buffer
show snmp correlator buffer
To display messages in SNMP correlator buffer, use the show snmp correlator buffer in EXEC modeXR
EXEC mode.
show snmp correlator buffer [all| correlation ID | rule-name name]
Syntax Description all
correlation id
rule-name name
Displays all messages in the correlator buffer.
Displays a message identified by correlation ID. Range is 0 to 4294967294. Up to 14 correlation rules can be specified, separated by a space.
Displays a messages associated with a SNMP correlation rule name. Up to
14 correlation rules can be specified, separated by a space.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.8.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID snmp
Operation read
Examples The sample shows an output from the show snmp correlator buffer command:
RP/0/0RP0RSP0/CPU0:router:hostname# show snmp correlator buffer correlationID 10
Correlation ID : 10
Rule : ospf-trap-rule
Rootcause: 1.3.6.1.6.3.1.1.5.3
Time : Dec 14 02:32:05
Varbind(s): ifIndex.17 = 17 ifDescr.17 = POS0/7/0/0hundredGigE0/1/0/8
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
71 OL-26517-02
show snmp correlator buffer ifType.17 = other(1) cieIfStateChangeReason.17 = down
Nonroot : 1.3.6.1.2.1.14.16.2.2
Time: Dec 14 02:32:04
Varbind(s): ospfRouterId = 1.1.1.1
ospfNbrIpAddr = 30.0.28.2
ospfNbrAddressLessIndex = 0 ospfNbrRtrId = 3.3.3.3
ospfNbrState = down(1)
Alarm Management and Logging Correlation Commands
72
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show snmp correlator info
show snmp correlator info
To display the SNMP correlator buffer size and the percentage of the buffer occupied by correlated messages, use the show snmp correlator info command in EXEC modeXR EXEC mode.
show snmp correlator info
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.8.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID snmp
Operation read
Examples The sample shows an output that contains remaining buffer size and percentage allocated to correlated messages from the show snmp correlator info command:
RP/0/0RP0RSP0/CPU0:router:hostname# show snmp correlator info
Buffer-Size
85720
Percentage-Occupied
0.00
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
73
Alarm Management and Logging Correlation Commands show snmp correlator rule
show snmp correlator rule
To display defined SNMP correlation rules, use the show snmp correlator rule command in EXEC modeXR
EXEC mode.
show snmp correlator rule [all| rule-name]
Syntax Description all rule-name
Displays all rule sets.
Specifies the name of a rule. Up to 14 predefined SNMP correlation rules can be specified, separated by a space.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.8.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID snmp
Operation read
Examples This sample shows an output from the show snmp correlator rule command:
RP/0/0RP0RSP0/CPU0:router:hostname# show snmp correlator rule rule_1
Rule Name : rule_1
Time out : 888 Rule State: RULE_APPLIED_ALL
Root: OID : 1.3.6.1.2.1.11.0.2
vbind : 1.3.6.1.2.1.2.2.1.2 value /3\.3\.\d{1,3}\.\d{1,3}/ vbind : 1.3.6.1.2.1.5.8.3
index val
Nonroot: OID : 1.3.6.1.2.1.11.3.3
74
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands show snmp correlator ruleset
show snmp correlator ruleset
To display defined SNMP correlation rule set names, use the show snmp correlator ruleset command in
EXEC modeXR EXEC mode.
show snmp correlator ruleset [all| ruleset-name]
Syntax Description all ruleset-name
Displays all rule set names.
Specifies the name of a rule set. Up to 14 predefined rule set names can be specified, separated by a space.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.8.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID snmp
Operation read
Examples This sample shows an output from the show snmp correlator ruleset command:
RP/0/0RP0RSP0/CPU0:router:hostname# show snmp correlator ruleset test
Rule Set Name : test
Rules: chris1 chris2
: Not Applied
: Applied
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
75 OL-26517-02
Alarm Management and Logging Correlation Commands source
source
To apply a logging suppression rule to alarms originating from a specific node on the router, use the source command in logging suppression apply rule configuration mode.
source location node-id
no source location node-id
Syntax Description
location node-id Specifies a node. The node-id argument is entered in the rack/slot/module notation.
Command Default No scope is configured by default.
Command Modes Logging suppression apply rule configuration
Command History
Release
Release 3.8.0
Release 3.8.0
Release 3.9.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID logging
Operations execute
Examples This example shows how to configure the logging suppression rule infobistate to suppress alarms from
0/RP0/CPU0:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress apply rule infobistate
RP/0/0RP0RSP0/CPU0:router:hostname(config-suppr-apply-rule)# source location 0/RP0/CPU0
76
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands source
Related Commands
Command
logging suppress apply rule, on page 39
Description
Applies and activates a logging suppression rule.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
77
Alarm Management and Logging Correlation Commands timeout
timeout
To specify the collection period duration time for the logging correlator rule message, use the timeout command in stateful or nonstateful correlation rule configuration modes. To remove the timeout period, use the no form of this command.
timeout [ milliseconds ] no timeout
Syntax Description milliseconds Range is 1 to 600000 milliseconds.
Command Default Timeout period is not specified.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Each correlation rule that is applied must have a timeout value, and only those messages captured within this timeout period can be correlated together.
The timeout begins when the first matching message for a correlation rule is received. If the root-cause message is received, it is immediately sent to syslog, while any non-root-cause messages are held.
When the timeout expires and the rootcause message has not been received, then all the non-root-cause messages captured during the timeout period are reported to syslog. If the root-cause message was received during the timeout period, then a correlation is created and placed in the correlation buffer.
Note The root-cause alarm does not have to appear first. It can appear at any time within the correlation time period.
78
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands timeout
Task ID
Task ID logging
Operations read, write
Examples This example shows how to define a logging correlation rule with a timeout period of 60,000 milliseconds
(one minute):
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# timeout 60000
Related Commands
Command
logging correlator rule, on page 25
Description
Defines the rules by which the correlator logs messages to the logging events buffer.
Specifies an optional parameter for an applied correlation rule.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
79
Alarm Management and Logging Correlation Commands timeout-rootcause
timeout-rootcause
To specify an optional parameter for an applied correlation rule, use the timeout-rootcause command in stateful or nonstateful correlation rule configuration modes. To remove the timeout period, use the no form of this command.
timeout-rootcause [ milliseconds ] no timeout-rootcause
Syntax Description milliseconds Range is 1 to 600000 milliseconds.
Range is 1 to 7200000 milliseconds.
Command Default Root-cause alarm timeout period is not specified.
Command Modes Stateful correlation rule configuration
Nonstateful correlation rule configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When a root-cause timeout is configured and a non-root-cause message is received first, the following occurs:
• When a root-cause timeout is configured and a non-root-cause message is received first, the following occurs:
When the root-cause message arrives before the root-cause timeout expires, then the correlation continues as normal using the remainder of the main rule timeout.
• When the root-cause message is not received before the root-cause timeout expires, then all the non-root-cause messages held during the root-cause timeout period are sent to syslog and the correlation is terminated.
80
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Alarm Management and Logging Correlation Commands timeout-rootcause
Task ID
Task ID logging
Operations read, write
Examples This example shows how to configure a timeout period for a root cause alarm:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging correlator rule state_rule type stateful
RP/0/0RP0RSP0/CPU0:router:hostname(config-corr-rule-st)# timeout-rootcause 50000
Related Commands
Command
logging correlator rule, on page 25
Description
Defines the rules by which the correlator logs messages to the logging events buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
81
timeout-rootcause
Alarm Management and Logging Correlation Commands
82
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Embedded Event Manager Commands
This module describes the commands that are used to set the Embedded Event Manager (EEM) operational attributes and monitor EEM operations.
The Cisco IOS XR software EEM functions as the central clearing house for the events detected by any portion of Cisco IOS XR software High Availability Services. The EEM is responsible for fault detection, fault recovery, and process the reliability statistics in a system. The EEM is policy driven and enables you to configure the high-availability monitoring features of the system to fit your needs.
The EEM monitors the reliability rates achieved by each process in the system. You can use these metrics during testing to identify the components that do not meet their reliability or availability goals, which in turn enables you to take corrective action.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
For detailed information about the EEM concepts, configuration tasks, and examples, see the Configuring
and Managing Embedded Event Manager Policies module in Cisco IOS XR System Monitoring Configuration
Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration Guide for the
Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration
GuideSystem Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
event manager directory user, page 85
•
event manager environment, page 87
•
•
event manager refresh-time, page 93
•
•
event manager scheduler suspend, page 97
•
show event manager directory user, page 99
•
show event manager environment, page 101
•
show event manager metric hardware , page 103
•
show event manager metric process, page 105
•
show event manager policy available, page 109
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
83
•
show event manager policy registered, page 111
•
show event manager refresh-time, page 115
•
show event manager statistics-table, page 117
•
show event manager scheduler thread, page 120
Embedded Event Manager Commands
84
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager directory user
event manager directory user
To specify a directory name for storing user library files or user-defined Embedded Event Manager (EEM) policies, use the event manager directory user command in Global Configuration modeXR Config mode.
To disable the use of a directory for storing user library files or user-defined EEM policies, use the no form of this command.
event manager directory user {library path| policy path}
no event manager directory user {library path| policy path}
Syntax Description library path policy
Specifies a directory name for storing user library files.
Absolute pathname to the user directory on the flash device.
Specifies a directory name for storing user-defined EEM policies.
Command Default No directory name is specified for storing user library files or user-defined EEM policies.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The fault manager userlibdirectory and fault manager userpolicydirectory commands were replaced with the event
manager directory user command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Cisco IOS XR software supports only the policy files that are created by using the Tool Command Language
(TCL) scripting language. The TCL software is provided in the Cisco IOS XR software image when the EEM is installed on the network device. Files with the .tcl extension can be EEM policies, TCL library files, or a special TCL library index file named tclindex. The tclindex file contains a list of user function names and
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
85 OL-26517-02
Embedded Event Manager Commands event manager directory user
Task ID library files that contain the user functions (procedures). The EEM searches the user library directory when the TCL starts to process the tclindex file.
User Library
A user library directory is needed to store user library files associated with authoring EEM policies. If you do not plan to write EEM policies, you do not have to create a user library directory.
To create user library directory before identifying it to the EEM, use the mkdir command in EXEC modeXR
EXEC mode. After creating the user library directory, use the copy command to copy the .tcl library files into the user library directory.
User Policy
A user policy directory is essential to store the user-defined policy files. If you do not plan to write EEM policies, you do not have to create a user policy directory. The EEM searches the user policy directory when you enter the event manager policy policy-name user command.
To create a user policy directory before identifying it to the EEM, use the mkdir command in EXEC modeXR
EXEC mode. After creating the user policy directory, use the copy command to copy the policy files into the user policy directory.
Task ID eem
Operations read, write
Examples This example shows how to set the pathname for a user library directory to /usr/lib/tcl on disk0:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager directory user library disk0:/usr/lib/tcl
This example shows how to set the location of the EEM user policy directory to /usr/fm_policies on disk0:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager directory user policy disk0:/usr/fm_policies
Related Commands
Command
event manager policy, on page 89
show event manager directory user, on page 99
Description
Registers an EEM policy with the EEM.
Displays the directory name for storing user library and policy files.
86
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager environment
event manager environment
To set an Embedded Event Manager (EEM) environment variable, use the event manager environment command in Global Configuration modeXR Config mode. To remove the configuration, use the no form of this command.
event manager environment var-name [ var-value ]
no event manager environment var-name
Syntax Description var-name var-value
Name assigned to the EEM environment configuration variable.
(Optional) Series of characters, including embedded spaces, to be placed in the environment variable var-name.
Command Default None
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The fault manager environment command was replaced with the
event manager environment command.
The var-value argument was changed from required to optional.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Environment variables are available to EEM policies when you set the variables using the event manager
environment command. They become unavailable when you remove them with the no form of this command.
By convention, the names of all the environment variables defined by Cisco begin with an underscore character
(_) to set them apart, for example, _show_cmd.
Spaces can be used in the var-value argument. This command interprets everything after the var-name argument uptil the end of the line in order to be a part of the var-value argument.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
87 OL-26517-02
Embedded Event Manager Commands event manager environment
Task ID
Use the
show event manager environment, on page 101
command to display the name and value of all EEM environment variables before and after they have been set using the event manager environment command.
Task ID eem
Operations read, write
Examples This example shows how to define a set of EEM environment variables:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _show_cmd show eem manager policy registered
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _email_server [email protected]
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _email_from [email protected]
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _email_to [email protected]
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager environment _email_cc
Related Commands
Command
show event manager environment, on page 101
Description
Displays the name and value for all the EEM environment variables.
88
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager policy
event manager policy
To register an Embedded Event Manager (EEM) policy with the EEM, use the event manager policy command in Global Configuration modeXR Config mode. To unregister an EEM policy from the EEM, use the no form of this command.
event manager policy policy-name username username [persist-time [seconds| infinite]| type {system|
user}]
no event manager policy policy-name [username username]
event manager policy <name of policy file> username <val> [persist-time <val>{system| user}[checksum|
{md5| sha-1}| <checksum_val>]][secure-mode| {trust| cisco rsa-2048}]
Syntax Description policy-name
username username
persist-time [seconds |
infinite] type system user
checksum{md5sha-1}
secure-mode{trustcisco
rsa-2048}
Name of the policy file.
Specifies the username used to run the script. This name can be different from that of the user who is currently logged in, but the registering user must have permissions that are a superset of the username that runs the script. Otherwise, the script is not registered, and the command is rejected.
In addition, the username that runs the script must have access privileges to the commands issued by the EEM policy being registered.
(Optional) The length of the username authentication validity, in seconds. The default time is 3600 seconds (1 hour). The seconds range is 0 to 4294967294.
Enter 0 to stop the username authentication from being cached. Enter the
infinite keyword to stop the username from being marked as invalid.
(Optional) Specifies the type of policy.
(Optional) Registers a system policy defined by Cisco.
(Optional) Registers a user-defined policy.
Specifies a script that is verified against checksum policies.
Specifies a script that is verified against Cisco signing server in secure mode.
Command Default The default persist time is 3600 seconds (1 hour).
Command Modes Global Configuration modeXR Config mode
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
89 OL-26517-02
Embedded Event Manager Commands event manager policy
Command History
Release
Release 2.0
Release 3.2
Release 3.3.0
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Release 5.2.0
Modification
This command was introduced.
This command was introduced.
Support was added for the required keyword and argument username
username .
Support was added for the optional keyword and argument persist-time
[ seconds | infinite ].
The fault manager policy command was replaced with the event
manager policy command.
The type keyword was added.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Support added for verifying scripts against digital signatures, checksum, third party scripts and Cisco signing server.
Usage Guidelines The EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When the event manager policy command is invoked, the EEM examines the policy and registers it to be run when the specified event occurs. An EEM script is available to be scheduled by the EEM until the
no form of this command is entered.
Note AAA authorization (such as the aaa authorization command with the eventmanager and default keywords) must be configured before the EEM policies can be registered. The eventmanager and default keywords must be configured for policy registration. See the Configuring AAA Services on the
Cisco IOS XR Softwarethe Cisco ASR 9000 Series Routermodule of Cisco IOS XR System Security
Configuration Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Security Configuration
Guide for the Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System Security
Configuration GuideSystem Security Configuration Guide for Cisco NCS 6000 Series Routers for more information on AAA authorization configuration.
Username
Enter the username that should execute the script with the username username keyword and argument. This name can be different from the user who is currently logged in, but the registering user must have permissions that are a superset of the username that runs the script. Otherwise, the script will not be registered, and the command will be rejected. In addition, the username that runs the script must have access privileges to the commands issued by the EEM policy being registered.
90
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager policy
Persist-time
When a script is first registered, the configured username for the script is authenticated. If authentication fails, or if the AAA server is down, the script registration fails.
After the script is registered, the username is authenticated each time a script is run.
If the AAA server is down, the username authentication can be read from memory. The persist-time determines the number of seconds this username authentication is held in memory.
• If the AAA server is down and the persist-time has not expired, the username is authenticated from memory, and the script runs.
• If the AAA server is down, and the persist-time has expired, user authentication fails, and the script does not run.
Task ID
Note EEM attempts to contact the AAA server and refresh the username reauthenticate whenever the configured
refresh-time expires. See the
event manager refresh-time, on page 93
command for more information.
These values can be used for the persist-time:
• The default persist-time is 3600 seconds (1 hour). Enter the event manager policy command without the persist-time keyword to set the persist-time to 1 hour.
• Enter zero to stop the username authentication from being cached. If the AAA server is down, the username is not authenticated and the script does 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 is authenticated from the cache.
Type
If you enter the event manager policy command without specifying the type keyword, the EEM first tries to locate the specified policy file in the system policy directory. If the EEM finds the file in the system policy directory, it registers the policy as a system policy. If the EEM does not find the specified policy file in the system policy directory, it looks in the user policy directory. If the EEM locates the specified file in the user policy directory, it registers the policy file as a user policy. If the EEM finds policy files with the same name in both the system policy directory and the user policy directory, the policy file in the system policy directory takes precedence, and the policy file is registered as a system policy.
Task ID eem
Operations read, write
Examples This example shows how to register a user-defined policy named cron.tcl located in the user policy directory:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager policy cron.tcl username joe
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
91
Embedded Event Manager Commands event manager policy
Related Commands
Command
event manager environment, on page 87
event manager refresh-time, on page 93
Description
Specifies a directory for storing user library files.
Specifies the time between the system attempts to contact the AAA server and refresh the username reauthentication.
show event manager environment, on page 101
Displays the name and value for all EEM environment variables.
show event manager policy available, on page 109
Displays EEM policies that are available to be registered.
show event manager policy registered, on page 111
Displays the EEM policies that are already registered.
92
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager refresh-time
event manager refresh-time
To define the time between user authentication refreshes in Embedded Event Manager (EEM), use the event
manager refresh-time command in Global Configuration modeXR Config mode. To restore the system to its default condition, use the no form of this command.
event manager refresh-time seconds
no event manager refresh-time seconds
Syntax Description seconds Number of seconds between user authentication refreshes, in seconds. Range is 10 to 4294967295.
Command Default The default refresh time is 1800 seconds (30 minutes).
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The fault manager refresh-time command was replaced with the
event manager refresh-time command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines EEM attempts to contact the AAA server and refresh the username reauthentication whenever the configured
refresh-time expires.
Task ID
Task ID eem
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
93 OL-26517-02
Embedded Event Manager Commands event manager refresh-time
Examples This example shows how to set the refresh time:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager refresh-time 1900
94
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager run
event manager run
To manually run an Embedded Event Manager (EEM) policy, use the event manager run command in EXEC modeXR EXEC mode.
event manager run policy [argument [... [ argument15 ]]]
Syntax Description policy
[argument[...[argument15]]]
Name of the policy file.
Argument that you want to pass to the policy. The maximum number of arguments is 15.
Command Default No registered EEM policies are run.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines EEM usually schedules and runs policies on the basis of an event specification that is contained within the policy itself. The event manager run command allows policies to be run manually.
You can query the arguments in the policy file by using the TCL command event_reqinfo , as shown in this example: array set arr_einfo [event_reqinfo] set argc $arr_einfo(argc) set arg1
$arr_einfo(arg1)
Use the
event manager policy, on page 89
command to register the policy before using the event manager
run command to run the policy. The policy can be registered with none as the event type.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
95 OL-26517-02
Embedded Event Manager Commands event manager run
Task ID
Task ID eem
Operations read
Examples This example of the event manager run command shows how to manually run an EEM policy named policy-manual.tcl:
RP/0/0RP0RSP0/CPU0:router:hostname# event manager run policy-manual.tcl parameter1 parameter2 parameter3
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.169 : user-plocy.tcl[65724]: The reqinfo of arg2 is parameter2.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.170 : user-plocy.tcl[65724]: The reqinfo of argc is 3.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.171 : user-plocy.tcl[65724]: The reqinfo of arg3 is parameter3.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.172 : user-plocy.tcl[65724]: The reqinfo of event_type_string is none.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.172 : user-plocy.tcl[65724]: The reqinfo of event_pub_sec is 1190283990.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.173 : user-plocy.tcl[65724]: The reqinfo of event_pub_time is 1190283990.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.173 : user-plocy.tcl[65724]: The reqinfo of event_id is
3.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.174 : user-plocy.tcl[65724]: The reqinfo of arg1 is parameter1.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.175 : user-plocy.tcl[65724]: The reqinfo of event_type is 16.
RP/0/RSP0RP00/CPU0:Sep 20 10:26:31.175 : user-plocy.tcl[65724]: The reqinfo of event_pub_msec is 830
Related Commands
Command
event manager policy, on page 89
Description
Registers an EEM policy with the EEM.
96
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands event manager scheduler suspend
event manager scheduler suspend
To suspend the Embedded Event Manager (EEM) policy scheduling execution immediately, use the event
manager scheduler suspend command in Global Configuration modeXR Config mode. To restore a system to its default condition, use the no form of this command.
event manager scheduler suspend no event manager scheduler suspend
Syntax Description This command has no keywords or arguments.
Command Default Policy scheduling is active by default.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The fault manager schedule-policy suspend command was replaced with the event manager scheduler suspend command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Use the event manager scheduler suspend command to suspend all the policy scheduling requests, and do not perform scheduling until you enter the no form of this command. The no form of this command resumes policy scheduling and runs pending policies, if any.
It is recommended that you suspend policy execution immediately instead of unregistering policies one by one, for the following reasons:
• Security—If you suspect that the security of your system has been compromised.
• Performance—If you want to suspend policy execution temporarily to make more CPU cycles available for other functions.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
97 OL-26517-02
Embedded Event Manager Commands event manager scheduler suspend
Task ID
Task ID eem
Operations read, write
Examples This example shows how to disable policy scheduling:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# event manager scheduler suspend
This example shows how to enable policy scheduling:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# no event manager scheduler suspend
Related Commands
Command
event manager policy, on page 89
Description
Registers an EEM policy with the EEM.
98
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager directory user
show event manager directory user
To display the current value of the EEM user library files or user-defined Embedded Event Manager (EEM) policies, use the show event manager directory user command in EXEC modeXR EXEC mode.
show event manager directory user {library| policy}
Syntax Description library policy
Specifies the user library files.
Specifies the user-defined EEM policies.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager userlibdirectory and show fault manager userpolicydirectory commands were replaced with the show event
manager directory user command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Use the show event manager directory user command to display the current value of the EEM user library or policy directory.
Task ID
Task ID eem
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
99 OL-26517-02
Embedded Event Manager Commands show event manager directory user
Examples This is a sample output of the show event manager directory user command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager directory user library disk0:/fm_user_lib_dir
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager directory user policy disk0:/fm_user_pol_dir
Related Commands
Command
event manager directory user, on page 85
Description
Specifies the name of a directory that is to be used for storing either the user library or the policy files.
100
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager environment
show event manager environment
To display the names and values of the Embedded Event Manager (EEM) environment variables, use the
show event manager environment command in EXEC modeXR EXEC mode.
show event manager environment [all| environment-name]
Syntax Description all environment-name
(Optional) Specifies all the environment variables.
(Optional) Environment variable for which data is displayed.
Command Default All environment variables are displayed.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager environment command was replaced with the show event manager environment command.
This command was introduced.
This command was introduced.
Usage Guidelines Use the show event manager environment command to display the names and values of the EEM environment variables.
Task ID
Task ID eem
Operations read
Examples This is a sample output of the show event manager environment command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager environment
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
101 OL-26517-02
Embedded Event Manager Commands show event manager environment
No.
Name
1 _email_cc
2
3
4
5
6
_email_to
_show_cmd
_cron_entry
_email_from
_email_server
Value [email protected]
show event manager policy registered
0-59/2 0-23/1 * * 0-7 [email protected]
This table describes the significant fields in the display.
Table 8: show event manager environment Field Descriptions
Field
No.
Name
Value
Description
Number of the EEM environment variable.
Name of the EEM environment variable.
Value of the EEM environment variable.
Related Commands
Command
event manager environment, on page 87
Description
Specifies a directory to use for storing user library files.
102
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager metric hardware
show event manager metric hardware
To display the Embedded Event Manager (EEM) reliability data for the processes running on a particular node, use the show event manager metric hardware command in EXEC modeXR EXEC mode.
show event manager metric hardware location {node-id| all}
Syntax Description location node-id all
Specifies the location of the node.
EEM reliability data for the specified node. The node-id argument is entered in the rack/slot/module notation.
Specifies all the nodes.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager metric hardware command was replaced with the show event manager metric environment command.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID eem
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
103 OL-26517-02
Embedded Event Manager Commands show event manager metric hardware
Examples This is a sample output of the show event manager metric hardware command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager metric hardware location
0/RSP1RP1RP00/CPU0
===================================== node: 0/RSP1RP0RP10/CPU0
Most recent online: Mon Sep 10 21:45:02 2007
Number of times online: 1
Cumulative time online: 0 days, 09:01:07
Most recent offline: n/a
Number of times offline: 0
Cumulative time offline: 0 days, 00:00:00
This table describes the significant fields shown in the display.
Table 9: show event manager metric hardware location Field Descriptions
Field node
Most recent online
Number of times online
Cumulative time online
Most recent offline
Number of times offline
Cumulative time offline
Description
Node with processes running.
The last time the node was started.
Total number of times the node was started.
Total amount of time the node was available.
The last time the process was terminated abnormally.
Total number of times the node was terminated.
Total amount of time the node was terminated.
Related Commands
Command show processes
Description
Displays information about active processes.
104
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager metric process
show event manager metric process
To display the Embedded Event Manager (EEM) reliability metric data for processes, use the show event
manager metric process command in EXEC modeXR EXEC mode.
show event manager metric process {all| job-id| process-name} location {all| node-id}
Syntax Description all job-id process-name location all node-id
Specifies all the processes.
Process associated with this job identifier. The value ranges from 0-4294967295.
Process associated with this name.
Specifies the location of the node.
Displays hardware reliability metric data for all the nodes.
Hardware reliability metric data for a specified node. Displays detailed Cisco
Express Forwarding information for the designated node. The node-id argument is entered in the rack/slot/module notation.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager metric process command was replaced with the show event manager metric process command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines The system maintains a record of when processes start and end. This data is used as the basis for reliability analysis.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
105 OL-26517-02
Embedded Event Manager Commands
Task ID show event manager metric process
Examples
Use the show event manager metric process command to obtain availability information for a process or group of processes. A process is considered available when it is running.
Task ID eem
Operations read
This is sample output from the show event manager metric process command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager metric process all location all
===================================== job id: 88, node name: 0/4/CPU0 process name: wd-critical-mon, instance: 1
-------------------------------last event type: process start recent start time: Wed Sep 19 13:31:07 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:
--------------------------
Wed Sep 19 13:31:07 2007
-------------------------most recent 10 process end times and types: cumulative process available time: 21 hours 1 minutes 31 seconds 46 milliseconds cumulative process unavailable time: 0 hours 0 minutes 0 seconds 0 milliseconds process availability: 1.000000000
number of abnormal ends within the past 60 minutes (since reload): 0 number of abnormal ends within the past 24 hours (since reload): 0 number of abnormal ends within the past 30 days (since reload): 0
===================================== job id: 54, node name: 0/4/CPU0 process name: dllmgr, instance: 1
-------------------------------last event type: process start recent start time: Wed Sep 19 13:31:07 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:
--------------------------
Wed Sep 19 13:31:07 2007
-------------------------most recent 10 process end times and types: cumulative process available time: 21 hours 1 minutes 31 seconds 41 milliseconds cumulative process unavailable time: 0 hours 0 minutes 0 seconds 0 milliseconds process availability: 1.000000000
number of abnormal ends within the past 60 minutes (since reload): 0 number of abnormal ends within the past 24 hours (since reload): 0 number of abnormal ends within the past 30 days (since reload): 0
This table describes the significant fields shown in the display.
106
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager metric process
Table 10: show event manager metric process Field Descriptions
Field job id node name process name instance comp id version
Description
Number assigned as the job identifier.
Node with the process running.
Name of the process running on the node.
Instance or thread of a multithreaded process.
Component of which the process is a member.
Specific software version or release of which the process is a member.
last event type recent end type recent start time recent normal end time recent abnormal end time recent abnormal end type
Last event type on the node.
Most recent end type.
Last time the process was started.
Last time the process was stopped normally.
Last time the process was terminated abnormally.
number of times started number of times ended normally number of times ended abnormally most recent 10 process start times cumulative process available time cumulative process unavailable time
Reason for the last abnormal process termination. For example, the process was aborted or crashed.
Number of times the process has been started.
Number of times the process has been stopped normally.
Number of times the process has stopped abnormally.
Times of the last ten process starts.
Total time the process has been available.
Total time the process has been out of service due to a restart, abort, communication problems, and so on.
process availability Uptime percentage of the process (time running—the duration of any outage).
number of abnormal ends within the past 60 minutes Number of times the process has stopped abnormally within the last 60 minutes.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
107
Embedded Event Manager Commands show event manager metric process
Field number of abnormal ends within the past 24 hours number of abnormal ends within the past 30 days
Description
Number of times the process has stopped abnormally within the last 24 hours.
Number of times the process has stopped abnormally within the last 30 days.
Related Commands
Command show processes
Description
Displays information about active processes.
108
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager policy available
show event manager policy available
To display Embedded Event Manager (EEM) policies that are available to be registered, use the show event
manager policy available command in EXEC modeXR EXEC mode.
show event manager policy available [system| user]
Syntax Description system user
(Optional) Displays all the available system policies.
(Optional) Displays all the available user policies.
Command Default If this command is invoked with no optional keywords, it displays information for all available system and user policies.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager policy available command was replaced with the show event manager policy available command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Use the show event manager policy available command to find out what policies are available to be registered just prior to using the event manager policy command to register policies.
This command is also useful if you forget the exact name of a policy that is required for the event manager
policy command.
Task ID
Task ID eem
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
109 OL-26517-02
Embedded Event Manager Commands show event manager policy available
Examples This is a sample output of the show event manager policy available command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager policy available
4
5
6
7
No.
Type
1
2
3 system system system
Time Created
Tue Jan 12 09:41:32 2004
Tue Jan 12 09:41:32 2004
Tue Jan 12 09:41:32 2004 system system system system
Tue Jan 12 09:41:32 2004
Tue Jan 12 09:41:32 2004
Tue Jan 12 09:41:32 2004
Tue Jan 12 09:41:32 2004
Name pr_sample_cdp_abort.tcl
pr_sample_cdp_revert.tcl
sl_sample_intf_down.tcl
tm_sample_cli_cmd.tcl
tm_sample_crash_hist.tcl
wd_sample_proc_mem_used.tcl
wd_sample_sys_mem_used.tcl
This table describes the significant fields shown in the display.
Table 11: show event manager policy available Field Descriptions
Field
No.
Type
Time Created
Name
Description
Number of the policy.
Type of policy.
Time the policy was created.
Name of the policy.
Related Commands
Command
event manager policy, on page 89
Description
Registers an EEM policy with the EEM.
show event manager policy registered, on page 111
Displays the EEM policies that are already registered.
110
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager policy registered
show event manager policy registered
To display the Embedded Event Manager (EEM) policies that are already registered, use the show event
manager policy registered command in EXEC modeXR EXEC mode.
show event manager policy registered[event-type type] [system| user] [time-ordered| name-ordered]
Syntax Description
event-type type (Optional) Displays the registered policies for a specific event type, where the valid type options are as follows:
• application—Application event type
• cli—CLI event type
• config—Conf event type
• counter—Counter event type
• hardware—Hardware event type
• none—None event type
• oir—Online insertion and removal (OIR) event type
• process-abort—Process abort event type
• process-start—Process start event type
• process-term—Process termination event type
• process-user-restart—Process user restart event type
• process-user-shutdown—Process user shutdown event type
• snmp—SNMP event type
• snmp-proxy—SNMP PROXY event type
• statistics—Statistics event type
• syslog—Syslog event type
• timer-absolute—Absolute timer event type
• timer-countdown—Countdown timer event type
• timer-cron—Clock daemon (cron) timer event type
• timer-watchdog—Watchdog timer event type
• track—Track event type
• wdsysmon—Watchdog system monitor event type system user
(Optional) Displays the registered system policies.
(Optional) Displays the registered user policies.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
111 OL-26517-02
Embedded Event Manager Commands show event manager policy registered time-ordered name-ordered
(Optional) Displays the policies according to registration time.
(Optional) Displays the policies in alphabetical order according to policy name.
Command Default If this command is invoked with no optional keywords or arguments, it displays the registered EEM policies for all the event types. The policies are displayed according to the registration time.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager policy registered command was replaced with the show event manager policy registered command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines The output of the show event manager policy registered command is most beneficial if you are writing and monitoring the EEM policies. The output displays registered policy information in two parts. The first line in each policy description lists the index number assigned to the policy, policy type (system or user), type of event registered, time at which the policy was registered, and name of the policy file. The remaining lines of each policy description display information about the registered event and how the event is to be handled, and come directly from the Tool Command Language (TCL) command arguments that make up the policy file.
Registered policy information is documented in the Cisco publication Writing Embedded Event Manager
Policies Using Tcl.
Task ID
Task ID eem
Operations read
Examples This is a sample output of the show event manager policy registered command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager policy registered
112
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager policy registered
No.
Type Event Type Time Registered
1 system proc abort Wed Jan 16 23:44:56 2004 version 00.00.0000 instance 1 path {cdp}
2 priority normal maxrun_sec 20 maxrun_nsec 0 system name {crontimer1} timer cron Wed Jan 16 23:44:58 2004
3 priority normal maxrun_sec 20 maxrun_nsec 0 system proc abort Wed Jan 16 23:45:02 2004
4 path {cdp} priority normal maxrun_sec 20 maxrun_nsec 0 system syslog Wed Jan 16 23:45:41 2004
5 occurs 1 pattern {test_pattern} priority normal maxrun_sec 90 maxrun_nsec 0 system name {crontimer2} timer cron Wed Jan 16 23:45:12 2004
Name test1.tcl
test2.tcl
test3.tcl
test4.tcl
test5.tcl
6 priority normal maxrun_sec 30 maxrun_nsec 0 system wdsysmon Wed Jan 16 23:45:15 2004 test6.tcl
timewin_sec 120 timewin_nsec 0 sub1 mem_tot_used {node {localhost} op gt val 23000}
7 priority normal maxrun_sec 40 maxrun_nsec 0 system wdsysmon Wed Jan 16 23:45:19 2004 test7.tcl
timewin_sec 120 timewin_nsec 0 sub1 mem_proc {node {localhost} procname
{wdsysmon} op gt val 80 is_percent FALSE} priority normal maxrun_sec 40 maxrun_nsec 0
This is the sample of a script that is signed by Cisco: script system timer watchdog Off Fri Apr 23 14:03:27 2010 script_signed_cisco.tcl
name {clistimer} time 30.000
nice 0 queue-priority normal maxrun 0.000 scheduler rp_primary Secu 2048 Dsig Cisco
This is the sample of a script that is signed by third party: script system timer watchdog name {clistimer} time 30.000
Off Fri Apr 23 14:03:27 2010 script_signed.tcl
nice 0 queue-priority normal maxrun 0.000 scheduler rp_primary Secu Trust Dsig
Tcl_trustpoint
This is the sample of a script that is verified against a configured checksum: script user timer watchdog Off Fri Apr 23 14:03:27 2010 test3_3rd_signed.tcl
name {clistimer} time 30.000
nice 0 queue-priority normal maxrun 0.000 scheduler rp_primary Secu none Cksm MD5
This is the sample of a script that is signed by a combination of security levels. If a SHA-1 or MD5 script is verified and registered, the checksum information displays as Cksm sha1 or Cksm md5. The following example shows a SHA-1 checksum signed by Tcl_trustpoint: script user timer watchdog name {clistimer} time 30.000
Off Fri Apr 23 14:03:27 2010 test3_3rd_signed.tcl
nice 0 queue-priority normal maxrun 0.000 scheduler rp_primary Cksm sha1 Dsig Tcl_trustpoint
This table describes the significant fields displayed in the example.
Table 12: show event manager policy registered Field Descriptions
Field
No.
Type
Event Type
Time Registered
Description
Number of the policy.
Type of policy.
Type of the EEM event for which the policy is registered.
Time at which the policy was registered.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
113
show event manager policy registered
Field
Name
Related Commands
Command
event manager policy, on page 89
Embedded Event Manager Commands
Description
Name of the policy.
Description
Registers an EEM policy with the EEM.
114
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager refresh-time
show event manager refresh-time
To display the time between the user authentication refreshes in the Embedded Event Manager (EEM), use the show event manager refresh-time command in EXEC modeXR EXEC mode.
show event manager refresh-time
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager refresh-time command was replaced with the show event manager refresh-time command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines The output of the show event manager refresh-time command is the refresh time, in seconds.
Task ID
Task ID eem
Operations read
Examples This is a sample output of the show event manager refresh-time command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager refresh-time
Output:
1800 seconds
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
115 OL-26517-02
Embedded Event Manager Commands show event manager refresh-time
Related Commands
Command
event manager refresh-time, on page 93
Description
Specifies the time between the system attempts to contact the AAA server, and refreshes the username reauthentication.
116
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager statistics-table
show event manager statistics-table
To display the currently supported statistic counters maintained by the Statistic Event Detector, use the show
event manager statistics-table command in EXEC modeXR EXEC mode.
show event manager statistics-table {stats-name| all}
Syntax Description stats-name all
Specific statistics type to be displayed. There are three statistics types:
• generic (ifstats-generic)
• interface table (ifstats-iftable)
• data rate (ifstats-datarate)
Displays the possible values for the stats-name argument.
Displays the output for all the statistics types.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.6.0
Release 3.7.0
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The show fault manager statistics-table command was replaced with the show event manager statistics-table command.
Task ID was changed from fault-mgr to eem.
This command was introduced.
This command was introduced.
Usage Guidelines Use the show event manager statistics-table all command to display the output for all the statistics types.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
117 OL-26517-02
Embedded Event Manager Commands show event manager statistics-table
Task ID
Examples
Task ID eem
Operations read
This is a sample output of the show event manager statistics-table all command:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager statistics-table all
Name ifstats-generic ifstats-iftable ifstats-datarate
Type bag bag bag
Description
Interface generic stats
Interface iftable stats
Interface datarate stats
This is a sample output providing more detailed information on the ifstats-iftable interface statistics table:
RP/0/0RP0RSP0/CPU0:router:hostname# show event manager statistics-table ifstats-iftable
Name
PacketsReceived
BytesReceived
Type uint64 uint64
PacketsSent
BytesSent uint64 uint64
MulticastPacketsReceived uint64
BroadcastPacketsReceived uint64
MulticastPacketsSent
BroadcastPacketsSent
OutputDropsCount
InputDropsCount
InputQueueDrops uint64 uint64 uint32 uint32 uint32
Description
Packets rcvd
Bytes rcvd
Packets sent
Bytes sent
Multicast pkts rcvd
Broadcast pkts rcvd
Multicast pkts sent
Broadcast pkts sent
Total output drops
Total input drops
Input queue drops
RuntPacketsReceived
GiantPacketsReceived uint32 uint32
ThrottledPacketsReceived uint32
ParityPacketsReceived uint32
Received runt packets
Received giant packets
Received throttled packets
Received parity packets
UnknownProtocolPacketsReceiveduint32
InputErrorsCount uint32
Unknown protocol pkts rcvd
Total input errors
CRCErrorCount uint32 Input crc errors
InputOverruns
FramingErrorsReceived
InputIgnoredPackets
InputAborts
OutputErrorsCount
OutputUnderruns
OutputBufferFailures uint32 uint32 uint32 uint32 uint32 uint32 uint32
Input overruns
Framing-errors rcvd
Input ignored packets
Input aborts
Total output errors
Output underruns
Output buffer failures
OutputBuffersSwappedOut uint32
Applique uint32
ResetCount
CarrierTransitions uint32 uint32
Output buffers swapped out
Applique
Number of board resets
Carrier transitions
AvailabilityFlag uint32 Availability bit mask
NumberOfSecondsSinceLastClearCountersuint32 Seconds since last clear counters
LastClearTime uint32 SysUpTime when counters were last cleared (in seconds)
This table describes the significant fields displayed in the example.
118
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager statistics-table
Table 13: show event manager statistics-table Field Descriptions
Field
Name
Type
Description
Description
Name of the statistic.
When the all keyword is specified, there are three types of statistics displayed:
• ifstats-generic
• ifstats-iftable
• ifstats-datarate
When a statistics type is specified, the statistics for the statistic type are displayed.
Type of statistic.
Description of the statistic.
Related Commands
Command
event manager policy, on page 89
Description
Registers an EEM policy with the EEM.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
119
Embedded Event Manager Commands show event manager scheduler thread
show event manager scheduler thread
To display the number of scripts running in parallel in Embedded Event Manager (EEM) policies, use the
show event manager scheduler thread command in EXEC modeXR EXEC mode.
show event manager scheduler thread[queue-type {script}[detailed]]
Syntax Description queue-type script detailed
(Optional) Displays the Event manager scheduler thread queue type information.
Displays the scheduler thread script data for EEM component.
(Optional) Displays detailed results.
Command Default If this command is invoked with no optional keywords or arguments, it displays the number of scripts running in parallel.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 5.2.0
Modification
This command was introduced.
Usage Guidelines The output of the show event manager scheduler thread command is used to display the number of scripts that are running in parallel. A maximum of 5 scripts can be run in parallel.
Task ID
Task ID eem
Operations read
Examples This is a sample output of the show event manager scheduler threadcommand: sh event manager scheduler thread queue-type script detailed
1 Script threads service class default total: 5 running: 2 idle: 3
1 job id: 16, pid: 2605384, name: script 1
2 job id: 17, pid: 2609470, name: script 2
120
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Embedded Event Manager Commands show event manager scheduler thread
Related Commands
Command
event manager policy, on page 89
Description
Registers an EEM policy with the EEM.
show event manager policy registered, on page 111
Display the EEM policies that are already registered.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
121
show event manager scheduler thread
Embedded Event Manager Commands
122
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
IP Service Level Agreement Commands
This module describes the Cisco IOS XR software commands to configure IP Service Level Agreements
(IP SLAs) on your router.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
For detailed information about IP SLA concepts, configuration tasks, and examples, see the Implementing
IP Service Level Agreements module in the Cisco IOS XR System Monitoring Configuration Guide for the
Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration Guide for the Cisco CRS
RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration GuideSystem
Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
•
•
•
•
buckets (statistics hourly), page 136
•
buckets (statistics interval), page 138
•
•
•
destination address (IP SLA), page 145
•
•
•
distribution interval, page 151
•
•
•
•
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
123
•
•
•
•
•
•
•
•
•
•
•
maximum paths (IP SLA), page 181
•
•
•
•
•
•
•
•
•
•
•
•
•
path discover session, page 206
•
•
•
•
•
•
•
•
•
124
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
IP Service Level Agreement Commands
OL-26517-02
IP Service Level Agreement Commands
•
•
•
•
•
•
•
•
•
show ipsla application, page 241
•
•
show ipsla mpls discovery vpn, page 247
•
show ipsla mpls lsp-monitor lpd, page 249
•
show ipsla mpls lsp-monitor scan-queue, page 251
•
show ipsla mpls lsp-monitor summary, page 253
•
show ipsla responder statistics, page 256
•
show ipsla statistics, page 258
•
show ipsla statistics aggregated, page 262
•
show ipsla statistics enhanced aggregated, page 272
•
show ipsla twamp connection, page 276
•
show ipsla twamp session, page 277
•
show ipsla twamp standards, page 278
•
•
•
•
•
•
•
•
•
•
threshold type average, page 299
•
threshold type consecutive, page 301
•
threshold type immediate, page 303
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
125
•
•
•
•
•
•
•
type icmp path-jitter, page 317
•
•
•
•
•
type udp ipv4 address, page 327
•
•
•
vrf (IP SLA MPLS LSP monitor), page 333
IP Service Level Agreement Commands
126
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands access-list
access-list
To specify an access-list name to filter provider edge (PE) addresses to restrict operations that are automatically created by MPLS LSP monitor (MPLSLM) instance, use the access-list command in the appropriate configuration mode. To return to the default value, use the no form of this command.
access-list acl-name no access-list
Syntax Description acl-name Filters an access-list name.
Command Default No access list is configured by default.
Command Modes IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Access-list changes are processed before the scan interval expires to display a planned list of changes in the scan-queue.
Note There is no verification check between the access list and the IPSLA configuration.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
127 OL-26517-02
IP Service Level Agreement Commands access-list
Examples The following example shows how to use the access-list command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# access-list ipsla
Related Commands
Command
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Specifies the frequency at which the MPLS LSP monitor instance checks the scan queue for updates.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
128
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands action (IP SLA)
action (IP SLA)
To specify what action or combination of actions the operation performs when you configure the react command or when threshold events occur, use the action command in the appropriate configuration mode.
To clear action or combination of actions (no action can happen), use the no form of this command.
action {logging| trigger}
no action {logging| trigger}
Syntax Description logging trigger
Sends a logging message when the specified violation type occurs for the monitored element.
The IP SLA agent generates a syslog and informs SNMP. Then, it is up to the SNMP agent to generate a trap or not.
Determines that the operation state of one or more target operations makes the transition from pending to active when the violation conditions are met. The target operations to be triggered are specified using the ipsla reaction trigger command. A target operation continues until its life expires, as specified by the lifetime value of the target operation. A triggered target operation must finish its life before it can be triggered again.
Command Default None
Command Modes IP SLA reaction condition configuration
IP SLA MPLS LSP monitor reaction configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor reaction configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines For the action command to occur for threshold events, the threshold type must be defined. Absence of threshold type configuration is considered if the threshold check is not activated.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
129 OL-26517-02
IP Service Level Agreement Commands action (IP SLA)
Task ID
When the action command is used from IP SLA MPLS LSP monitor reaction configuration mode, only the
logging keyword is available.
If the action command is used in IP SLA operation mode, the action defined applies to the specific operation being configured. If the action command is used in IP SLA MPLS LSP monitor mode, the action defined applies to all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the action command with the logging keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react connection-loss
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# action logging
The following example shows how to use the action command from the IP SLA MPLS LSP monitor reaction configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# reaction monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react)# react connection-loss
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react-cond)# action logging
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type average, on page 299
Description
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures MPLS LSP monitoring reactions.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Sets the lower-limit and upper-limit values.
Takes action on average values to violate a threshold.
130
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands action (IP SLA)
Command
threshold type consecutive, on page 301
threshold type immediate, on page 303
threshold type xofy, on page 305
Description
Takes action after a number of consecutive violations.
Takes action immediately upon a threshold violation.
Takes action upon X violations in Y probe operations.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
131
IP Service Level Agreement Commands ageout
ageout
To specify the number of seconds to keep the operation in memory when it is not actively collecting information, use the ageout command in IP SLA schedule configuration mode. To use the default value so that the operation will never age out, use the no form of this command.
ageout seconds no ageout
Syntax Description seconds Age-out interval in seconds. The value 0 seconds means that the collected data is not aged out. Range is 0 to 2073600.
Command Default The default value is 0 seconds (never aged out).
Command Modes IP SLA schedule configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the ageout command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)# ageout 3600
132
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
ageout
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
133
IP Service Level Agreement Commands buckets (history)
buckets (history)
To set the number of history buckets that are kept during the lifetime of the IP SLA operation, use the buckets command in IP SLA operation history configuration mode. To use the default value, use the no form of this command.
buckets buckets no buckets
Syntax Description buckets Number of history buckets that are kept during the lifetime of an IP SLA operation.
Range is 1 to 60.
Command Default The default value is 15 buckets.
Command Modes IP SLA operation history configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The buckets command is supported only to configure the following operations:
• IP SLA ICMP path-echo
• IP SLA ICMP echo
• IP SLA UDP echo
Task ID
Task ID monitor
Operations read, write
134
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands buckets (history)
Examples The following example shows how to use the buckets command in IP SLA UDP echo configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-echo)# history
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-hist)# buckets 30
Related Commands
Command
schedule operation, on page 236
Description
Configures the history parameters for the IP SLA operation.
Configures an IP SLA operation.
Schedules an IP SLA operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
135
IP Service Level Agreement Commands buckets (statistics hourly)
buckets (statistics hourly)
To set the number of hours for which statistics are kept, use the bucket command in the appropriate configuration mode. To use the default value, use the no form of this command.
buckets hours no buckets
Syntax Description hours Number of hours for which statistics are maintained for the IP SLA operations. Range is
0 to 25 in IP SLA operation statistics configuration mode, and 0 to 2 in IP SLA MPLS LSP monitor statistics configuration mode.
Command Default The default value is 2.
Command Modes IP SLA operation statistics configuration
IP SLA MPLS LSP monitor statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor statistics configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines The buckets command with the hours argument is valid only for the statistics command with the hourly keyword.
Task ID
Task ID monitor
Operations read, write
136
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands buckets (statistics hourly)
Examples The following example shows how to set the number of hours in which statistics are maintained for the IP
SLA UDP jitter operation for the buckets command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# buckets 10
Related Commands
Command
Description
Sets the statistics collection parameters for the operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
137
IP Service Level Agreement Commands buckets (statistics interval)
buckets (statistics interval)
To specify the maximum number of buckets in which the enhanced history statistics are kept, use the buckets command in IP SLA operation statistics configuration mode. To remove the statistics collection of the specified interval, use the no form of this command.
buckets bucket-size no buckets
Syntax Description bucket-size The bucket size is when the configured bucket limit is reached. Therefore, statistics gathering for the operation ends. Range is 1 to 100. Default is 100.
Command Default The default value is 100.
Command Modes IP SLA operation statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The buckets command with the bucket-size argument is valid only for the statistics command with the interval keyword.
Examples The following example shows how to collect statistics for a given time interval for the IP SLA UDP jitter operation for the buckets command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics interval 60
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# buckets 50
138
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Related Commands
Command
buckets (statistics interval)
Description
Sets the statistics collection parameters for the operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
139
IP Service Level Agreement Commands control disable
control disable
To disable the control packets, use the control disable command in the appropriate configuration mode. To use the control packets again, use the no form of this command.
control disable no control disable
Syntax Description This command has no keywords or arguments.
Command Default Control packets are enabled by default.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When you configure the control disable command on the agent side, you need to configure a permanent port on the responder side or the operation returns a timeout error. If you configure the control disable command, a permanent port of the IP SLA Responder or some other functionality, such as the UDP echo server, is required on the remote device.
The control disable command is valid for operations that require a responder.
The IP SLA control protocol is disabled, which is used to send a control message to the IP SLA Responder prior to sending an operation packet. By default, IP SLA control messages are sent to the destination device to establish a connection with the IP SLA Responder.
Task ID
Task ID monitor
Operations read, write
140
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands control disable
Examples The following example shows how to use the control disable command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# control disable
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
141
IP Service Level Agreement Commands datasize request
datasize request
To set the protocol data size in the request packet in the payload of an operation, use the datasize request command in the appropriate configuration mode. To reset the default data size, use the no form of this command.
datasize request size no datasize request
Syntax Description size Specifies the following ranges and default values that are protocol dependent:
• For a UDP jitter operation, range is 1628 to 1500 B.
• For a UDP echo operation, range is 4 to 1500 B.
• For an ICMP echo operation, range is 0 to 16384 B.
• For an ICMP path-echo operation, range is 0 to 16384 B.
• For an ICMP path-jitter operation, range is 0 to 16384 B.
• For an MPLS LSP ping operation, range is 100 to 17986 B.
Command Default For a UDP jitter operation, the default value is 32 B.
For a UDP echo operation, the default value is 16 B.
For an ICMP echo operation, the default value is 36 B.
For an ICMP path-echo operation, the default value is 36 B.
For an ICMP path-jitter operation, the default value is 36 B.
For an MPLS LSP ping operation, the default value is 100 B.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
Command History
Release
Release 3.3.0
Modification
This command was introduced.
142
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands datasize request
Release
Release 3.3.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
Support was added for IP SLA MPLS LSP ping configuration mode.
This command was added to IP SLA MPLS LSP monitor ping configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the datasize request command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# datasize request 512
Related Commands
Command
schedule operation, on page 236
type icmp path-echo, on page 315
type icmp path-echo, on page 315
Description
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures an IP SLA ICMP echo operation.
Configures an IP SLA ICMP path-echo operation.
Configures an IP SLA ICMP echo operation.
Configures an IP SLA ICMP path-echo operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
143
datasize request
Command
type icmp path-jitter, on page 317
IP Service Level Agreement Commands
Description
Configures an IP SLA ICMP path-jitter operation.
Configures an IP SLA UDP jitter operation.
144
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands destination address (IP SLA)
destination address (IP SLA)
To identify the address of the target device, use the destination address command in the appropriate configuration mode. To unset the destination address, use the no form of this command.
destination address ipv4-address no destination address
Syntax Description ipv4-address IP address of the target device.
Command Default None
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines You must specify the address of the target device. The configuration for the destination address command is mandatory for all operations.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
145 OL-26517-02
IP Service Level Agreement Commands destination address (IP SLA)
Examples The following example shows how to designate an IP address for the destination address command in IP
SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# destination address 192.0.2.12
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
146
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands destination port
destination port
To identify the port of the target device, use the destination port command in the appropriate configuration mode. To unset the destination port, use the no form of this command.
destination port port no destination port
Syntax Description port Port number of the target device. Range is 1 to 65355.
Command Default None
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The destination port command is not supported when you configure an ICMP operation; it is supported only to configure UDP operations.
You must specify the port of the target device. The configuration for the destination port command is mandatory for both IP SLA UDP echo and IP SLA UDP jitter configurations.
Task ID
Task ID monitor
Operations read, write
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
147
IP Service Level Agreement Commands destination port
Examples The following example shows how to designate a port for the destination port command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# destination port 11111
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
148
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands distribution count
distribution count
To set the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation, use the distribution count command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
distribution count slot no distribution count
Syntax Description slot Number of statistics distributions that are kept. Range is 1 to 20. Default is 1.
Command Default The default value is 1.
Command Modes IP SLA operation statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines In most situations, you do not need to change the number of statistics distributions kept or the time interval for each distribution. Only change these parameters when distributions are needed, for example, when performing statistical modeling of your network. To set the statistics distributions interval, use the distribution
interval command in IP SLA operation statistics configuration mode. The total number of statistics distributions captured is the value set by the distribution count command times the value set by the maximum hops command times the value set by the maximum path command times the value set by the buckets command.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
149 OL-26517-02
IP Service Level Agreement Commands distribution count
Examples The following example shows how to set the number of statistics distribution for the distribution count command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# distribution count 15
Related Commands
Command
buckets (statistics hourly), on page 136
distribution interval, on page 151
maximum paths (IP SLA), on page 181
Description
Sets the number of hours in which statistics are kept.
Sets the time interval (in milliseconds) for each statistical distribution.
Sets the number of hops in which statistics are maintained for each path for the IP SLA operation.
Sets the number of paths in which statistics are maintained for each hour for an IP SLA operation.
Sets the statistics collection parameters for the operation.
150
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands distribution interval
distribution interval
To set the time interval (in milliseconds) for each statistical distribution, use the distribution interval command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
distribution interval interval no distribution interval
Syntax Description interval Number of milliseconds used for each statistics distribution that is kept. Range is
1 to 100. Default is 20.
Command Default The default value is 20.
Command Modes IP SLA operation statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines In most situations, you do not need to change the number of statistics distributions kept or the time interval for each distribution. Only change these parameters when distributions are needed, for example, when performing statistical modeling of your network. To set the statistics distributions count, use the distribution
count command in IP SLA operation statistics configuration mode. The total number of statistics distributions captured is the value set by the distribution count command times the value set by the maximum hops command times the value set by the maximum path command times the value set by the buckets command.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
151 OL-26517-02
IP Service Level Agreement Commands distribution interval
Examples The following example shows how to set the time interval for the distribution interval command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# distribution interval 50
Related Commands
Command
buckets (statistics hourly), on page 136
distribution count, on page 149
maximum paths (IP SLA), on page 181
Description
Sets the number of hours in which statistics are kept.
Sets the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation.
Sets the number of hops in which statistics are maintained for each path for the IP SLA operation.
Sets the number of paths in which statistics are maintained for each hour for an IP SLA operation.
Sets the statistics collection parameters for the operation.
152
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands exp
exp
To specify the MPLS experimental field (EXP) value in the header of echo request packets, use the exp command in the appropriate configuration mode. To return to the default value, use the no form of this command.
exp exp-bits no exp
Syntax Description exp-bits Experimental field value in the header of an echo request packet. Valid values are from 0 to 7. Default is 0.
Command Default The experimental field value is set to 0.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to the IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines Use the exp command to set the MPLS experimental field in the headers of echo request packets in an MPLS
LSP ping or MPLS LSP trace operation. The experimental (EXP) field allows for eight different quality-of-service (QoS) markings that determine the treatment (per-hop behavior) that a transit LSR node gives to a request packet. You can configure different MPLS EXP levels for different operations to create differentiated levels of response.
If the exp command is used in IP SLA operation mode, it acts on the headers of echo request packets for the specific operation being configured. If the exp command is used in IP SLA MPLS LSP monitor mode, it acts
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
153 OL-26517-02
IP Service Level Agreement Commands exp
Task ID on the headers of echo request packets for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the exp command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# exp 5
The following example shows how to use the exp command in MPLS LSP monitor mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-trace)# exp 5
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
154
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands filter
filter
To define the type of information that are kept in the history table for the IP SLA operation, use the filter command in IP SLA operation history configuration mode. To unset the history filter, use the no form of this command.
filter {all| failures} no filter
Syntax Description all failures
Stores history data for all operations, if set.
Stores data for operations that failed, if set.
Command Default The default is not to collect the history unless the filter command is enabled.
Command Modes IP SLA operation history configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The filter command is supported only to configure the following operations:
• IP SLA ICMP path-echo
• IP SLA ICMP echo
• IP SLA UDP echo
If you use the no form of the filter command, the history statistics are not collected.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
155 OL-26517-02
IP Service Level Agreement Commands filter
Examples The following example shows how to use the filter command in IP SLA UDP echo configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-echo)# history
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-hist)# filter all
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
156
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands force explicit-null
force explicit-null
To add an explicit null label to the label stack of an LSP when an echo request is sent, use the force explicit-null command in the appropriate configuration mode. To return to the default value, use the no form of this command.
force explicit-null no force explicit-null
Syntax Description This command has no keywords or arguments.
Command Default An explicit null label is not added.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
Usage Guidelines Use the force explicit-null command to force an unsolicited explicit null label to be added to the MPLS label stack of the LSP when an echo request packet is sent in an MPLS LSP ping or MPLS LSP trace operation.
If the force explicit-null command is used in IP SLA operation mode, it acts on the label stack of the LSP for the specific operation being configured. If the force explicit-null command is used in IP SLA MPLS LSP monitor mode, it acts on the label stack of all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
You cannot use the force explicit-null command if pseudowire is specified as the target to be used in an
MPLS LSP ping operation.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
157 OL-26517-02
IP Service Level Agreement Commands force explicit-null
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the force explicit-null command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# force explicit-null
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
158
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands frequency (IP SLA)
frequency (IP SLA)
To set the frequency for probing, use the frequency command in the appropriate configuration mode. To use the default value, use the no form of this command.
frequency seconds no frequency
Syntax Description seconds Rate at which the specific IP SLA operation is sent into the network. Range is 1 to 604800.
Command Default If the frequency command is not used, the default value is 60 seconds.
In IP SLA MPLS LSP monitor schedule configuration mode, the default value is equal to the schedule period that is set using the schedule period command.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor schedule configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Support was added for IP SLA MPLS ping and IP SLA MPLS trace configuration modes.
This command was added to IP SLA MPLS LSP monitor schedule configuration mode.
This command was introduced.
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
159 OL-26517-02
IP Service Level Agreement Commands frequency (IP SLA)
Usage Guidelines If this command is used in IP SLA MPLS LSP monitor schedule configuration mode, it represents the frequency for the schedule period. In other words, if the frequency is set to 1000 seconds and the schedule period is set to 600 seconds, every 1000 seconds the LSP operations are run. Each run takes 600 seconds. Use the schedule
period command to specify the schedule period.
The frequency value must be greater than or equal to the schedule period.
This configuration is inherited automatically by all LSP operations that are created.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the frequency command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# frequency 300
The following example shows how to use the frequency command in IP SLA MPLS LSP monitor schedule configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# schedule monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-sched)# frequency 1200
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-sched)# schedule period 600
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures the amount of time during which all LSP operations are scheduled to start or run.
160
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands history
history
To configure the history parameters for the IP SLA operation, use the history command in the appropriate configuration mode. To use the default value, use the no form of this command.
history [buckets buckets| filter {all| failures}| lives lives] no history
Syntax Description buckets buckets filter all failures lives lives
Sets the number of history buckets that are kept during the lifetime of the IP SLA operation.
Number of history buckets that are kept during the lifetime of an IP SLA operation.
Range is 1 to 60.
Defines the type of information that is kept in the history table for the IP SLA operation.
Stores history data for all operations, if set.
Stores data for operations that failed, if set.
Sets the number of lives that are maintained in the history table for an IP SLA operation.
Number of lives that are maintained in the history table for an IP SLA operation.
Range is 0 to 2.
Command Default None
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
Command History
Release
Release 3.3.0
Modification
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
161 OL-26517-02
IP Service Level Agreement Commands history
Release
Release 3.3.0
Release 3.4.0
Release 3.7.2
Modification
This command was introduced.
Support was added for IP SLA MPLS LSP ping and IP SLA MPLS
LSP trace configuration modes.
This command was introduced.
Usage Guidelines The history command enters IP SLA operation history configuration mode in which you can configure more history configuration parameters.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the history command in IP SLA UDP echo configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-echo)# history
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-hist)#
Related Commands
Command
buckets (history), on page 134
schedule operation, on page 236
Description
Sets the number of history buckets that are kept during the lifetime of the IP SLA operation.
Defines the type of information that are kept in the history table for the IP SLA operation.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Sets the number of lives that are maintained in the history table for an IP SLA operation.
Sets the number of hop entries that are kept in the history table for an IP SLA ICMP path-echo operation.
162
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands interval
interval
To configure the refresh interval for MPLS label switched path (LSP) monitoring, use the interval command in IP SLA MPLS discovery VPN configuration mode. To use the default value, use the no form of this command.
interval refresh-interval no interval
Syntax Description refresh-interval Specifies the time interval, in minutes, after which routing entries that are no longer valid are removed from the Layer 3 VPN discovery database. Range is 30 to 70560.
Command Default The default refresh interval is 60 minutes.
Command Modes IP SLA MPLS discovery VPN configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines
Note If the total number of routes is large, there is a negative impact on the performance during the refresh of the discovery database. Therefore, the value of the refresh-interval argument should be large enough that router performance is not affected. If there are a very large number of routes, we recommend that you set the value of the refresh-interval argument to be several hours.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
163 OL-26517-02
IP Service Level Agreement Commands interval
Examples The following example shows how to use the interval command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls discovery vpn
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-discovery-vpn)# interval 120
Related Commands
Command
mpls discovery vpn, on page 185
Description
Configures MPLS label switched path (LSP) provider edge (PE) router discovery.
Configures MPLS label switched path (LSP) monitoring.
164
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands ipsla
ipsla
To enter IP SLA configuration mode and configure IP Service Level Agreements, use the ipsla command in
Global Configuration modeXR Config mode. To return to the default setting, use the no form of this command.
ipsla no ipsla
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The ipsla command enters IP SLA configuration mode where you can configure the various IP service level agreement options.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to enter IP SLA configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
165 OL-26517-02
IP Service Level Agreement Commands ipsla
Related Commands
Command
mpls discovery vpn, on page 185
reaction operation, on page 215
schedule operation, on page 236
Description
Configures MD5 authentication for IP SLA control messages.
Configures a low-water memory mark.
Configures MPLS label switched path (LSP) provider edge (PE) router discovery.
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Configures certain actions that are based on events under the control of the IP SLA agent.
Defines a second IP SLA operation to make the transition from a pending state to an active state when one of the trigger-type options is defined with the
reaction operation command.
Enables the IP SLA responder for UDP echo or jitter operations.
Schedules an IP SLA operation.
166
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands key-chain
key-chain
To configure the MD5 authentication for the IP SLA control message, use the key-chain command in IP SLA configuration mode. To unset the keychain name and not use MD5 authentication, use the no form of this command.
key-chain key-chain-name no key-chain
Syntax Description key-chain-name Name of the keychain.
Command Default No default values are defined. No authentication is used.
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When you configure the key-chain command, you must also configure the key chain command in global configurationXR Config mode to provide MD5 authentication.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the ipsla key-chain command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# key-chain ipsla-keys
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
167 OL-26517-02
IP Service Level Agreement Commands key-chain
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
168
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands life
life
To specify the length of time to execute, use the life command in IP SLA schedule configuration mode. To use the default value, use the no form of this command.
life {forever| seconds} no life
Syntax Description forever seconds
Schedules the operation to run indefinitely.
Determines the number of seconds the operation actively collects information.
Range is 1 to 2147483647. Default value is 3600 seconds (one hour).
Command Default The default value is 3600 seconds.
None
Command Modes IP SLA schedule configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the life command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
169 OL-26517-02
IP Service Level Agreement Commands life
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)# life forever
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
170
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands lives
lives
To set the number of lives that are maintained in the history table for an IP SLA operation, use the lives command in IP SLA operation history configuration mode. To use the default value, use the no form of this command.
lives lives no lives
Syntax Description lives Number of lives that are maintained in the history table for an IP SLA operation.
Range is 0 to 2.
Command Default The default value is 0 lives.
Command Modes IP SLA operation history configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The lives command is supported only to configure the following operations:
• IP SLA ICMP path-echo
• IP SLA ICMP echo
• IP SLA UDP echo
If you use the no form of the lives command, the history statistics are not collected.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
171 OL-26517-02
IP Service Level Agreement Commands lives
Examples The following example shows how to use the lives command in IP SLA UDP echo configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-echo)# history
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-hist)# lives 2
Related Commands
Command
buckets (history), on page 134
schedule operation, on page 236
Description
Sets the number of history buckets that are kept during the lifetime of the IP SLA operation.
Defines the type of information that are kept in the history table for the IP SLA operation.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Sets the number of hop entries that are kept in the history table for an IP SLA ICMP path-echo operation.
172
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands low-memory
low-memory
low-memory value no low-memory
Syntax Description value Low-water memory mark watermark value. Range is 0 to 4294967295.
Command Default The default value is 20 MB (free memory).
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines IP SLA ensures that the system provides the specified memory before adding new operations or scheduling the pending operation.
When the 0 value is used, no memory limitation is enforced.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the low-memory command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# low-memory 102400
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
173 OL-26517-02
IP Service Level Agreement Commands low-memory
Related Commands
Command
schedule operation, on page 236
show ipsla application, on page 241
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Displays the information for the IP SLA application.
174
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands lsp selector ipv4
lsp selector ipv4
To specify the local host IPv4 address used to select an LSP, use the lsp selector ipv4 command in the appropriate configuration mode. To clear the host address, use the no form of this command.
lsp selector ipv4 ip-address no lsp selector ipv4
Syntax Description ip-address A local host IPv4 address used to select the LSP.
Command Default The local host IP address used to select the LSP is 127.0.0.1.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines Use the lsp selector ipv4 command to force an MPLS LSP ping or MPLS LSP trace operation to use a specific
LSP when there are multiple equal cost paths between provider edge (PE) routers. This situation occurs when transit label switching routers (LSRs) use the destination address in IP packet headers for load balancing.
The IPv4 address configured with the lsp selector ipv4 command is the destination address in the User
Datagram Protocol (UDP) packet sent as the MPLS echo request. Valid IPv4 addresses are defined in the subnet 127.0.0.0/8 and used to:
• Force the packet to be consumed by the router where an LSP breakage occurs.
• Force processing of the packet at the terminal point of the LSP if the LSP is intact.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
175 OL-26517-02
IP Service Level Agreement Commands lsp selector ipv4
Task ID
• Influence load balancing during forwarding when the transit routers use the destination address in the
IP header for load balancing.
If the lsp selector ipv4 command is used in IP SLA operation mode, it acts on the MPLS echo requests for the specific operation being configured. If the lsp selector ipv4 command is used in IP SLA MPLS LSP monitor mode, it acts on the MPLS echo requests for all operations associated with the monitored provider edge (PE) routers.
Task ID monitor
Operations read, write
Examples The following example shows how to use the lsp selector ipv4 command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# lsp selector ipv4 127.10.10.1
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
176
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands lsr-path
lsr-path
To specify a loose source routing path in which to measure the ICMP, use the lsr-path command in the appropriate configuration mode. To use a path other than the specified one, use the no form of this command.
lsr-path ipaddress1 [ipaddress2 [... [ipaddress8]]] no lsr-path
Syntax Description ip address IPv4 address of the intermediate node. Up to eight addresses can be entered.
Command Default No path is configured.
Command Modes IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The lsr-path command applies only to ICMP path-echo and ICMP path-jitter operation types.
You can configure up to a maximum of eight hop addresses by using the lsr-path command, as shown in the following example: lsr-path ipaddress1 [ipaddress2 [... [ipaddress8]]]
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
177 OL-26517-02
IP Service Level Agreement Commands lsr-path
Examples The following example shows how to use the lsr-path command in IP SLA ICMP Path-echo configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-echo)# lsr-path 192.0.2.40
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
178
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands maximum hops
maximum hops
To set the number of hops in which statistics are maintained for each path for the IP SLA operation, use the
maximum hops command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
maximum hops hops no maximum hops
Syntax Description hops Number of hops for which statistics are maintained for each path. Range is 1 to 30. Default value is 16 for path operations; for example, pathecho.
Command Default The default value is 16 hops.
Command Modes IP SLA operation statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced
This command was introduced.
This command was introduced.
Usage Guidelines The maximum hops command is supported only when you configure path operations and the IP SLA ICMP path-echo operation.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to set the number of hops for the statistics for the maximum command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
179 OL-26517-02
IP Service Level Agreement Commands maximum hops
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-echo)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# maximum hops 20
Related Commands
Command
buckets (statistics hourly), on page 136
distribution count, on page 149
distribution interval, on page 151
maximum paths (IP SLA), on page 181
Description
Sets the number of hours in which statistics are kept.
Sets the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation.
Sets the time interval (in milliseconds) for each statistical distribution.
Sets the number of paths in which statistics are maintained for each hour for an IP SLA operation.
Sets the statistics collection parameters for the operation.
180
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands maximum paths (IP SLA)
maximum paths (IP SLA)
To set the number of paths in which statistics are maintained for each hour for an IP SLA operation, use the
maximum paths command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
maximum paths paths no maximum paths
Syntax Description paths Number of paths for which statistics are maintained for each hour. Range is 1 to 128.
Default value is 5 for path operations; for example, pathecho.
Command Default The default value is 5 paths.
Command Modes IP SLA operation statistics configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The maximum paths command is supported only when you configure path operations and the IP SLA ICMP path-echo operation.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to set the number of paths for the statistics for the maximum paths command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
181 OL-26517-02
IP Service Level Agreement Commands maximum paths (IP SLA)
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-echo)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)# maximum paths 20
Related Commands
Command
buckets (statistics hourly), on page 136
distribution count, on page 149
distribution interval, on page 151
Description
Sets the number of hours in which statistics are kept.
Sets the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation.
Sets the time interval (in milliseconds) for each statistical distribution.
Sets the number of hops in which statistics are maintained for each path for the IP SLA operation.
Sets the statistics collection parameters for the operation.
182
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands monitor
monitor
To configure an MPLS LSP monitor instance, use the monitor command in IP SLA LSP monitor configuration mode. To remove the monitor instance, use the no form of this command.
monitor monitor-id
no monitor [ monitor-id ]
Syntax Description monitor-id Number of the IP SLA LSP monitor instance to be configured. Range is 1 to
2048.
Command Default No monitor instance is configured.
Command Modes IP SLA LSP monitor configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The monitor command enters IP SLA MPLS LSP monitor configuration mode so that you can set the desired monitor type for all operations associated with the monitored provider edge (PE) routers.
To remove all monitor instances, use the no monitor command with no argument.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the monitor command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
183 OL-26517-02
IP Service Level Agreement Commands monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)#
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
184
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands mpls discovery vpn
mpls discovery vpn
To configure MPLS label switched path (LSP) provider edge (PE) router discovery, use the mpls discovery
vpn command in IP SLA configuration mode. To use the default value, use the no form of this command.
mpls discovery vpn [interval interval] no mpls discovery vpn
Syntax Description interval Configures the refresh interval for MPLS label switched path (LSP) monitoring.
Command Default None
Command Modes IP SLA configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Usage Guidelines Use the mpls discovery vpn command to configure provider edge (PE) router discovery. PE Discovery discovers the LSPs used to reach every routing next hop. Routing entities are stored in a Layer 3 VPN discover database.
Task ID
Task ID monitor
Operations read, write
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
The following example shows how to enter IP SLA MPLS discovery VPN mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls discovery vpn
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-discovery-vpn)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
185 OL-26517-02
mpls discovery vpn
Related Commands
Command
IP Service Level Agreement Commands
Description
Configures the refresh interval for MPLS label switched path (LSP) monitoring.
Configures MPLS label switched path (LSP) monitoring.
186
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands mpls lsp-monitor
mpls lsp-monitor
To configure MPLS label switched path (LSP) monitoring, use the mpls lsp-monitor command in IP SLA configuration mode. To use the default value, use the no form of this command.
mpls lsp-monitor no mpls lsp-monitor
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes IP SLA configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the mpls lsp-monitor command to configure MPLS LSP PE monitoring on the router. This provides a means to configure all operations associated with the monitored provider edge (PE) routers. The configuration is inherited by all LSP operations that are created automatically by the PE discovery.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to enter IP SLA MPLS LSP monitor mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
187 OL-26517-02
IP Service Level Agreement Commands mpls lsp-monitor
Related Commands
Command
mpls discovery vpn, on page 185
Related Commands
Command
mpls discovery vpn, on page 185
Description
Configures MPLS label switched path (LSP) provider edge (PE) router discovery.
Description
Configures an IP SLA MPLS LSP monitor instance.
Configures MPLS label switched path (LSP) provider edge (PE) router discovery.
Configures MPLS LSP monitoring reactions.
Schedules an IP SLA MPLS LSP monitor instance.
188
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands operation
operation
To configure an IP SLA operation, use the operation command in IP SLA configuration mode. To remove the operation, use the no form of this command.
operation operation-number
no operation operation-number
Syntax Description operation-number Operation number. Range is 1 to 2048.
Command Default None
Command Modes IP SLA configuration
Command History
Examples
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
The following example shows how to use the IP SLA operation command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
189 OL-26517-02
IP Service Level Agreement Commands operation
Related Commands
Command
schedule operation, on page 236
Description
Schedules an IP SLA operation.
190
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands output interface
output interface
To specify the echo request output interface to be used for LSP ping or LSP trace operations, use the output
interface command in IP SLA MPLS LSP ping or IP SLA MPLS LSP trace configuration mode. To return the output interface to the default, use the no form of this command.
output interface type interface-path-id no output interface
Syntax Description type interface-path-id
Interface type. For more information, use the question mark (?) online help function.
Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark (?) online help function.
Command Default No default behavior or values.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the output interface command to help monitor path-to-target over the path if there are some ECMP routes in a topology.
You cannot use the output interface command if pseudowire is specified as the target to be used in an MPLS
LSP ping operation.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
191 OL-26517-02
IP Service Level Agreement Commands output interface
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the output interface command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls ls output interface pos
0/1/0/0
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Configures the next-hop address to be used for LSP ping or LSP trace operations.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
192
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands output nexthop
output nexthop
To specify the next-hop address to be used for a Label Switched Path (LSP) ping or LSP trace operations, use the output nexthop command in the appropriate configuration mode. To return the output next hop to the default, use the no form of this command.
output nexthop ip-address no output nexthop
Syntax Description ip-address IP address of the next hop.
Command Default No default behavior or values
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When LSP Path Discovery (LPD) is enabled, the next-hop IP address is also used to filter out the paths that are not associated with the specified next-hop address.
Note After you configure the output next hop, you must also configure the output interface.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
193 OL-26517-02
IP Service Level Agreement Commands output nexthop
Examples The following example shows how to use the output nexthop command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# output nexthop 10.1.1.1
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Configures the echo request output interface to be used for LSP ping or LSP trace operations.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
194
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands packet count
packet count
To specify the number of packets that are to be transmitted during a probe, such as a sequence of packets being transmitted for a jitter probe, use the packet count command in the appropriate configuration mode.
To use the default value, use the no form of this command.
packet count count no packet count
Syntax Description count Number of packets to be transmitted in each operation. Range for a UDP jitter operation is 1 to 60000. Range for an ICMP path-jitter operation is 1 to 100.
Command Default The default packet count is 10.
Command Modes IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the packet count command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
195 OL-26517-02
IP Service Level Agreement Commands packet count
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# packet count 30
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Specifies the interval between packets.
196
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands packet interval
packet interval
To specify the interval between packets, use the packet interval command in the appropriate configuration mode. To use the default value, use the no form of this command.
packet interval interval no packet interval
Syntax Description interval Interpacket interval in milliseconds. Range is 110 to 60000 (in milliseconds).
Command Default The default packet interval is 20 ms.
Command Modes IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the packet interval command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# packet interval 30
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
197 OL-26517-02
IP Service Level Agreement Commands packet interval
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Specifies the number of packets that are to be transmitted during a probe.
198
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands path discover
path discover
To enable path discovery and enter MPLS LSP monitor (MPLSLM) LPD submode, use the path discover command in IP SLA MPLS LSP monitor ping configuration mode. To use the default value, use the no form of this command.
path discover no path discover
Syntax Description None
Command Default No default behavior or values
Command Modes IP SLA MPLS LSP monitor ping configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to enter path discover submode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)#
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lpd)# path discover
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
199 OL-26517-02
IP Service Level Agreement Commands path discover echo
path discover echo
To configure MPLS LSP echo parameters, use the path discover command in the appropriate configuration mode. To use the default value, use the no form of this command.
path discover echo {interval time| maximum lsp selector ipv4 host address| multipath bitmap size size|
retry count| timeout value}
no path discover echo {interval time| maximum lsp selector ipv4 host address| multipath bitmap size
size| retry count| timeout value}
Syntax Description
interval time Configures the interval (in milliseconds) between MPLS LSP echo requests sent during path discovery. Range is 0 to 3600000. Default is 0.
maximum lsp selector ipv4 host-address
Configures a local host IP address (127.x.x.x) that is the maximum selector value to be used during path discovery. Default is 127.255.255.255.
multipath bitmap size size Configures the maximum number of selectors sent in the downstream mapping of an MPLS LSP echo request during path discovery. Range is 1 to 256.
Default is 32.
retry count
timeout value
Configures the number of timeout retry attempts for MPLS LSP echo requests sent during path discovery. Range is 0 to 10. Default is 3.
Configures the timeout value (in seconds) for MPLS LSP echo requests sent during path discovery. Range is 1 to 3600. Default is 5.
Command Default interval time: 0
maximum lsp selector ipv4 host address: 127.255.255.255
multipath bitmap size size : 32
retry count: 3
timeout value: 5
Command Modes Path discover configuration
MPLS LSP ping configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Modification
This command was introduced.
This command was introduced.
200
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands path discover echo
Release
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines A retry occurs when either an echo reply was not received on time for an outstanding echo request, or when no selectors are found for a given path by a transit router.
When a selector value is configured in MPLSLM configuration mode, the maximum selector specified must be larger than that value. In such a scenario, the range of selectors used for path discovery is set by the two values.
When the interval time is zero, a new echo request is sent after the previous echo retry was received.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to configure the path discover echo interval:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# path discover
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-lpd)# echo interval 777
Related Commands
Command
path discover path, on page 202
path discover scan, on page 204
path discover session, on page 206
Description
Configures MPLS LSP path parameters.
Configures MPLS LSP scan parameters.
Configures MPLS LSP session parameters.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
201
IP Service Level Agreement Commands path discover path
path discover path
To configure MPLS LSP path parameters, use the path discover path command in MPLS LSP monitor
(MPLSLM) LPD configuration submode. To use the default value, use the no form of this command.
path discover path {retry range| secondary frequency {both| connection-loss| timeout} value} no path-discover path
Syntax Description
retry range secondary frequency both connection-loss timeout value
Configures the number of attempts to be performed before declaring a path as down. Default is 1 (LSP group will not retry to perform the echo request if the previous attempt fails). Range is 1 to 16.
Configures a secondary frequency to use after a failure condition (that is, a connection-loss or timeout) occurs.
Enable secondary frequency for a timeout and connection loss.
Enable secondary frequency for only a connection loss.
Enable secondary frequency for only a timeout.
Frequency value range is 1 to 604800.
Command Default None
Command Modes MPLSLM LPD configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines In the event of a path failure, the secondary frequency value is used instead of the normal frequency value.
The normal frequency value is determined by a frequency value or schedule period value, and the LSP operations are scheduled to start periodically at this interval. By default, the secondary frequency value is disabled. When failure condition disappears, probing resumes at the regular frequency.
202
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands path discover path
Task ID
Note The secondary command works in tandem with the retry keyword. Both must be configured.
Task ID monitor
Operations read, write
Examples The following example shows how to configure MPLS LSP path parameters:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# path discover
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-lpd)# path retry 12
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-lpd)# path secondary frequency both 10
Related Commands
Command
path discover echo, on page 200
path discover scan, on page 204
path discover session, on page 206
Description
Configures MPLS LSP echo parameters.
Configures MPLS LSP scan parameters.
Configures MPLS LSP session parameters.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
203
IP Service Level Agreement Commands path discover scan
path discover scan
To configure MPLS LSP scan parameters, use the path discover scan command in MPLS LSP monitor
(MPLSLM) LPD configuration submode. To use the default value, use the no form of this command.
path discover scan period value
no path discover scan period value
Syntax Description
period value Configures the time (in minutes) between consecutive cycles of path discovery requests per MPLSLM instance. Range is 0 to 7200. Default is 5.
Command Default period value : 5
Command Modes MPLSLM LPD configuration submode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines MPLSLM instances periodically trigger path discovery requests for LSP groups. At certain intervals, an
MPLSLM instance begins triggering path discovery requests for each group in ascending order (determined by group ID). By default, the path discovery requests are triggered sequentially, although some concurrency may occur if the session limit value is greater than 1. The cycle concludes when the last LSP group finishes path discovery.
If the duration of the discovery cycle is larger than the scan period, a new cycle starts as soon as the previous one completes.
Task ID
Task ID monitor
Operations read, write
204
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands path discover scan
Examples The following example shows how to configure the path discovery scan period value:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# path discover
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-lpd)# scan period 2
Related Commands
Command
path discover echo, on page 200
path discover path, on page 202
path discover session, on page 206
Description
Configures MPLS LSP echo parameters.
Configures MPLS LSP path parameters.
Configures MPLS LSP session parameters.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
205
IP Service Level Agreement Commands path discover session
path discover session
To configure MPLS LSP session parameters, use the path discover session command in MPLS LSP monitor
(MPLSLM) LPD configuration submode. To use the default value, use the no form of this command.
path discover session {limit value| timeout value}
no path discover session {limit value| timeout value}
Syntax Description
limit value
timeout value
Configures the number of concurrent active path discovery requests the MPLSLM instance submits to the LSPV server. Range is 1 to 15. Default is 1.
Configures the time (in seconds) the MPLSLM instance will wait for the result of a path discovery request submitted to the LSPV server. Range is 1 to 900. Default is 120.
Command Default limit value : 1
timeout value : 120
Command Modes MPLSLM LPD configuration submode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines An MPLSLM instance considers the path discovery as a failure when it receives no response within the configured timeout configuration value.
Task ID
Task ID monitor
Operations read, write
206
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands path discover session
Examples The following example shows how to configure the path discovery session timeout value:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# path discover
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-lpd)# session timeout 22
Related Commands
Command
path discover echo, on page 200
path discover path, on page 202
path discover scan, on page 204
Description
Configures MPLS LSP echo parameters.
Configures MPLS LSP path parameters.
Configures MPLS LSP scan parameters.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
207
IP Service Level Agreement Commands react
react
To specify an element to be monitored for a reaction, use the react command in the appropriate configuration mode. To remove the specified reaction type, use the no form of this command.
react {connection-loss| jitter-average [dest-to-source| source-to-dest]| packet-loss {dest-to-source|
source-to-dest}| rtt| timeout| verify-error}
no react {connection-loss| jitter-average [dest-to-source| source-to-dest]| packet-loss {dest-to-source|
source-to-dest}| rtt| timeout| verify-error}
Syntax Description connection-loss jitter-average
[dest-to-source |
source-to-dest]
Specifies that a reaction occurs if there is a connection-loss for the monitored operation.
Specifies that 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:
• dest-to-source—(Optional) Specifies the jitter average destination to source (DS).
• source-to-dest—(Optional) Specifies the jitter average source to destination (SD).
packet-loss {dest-to-source
| source-to-dest}
Specifies the reaction on packet loss value violation. The following options are listed for the packet-loss keyword:
• dest-to-source—(Optional) Specifies the packet loss destination to source
(DS) violation.
• source-to-dest—(Optional) Specifies the packet loss source to destination
(SD) violation.
rtt timeout verify-error
Specifies that a reaction occurs if the round-trip value violates the upper threshold or lower threshold.
Specifies that a reaction occurs if there is a timeout for the monitored operation.
Specifies that a reaction occurs if there is an error verification violation.
Command Default If there is no default value, no reaction is configured.
Command Modes IP SLA reaction configuration
IP SLA MPLS LSP monitor reaction configuration
208
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands react
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Usage Guidelines For the connection-loss keyword, jitter-average keyword, and rtt keyword, the reaction does not occur when the value violates the upper or the lower threshold. The reaction condition is set when the upper threshold is passed, and it is cleared when values go below the lower threshold.
For the connection-loss keyword and verify-error keyword, thresholds do not apply to the monitored element.
For the jitter-average keyword, packet-loss keyword, and rtt keyword, if the upper threshold for react threshold type average 3 is configured as 5000 ms and the last three results of the operation are 6000, 6000, and 5000 ms, the average is 6000 + 6000 + 5000=17000/3 = 5667—therefore violating the 5000-ms upper threshold. The threshold type average must be configured when setting the type. These keywords are not available if connection-loss, timeout, or verify-error is specified as the monitored element, because upper and lower thresholds do not apply to these options.
In IP SLA MPLS LSP monitor reaction configuration mode, only the connection-loss and timeout keywords are available. If the react command is used in IP SLA MPLS LSP monitor reaction configuration mode, it configures all operations associated with the monitored provider edge (PE) routers. The configuration is inherited by all LSP operations that are created automatically by the PE discovery.
Task ID
Task ID monitor
Operations read, write
Examples
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor reaction configuration mode.
This command was introduced.
This command was introduced.
The following example shows how to use the react command with the connection-loss keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react connection-loss
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
The following example shows how to use the react command with the jitter-average keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
209
IP Service Level Agreement Commands react
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
The following example shows how to use the react command with the packet-loss keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react packet-loss dest-to-source
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
The following example shows how to use the react command with the rtt keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react rtt
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
The following example shows how to use the react command with the timeout keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react timeout
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
The following example shows how to use the react command with the verify-error keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react verify-error
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)#
Related Commands
Command
schedule operation, on page 236
threshold type average, on page 299
threshold type consecutive, on page 301
threshold type immediate, on page 303
threshold type xofy, on page 305
Description
Specifies what action or combination of actions the operation performs when you configure the react command or when threshold events occur.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Sets the lower-limit and upper-limit values.
Takes action on average values to violate a threshold.
Takes action after a number of consecutive violations.
Takes action immediately upon a threshold violation.
Takes action upon X violations in Y probe operations.
210
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands react lpd
react lpd
To specify that a reaction should occur if there is an LSP Path Discovery (LPD) violation, use the react lpd command in the appropriate configuration mode. To use the default value, use the no form of this command.
react lpd {lpd-group| tree-trace} action logging
no react lpd {lpd-group| tree-trace}
Syntax Description lpd-group tree-trace action logging
Specifies that a reaction should occur if there is a status violation for the monitored LPD group.
Specifies that a reaction should occur if there is a path discovery violation for the monitored LPD group.
Configures the action to be taken on threshold violation.
Specifies the generation of a syslog alarm on threshold violation.
Command Default None
Command Modes IP SLA MPLS LSP monitor configuration
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines A status violation for a monitored LPD group happens when the Label Switched Path (LSP) group status changes (with the exception of the status change from the initial state).
A path discovery violation for the monitored LPD group happens when path discovery to the target PE fails, or successful path discovery clears such a failure condition.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
211 OL-26517-02
IP Service Level Agreement Commands react lpd
Examples The following example shows how to specify that a reaction should occur if there is a status violation for the monitored LPD group:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# reaction monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react)# react lpd lpd-group action logging
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
212
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands reaction monitor
reaction monitor
To configure MPLS label switched path (LSP) monitoring reactions, use the reaction monitor command in
IP SLA MPLS LSP monitor configuration mode. To remove the reaction so that no reaction occurs, use the
no form of this command.
reaction monitor monitor-id
no reaction monitor [ monitor-id ]
Syntax Description monitor-id Number of the IP SLA MPLS LSP monitor instance for the reactions to be configured. Range is 1 to 2048.
Command Default No reaction is configured.
Command Modes IP SLA MPLS LSP monitor configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The reaction monitor command enters IP SLA LSP monitor reaction configuration mode so that you can set the desired threshold and action in the event of a connection loss or timeout.
To remove all reactions, use the no reaction monitor command with no monitor-id argument.
The reaction monitor command configures reactions for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
213 OL-26517-02
IP Service Level Agreement Commands reaction monitor
Examples The following example shows how to use the reaction operation command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# reaction monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react)#
Related Commands
Command
threshold type consecutive, on page 301
threshold type immediate, on page 303
Description
Specifies what action or combination of actions the operation performs when you configure the react command or when threshold events occur.
Configures an IP SLA MPLS LSP monitor instance.
Specifies an element to be monitored for a reaction.
Schedules an IP SLA MPLS LSP monitor instance.
Specifies to take action after a number of consecutive violations.
Specifies to take action immediately upon a threshold violation.
214
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands reaction operation
reaction operation
To configure certain actions that are based on events under the control of the IP SLA agent, use the reaction
operation command in IP SLA configuration mode.To remove the reaction so that no reaction occurs, use the no form of this command.
reaction operation operation-id
no reaction operation operation-id
Syntax Description operation-id Number of the IP SLA operation for the reactions to be configured. Range is 1 to 2048.
Command Default No reaction is configured.
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the reaction operation command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
215 OL-26517-02
IP Service Level Agreement Commands reaction operation
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
216
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands reaction trigger
reaction trigger
To define a second IP SLA operation to make the transition from a pending state to an active state when one of the trigger-type options is defined with the reaction operation command, use the reaction trigger command in IP SLA configuration mode. To remove the reaction trigger when the triggering-operation argument does not trigger any other operation, use the no form of this command.
reaction trigger triggering-operation triggered-operation
no reaction trigger triggering-operation triggered-operation
Syntax Description triggering-operation triggered-operation
Operation that contains a configured action-type trigger and can generate reaction events. Range is 1 to 2048.
Operation that is started when the triggering-operation argument generates a trigger reaction event. Range is 1 to 2048.
Command Default No triggered operation is configured.
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Both the triggering-operation and triggered-operation arguments must be configured. The triggered operation must be in the pending state.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
217 OL-26517-02
IP Service Level Agreement Commands reaction trigger
Examples The following example shows how to use the ipsla reaction trigger command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction trigger 1 2
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
218
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands responder
responder
To enable the IP SLA responder for UDP echo or jitter operations, use the responder command in IP SLA configuration mode. To disable the responder, use the no form of this command.
responder no responder
Syntax Description This command has no keywords or arguments.
Command Default The IP SLA responder command is disabled.
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines An IP address and port are configured and identified as a permanent port (for example, a port to which the responder is permanently listening). If no IP address and port are configured, the responder handles only dynamic ports (for example, ports that are listened to when requested by a remote operation).
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to enable the IP SLA responder:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# responder
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-resp)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
219 OL-26517-02
IP Service Level Agreement Commands responder
Related Commands
Command
type udp ipv4 address, on page 327
Description
Configures a permanent port in the IP SLA Responder for UDP echo or jitter operations.
220
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands recurring
recurring
To indicate that the operation starts automatically at the specified time and for the specified duration every day, use the recurring command in IP SLA schedule configuration mode. To not start the operation everyday, use the no form of this command.
recurring no recurring
Syntax Description This command has no keywords or arguments.
Command Default Recurring is disabled.
Command Modes IP SLA schedule configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the recurring command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)# recurring
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
221 OL-26517-02
IP Service Level Agreement Commands recurring
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
222
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands reply dscp
reply dscp
To specify the differentiated services codepoint (DSCP) value used in echo reply packets, use the reply dscp command in the appropriate configuration mode. To return to the default value, use the no form of this command.
reply dscp dscp-bits no reply dscp
Syntax Description dscp-bits Differentiated services codepoint (DSCP) value for an echo reply packet. Valid values are from 0 to 63.
Reserved keywords such as EF (expedited forwarding) and AF11 (assured forwarding class AF11) can be specified instead of numeric values.
Command Default No default behavior or values
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines Use the reply dscp command to set the DCSP value used in the headers of IPv4 UDP packets sent as echo replies in an MPLS LSP ping or MPLS LSP trace operation.
The DSCP value consists of the six most significant bits of the 1-byte IP type of service (ToS) field. These bits determine the quality-of-service (QoS) treatment (per-hop behavior) that an transit LSR node gives to an echo reply packet. For information about how packets are classified and processed depending on the value
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
223 OL-26517-02
IP Service Level Agreement Commands reply dscp
Task ID you assign to the 6-bit DSCP field, refer to “The Differentiated Services Model (DiffServ)” at the following
URL: http://www.cisco.com/en/US/products/ps6610/products_data_sheet09186a00800a3e30.html
If the reply dscp command is used in IP SLA operation mode, it acts on the headers of echo replies for the specific operation being configured. If the reply dscp command is used in IP SLA MPLS LSP monitor mode, it acts on the headers of echo replies for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the reply dscp command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)# reply dscp 5
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
224
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands reply mode
reply mode
To specify how to reply to echo requests, use the reply mode command in the appropriate configuration mode.
To return to the default value, use the no form of this command.
reply mode {control-channel| router-alert} no reply mode
Syntax Description control-channel router-alert
Sets echo requests to reply by way of a control channel.
Note This option is available only in IP SLA MPLS LSP ping configuration mode.
Sets echo requests to reply as an IPv4 UDP packet with IP router alert.
Command Default The default reply mode for an echo request packet is an IPv4 UDP packet without IP router alert set.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
The control-channel keyword was added in IP SLA MPLS LSP ping configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines Use the reply mode command with the control-channel keyword to send echo reply packets by way of a control channel in an MPLS LSP ping operation. If the target is not set to pseudowire, the configuration of
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
225 OL-26517-02
IP Service Level Agreement Commands reply mode
Task ID the control-channel keyword is rejected. Refer to the target pseudowire command for information about setting the target.
Use the reply mode command with the router-alert keyword to set the reply mode of echo reply packets in an MPLS LSP ping or MPLS LSP trace operation. After you enter this command, echo reply packets are set to reply as an IPv4 UDP packet with the IP router alert option in the UDP packet header.
If the reply mode command is used in IP SLA operation mode, it sets the reply mode of echo reply packets for the specific operation being configured. If the reply mode command is used in IP SLA MPLS LSP monitor mode, it sets the reply mode of echo reply packets for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
The router-alert reply mode forces an echo reply packet to be specially handled by the transit LSR router at each intermediate hop as it moves back to the destination. Because this reply mode is more expensive, it is recommended only if the headend router does not receive echo replies using the default reply mode.
Task ID monitor
Operations read, write
Examples The following example shows how to use the reply mode command with the router-alert keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# reply mode router-alert
The following example shows how to use the reply mode command with the control-channel keyword:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)# target pseudowire 192.168.1.4
4211
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)# reply mode control-channel
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
226
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands responder twamp
responder twamp
To configure the TWAMP responder, use the responder twamp command in the appropriate mode. To remove the set configuration, use the no form of the command.
responder twamp[ timeout value ]
no responder twamp [ timeout value ]
Syntax Description
timeout value Inactivity timeout period (in seconds). Range is 1 to 604800.
Command Default Default timeout is 900 seconds.
Command Modes IPSLA configuration mode
Command History
Release
Release 5.1.1
Modification
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operation read, write
Examples This example shows how to run the responder twamp command:
RP/0/0RP0RSP0/CPU0:router:hostname (config-ipsla) # responder twamp timeout 100
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
227
IP Service Level Agreement Commands samples
samples
To set the number of hop entries that are kept in the history table for an IP SLA ICMP path-echo operation, use the samples command in IP SLA operation ICMP path-echo history configuration mode. To use the default value, use the no form of this command.
samples sample-count no samples
Syntax Description sample-count Number of history samples that are kept in the history table for an IP SLA ICMP path-echo operation. Range is 1 to 30.
Command Default The default value is 16.
Command Modes IP SLA operation ICMP path-echo history configuration
Command History
Release
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The samples command is supported only when you configure an IP SLA ICMP path-echo operation.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the samples command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-echo)# history
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-hist)# samples 30
228
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Related Commands
Command
buckets (history), on page 134
schedule operation, on page 236
samples
Description
Sets the number of history buckets that are kept during the lifetime of the IP SLA operation.
Defines the type of information that are kept in the history table for the IP SLA operation.
Configures the history parameters for the IP SLA operation.
Configures an IP SLA operation.
Schedules an IP SLA operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
229
IP Service Level Agreement Commands scan delete-factor
scan delete-factor
To specify the frequency with which the MPLS LSP monitor (MPLSLM) instance searches for provider edge
(PE) routers to delete, use the scan delete-factor command in the appropriate configuration mode. To return to the default value, use the no form of this command.
scan delete-factor factor-value no scan delete-factor
Syntax Description factor-value Specifies a factor that is multiplied by the scan interval to determine the frequency at which the MPLS LSP monitor instance deletes the provider edge (PE) routers that are no longer valid. Range is 0 to 2147483647.
Command Default factor-value: 1
Command Modes IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The scan delete-factor command specifies a factor value for automatic PE deletion. The specified factor-value is multiplied by the scan interval to acquire the frequency at which the MPLS LSP monitoring instance deletes not-found PEs. A scan delete factor of zero (0) means that provider edge (PE) routers that are no longer valid are never removed.
Task ID
Task ID monitor
Operations read, write
230
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands scan delete-factor
Examples The following example shows how to use the scan delete-factor command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# scan delete-factor 214
Related Commands
Command
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA MPLS LSP monitor instance.
Specifies the frequency at which the MPLSLM instance checks the scan queue for updates.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
231
IP Service Level Agreement Commands scan interval
scan interval
To specify the frequency at which the MPLS LSP monitor (MPLSLM) instance checks the scan queue for updates, use the scan interval command in the appropriate configuration mode. To return to the default value, use the no form of this command.
scan interval scan-interval no scan interval
Syntax Description scan-interval Time interval between provider edge (PE) router updates. Range is
1 to 70560.
Command Default interval: 240 minutes
Command Modes IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the scan interval command to specify a frequency value in minutes at which the MPLS LSP monitoring instance checks the scan queue for PE updates. Updates from PE discovery are not processed immediately, but rather stored in a scan queue for batched processing at periodic intervals, specified by this value.
Task ID
Task ID monitor
Operations read, write
232
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands scan interval
Examples The following example shows how to use the scan command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# scan interval 120
Related Commands
Command
scan delete-factor, on page 230
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Specifies the frequency with which the MPLSLM instance searches for PE routers to delete.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
233
IP Service Level Agreement Commands schedule monitor
schedule monitor
To schedule MPLS LSP monitoring instances, use the schedule monitor command in IP SLA LSP monitor configuration mode. To unschedule the monitoring instances, use the no form of this command.
schedule monitor monitor-id
no schedule monitor [ monitor-id ]
Syntax Description monitor-id Number of the monitoring instance to schedule. Range is 1 to 2048.
Command Default No schedule is configured.
Command Modes IP SLA MPLS LSP monitor configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The schedule monitor command enters IP SLA MPLS LSP monitor schedule configuration mode so that you can set the desired schedule parameters for the MPLS LSP monitor instance. This schedules the running of all operations created for the specified monitor instance.
To remove all configured schedulers, use the no schedule monitor command with no monitor-id argument.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to access and use the schedule monitor command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
234
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands schedule monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# schedule monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-sched)#
Related Commands
Command
frequency (IP SLA), on page 159
Description
Configures the frequency interval during which LSP groups and operations are scheduled to start.
Configures the amount of time during which all LSP operations are scheduled to start or run.
Determines the time when an operation starts.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
235
IP Service Level Agreement Commands schedule operation
schedule operation
To enter schedule configuration mode, use the schedule operation command in IP SLA configuration mode.
To remove the scheduler, use the no form of this command.
schedule operation operation-number
no schedule operation operation-number
Syntax Description operation-number Configuration number or schedule number that is used to schedule an IP
SLA operation. Range is 1 to 2048.
Command Default None
Command Modes IP SLA configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The schedule operation command enters the IP SLA schedule configuration mode. You can configure more schedule configuration parameters to schedule the operation. When an operation is scheduled, it continues collecting information until the configured life expires.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the ipsla schedule operation command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)#
236
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Related Commands
Command
schedule operation
Description
Specifies the number of seconds to keep the operation in memory when it is not actively collecting information.
Configures an IP SLA operation.
Specifies the length of time to execute.
Indicates that the operation starts automatically at the specified time and for the specified duration every day.
Determines the time when the operation starts.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
237
IP Service Level Agreement Commands schedule period
schedule period
To configure the amount of time during which all LSP operations are scheduled to start or run, use the schedule
period command in IP SLA MPLS LSP monitor schedule configuration mode. To remove the scheduler, use the no form of this command.
schedule period seconds no schedule period
Syntax Description seconds Amount of time in seconds for which label switched path (LSP) operations are scheduled to run. Range is 1 to 604800.
Command Default None
Command Modes IP SLA MPLS LSP monitor schedule configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the schedule period command to specify the amount of time in seconds during which all LSP operations are scheduled to start running. All LSP operations are scheduled equally spaced throughout the schedule period.
For example, if the schedule period is 600 seconds and there are 60 operations to be scheduled, they are scheduled at 10-second intervals.
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 configure the schedule period before you can start MPLS LSP monitoring. Start MPLS LSP monitoring using the start-time command.
Task ID
Task ID monitor
Operations read, write
238
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands schedule period
Examples The following example shows how to use the schedule period command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# schedule monitor 20
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-sched)# schedule period 6000
Related Commands
Command
frequency (IP SLA), on page 159
Description
Configures the frequency interval during which LSP groups and operations are scheduled to start.
Determines the time when the operation starts.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
239
IP Service Level Agreement Commands server twamp
server twamp
To configure the TWAMP server, use the server twamp command in the appropriate mode. To remove the set configuration, use the no form of the command.
server twamp [ port number | timer inactivity value ]
noserver twamp [ port number | timer inactivity value ]
Syntax Description port number timer
inactivity value
Configures the port for the server.
Port number. Range is 1 to 65535.
Configures the timer for the server.
Inactivity timer value in seconds. Range is 1 to 6000.
Command Default Default port is 862.
Default timer value is 900 seconds.
Command Modes IPSLA configuration mode
Command History
Release
Release 5.1.1
Modification
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operation read, write
Examples This example shows how to use the server twamp command:
RP/0/0RP0RSP0/CPU0:router:hostname (config-ipsla) # server twamp timer inactivity 100
240
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla application
show ipsla application
To display the information for the IP SLA application, use the show ipsla application command in EXEC modeXR EXEC mode.
show ipsla application
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples The following sample output is from the show ipsla application command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla application
Estimated system max number of entries: 2048
Number of Entries configured: 1
Number of active Entries : 0
Number of pending Entries : 0
Number of inactive Entries : 1
Supported Operation Types: 7
Type of Operation: ICMP ECHO
Type of Operation: ICMP PATH JITTER
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
241 OL-26517-02
IP Service Level Agreement Commands show ipsla application
Type of Operation: ICMP PATH ECHO
Type of Operation: UDP JITTER
Type of Operation: UDP ECHO
Type of Operation: MPLS LSP PING
Type of Operation: MPLS LSP TRACE
Number of configurable probes : 2047
SA Agent low memory water mark: 20480 (KB)
RP/0/0RP0RSP0/CPU0:router:hostname#show ipsla application
Estimated system max number of entries: 2048
Number of Entries configured: 143
Number of active Entries : 111
Number of pending Entries : 0
Number of inactive Entries : 32
Supported Operation Types: 1
Type of Operation: UDP JITTER
Number of configurable probes : 1905
SA Agent low memory water mark: 20480 (KB)
This table describes the significant fields shown in the display.
Table 14: show ipsla application Field Descriptions
Field
Estimated system max number of entries
Number of Entries configured
Number of active Entries
Number of pending Entries
Number of inactive Entries
Supported Operation Types
Number of configurable probes
Description
Maximum number of operations that are configured in the system. The low-memory configured parameter and the available memory in the system are given.
Total number of entries that are configured, such as active state, pending state, and inactive state.
Number of entries that are in the active state. The active entries are scheduled and have already started a life period.
Number of entries that are in pending state. The pending entries have a start-time scheduled in the future. These entries either have not started the first life, or the entries are configured as recurring and completed one of its life.
Number of entries that are in the inactive state. The inactive entries do not have a start-time scheduled.
Either the start-time has never been scheduled or life has expired. In addition, the entries are not configured as recurring.
Types of operations that are supported by the system.
Number of remaining entries that can be configured.
The number is just an estimated value and it may vary over time according to the available resources.
242
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Field
SA Agent low memory water mark
Related Commands
Command
show ipsla application
Description
Available memory for the minimum system below which the IP SLA feature does not configure any more operations.
Description
Configures a low-water memory mark.
Configures an IP SLA operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
243
IP Service Level Agreement Commands show ipsla history
show ipsla history
To display the history collected for all IP SLA operations or for a specified operation, use the show ipsla
history command in EXEC modeXR EXEC mode.
show ipsla history [ operation-number ]
Syntax Description operation-number (Optional) Number of the IP SLA operation.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines
4
5
2
3
Code
1
By default, history statistics are not collected. To have any data displayed by using the show ipsla history command, you must configure the history collection.
This table lists the response return values that are used in the show ipsla history command.
Table 15: Response Return Values for the show ipsla history Command
Description
Okay
Disconnected
Over Threshold
Timeout
Busy
244
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla history
Task ID
Examples
8
9
10
Code
6
7
Description
Not Connected
Dropped
Sequence Error
Verify Error
Application Specific
If the default tabular format is used, the response return description is displayed as code in the Sense column.
The Sense field is always used as a return code.
Task ID monitor
Operations read
The following sample output is from the show ipsla history command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla history 1
Point by point History
Multiple Lines per Entry
Line 1:
Entry
LifeI
= Entry number
= Life index
BucketI = Bucket index
SampleI = Sample index
SampleT = Sample start time
CompT = RTT (milliseconds)
Sense = Response return code
1
1
1
Line 2 has the Target Address
Entry LifeI BucketI SampleI
1 0 0 0
0
0
0
1
2
3
0
0
0
SampleT CompT
1134419252539 9
1134419312509 6
1134419372510 6
1134419432510 5
This table describes the significant fields shown in the display.
Table 16: show ipsla history Field Descriptions
Field
Entry number
LifeI
BucketI
Description
Entry number.
Life index.
Bucket index.
Sense
1
1
1
1
TargetAddr
192.0.2.6
192.0.2.6
192.0.2.6
192.0.2.6
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
245
IP Service Level Agreement Commands show ipsla history
Field
SampleI
SampleT
CompT
Sense
TargetAddr
Description
Sample index.
Sample start time.
Completion time in milliseconds.
Response return code.
IP address of intermediate hop device or destination device.
Related Commands
Command
show ipsla statistics aggregated, on page 262
Description
Displays the statistical errors for all the IP SLA operations or for a specified operation.
246
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla mpls discovery vpn
show ipsla mpls discovery vpn
To display routing information relating to the BGP next-hop discovery database in the MPLS VPN network, use the show ipsla mpls discovery vpn command in EXEC modeXR EXEC mode.
show ipsla mpls discovery vpn
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples The following sample output is from the show ipsla mpls discovery vpn command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls discovery vpn
Next refresh after: 46 seconds
BGP next hop
192.255.0.4
Prefix
192.255.0.4/32
192.255.0.5
192.254.1.6
192.255.0.5/32
192.254.1.0/24
VRF red blue green red green yellow
5
3
4
PfxCount
10
5
7
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
247 OL-26517-02
IP Service Level Agreement Commands show ipsla mpls discovery vpn
This table describes the significant fields shown in the display.
Table 17: show ipsla mpls discovery vpn Field Descriptions
Field
BGP next hop
Prefix
VRF
PfxCount
Description
Identifier for the BGP next-hop neighbor.
IPv4 Forward Equivalence Class (FEC) of the BGP next-hop neighbor to be used by the MPLS LSP ping or trace operation.
Names of the virtual routing and forwarding instances
(VRFs) that contain routing entries for the specified
BGP next-hop neighbor.
Count of the routing entries that participate in the
VRF for the specified BGP next-hop neighbor.
248
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor lpd
show ipsla mpls lsp-monitor lpd
To display LSP Path Discovery (LPD) operational status, use the show ipsla mpls lsp-monitor lpd command in EXEC modeXR EXEC mode.
show ipsla mpls lsp-monitor lpd {statistics [group-ID| aggregated group-ID]| summary group}
statistics group-ID
aggregated group-ID
summary group- ID
Displays statistics for the specified LPD group, including the latest LPD start time, return code, completion time, and paths.
Displays the aggregated statistics of the LPD group.
Displays the current LPD operational status, which includes LPD start time, return code, completion time, and all ECMP path information.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.6.0
Release 3.6.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines For the aggregated group ID, a maximum of two buckets are allowed.
Task ID
Task ID monitor
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
249 OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor lpd
Examples The following sample output is from the show ipsla mpls lsp-monitor lpd statistics command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls lsp-monitor lpd statistics 10001
Group ID: 100001
Latest path discovery start time : 00:41:01.129 UTC Sat Dec 10 2005
Latest path discovery return code : OK
Latest path discovery completion time (ms): 3450
Completion Time Values:
CompTAvg: 3450 NumOfCompT: 1 CompTMin: 3450
Number of Paths Values:
CompTMax : 3450
NumOfPaths: 10 MinNumOfPaths: 10 MaxNumOfPaths: 10
This table describes the significant fields shown in the display.
Table 18: show ipsla mpls lsp-monitor lpd statistics Field Descriptions
Field
Group ID
Latest path discovery start time
Latest path discovery return code
Latest path discovery completion time
Completion Time Values
Number of Paths Values
Description
LPD group ID number.
LPD start time.
LPD return code.
LPD completion time.
Completion time values, consisting of Number of
Completion Time samples and Minimum Completion
Time.
Number of paths values, consisting of Minimum number of paths and Maximum number of paths.
250
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor scan-queue
show ipsla mpls lsp-monitor scan-queue
To display information about BGP next-hop addresses that are waiting to be added to or deleted from the
MPLS label switched path (LSP) monitor instance, use the show ipsla mpls lsp-monitor scan-queue command in EXEC modeXR EXEC mode.
show ipsla mpls lsp-monitor scan-queue [ monitor-id ]
Syntax Description monitor-id (Optional) Number of the IP SLA MPLS LSP monitor instance.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines If the monitor-id argument is not specified, the scan-queue is displayed for all MPLS LSP monitor instances.
Task ID
Task ID monitor
Operations read
Examples The following sample output is from the show ipsla mpls lsp-monitor scan-queue command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls lsp-monitor scan-queue 1
IPSLA MPLS LSP Monitor : 1
Next scan Time after : 23 seconds
Next Delete scan Time after: 83 seconds
BGP Next hop Prefix Add/Delete?
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
251 OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor scan-queue
192.255.0.2
192.255.0.3
192.255.0.2/32
192.255.0.5/32
Add
Delete
This table describes the significant fields shown in the display.
Table 19: show ipsla responder statistics port Field Descriptions
Field
IPSLA MPLS LSP Monitor
Next scan Time after
Next delete Time after
BGP next hop
Prefix
Add/Delete
Description
Monitor identifier.
Amount of time before the MPLS LSP monitor instance checks the scan queue for adding BGP next-hop neighbors. At the start of each scan time, IP
SLA operations are created for all newly discovered neighbors.
Amount of time left before the MPLS LSP monitor instance checks the scan queue for deleting BGP next-hop neighbors. At the start of each delete scan time, IP SLAs operations are deleted for neighbors that are no longer valid.
Identifier for the BGP next-hop neighbor.
IPv4 Forward Equivalence Class (FEC) of the BGP next-hop neighbor to be used.
Indicates that the specified BGP next-hop neighbor will be added or removed.
252
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor summary
show ipsla mpls lsp-monitor summary
To display the list of operations that have been created automatically by the specified MPLS LSP monitor
(MPLSLM) instance, use the show ipsla mpls lsp-monitor summary command in EXEC modeXR EXEC mode.
show ipsla mpls lsp-monitor summary [monitor-id [group [group id]]]
Syntax Description monitor-id
group group-id
(Optional) Displays a list of LSP group, ping, and trace operations created automatically by the specified MPLSLM instance.
(Optional) Displays the ECMP LSPs found through ECMP path discovery within the specified LSP group.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Show output response was expanded to add a pending status when waiting for an LSP ping or trace response.
This command was introduced.
This command was introduced.
Usage Guidelines The show ipsla mpls lsp-monitor summary command shows the list of LSP operations that were created automatically by the specified MPLS LSP monitor instance. It also shows the current status and the latest operation time of each operation.
If the monitor-id argument is not specified, the list of operations is displayed for all MPLS LSP monitor instances.
The show ipsla mpls lsp-monitor summary command with the group option shows the list of ECMP paths that are found automatically by the specified LSP path discovery (LPD). In addition, this command with option shows the current status; the number of successes, failures; the most recent round trip time (RTT); and the latest operation time of each path.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
253 OL-26517-02
IP Service Level Agreement Commands
Task ID show ipsla mpls lsp-monitor summary
Examples
If the group-id argument is not specified, the list of paths is displayed for all operations created by the MPLS
LSP monitor instance.
Task ID monitor
Operations read
The following sample output is from the show ipsla mpls lsp-monitor summary command. This output shows a pending status when an MPLS LSP ping operation is waiting to receive the timeout response from the LSP Verification (LSPV) process.
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls lsp-monitor summary 1
MonID Op/GrpID TargetAddress
1
1
1
100001
100002
100003
192.255.0.4/32
192.255.0.5/32
192.255.0.6/32
Status Latest Operation Time up down
19:33:37.915 EST Mon Feb 28 2005
19:33:47.915 EST Mon Feb 28 2005 pending 19:33:35.915 EST Mon Feb 28 2005
The following sample output shows that a down status is displayed after a timeout response is received.
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls lsp-monitor summary 1
1
1
1
MonID Op/GrpID TargetAddress
1
1
100001
100002
193.100.0.1/32
193.100.0.2/32
100003
100004
100005
193.100.0.3/32
193.100.0.4/32
193.100.0.5/32
Status Latest Operation Time down 12:47:16.417 PST Tue Oct 23 2007 partial 12:47:22.418 PST Tue Oct 23 2007 partial 12:47:22.429 PST Tue Oct 23 2007 down 12:47:16.429 PST Tue Oct 23 2007 down 12:47:21.428 PST Tue Oct 23 2007
This table describes the significant fields shown in the display.
Table 20: show ipsla mpls lsp-monitor summary Field Descriptions
Field
MonID
Op/GrpID
TargetAddress
Status
Description
Monitor identifier.
Operation identifiers that have been created by this
MPLS LSP monitor instance.
IPv4 Forward Equivalence Class (FEC) to be used by this operation.
Status of the paths. Values can be as follows:
• up—Indicates that the latest operation cycle was successful.
• down—Indicates that the latest operation cycle was not successful.
• pending—Indicates that the latest operation cycle is waiting for an LSP ping or trace response.
254
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla mpls lsp-monitor summary
Field
Latest Operation Time
Description
Time the latest operation cycle was issued.
The following sample output is from the show ipsla mpls lsp-monitor summary group command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla mpls lsp-monitor summary 1 group 100001
GrpID LSP-Selector
100001 127.0.0.13
100001 127.0.0.15
100001 127.0.0.16
100001 127.0.0.26
Status Failure Success RTT Latest Operation Time up 0 retry 1
78
77
32
0
20:11:37.895 EST Feb 28 2005
20:11:37.995 EST Feb 28 2005 up up
0
0
78
78
32
32
20:11:38.067 EST Feb 28 2005
20:11:38.175 EST Feb 28 2005
This table describes the significant fields shown in the display.
Table 21: show ipsla mpls lsp-monitor summary group Field Descriptions
Field
GrpID
LSP-Selector
Status
Description
Group identifer that has been created by this MPLS
LSP monitor instance.
LSP selector address.
Status of the paths. Values can be as follows:
• up—Indicates that all the paths were successful.
• down—Indicates that all the paths were not successful.
• partial—Indicates that only some paths were successful.
• unknown—Indicates that some (or all) of the paths did not complete a single LSP echo request so the group status could not be identified.
Failure
Success
RTT
Latest Operation Time
Number of failures.
Number of successes.
Round Trip Time (RTT) in milliseconds of the latest
LSP echo request for the path.
Time the latest operation cycle was issued for the path.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
255
IP Service Level Agreement Commands show ipsla responder statistics
show ipsla responder statistics
To display the number of probes that are received or handled by the currently active ports on the responder, use the show ipsla responder statistics ports command in EXEC modeXR EXEC mode.
show ipsla responder statistics {all| permanent} ports
Syntax Description all permanent
Port statistics is displayed for all ports.
Port statistics is displayed only for permanent ports.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The output of the show ipsla responder statistics port command is available only for specific intervals of time in which only nonpermanent ports are being used at the responder. The reason is that the responder closes the nonpermanent ports after each operation cycle. However, if both permanent and nonpermanent ports are used, the output always contains rows for the permanent ports. The rows for the nonpermanent ports are displayed only if those nonpermanent ports are enabled at the instant the command is issued.
Task ID
Task ID monitor
Operations read
Examples The following sample output is from the show ipsla responder statistics port command:
256
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla responder statistics
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla responder statistics all port
Port Statistics
---------------
Local Address Port Port Type Probes Drops CtrlProbes Discard
172.16.5.1
3001 Permanent 0 0 0
172.16.5.1
172.16.5.5
172.16.5.1
10001 Permanent
8201 Dynamic
4441 Dynamic
728160
12132
207216
0
0
0
24272
12135
3641
ON
ON
This table describes the significant fields shown in the display.
Table 22: show ipsla responder statistics port Field Descriptions
Field
Local Address
Port
Port Type
Probes
Drops
CtrlProbes
Discard
Description
Local IP address of the responder device used to respond to IPSLA probes.
UDP socket local to the responder device used to respond to IPSLA probes.
It could be "permanent" or "dynamic"; depends upon whether a permanent port configuration is done.
Number of probe packets the responder has received.
Number of probes dropped.
Number of control packets the responder has received.
If the state is ON, the responder will not respond to probes.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
257
IP Service Level Agreement Commands show ipsla statistics
show ipsla statistics
To display the operational data and the latest statistics for the IP SLA operation in tabular format, use the
show ipsla statistics command in EXEC modeXR EXEC mode.
show ipsla statistics [ operation-number ]
Syntax Description operation-number (Optional) Operation for which the latest statistics are to be displayed.
Range is 1 to 2048.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.6.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Show output was expanded to include path information for LSP groups.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples The output of the show ipsla statistics command varies depending on the operation type.
The following sample output is from the show ipsla statistics command for an ICMP echo operation:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics 100025
Entry number: 100025
258
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics
OL-26517-02
Modification time: 00:36:58.602 UTC Sat Dec 10 2007
Start time : 00:36:58.605 UTC Sat Dec 10 2007
Number of operations attempted: 5
Number of operations skipped : 0
Current seconds left in Life : Forever
Operational state of entry
Connection loss occurred
Timeout occurred
Latest RTT (milliseconds)
: Active
: FALSE
: FALSE
: 3
Latest operation start time : 00:41:01.129 UTC Sat Dec 10 2007
Latest operation return code : OK
RTT Values:
RTTAvg : 71
NumOfRTT: 1
Path Information:
Path Path LSP
Idx Sense Selector
1 1 127.0.0.13
RTTMin: 71
RTTSum: 71
Outgoing
Interface
PO0/2/5/0
RTTMax : 71
RTTSum2: 729
Nexthop
Address
192.12.1.2
Downstream
Label Stack
38
2
3
4
5
6
1
1
1
1
1
7
8
1
1
9 1
10 1
127.0.0.6
127.0.0.1
127.0.0.2
127.0.0.13
127.0.0.6
127.0.0.1
127.0.0.2
127.0.0.4
127.0.0.5
PO0/2/5/0
PO0/2/5/0
PO0/2/5/0
PO0/2/5/1
PO0/2/5/1
PO0/2/5/1
PO0/2/5/1
Gi0/2/0/0
Gi0/2/0/0
192.12.1.2
192.12.1.2
192.12.1.2
192.12.2.2
192.12.2.2
192.12.2.2
192.12.2.2
192.15.1.2
192.15.1.2
38
38
38
38
38
38
38
38
38
The following sample output is from the show ipsla statistics command for an UDP jitter operation:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics
Entry number: 101
Modification time: 16:39:36.608 GMT Fri Nov 28 2014
Start time : 16:39:36.633 GMT Fri Nov 28 2014
Number of operations attempted: 10
Number of operations skipped : 0
Current seconds left in Life : Forever
Operational state of entry : Active
Operational frequency(seconds): 60
Connection loss occurred : FALSE
Timeout occurred
Latest RTT (milliseconds)
: FALSE
: 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
NumOfRTT: 10
Packet Loss Values:
RTTMin: 3
RTTSum: 33
RTTMax : 4
RTTSum2: 111
PacketLossSD
Errors
: 0
PacketOutOfSequence: 0
PacketLateArrival : 0
: 0
InvalidTimestamp : 0
PacketLossDS : 0
PacketMIA : 0
PacketSkipped: 0
Busies : 0
Jitter Values :
MinOfPositivesSD: 1
NumOfPositivesSD: 2
Sum2PositivesSD : 2
MaxOfPositivesSD: 1
SumOfPositivesSD: 2
MinOfNegativesSD: 1
NumOfNegativesSD: 1
Sum2NegativesSD : 1
MinOfPositivesDS: 1
NumOfPositivesDS: 1
MaxOfNegativesSD: 1
SumOfNegativesSD: 1
Sum2PositivesDS : 1
MinOfNegativesDS: 1
NumOfNegativesDS: 1
Sum2NegativesDS : 1
JitterAve: 1
MaxOfNegativesDS: 1
SumOfNegativesDS: 1
JitterSDAve: 1
Interarrival jitterout: 0
One Way Values :
JitterDSAve: 1
Interarrival jitterin: 0
NumOfOW: 0
OWMinSD : 0
MaxOfPositivesDS: 1
SumOfPositivesDS: 1
OWMaxSD: 0 OWSumSD: 0
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
259
IP Service Level Agreement Commands show ipsla statistics
OWSum2SD: 0
OWMinDS : 0
OWSum2DS: 0
OWAveSD: 0
OWMaxDS: 0
OWAveDS: 0
OWSumDS: 0
This table describes the significant fields shown in the display.
Table 23: show ipsla statistics Field Descriptions
Field
Entry number
Modification time
Start time
Number of operations attempted
Number of operations skipped
Current seconds left in Life
Operational state of entry
Connection loss occurred
Timeout occurred
Latest RTT (milliseconds)
Latest operation start time
Latest operation return code
RTTAvg
RTTMin
RTTMax
NumOfRTT
RTTSum
RTTSum2
Description
Entry number.
Latest time the operation was modified.
Time the operation was started.
Number of operation cycles that were issued.
Number of operation cycles that were not issued because one of the cycles extended over the configured time interval.
Time remaining until the operation stops execution.
State of the operation, such as active state, pending state, or inactive state.
Whether or not a connection-loss error happened.
Whether or not a timeout error happened.
Value of the latest RTT sample.
Time the latest operation cycle was issued.
Return code of the latest operation cycle
Average RTT value that is observed in the last cycle.
Minimum RTT value that is observed in the last cycle.
Maximum RTT value that is observed in the last cycle.
Number of successful round trips.
Sum of all successful round-trip values in milliseconds.
Sum of squares of the round-trip values in milliseconds.
260
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics
Field
Path Idx
Path Sense
LSP Selector
Outgoing Interface
Nexthop Address
Downstream Label Stack
Description
Path index number.
Response return code for the path. (See
Response Return Values for the show ipsla history
, in show ipsla history command.)
LSP selector address of the path.
Outgoing interface of the path.
Next hop address of the path.
MPLS label stacks of the path.
Related Commands
Command
show ipsla statistics aggregated, on page 262
Description
Displays the statistical errors for all the IP SLA operations or for a specified operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
261
IP Service Level Agreement Commands show ipsla statistics aggregated
show ipsla statistics aggregated
To display the hourly statistics for all the IP SLA operations or specified operation, use the show ipsla statistics
aggregated command in EXEC modeXR EXEC mode.
show ipsla statistics aggregated [detail] [ operation-number ]
Syntax Description detail operation-number
Displays detailed information.
(Optional) Number of IP SLA operations. Range is 1 to 2048.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.6.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Show output was expanded to include detailed information when path discovery is enabled.
This command was introduced.
This command was introduced.
Usage Guidelines The show ipsla statistics aggregated command displays information such as the number of failed operations and the reason for failure. Unless you configured a different amount of time for the buckets command (statistics command with hourly keyword), the show ipsla statistics aggregated command displays the information collected over the past two hours.
For one-way delay and jitter operations to be computed for UDP jitter operations, the clocks on local and target devices must be synchronized using NTP or GPS systems. If the clocks are not synchronized, one-way measurements are discarded. If the sum of the source to destination (SD) and the destination to source (DS) values is not within 10 percent of the round-trip time, the one-way measurement values are assumed to be faulty, and are discarded.
262
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics aggregated
Task ID
Examples
Task ID monitor
Operations read
The output of the show ipsla statistics aggregated command varies depending on operation type. The following sample output shows the aggregated statistics for UDP echo operation from the show ipsla statistics aggregated command:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics aggregated 1
Entry number: 1
Hour Index: 0
Start Time Index: 21:02:32.510 UTC Mon Dec 12 2005
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
: 0
: 0
Number of Failed Operations due to a Busy : 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 6
NumOfRTT: 36
RTTMin: 4
RTTSum: 229
RTTMax : 38
RTTSum2: 2563
The following sample output is from the show ipsla statistics aggregated command in which operation 10 is a UDP jitter operation:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics aggregated 10
Entry number: 10
Hour Index: 0
Start Time Index: 00:35:07.895 UTC Thu Mar 16 2006
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Number of Failed Operations due to a Busy
: 0
: 0
: 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 14
NumOfRTT: 70
RTTMin: 2
RTTSum: 1034
Packet Loss Values:
PacketLossSD : 0
PacketOutOfSequence: 0
RTTMax : 99
RTTSum2: 60610
PacketLossDS: 0
PacketMIA : 0
PacketLateArrival : 0
Errors
Jitter Values :
: 0
MinOfPositivesSD: 1
NumOfPositivesSD: 17
Sum2PositivesSD : 629
MinOfNegativesSD: 1
NumOfNegativesSD: 24
Sum2NegativesSD : 914
MinOfPositivesDS: 1
NumOfPositivesDS: 17
Sum2PositivesDS : 174
MinOfNegativesDS: 1
NumOfNegativesDS: 24
Sum2NegativesDS : 267
Interarrival jitterout: 0
One Way Values :
Busies : 0
MaxOfPositivesSD: 19
SumOfPositivesSD: 65
MaxOfNegativesSD: 16
SumOfNegativesSD: 106
MaxOfPositivesDS: 7
SumOfPositivesDS: 44
MaxOfNegativesDS: 8
SumOfNegativesDS: 63
Interarrival jitterin: 0
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
263
IP Service Level Agreement Commands show ipsla statistics aggregated
NumOfOW: 0
OWMinSD : 0
OWSum2SD: 0
OWMinDS : 0
OWMaxSD: 0
OWMaxDS: 0
OWSumSD: 0
OWSumDS: 0
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics aggregated
Captured Statistics
Each Entry per Line
Column Description per Entry:
Entry = Entry number
StartT = Start time of entry (hundredths of seconds)
Pth
Hop
Dst
= Path index
= Hop in path index
= Time distribution index
Comps = Operations completed
SumCmp = Sum of RTT (milliseconds)
SumCmp2H = Sum of RTT squared high 32 bits (milliseconds)
SumCmp2L = Sum of RTT squared low 32 bits (milliseconds)
TMax
TMin
= RTT maximum (milliseconds)
= RTT minimum (milliseconds)
Entry StartT
TMin
Pth Hop Dst Comps
101 1417192777884 1 1 0 0
0
101 1417192777884 1 1 1 0
0
101 1417192777884 1 1 2 2
1
101 1417192777884 1 1 3 8
2
101 1417192777884 1 1 4 0
0
SumCmp
0
0
58
258
0
0
0
0
0
0
SumCmp2H
0
SumCmp2L
0
176
852
0
0
4
5
0
0
TMax
This table describes the significant fields shown in the display.
Table 24: show ipsla statistics aggregated Field Descriptions
Field
Busies
Entry Number
Hop in Path Index
Errors
Jitter Values
NumOfJitterSamples
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Description
Number of times that the operation cannot be started because the previously scheduled run was not finished.
Entry number.
Hop in path index.
Number of internal errors.
Jitter statistics appear on the specified lines. Jitter is defined as interpacket delay variance.
Number of jitter samples that are collected. The number of samples are used to calculate the jitter statistics.
Number of failed operations due to a disconnect.
Number of failed operations due to a timeout.
264
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics aggregated
Field
Number of Failed Operations due to a Busy
Description
Number of failed operations due to a busy error.
Number of Failed Operations due to a No Connection Error that refers to the case in which the control connection cannot be established.
Number of Failed Operations due to an Internal Error Number of failed operations due to an internal error.
Number of Failed Operations due to a Sequence Error Number of failed operations due to a sequence error.
Number of Failed Operations due to a Verify Error Number of failed operations due to a verify error.
MaxOfNegativesSD
MaxOfPositivesSD
MaxOfPositivesDS
MaxOfNegativesDS
Maximum negative jitter values from the source to the destination. The absolute value is given.
Maximum jitter values from the source to the destination in milliseconds.
Maximum jitter values from the destination to the source in milliseconds.
Maximum negative jitter values from destination-to-source. The absolute value is given.
MinOfPositivesDS
MinOfNegativesSD
MinOfPositivesSD
MinOfNegativesDS
NumOfOW
NumOfNegativesDS
NumOfNegativesSD
NumOfPositivesDS
Minimum jitter values from the destination to the source in milliseconds.
Minimum negative jitter values from the source to the destination. The absolute value is given.
Minimum jitter values from the source to the destination in milliseconds.
Minimum negative jitter values from the destination to the source. The absolute value is given.
Number of successful one-way time measurements.
Number of jitter values from the destination to the source that are negative; for example, network latency decreases for two consecutive test packets.
Number of jitter values from the source to the destination that are negative; for example, network latency decreases for two consecutive test packets.
Number of jitter values from the destination to the source that are positive; for example, network latency increases for two consecutive test packets.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
265
show ipsla statistics aggregated
Field
NumOfPositivesSD
NumOfRTT
One Way Values
OWMaxDS
OWMaxSD
OWMinDS
OWMinSD
OWSumDS
OWSumSD
OWSum2DS
OWSum2SD
PacketLateArrival
PacketLossDS
PacketLossSD
PacketMIA
PacketOutOfSequence
Path Index
Port Number
266
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
IP Service Level Agreement Commands
Description
Number of jitter values from the source to the destination that are positive; for example, network latency increases for two consecutive test packets.
Number of successful round trips.
One-way measurement statistics appear on the specified lines. One Way (OW) values are the amount of time that it took the packet to travel from the source router to the target router or from the target router to the source router.
Maximum time from the destination to the source.
Maximum time from the source to the destination.
Minimum time from the destination to the source.
Minimum time from the source to the destination.
Sum of one-way delay values from the destination to the source.
Sum of one-way delay values from the source to the destination.
Sum of squares of one-way delay values from the destination to the source.
Sum of squares of one-way delay values from the source to the destination.
Number of packets that arrived after the timeout.
Number of packets lost from the destination to the source (DS).
Number of packets lost from the source to the destination (SD).
Number of packets lost in which the SD direction or
DS direction cannot be determined.
Number of packets that are returned out of order.
Path index.
Target port number.
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics aggregated
OL-26517-02
SumOfPositivesDS
SumOfPositivesSD
SumOfNegativesDS
SumOfNegativesSD
Sum2PositivesDS
Sum2PositivesSD
Sum2NegativesDS
Sum2NegativesSD
Target Address
Field
RTTSum
RTTSum2
RTT Values
Start Time
Start Time Index
Description
Sum of all successful round-trip values in milliseconds.
Sum of squares of the round-trip values in milliseconds.
Round-trip time statistics appear on the specified lines.
Start time, in milliseconds.
Statistics that are aggregated for over 1-hour intervals.
The value indicates the start time for the 1-hour interval that is displayed.
Sum of the positive jitter values from the destination to the source.
Sum of the positive jitter values from the source to the destination.
Sum of the negative jitter values from the destination to the source.
Sum of the negative jitter values from the source to the destination.
Sum of squares of the positive jitter values from the destination to the source.
Sum of squares of the positive jitter values from the source to the destination.
Sum of squares of the negative jitter values from the destination to the source.
Sum of squares of the negative jitter values from the source to the destination.
Target IP address.
The output of the show ipsla statistics aggregated detail command varies depending on operation type. The following sample output is from the show ipsla statistics aggregated detail command in tabular format, when the output is split over multiple lines:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics aggregated detail 2
Captured Statistics
Multiple Lines per Entry
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
267
IP Service Level Agreement Commands show ipsla statistics aggregated
Field
Entry
StartT
Pth
Hop
Dst
Comps
SumCmp
SumCmp2L
Line1:
Entry = Entry number
StartT = Start time of entry (hundredths of seconds)
Pth = Path index
Hop = Hop in path index
Dst
Comps
= Time distribution index
= Operations completed
SumCmp = Sum of RTT (milliseconds)
Line2:
SumCmp2H = Sum of RTT squared high 32 bits (milliseconds)
SumCmp2L = Sum of RTT squared low 32 bits (milliseconds)
TMax
TMin
= RTT maximum (milliseconds)
= RTT minimum (milliseconds)
Entry StartT
2
Pth Hop Dst Comps
SumCmp2H SumCmp2L TMax
1134423910701 1 1 0 12
2
0 1231 6
1134423851116 1 1 1 2
2
2
0 2419 41
1134423070733 1 1 2 1
0 1119 16
0
0
1 1 3 0
0 0
SumCmp
TMin
367
6
129
41
101
16
0
0
This table describes the significant fields shown in the display.
Table 25: show ipsla statistics aggregated detail Field Descriptions
SumCmp2H
TMax
TMin
Description
Entry number.
Start time of entry, in hundredths of seconds.
Path index.
Hop in path index.
Time distribution index.
Operations completed.
Sum of completion times, in milliseconds.
Sum of completion times squared low 32 bits, in milliseconds.
Sum of completion times squared high 32 bits, in milliseconds.
Completion time maximum, in milliseconds.
Completion time minimum, in milliseconds.
268
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics aggregated
The following sample output is from the show ipsla statistics aggregated command when a path discovery operation is enabled. Data following the hourly index is aggregated for all paths in the group during the given hourly interval.
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics aggregated 100041
Entry number: 100041
Hour Index: 13
<The following data after the given hourly index is aggregated for all paths in the group during the given hourly interval.>
Start Time Index: 12:20:57.323 UTC Tue Nov 27 2007
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
: 0
: 249
Number of Failed Operations due to a Busy : 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
<end>
RTT Values:
RTTAvg : 21
NumOfRTT: 2780
RTTMin: 19
RTTSum: 59191
RTTMax : 73
RTTSum2: 1290993
<The following data for LSP path information is available after path discovery is enabled.>
Path Information:
Path Path LSP
Idx Sense Selector
1
2
3
1
1
1
127.0.0.1
127.0.0.1
127.0.0.1
Outgoing
Interface
Gi0/4/0/0
Gi0/4/0/0.1
Gi0/4/0/0.2
Nexthop
Address
192.39.1.1
192.39.2.1
192.39.3.1
4
5
6
7
1
1
1
1
127.0.0.1
127.0.0.8
127.0.0.8
127.0.0.8
127.0.0.8
Gi0/4/0/0.3
Gi0/4/0/0
Gi0/4/0/0.1
Gi0/4/0/0.2
Gi0/4/0/0.3
192.39.4.1
192.39.1.1
192.39.2.1
192.39.3.1
192.39.4.1
8 1
<end>
Hour Index: 14
Start Time Index: 13:20:57.323 UTC Tue Nov 27 2007
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Number of Failed Operations due to a Busy
: 0
: 122
: 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 21
NumOfRTT: 3059
RTTMin: 19
RTTSum: 65272
RTTMax : 212
RTTSum2: 1457612
Path Information:
Path Path LSP
Idx Sense Selector
1 1 127.0.0.1
2
3
4
1
1
1
127.0.0.1
127.0.0.1
127.0.0.1
5
6
7
8
1
1
1
1
127.0.0.8
127.0.0.8
127.0.0.8
127.0.0.8
Outgoing
Interface
Gi0/4/0/0
Gi0/4/0/0.1
Gi0/4/0/0.2
Gi0/4/0/0.3
Gi0/4/0/0
Gi0/4/0/0.1
Gi0/4/0/0.2
Gi0/4/0/0.3
Nexthop
Address
192.39.1.1
192.39.2.1
192.39.3.1
192.39.4.1
192.39.1.1
192.39.2.1
192.39.3.1
192.39.4.1
This table describes the significant fields shown in the display.
Downstream
Label Stack
677
677
677
677
677
677
677
677
Downstream
Label Stack
677
677
677
677
677
677
677
677
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
269
IP Service Level Agreement Commands show ipsla statistics aggregated
Table 26: show ipsla statistics aggregated (with Path Discovery enabled) Field Descriptions
Field
Entry Number
Start Time Index
Description
Entry number.
Start time.
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Number of failed operations due to a disconnect.
Number of failed operations due to a timeout.
Number of Failed Operations due to a Busy Number of failed operations due to a busy error.
Number of Failed Operations due to a No Connection Error that refers to the case in which the control connection cannot be established.
Number of Failed Operations due to an Internal Error Number of failed operations due to an internal error.
Number of Failed Operations due to a Sequence Error Number of failed operations due to a sequence error.
Number of Failed Operations due to a Verify Error Number of failed operations due to a verify error.
RTT Values
RTT Min/Avg/Max
NumOfRTT
RTT Sum
RTT Sum2
Round-trip time statistics appear on the specified lines.
Maximum values of the RTT that are observed in the latest cycle (*).
Number of successful round trips.
Sum of all successful round-trip values, in milliseconds.
Sum of squares of the round-trip values, in milliseconds.
RTT Min/Avg/Max
NumOfRTT
Path Idx
Path Sense
LSP Selector
Maximum values of the RTT that are observed in the latest cycle (*).
Number of successful round trips.
Path index number.
Response return code for the path. (See
Response Return Values for the show ipsla history
, in show ipsla history command.)
LSP selector address of the path.
270
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics aggregated
Field
Outgoing Interface
Nexthop Address
Downstream Label Stack
Description
Outgoing interface name of the path.
Next hop address of the path.
MPLS label stacks of the path.
Related Commands
Command
show ipsla statistics, on page 258
Description
Displays the operational data for the IP SLA operation.
show ipsla statistics enhanced aggregated, on page
272
Displays the statistical errors for all the IP SLA operations or for a specified operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
271
IP Service Level Agreement Commands show ipsla statistics enhanced aggregated
show ipsla statistics enhanced aggregated
To display the enhanced history statistics for all collected enhanced history buckets for the specified IP SLA operation, use the show ipsla statistics enhanced aggregated command in EXEC modeXR EXEC mode.
show ipsla statistics enhanced aggregated [ operation-number ] [interval seconds]
Syntax Description operation-number
interval seconds
(Optional) Operation number for which to display the enhanced history distribution statistics.
(Optional) Specifies the aggregation interval in seconds for which to display the enhanced history distribution statistics.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The show ipsla statistics enhanced aggregated command displays data for each bucket of enhanced history data shown individually; for example, one after the other. The number of buckets and the collection interval is set using the interval keyword, seconds argument, buckets keyword, and number-of-buckets argument.
Task ID
Task ID monitor
Operations read
Examples The output of the show ipsla statistics enhanced aggregated command varies depending on the operation type.
272
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics enhanced aggregated
The following sample output is from the show ipsla statistics enhanced aggregated command for the UDP echo operation:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics enhanced aggregated 20
Entry number: 20
Interval : 300 seconds
Bucket : 1 (0 - 300 seconds)
Start Time Index: 00:38:14.286 UTC Thu Mar 16 2006
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
: 0
: 0
Number of Failed Operations due to a Busy : 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 2
NumOfRTT: 5
RTTMin: 2
RTTSum: 13
Bucket : 2 (300 - 600 seconds)
RTTMax : 5
RTTSum2: 41
Start Time Index: 00:43:12.747 UTC Thu Mar 16 2006
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Number of Failed Operations due to a Busy
: 0
: 0
: 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 2
NumOfRTT: 1
RTTMin: 2
RTTSum: 2
RTTMax : 2
RTTSum2: 4
The following sample output is from the show ipsla statistics enhanced aggregated command for the UDP jitter operation:
RP/0/0RP0RSP0/CPU0:router:hostname# show ipsla statistics enhanced aggregated 20
Entry number: 101
Interval : 120 seconds
Bucket : 1
Start Time Index: 16:39:37.884 GMT Fri Nov 28 2014
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
: 0
: 0
Number of Failed Operations due to a Busy : 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 3
NumOfRTT: 20
Packet Loss Values:
RTTMin: 1
RTTSum: 63
RTTMax : 5
RTTSum2: 213
PacketLossSD : 0
PacketOutOfSequence: 0
PacketLateArrival : 0
Errors : 0
InvalidTimestamp : 0
Jitter Values :
MinOfPositivesSD: 1
PacketLossDS : 0
PacketMIA : 0
PacketSkipped: 0
Busies : 0
MaxOfPositivesSD: 2
SumOfPositivesSD: 9 NumOfPositivesSD: 7
Sum2PositivesSD : 13
MinOfNegativesSD: 1
NumOfNegativesSD: 7
MaxOfNegativesSD: 1
SumOfNegativesSD: 7
Sum2NegativesSD : 7
MinOfPositivesDS: 1
NumOfPositivesDS: 2
Sum2PositivesDS : 2
MinOfNegativesDS: 1
NumOfNegativesDS: 2
Sum2NegativesDS : 2
JitterAve: 1
MaxOfPositivesDS: 1
SumOfPositivesDS: 2
MaxOfNegativesDS: 1
SumOfNegativesDS: 2
JitterSDAve: 1 JitterDSAve: 1
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
273
IP Service Level Agreement Commands show ipsla statistics enhanced aggregated
Interarrival jitterout: 0
One Way Values :
Interarrival jitterin: 0
NumOfOW: 0
OWMinSD : 0
OWSum2SD: 0
OWMinDS : 0
OWSum2DS: 0
OWMaxSD: 0
OWAveSD: 0
OWMaxDS: 0
OWAveDS: 0
OWSumSD: 0
OWSumDS: 0
Bucket : 2
Start Time Index: 16:41:36.657 GMT Fri Nov 28 2014
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Number of Failed Operations due to a Busy
: 0
: 0
: 0
Number of Failed Operations due to a No Connection : 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error : 0
Number of Failed Operations due to a Verify Error : 0
RTT Values:
RTTAvg : 3
NumOfRTT: 20
RTTMin: 2
RTTSum: 61
RTTMax : 4
RTTSum2: 189
...
This table describes the significant fields shown in the display.
Table 27: show ipsla statistics enhanced aggregated Field Descriptions
Field
Entry Number
Interval
Bucket
Start Time Index
RTT Values
RTT Min/Avg/Max
NumOfRTT
RTT Sum
RTT Sum2
Description
Entry number.
Multiple of the frequency of the operation. The
Enhanced interval field defines the interval in which statistics displayed by the show ipsla statistics
enhanced aggregated command are aggregated. This field must be configured so that the enhanced aggregated statistics are displayed.
Bucket index.
Statistics that are aggregated depend on the interval configuration mode. The value depends on the interval configuration that is displayed.
Round-trip time statistics appear on the specified lines.
Maximum values of the RTT that are observed in the latest cycle (*).
Number of successful round trips.
Sum of all successful round-trip values, in milliseconds.
Sum of squares of the round-trip values, in milliseconds.
274
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla statistics enhanced aggregated
Field
Number of Failed Operations due to a Disconnect
Number of Failed Operations due to a Timeout
Description
Number of failed operations due to a disconnect.
Number of failed operations due to a timeout.
Number of Failed Operations due to a Busy Number of failed operations due to a busy error.
Number of Failed Operations due to a No Connection Error that refers to the case in which the control connection cannot be established.
Number of Failed Operations due to an Internal Error Number of failed operations due to an internal error.
Number of Failed Operations due to a Sequence Error Number of failed operations due to a sequence error.
Number of Failed Operations due to a Verify Error Number of failed operations due to a verify error.
Related Commands
Command
show ipsla statistics, on page 258
show ipsla statistics aggregated, on page 262
Description
Displays the operational data for the IP SLA operation.
Displays the statistical errors for all the IP SLA operations or for a specified operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
275
IP Service Level Agreement Commands show ipsla twamp connection
show ipsla twamp connection
To display the Two-Way Active Management Protocol (TWAMP) connections, use the show ipsla twamp
conection command in the EXEC modeXR EXEC mode.
show ipsla twamp connection[ detailsource-ip | requests]
Syntax Description
detail source-ip requests
Displays details of the connection for a specified source-ip.
Displays request details.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 5.1.1
Modification
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID ip-services
Operation read
Examples This example shows how to run the show ipsla twamp conection command with the requests keyword:
RP/0/0RP0RSP0/CPU0:router:hostname # show ipsla twamp connection requests
276
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands show ipsla twamp session
show ipsla twamp session
To display the Two-way Active Management Protocol (TWAMP) sessions, use the show ipsla twamp session command in the EXEC modeXR EXEC mode.
show ipsla twamp session [ source-ip host-name ]
Syntax Description
source-ip host-name Displays session information for the specified source-ip and hostname.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 5.1.1
Modification
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operation read
Examples This example shows how to run show ipsla twamp session command:
RP/0/0RP0RSP0/CPU0:router:hostname # show ipsla twamp session
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
277
IP Service Level Agreement Commands show ipsla twamp standards
show ipsla twamp standards
To display the Two-way Active Management Protocol (TWAMP) standards, use the show ipsla twamp
standards command in the EXEC modeXR EXEC mode.
The relevant RFC standards for the TWAMP server and TWAMP reflector are indicated.
show ipsla twamp standards
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 5.1.1
Modification
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID ip-services
Operation read
Examples This example shows how to use the show ipsla twamp standards command:
RP/0/0RP0RSP0/CPU0:router:hostname # show ipsla twamp standards
Feature Organization Standard
TWAMP Server
TWAMP Reflector
IETF
IETF
RFC5357
RFC5357
278
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands source address
source address
To identify the address of the source device, use the source address command in the appropriate configuration mode. To use the best local address, use the no form of this command.
source address ipv4-address no source address
Syntax Description ipv4-address IP address or hostname of the source device.
Command Default IP SLA finds the best local address to the destination and uses it as the source address.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.4.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Support was added for IP SLA MPLS LSP Ping and IP SLA MPLS
LSP Trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
279 OL-26517-02
IP Service Level Agreement Commands source address
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to designate an IP address for the source address command in IP SLA
UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# source address 192.0.2.9
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
280
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands source port
source port
To identify the port of the source device, use the source port command in the appropriate configuration mode.
To use the unused port number, use the no form of this command.
source port port no source port
Syntax Description
port port Identifies the port number of the source device. Range is 1 to 65535.
Command Default IP SLA uses an unused port that is allocated by system.
Command History
Releas
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The source port command is not supported to configure ICMP operations; it is supported only to configure
UDP operations.
The specified source port should not be used in other IPSLA operations configured on the same source IP address and source VRF.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to designate a port for the source port command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# source port 11111
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
281 OL-26517-02
IP Service Level Agreement Commands source port
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
282
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands start-time
start-time
To determine the time when the operation or MPLS LSP monitor instance starts, use the start-time command in the appropriate configuration mode. To stop the operation and place it in the default state, use the no form of this command.
start-time {hh:mm:ss [day| month day year]| after hh:mm:ss| now| pending} no start-time
Syntax Description hh:mm:ss month day year
after hh:mm:ss now pending
Absolute start time in hours, minutes, and seconds. You can use the 24-hour clock notation. For example, the start-time 01:02 is defined as 1:02 am, or start-time
13:01:30 is defined as start at 1:01 pm. and 30 seconds. The current day is used; unless, you specify a month and day.
(Optional) Name of the month to start the operation. When you use the month argument, you are required to specify a day. You can specify the month by using the full English name or the first three letters of the month.
(Optional) Number of the day, in the range of 1 to 31, to start the operation. In addition, you must specify a month.
(Optional) Year in the range of 1993 to 2035.
Specifies that the operation starts at hh hours, mm minutes, and ss seconds after the
start-time command is used.
Specifies that the operation should start immediately.
Specifies that no information is collected. The default value is the pending keyword.
Command Default If a month and day are not specified, the current month and day are used.
Command Modes IP SLA schedule configuration
IP SLA MPLS LSP monitor schedule configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor schedule configuration mode.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
283 OL-26517-02
IP Service Level Agreement Commands start-time
Release
Release 3.7.0
Release 3.7.2
Release 5.2.3
Modification
Added the ability to specify a year.
This command was introduced.
This command was introduced.
Usage Guidelines If the start-time command is used in IP SLA operation mode, it configures the start time for the specific operation being configured. If the start-time command is used in IP SLA MPLS LSP monitor mode, it configures the start time for all monitor instances associated with the monitored provider edge (PE) routers.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the start-time command option for the schedule operation:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)# start-time after 01:00:00
The following example shows how to use the start-time command in IP SLA MPLS LSP monitor schedule configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# schedule monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-sched)# start-time after 01:00:00
The following example shows how to use the start-time command and specify a year for a scheduled operation:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla operation 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-echo)# destination address 192.0.2.9
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-echo)# exit
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# exit
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# schedule operation 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)# start 20:0:0 february 7 2008
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-sched)#
Related Commands
Command
Description
Specifies the length of time to execute.
Configures an IP SLA operation.
284
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands
Command
schedule operation, on page 236
start-time
Description
Indicates that the operation starts automatically at the specified time and for the specified duration every day.
Schedules an IP SLA MPLS LSP monitoring instance.
Schedules an IP SLA operation.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
285
IP Service Level Agreement Commands statistics
statistics
To set the statistics collection parameters for the operation, use the statistics command in the appropriate configuration mode. To remove the statistics collection or use the default value, use the no form of this command.
statistics {hourly| interval seconds}
no statistics {hourly| interval seconds}
Syntax Description hourly
interval seconds
Sets the distribution for statistics configuration that is aggregated for over an hour.
Collects statistics over a specified time interval. Interval (in seconds) over which to collect statistics. Range is 1 to 3600 seconds.
Command Default None
Command Modes IP SLA operation UDP jitter configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines The statistics interval command is not supported for the configuration of ICMP path-echo and ICMP path-jitter operations, nor for the configuration of MPLS LSP monitor instances.
286
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands statistics
Task ID
If the statistics command is used in IP SLA operation mode, it configures the statistics collection for the specific operation being configured. If the statistics command is used in IP SLA MPLS LSP monitor mode, it configures the statistics collection for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to set the number of hours in which statistics are maintained for the IP
SLA UDP jitter operation for the statistics command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)#
The following example shows how to collect statistics for a specified time interval, using the statistics command in an IP SLA UDP jitter operation:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# statistics interval 60
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op-stats)#
The following example shows how to set the number of hours in which statistics are maintained for the IP
SLA MPLS LSP monitor ping operation, using the statistics command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# statistics hourly
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-stats)#
Related Commands
Command
buckets (statistics hourly), on page 136
buckets (statistics interval), on page 138
distribution count, on page 149
distribution interval, on page 151
Description
Sets the number of hours in which statistics are kept.
Refers to the data buckets in which the enhanced history statistics are kept.
Sets the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation.
Sets the time interval (in milliseconds) for each statistical distribution.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
287
statistics
IP Service Level Agreement Commands
Command
schedule operation, on page 236
maximum paths (IP SLA), on page 181
Description
Configures an IP SLA MPLS LSP monitor instance.
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Sets the number of hops in which statistics are maintained for each path for the IP SLA operation.
Sets the number of paths in which statistics are maintained for each hour for an IP SLA operation.
288
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands tag (IP SLA)
tag (IP SLA)
To create a user-specified identifier for an IP SLA operation, use the tag command in the appropriate configuration mode. To unset the tag string, use the no form of this command.
tag [ text ] no tag
Syntax Description text (Optional) Specifies a string label for the IP SLA operation.
Command Default No tag string is configured.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Support was added for IP SLA MPLS LSP ping and IP SLA MPLS
LSP trace configuration modes.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
289 OL-26517-02
IP Service Level Agreement Commands tag (IP SLA)
Usage Guidelines If the tag command is used in IP SLA operation mode, it configures the user-defined tag string for the specific operation being configured. If the tag command is used in IP SLA MPLS LSP monitor mode, it configures the user-defined tag string for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the tag command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# tag ipsla
The following example shows how to use the tag command in IP SLA MPLS LSP monitor ping configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# tag mplslm-tag
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
290
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands target ipv4
target ipv4
To specify the IPv4 address of the target router to be used in an MPLS LSP ping or MPLS LSP trace operation, use the target ipv4 command in the appropriate configuration mode. To unset the address, use the no form of this command.
target ipv4 destination-address destination-mask no target ipv4
Syntax Description destination-address IPv4 address of the target device to be tested.
destination-mask Number of bits in the network mask of the target address. The network mask can be specified in either of two ways:
• The network mask can be a four-part dotted decimal address. For example,
255.0.0.0 indicates that each bit equal to 1 means the corresponding address bit belongs to the network address.
• The network mask can be indicated as a slash (/) and number. For example, /8 indicates that the first 8 bits of the mask are ones, and the corresponding bits of the address are network address.
Command Default None
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the target ipv4 command to specify the IPv4 address of the target router at the end of the LSP to be tested or traced and to indicate the destination as an Label Distribution Protocol (LDP) IPv4 address. The target
IPv4 address identifies the appropriate label stack associated with the LSP.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
291 OL-26517-02
IP Service Level Agreement Commands target ipv4
Task ID
Note Using the target ipv4 command, you can configure only one LDP IPv4 address as the target in an MPLS
LSP ping or trace operation. If you enter the command a second time and configure a different IPv4 target address, you overwrite the first IPv4 address.
An MPLS LSP ping operation tests connectivity in the LSP using verification on the specified Forwarding
Equivalence Class (FEC)— in this case, LDP IPv4 prefix—between the ping origin and the egress node identified with the target ipv4 command. This test is carried out by sending an MPLS echo request along the same data path as other packets belonging to the FEC. When the ping packet reaches the end of the path, it is sent to the control plane of the egress label switching router (LSR), which then verifies that it is indeed an egress for the LSP. The MPLS echo request contains information about the LSP that is being verified.
In an MPLS network, an MPLS LSP trace operation traces LSP paths to the target router identified with the
target ipv4 command. In the verification of LSP routes, a packet is sent to the control plane of each transit
LSR, which performs various checks, including one that determines if it is a transit LSR for the LSP path.
Each transit LSR also returns information related to the LSP being tested (that is, the label bound to the LDP
IPv4 prefix).
Task ID monitor
Operations read, write
Examples The following example shows how to use the target ipv4 command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)# target ipv4 192.168.1.4
255.255.255.255
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
292
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands target pseudowire
target pseudowire
To specify the pseudowire as the target to be used in an MPLS LSP ping operation, use the target pseudowire command in IP SLA MPLS LSP ping configuration mode. To unset the target, use the no form of this command.
target pseudowire destination-address circuit-id no target pseudowire
Syntax Description destination-address circuit-id
IPv4 address of the target device to be tested.
Virtual circuit identifier. Range is 1 to 4294967295.
Command Default No default behavior or values
Command Modes IP SLA MPLS LSP ping configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the target pseudowire command to specify a target router and to indicate the destination as a Layer 2
VPN pseudowire in an MPLS LSP ping operation. The target pseudowire command identifies the target address and the virtual circuit (VC) identifier.
Note Using the target pseudowire command, you can configure only one pseudowire address as the target in an MPLS LSP ping operation. If you use the command a second time and configure a different pseudowire target address, the first pseudowire address is overwritten.
A pseudowire target of the LSP ping operation allows active monitoring of statistics on Pseudowire
Edge-to-Edge (PWE3) services across an MPLS network. PWE3 connectivity verification uses the Virtual
Circuit Connectivity Verification (VCCV).
For more information on VCCV, refer to the VCCV draft, “Pseudowire Virtual Circuit Connectivity Verification
(VCCV)” on the IETF web page.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
293 OL-26517-02
IP Service Level Agreement Commands target pseudowire
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the target pseudowire command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# target pseudowire 192.168.1.4
4211
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
294
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands target traffic-eng
target traffic-eng
To specify the target MPLS traffic engineering tunnel to be used in an MPLS LSP ping or MPLS LSP trace operation, use the target traffic-eng command in the appropriate configuration mode. To unset the tunnel, use the no form of this command.
target traffic-eng tunnel tunnel-interface no target traffic-eng
Syntax Description
tunnel tunnel-interface Tunnel ID of an MPLS traffic-engineering tunnel (for example, tunnel
10) configured on the router. Range is 0 to 65535.
Command Default No default behavior or values
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the target traffic-eng command to specify a target router and to indicate the destination as an MPLS traffic-engineering (TE) tunnel in an MPLS LSP ping or MPLS LSP trace operation. The target traffic-eng command identifies the tunnel interface and the appropriate label stack associated with the LSP to be pinged or traced. An LSP tunnel interface is the head-end of a unidirectional virtual link to a tunnel destination.
Note Using the target traffic-eng command, you can configure only one MPLS TE tunnel as the target in an
MPLS LSP ping or trace operation. If you enter the command a second time and configure a different tunnel interfaces, you overwrite the first tunnel ID.
An IP SLA ping operation tests connectivity in the LSP using verification on the specified Forwarding
Equivalence Class (FEC)—in this case, MPLS TE tunnel—between the ping origin and the egress node identified with the target traffic-eng command. This test is carried out by sending an MPLS echo request
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
295 OL-26517-02
IP Service Level Agreement Commands target traffic-eng
Task ID along the same data path as other packets belonging to the tunnel. When the ping packet reaches the end of the path, it is sent to the control plane of the egress label switching router (LSR), which then verifies that it is indeed an egress for the MPLS TE tunnel. The MPLS echo request contains information about the tunnel whose LSP path is being verified.
In an MPLS network, an IP SLA trace operation traces the LSP paths to a target router identified with the
target traffic-eng command. In the verification of LSP routes, a packet is sent to the control plane of each transit LSR, which performs various checks, including one that determines if it is a transit LSR for the LSP path. Each transit LSR also returns information related to the MPLS TE tunnel to see if the local forwarding information matches what the routing protocols determine as the LSP path.
MPLS traffic engineering automatically establishes and maintains LSPs across the backbone. The path that an LSP uses is determined by the LSP resource requirements and network resources, such as bandwidth.
For more information on MPLS traffic-engineering tunnels, refer to MPLS Traffic Engineering and
Enhancements.
Task ID monitor
Operations read, write
Examples The following example shows how to use the target traffic-eng tunnel command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)# target traffic-eng tunnel
101
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
296
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands threshold
threshold
To set the lower-limit and upper-limit values, use the threshold command in IP SLA reaction condition configuration mode. To use the default value, use the no form of this command.
threshold lower-limit value upper-limit value
no threshold lower-limit value upper-limit value
Syntax Description
lower-limit value
upper-limit value
Specifies the threshold lower-limit value. Range is 1 to 4294967295 ms.
Default lower-limit value is 3000 ms.
Specifies the threshold upper-limit value. Range is 5000 to 4294967295 ms.
Default upper-limit value is 5000 ms.
Command Default lower-limit value: 3000 ms
upper-limit value: 5000 ms
Command Modes IP SLA reaction condition configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The threshold command is supported only when used with the react command and jitter-average and
packet-loss keywords.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
297 OL-26517-02
IP Service Level Agreement Commands threshold
Examples The following example shows how to set the lower-limit and upper-limit values for the react command with the jitter-average keyword for the threshold command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold lower-limit 8000 upper-limit 10000
The following example shows how to set the lower-limit and upper-limit values for the react command with the packet-loss keyword for the threshold command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react packet-loss dest-to-source
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold lower-limit 8000 upper-limit 10000
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type average, on page 299
threshold type consecutive, on page 301
threshold type immediate, on page 303
threshold type xofy, on page 305
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Takes action on average values to violate a threshold.
Takes action after a number of consecutive violations.
Takes action immediately upon a threshold violation.
Takes action upon X violations in Y probe operations.
298
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands threshold type average
threshold type average
To take action on average values to violate a threshold, use the threshold type average command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type average number-of-probes no threshold type
Syntax Description number-of-probes When the average of the last five values for the monitored element exceeds the upper threshold or the average of the last five values for the monitored element drops below the lower threshold, the action is performed as defined by the action command. Range is 1 to 16.
Command Default If there is no default value, no threshold type is configured.
Command Modes IP SLA reaction condition configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The threshold type average command is supported only when used with the react command and
jitter-average, packet-loss, and rtt keywords.
Task ID
Task ID monitor
Operations read, write
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
299
IP Service Level Agreement Commands threshold type average
Examples The following example shows how to set the number of probes for the react command with the jitter-average keyword for the threshold type average command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold type average 8
The following example shows how to set the number of probes for the react command with the packet-loss keyword for the threshold type average command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react packet-loss dest-to-source
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold type average 8
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type consecutive, on page 301
threshold type immediate, on page 303
threshold type xofy, on page 305
Description
Specifies what action or combination of actions the operation performs.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Sets the lower-limit and upper-limit values.
Takes action after a number of consecutive violations.
Takes action immediately upon a threshold violation.
Takes action upon X violations in Y probe operations.
300
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands threshold type consecutive
threshold type consecutive
To take action after a number of consecutive violations, use the threshold type consecutive command in the appropriate configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type consecutive occurrences no threshold type
Syntax Description occurrences When the reaction condition is set for a consecutive number of occurrences, there is no default value. The number of occurrences is set when specifying the threshold type.
The number of consecutive violations is 1 to 16.
Command Default No default behavior or values
Command Modes IP SLA reaction condition configuration
IP SLA MPLS LSP monitor reaction condition configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor reaction condition configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines If the threshold type consecutive command is used in IP SLA reaction condition mode, it configures the threshold for the specific operation being configured. If the threshold type consecutive command is used in
IP SLA MPLS LSP monitor reaction condition configuration mode, it configures the threshold for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
301 OL-26517-02
IP Service Level Agreement Commands threshold type consecutive
Examples The following example shows how to use the threshold type consecutive command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla )# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold type consecutive 8
The following example shows how to use the threshold type consecutive command in IP SLA MPLS LSP monitor reaction condition configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# reaction monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react)# react connection-loss
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react-cond)# threshold type consecutive
2
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type average, on page 299
threshold type immediate, on page 303
threshold type xofy, on page 305
Description
Specifies what action or combination of actions the operation performs.
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures MPLS LSP monitoring reactions.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Sets the lower-limit and upper-limit values.
Takes action on average values to violate a threshold.
Takes action immediately upon a threshold violation.
Takes action upon X violations in Y probe operations.
302
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands threshold type immediate
threshold type immediate
To take action immediately upon a threshold violation, use the threshold type immediate command in the appropriate configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type immediate no threshold type
Syntax Description This command has no keywords or arguments.
Command Default If there is no default value, no threshold type is configured.
Command Modes IP SLA reaction condition configuration
IP SLA MPLS LSP monitor reaction condition configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor reaction condition configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines When the reaction conditions, such as threshold violations, are met for the monitored element, the action is immediately performed as defined by the action command.
If the threshold type immediate command is used in IP SLA reaction condition mode, it configures the threshold for the specific operation being configured. If the threshold type immediate command is used in
IP SLA MPLS LSP monitor reaction condition configuration mode, it configures the threshold for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
303 OL-26517-02
IP Service Level Agreement Commands threshold type immediate
Examples The following example shows how to use the threshold type immediate command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold type immediate
The following example shows how to use the threshold type immediate command in IP SLA MPLS LSP monitor reaction condition configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# reaction monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react)# react connection-loss
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-react-cond)# threshold type immediate
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type average, on page 299
threshold type consecutive, on page 301
threshold type xofy, on page 305
Description
Specifies what action or combination of actions the operation performs.
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures MPLS LSP monitoring reactions.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Sets the lower-limit and upper-limit values.
Takes action on average values to violate a threshold.
Takes action after a number of consecutive violations.
Takes action upon X violations in Y probe operations.
304
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands threshold type xofy
threshold type xofy
To take action upon X violations in Y probe operations, use the threshold type xofy command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type xofy x-value y-value no threshold type
Syntax Description x-value y-value When the reaction conditions, such as threshold violations, are met for the monitored element after some x number of violations within some other y number of probe operations (for example, x of y), the action is performed as defined by the action command. Default is 5 for both x-value and y-value; for example, xofy 5 5. Range is 1 to 16.
Command Default If there is no default value, no threshold type is configured.
Command Modes IP SLA reaction condition configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the threshold type xofy command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
305 OL-26517-02
IP Service Level Agreement Commands threshold type xofy
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# reaction operation 432
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react)# react jitter-average
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-react-cond)# threshold type xofy 1 5
Related Commands
Command
schedule operation, on page 236
reaction operation, on page 215
threshold type average, on page 299
threshold type consecutive, on page 301
threshold type immediate, on page 303
Description
Specifies what action or combination of actions the operation performs.
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures certain actions that are based on events under the control of the IP SLA agent.
Specifies an element to be monitored for a reaction.
Sets the lower-limit and upper-limit values.
Takes action on average values to violate a threshold.
Takes action after a number of consecutive violations.
Takes action immediately upon a threshold violation.
306
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands timeout (IP SLA)
timeout (IP SLA)
To set the probe or control timeout interval, use the timeout command in the appropriate configuration mode.
To use the default value, use the no form of this command.
timeout milliseconds no timeout
Syntax Description milliseconds Sets the amount of time (in milliseconds) that the IP SLA operation waits for a response from the request packet. Range is 1 to 604800000.
Command Default None.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
Support was added for IP SLA MPLS LSP ping and IP SLA MPLS
LSP trace configuration modes.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
307 OL-26517-02
IP Service Level Agreement Commands timeout (IP SLA)
Usage Guidelines If the timeout command is used in IP SLA operation mode, it configures the amount of time that a specific
IP SLA operation waits for a response from the request packet. If the timeout command is used in IP SLA
MPLS LSP monitor mode, it configures the amount of time that all operations associated with the monitored provider edge (PE) routers wait for a response from the request packet. This configuration is inherited by all
LSP operations that are created automatically.
Note The IP SLA responder needs at least one second to open a socket and program Local Packet Transport
Services (LPTS). Therefore, configure the IP SLA timeout to at least 2000 milli seconds.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the timeout command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# timeout 10000
The following example shows how to use the timeout command in IP SLA MPLS LSP monitor configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)# timeout 10000
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
308
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands tos
tos
To set the type of service (ToS) in a probe packet, use the tos command in the appropriate configuration mode.
To use the default value, use the no form of this command.
tos number no tos
Syntax Description number Type of service number. Range is 0 to 255.
Command Default The type of service number is 0.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The ToS value is an 8-bit field in IP headers. The field contains information, such as precedence and ToS.
The information is useful for policy routing and for features like Committed Access Rate (CAR) in which routers examine ToS values. When the type of service is defined for an operation, the IP SLA probe packet contains the configured tos value in the IP header.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
309 OL-26517-02
IP Service Level Agreement Commands tos
Examples The following example shows how to use the tos command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# tos 60
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
310
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands ttl
ttl
To specify the time-to-live (TTL) value in the MPLS label of echo request packets, use the ttl command in the appropriate configuration mode. To return to the default value, use the no form of this command.
ttl time-to-live no ttl
Syntax Description time-to-live Maximum hop count for an echo request packet. Valid values are from 1 to
255.
Command Default For an MPLS LSP ping operation, the default time-to-live value is 255.
For an MPLS LSP trace operations, the default time-to-live value is 30.
Command Modes IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor ping and monitor trace configuration modes.
This command was introduced.
This command was introduced.
Usage Guidelines Use the ttl command to set the maximum number of hops allowed for echo request packets in an MPLS LSP ping or MPLS LSP trace operation. Note that the number of possible hops differs depending the type of IP
SLA operation:
• For MPLS LSP ping operations, valid values are from 1 to 255 and the default is 255.
• For MPLS LSP trace operations, valid values are from 1 to 30 and the default is 30.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
311 OL-26517-02
IP Service Level Agreement Commands ttl
Task ID
If the ttl command is used in IP SLA operation mode, it configures the time-to-live value for the specific operation being configured. If the ttl command is used in IP SLA MPLS LSP monitor mode, it configures the time-to-live value for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the ttl command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)# ttl 200
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
312
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type icmp echo
type icmp echo
To use the ICMP echo operation type, use the type icmp echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp echo no type icmp echo
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes IP SLA operation configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the type icmp echo command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-echo)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
313 OL-26517-02
IP Service Level Agreement Commands type icmp echo
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
314
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type icmp path-echo
type icmp path-echo
To use the ICMP path-echo operation type, use the type icmp path-echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp path-echo no type icmp path-echo
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes IP SLA operation configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the type icmp path-echo command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-echo)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
315 OL-26517-02
IP Service Level Agreement Commands type icmp path-echo
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
316
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type icmp path-jitter
type icmp path-jitter
To use the ICMP path-jitter operation type, use the type icmp path-jitter command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp path-jitter no type icmp path-jitter
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes IP SLA operation configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the type icmp path-jitter command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type icmp path-jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-icmp-path-jitter)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
317 OL-26517-02
IP Service Level Agreement Commands type icmp path-jitter
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
318
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type mpls lsp ping
type mpls lsp ping
To verify the end-to-end connectivity of a label switched path (LSP) and the integrity of an MPLS network, use the type mpls lsp ping command in the appropriate configuration mode. To remove the operation, use the no form of this command.
type mpls lsp ping no type mpls lsp ping
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes IP SLA operation configuration
IP SLA MPLS LSP monitor definition configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines Use the type mpls lsp ping command to configure parameters for an IP SLA LSP ping operation. After you enter the command, you enter IP SLA MPLS LSP Ping configuration mode.
An MPLS LSP ping operation tests connectivity between routers along an LSP path in an MPLS network and measures round-trip delay of the LSP by using an echo request and echo reply.
The MPLS LSP ping operation verifies LSP 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:
• IPv4 LDP prefixes (configured with the
command)
• MPLS TE tunnels (configured with the
target traffic-eng , on page 295
command)
• Pseudowire (configured with the
target pseudowire, on page 293
command)
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
319 OL-26517-02
IP Service Level Agreement Commands type mpls lsp ping
Task ID
For MPLS LSP monitor ping operations, only IPv4 LDP prefixes are supported.
If the type mpls lsp ping command is used in IP SLA operation configuration mode, it configures the parameters for the specific operation being configured. If the type mpls lsp ping command is used in IP SLA
MPLS LSP monitor configuration mode, it configures the parameters for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the type mpls lsp ping command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-ping)#
The following example shows how to use the type mpls lsp ping command in IP SLA MPLS LSP monitor configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp ping
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-ping)#
Related Commands
Command
schedule operation, on page 236
type mpls lsp trace, on page 321
Description
Configures an IP SLA MPLS LSP monitor instance.
Configures MPLS label switched path (LSP) monitoring.
Configures an IP SLA operation.
Schedules an IP SLA MPLS LSP monitoring instance.
Schedules an IP SLA operation.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
320
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type mpls lsp trace
type mpls lsp trace
To trace LSP paths and localize network faults in an MPLS network, use the type mpls lsp trace command in the appropriate configuration mode. To remove the operation, use the no form of this command.
type mpls lsp trace no type mpls lsp trace
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes IP SLA operation configuration
IP SLA MPLS LSP monitor definition configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was added to IP SLA MPLS LSP monitor configuration mode.
This command was introduced.
This command was introduced.
Usage Guidelines Use the type mpls lsp trace command to configure parameters for an IP SLA LSP trace operation. After you enter the command, you enter IP SLA MPLS LSP Trace configuration mode.
An MPLS LSP trace operation traces the hop-by-hop route of LSP paths to a target router and measures the hop-by-hop round-trip delay for IPv4 LDP prefixes and TE tunnel FECs in an MPLS network. Echo request packets are sent to the control plane of each transit label switching router (LSR). A transit LSR performs various checks to determine if it is a transit LSR for the LSP path. A trace operation allows you to troubleshoot network connectivity and localize faults hop-by-hop.
In an MPLS LSP trace operation, each transit LSR returns information related to the type of Forwarding
Equivalence Class (FEC) entity that is being traced. This information allows the trace operation to check if the local forwarding information matches what the routing protocols determine as the LSP path.
An MPLS label is bound to a packet according to the type of FEC used for the LSP. The following FEC types are supported for an MPLS LSP trace operation:
• LDP IPv4 prefixes (configured with the
command)
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
321 OL-26517-02
IP Service Level Agreement Commands type mpls lsp trace
Task ID
• MPLS TE tunnels (configured with the
target traffic-eng , on page 295
command)
For MPLS LSP monitor trace operations, only IPv4 LDP prefixes are supported.
If the type mpls lsp trace command is used in IP SLA operation configuration mode, it configures the parameters for the specific operation being configured. If the type mpls lsp trace command is used in IP SLA
MPLS LSP monitor configuration mode, it configures the parameters for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID monitor
Operations read, write
Examples The following example shows how to use the type mpls lsp trace command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mpls-lsp-trace)#
The following example shows how to use the type mpls lsp trace command in IP SLA MPLS LSP monitor configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-trace)#
Related Commands
Command
schedule operation, on page 236
type mpls lsp ping, on page 319
Description
Configures an IP SLA operation.
Schedules an IP SLA MPLS LSP monitoring instance.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
322
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type udp echo
type udp echo
To use the UDP echo operation type, use the type udp echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type udp echo no type udp echo
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes IP SLA operation configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the type udp echo command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp echo
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-echo)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
323 OL-26517-02
IP Service Level Agreement Commands type udp echo
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
324
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type udp jitter
type udp jitter
To use the UDP jitter operation type, use the type udp jitter command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type udp jitter no type udp jitter
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes IP SLA operation configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the type udp jitter command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)#
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
325 OL-26517-02
IP Service Level Agreement Commands type udp jitter
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
326
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands type udp ipv4 address
type udp ipv4 address
To configure a permanent port in the IP SLA responder for UDP echo or jitter operations, use the type udp
ipv4 address command in IP SLA responder configuration mode. To remove the specified permanent port, use the no form of this command.
type udp ipv4 address ip-address port port
no type udp ipv4 address ip-address port port
Syntax Description ip-address
port port
Specifies the IPv4 address at which the operation is received.
Specifies the port number at which the operation is received. Range is identical to the one used for the subagent that is, 1 to 65355.
Command Default If there is no default value, no permanent port is configured.
Command Modes IP SLA responder configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to configure a permanent port for the type udp ipv4 address command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
327 OL-26517-02
IP Service Level Agreement Commands type udp ipv4 address
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# responder
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-resp)# type udp ipv4 address 192.0.2.11
port 10001
Related Commands
Command
Description
Enables the IP SLA responder for a UDP echo or jitter operation.
328
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands verify-data
verify-data
To check each IP SLA response for corruption, use the verify-data command in the appropriate configuration mode. To disable data corruption checking, use the no form of this command.
verify-data no verify-data
Syntax Description This command has no keywords or arguments.
Command Default The verify-data command is disabled.
Command Modes IP SLA UDP echo configuration
IP SLA UDP jitter configuration
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the verify-data command in IP SLA UDP jitter configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# verify-data
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
329 OL-26517-02
IP Service Level Agreement Commands verify-data
Related Commands
Command
schedule operation, on page 236
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
330
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands vrf (IP SLA)
vrf (IP SLA)
To enable the monitoring of a Virtual Private Network (VPN) in an ICMP echo, ICMP path-echo, ICMP path-jitter, UDP echo, or UDP jitter operation, use the vrf command in the appropriate configuration mode.
To disable VPN monitoring, use the no form of this command.
vrf vrf-name no vrf
Syntax Description vrf-name Name of the VPN. Maximum length is 32 alphanumeric characters.
Command Default VPN monitoring is not configured for an IP SLA operation.
Command Modes IP SLA ICMP path-jitter configuration
IP SLA ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA UDP echo configuration
IP SLA UDP jitter configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP trace configuration
Command History
Release
Release 3.4.0
Release 3.4.0
Release 3.7.2
Release 5.2.3
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the vrf command to configure a non-default VPN routing and forwarding (VRF) table for an IP SLA operation. A VPN is commonly identified using the name of a VRF table. If you use the vrf command in the configuration of an IP SLA operation, the vrf-name value is used to identify the VPN for the particular operation.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
331 OL-26517-02
IP Service Level Agreement Commands vrf (IP SLA)
Task ID
The default VRF table is used if no value is specified with the vrf command. If you enter a VPN name for an unconfigured VRF, the IP SLA operation fails and the following information is displayed in the results for the
show ipsla statistics, on page 258
command:
Latest operation return code : VrfNameError
The vrf command is supported only to configure the following IP SLA operations:
• IP SLA ICMP echo
• IP SLA ICMP path-echo
• IP SLA ICMP path-jitter
• IP SLA UDP echo
• IP SLA UDP jitter
• IP SLA MPLS LSP ping
• IP SLA MPLS LSP trace
Task ID monitor
Operations read, write
Examples The following example shows how to use the vrf command:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# operation 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-op)# type udp jitter
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-udp-jitter)# vrf vpn2
Related Commands
Command
schedule operation, on page 236
type icmp path-echo, on page 315
type icmp path-jitter, on page 317
Description
Configures an IP SLA operation.
Schedules an IP SLA operation.
Configures an IP SLA UDP jitter operation.
Configures an IP SLA ICMP echo operation.
Configures an IP SLA ICMP path-echo operation.
Configures an IP SLA ICMP path-jitter operation.
Configures an IP SLA UDP echo operation.
332
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
IP Service Level Agreement Commands vrf (IP SLA MPLS LSP monitor)
vrf (IP SLA MPLS LSP monitor)
To specify which virtual routing and forwarding instance (VRF) is monitored in an IP SLA MPLS LSP monitor ping or trace, use the vrf command in the the appropriate configuration mode. To revert to the monitoring of all VRFs, use the no form of this command.
vrf vrf-name no vrf
Syntax Description vrf-name Name of the VRF. Maximum length is 32 alphanumeric characters.
Command Default All VRFs are monitored.
Command Modes IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configuration
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The vrf command in IP SLA MPLS LSP monitor configuration mode specifies to monitor a specific VRF in ping and trace operations. The default is that all VRFs are monitored.
Task ID
Task ID monitor
Operations read, write
Examples The following example shows how to use the vrf command in IP SLA MPLS LSP monitor configuration mode:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# ipsla
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
333 OL-26517-02
IP Service Level Agreement Commands vrf (IP SLA MPLS LSP monitor)
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla)# mpls lsp-monitor
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm)# monitor 2
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-def)# type mpls lsp trace
RP/0/0RP0RSP0/CPU0:router:hostname(config-ipsla-mplslm-lsp-trace)# vrf vpn-lsp
Related Commands
Command
type mpls lsp ping, on page 319
type mpls lsp trace, on page 321
Description
Configures an IP SLA MPLS LSP monitor instance.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an
MPLS VPN.
334
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Logging Services Commands
This module describes the Cisco IOS XR software commands to configure system logging (syslog) for system monitoring on the router.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
For detailed information about logging concepts, configuration tasks, and examples, see the Implementing
Logging Services module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000
Series RouterCisco IOS XR System Monitoring Configuration Guide for the Cisco CRS RouterCisco ASR 9000
Series Aggregation Services Router System Monitoring Configuration GuideSystem Monitoring Configuration
Guide for Cisco NCS 6000 Series Routers.
For alarm management and logging correlation commands, see the Alarm Management and Logging
Correlation Commands module in the Cisco IOS XR System Monitoring Command Reference for the
Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Command Reference for the Cisco CRS
RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Command ReferenceSystem
Monitoring Command Reference for Cisco NCS 6000 Series Routers.
For detailed information about alarm and logging correlation concepts, configuration tasks, and examples, see the Implementing Alarm Logs and Logging Correlation module in the Cisco IOS XR System Monitoring
Configuration Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration
Guide for the Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring
Configuration GuideSystem Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
•
•
•
•
•
•
•
•
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
335
•
•
logging console disable, page 354
•
logging events link-status, page 355
•
logging events link-status (interface), page 357
•
•
•
logging history size, page 365
•
logging hostnameprefix, page 367
•
•
logging localfilesize, page 372
•
•
logging source-interface, page 376
•
logging suppress deprecated, page 378
•
logging suppress duplicates, page 379
•
•
•
•
•
show logging history, page 393
•
Logging Services Commands
336
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands archive-length
archive-length
To specify the length of time that logs are maintained in the logging archive, use the archive-length command in logging archive configuration mode. To return to the default, use the no form of this command.
archive-length weeks no archive-length
Syntax Description weeks Length of time (in weeks) that logs are maintained in the archive. Range is 0 to
4294967295.
Command Default weeks: 4 weeks
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the archive-length command to specify the maximum number of weeks that the archive logs are maintained in the archive. Any logs older than this number are automatically removed from the archive.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the log archival period to 6 weeks:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# archive-length 6
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
337 OL-26517-02
Logging Services Commands archive-size
archive-size
To specify the amount of space allotted for syslogs on a device, use the archive-size command in logging archive configuration mode. To return to the default, use the no form of this command.
archive-size size no archive-size
Syntax Description size Amount of space (in MB) allotted for syslogs. The range is 0 to 4294967295 2047.
Command Default size: 20 MB
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the archive-length command to specify the maximum total size of the syslog archives on a storage device.
If the size is exceeded, then the oldest file in the archive is deleted to make space for new logs.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the allotted space for syslogs to 50 MB:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# archive-size 50
338
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands clear logging
clear logging
To clear system logging (syslog) messages from the logging buffer, use the clear logging command in EXEC modeXR EXEC mode.
clear logging
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was supported.
Removed the internal keyword.
This command was introduced.
This command was introduced.
Usage Guidelines Use the clear logging command to empty the contents of the logging buffer. When the logging buffer becomes full, new logged messages overwrite old messages.
Use the
command to specify the logging buffer as a destination for syslog messages, set the size of the logging buffer, and limit syslog messages sent to the logging buffer based on severity.
Use the
command to display syslog messages stored in the logging buffer.
Task ID
Task ID logging
Operations execute
Examples This example shows how to clear the logging buffer:
RP/0/0RP0RSP0/CPU0:router:hostname# clear logging
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
339 OL-26517-02
Logging Services Commands clear logging
Clear logging buffer [confirm] [y/n] : y
Related Commands
Command
Description
Specifies the logging buffer as a destination for syslog messages, sets the size of the logging buffer, and limits syslog messages sent to the logging buffer based on severity.
Displays syslog messages stored in the logging buffer.
340
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands device
device
To specify the device to be used for logging syslogs, use the device command in logging archive configuration mode. To return to the default, use the no form of this command.
device {disk0| disk1| harddisk} no device
Syntax Description disk0 disk1 harddisk
Uses disk0 as the archive device.
Uses disk1 as the archive device.
Uses the harddisk as the archive device.
Command Default None
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the device command to specify where syslogs are logged. The logs are created under the directory
<device>/var/log. If the device is not configured, then all other logging archive configurations are rejected.
Similarly, the configured device cannot be removed until the other logging archive configurations are removed.
It is recommended that the syslogs be archived to the harddisk because it has more capacity.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
341 OL-26517-02
Logging Services Commands device
Examples This example shows how to specify disk1 as the device for logging syslog messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# device disk1
342
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands file-size
file-size
To specify the maximum file size for a log file in the archive, use the file-size command in logging archive configuration mode. To return to the default, use the no form of this command.
file-size size no file-size
Syntax Description size Maximum file size (in MB) for a log file in the logging archive. The range is 1 to 2047.
Command Default size: 1 MB
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the file-size command to specify the maximum file size 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.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the maximum log file size to 10 MB:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# file-size 10
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
343 OL-26517-02
Logging Services Commands frequency (logging)
frequency (logging)
To specify the collection period for logs, use the frequency command in logging archive configuration mode.
To return to the default, use the no form of this command.
frequency {daily| weekly} no frequency
Syntax Description daily weekly
Logs are collected daily.
Logs are collected weekly.
Command Default Logs are collected daily.
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Usage Guidelines Use the frequency command to specify if logs are collected daily or weekly.
Task ID
Task ID logging
Operations read, write
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
This example shows how to specify that logs are collected weekly instead of daily:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# frequency weekly
344
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging
logging
To specify a system logging (syslog) server host as the recipient of syslog messages, use the logging command in Global Configuration modeXR Config mode. To remove the logging command from the configuration file and delete a syslog server from the list of syslog server hosts, use the no form of this command.
logging {ip-address| hostname}{ vrf| severity| [alerts| critical| debugging| emergencies| error| info|
notifications| warning]}
no logging {ip-address| hostname}{ vrf| severity| [alerts| critical| debugging| emergencies| error| info|
notifications| warning]}
logging {ip-address| hostname| {vrf| vrf_name}}{archive| buffered| console| correlator| disable| events|
facility| history| hostnameprefix| localfilesize| monitor| source-interface| suppress| trap}
no logging {ip-address| hostname| {vrf| vrf_name}}{archive| buffered| console| correlator| disable| events|
facility| history| hostnameprefix| localfilesize| monitor| source-interface| suppress| trap}
Syntax Description
ip-address | hostname severity alerts critical debugging emergencies error info notifications warning
vrf vrf-name
IP address or hostname of the host to be used as a syslog server.
Set severity of messages for particular remote host/vrf.
Specifies Immediate action needed
Specifies Critical conditions
Specifies Debugging messages
Specifies System is unusable
Specifies Error conditions
Specifies Informational messages
Specifies Normal but significant conditions
Specifies Warning conditions
Name of the VRF. Maximum length is 32 alphanumeric characters.
ip-address | hostname
vrf vrf-name archive
IP address or hostname of the host to be used as a syslog server.
Name of the VRF. Maximum length is 32 alphanumeric characters.
Specifies logging to a persistent device(disk/harddisk).
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
345 OL-26517-02
Logging Services Commands logging buffered console correlator disable events facility history hostnameprefix localfilesize monitor source-interfac suppress trap
Sets buffered logging parameters.
Sets console logging.
Configures properties of the event correlator
Disables console logging.
Configures event monitoring parameters.
Modifies message logging facilities.
Sets history logging.
Adds the hostname prefix to messages on servers.
Sets size of the local log file.
Sets monitor logging
Specifies interface for source address in logging transactions.
Configures properties for the event suppression.
Sets trap logging.
Command Default No syslog server hosts are configured as recipients of syslog messages.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 4.1.0
Release 4.3
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
The vrf keyword was added.
The severity keyword was added.
This command was introduced.
346
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging
Usage Guidelines Use the logging command to identify a syslog server host to receive messages. By issuing this command more than once, you build a list of syslog servers that receive messages.
When syslog messages are sent to a syslog server, the Cisco IOS XR software includes a numerical message identifier in syslog messages. The message identifier is cumulative and sequential. The numerical identifier included in syslog messages sent to syslog servers provides a means to determine if any messages have been lost.
Use the
command to limit the messages sent to snmp server.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to log messages to a host named host1:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging host1
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging A.B.C.D
severity Set severity of messages for particular remote host/vrf vrf Set VRF option
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging A.B.C.D
RP/0/0RP0RSP0/CPU0:router:hostname(config)# commit
Wed Nov 14 03:47:58.976 PST
RP/0/0RP0RSP0/CPU0:router:hostname(config)# do show run logging
Wed Nov 14 03:48:10.816 PST logging A.B.C.D vrf default severity info
Note Default level is severity info.
Related Commands
Command
Description
Limits the messages sent to snmp server.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
347
Logging Services Commands logging archive
logging archive
To configure attributes for archiving syslogs, use the logging archive command in Global Configuration modeXR Config mode. To exit the logging archive submode, use the no form of this command.
logging archive{archive-length| archive-size| device| file-size| frequency| severity} no logging archive
Syntax Description archive-length archive-size device file-size frequency severity
Maximum no of weeks that the log is maintained. Minimum number of week is 1 and the maximum number of weeks are 256. Recommended is 4 weeks.
Total size of the archive. Value range from 1 MB to 2047 MB. Recommended is 20
MB.
Use configured devices (disk0 | disk1 | harddisk) as the archive device. Recommended is harddisk.
Maximum file size for a single log file. Value range from 1 MB to 2047 MB.
Recommended is 1 MB.
Collection interval (daily or weekly) for logs. Recommend is daily.
Specifies the filter levels for log messages to archive.
• alerts - Immediate action needed (severity=1)
• critical - Critical conditions (severity=2)
• debugging - Debugging messages (severity=7)
• emergencies - System is unusable (severity=0)
• errors - Error conditions (severity=3)
• informational - Informational messages (severity=6)
• notifications - Normal but significant conditions (severity=5)
• warnings Warning conditions (severity=4)
Recommended is informational (severity=6).
Command Default None
Command Modes Global Configuration modeXR Config mode
348
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging archive
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Usage Guidelines Use the logging archive command to configure attributes for archiving syslogs. This command enters logging archive configuration mode and allows you to configure the commands.
Note The configuration attributes must be explicitly configured in order to use the logging archive feature.
Task ID
Task ID logging
Operations read, write
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
This example shows how to enter logging archive configuration mode and change the device to be used for logging syslogs to disk1:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# device disk1
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
349
Logging Services Commands logging buffered
logging buffered
To specify the logging buffer as a destination for system logging (syslog) messages, use the logging buffered command in Global Configuration modeXR Config mode. To remove the logging buffered command from the configuration file and cancel the use of the buffer, use the no form of this command.
logging buffered {size| severity}
no logging buffered {size| severity}
Syntax Description size severity
Size of the buffer, in bytes. Range is 307200 to 125000000 bytes. The default is 307200 bytes.
Severity level of messages that display on the console. Possible severity levels and their respective system conditions are listed under
Table 28: Severity Levels for Messages, on
page 351 in the “Usage Guidelines” section. The default is debugging.
Command Default size: 307200 bytes
severity: debugging
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 4.0.0
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
The value of size argument is changed from 4096 to 307200.
This command was introduced.
Usage Guidelines Use the logging buffered command to copy messages to the logging buffer. The logging buffer is circular, so newer messages overwrite older messages after the buffer is filled. This command is related to the show
logging buffer command, which means that when you execute a logging buffered warnings command, it enables the logging for all the levels below the configured level, including log for LOG_ERR, LOG_CRIT,
LOG_ALERT, LOG_EMERG, and LOG_WARNING messages. Use the logging buffer size to change the size of the buffer.
350
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging buffered
The value specified for the severity argument causes messages at that level and at numerically lower levels to be displayed on the console terminal. See
Table 28: Severity Levels for Messages, on page 351
for a list of the possible severity level keywords for the severity argument.
This table describes the acceptable severity levels for the severity argument.
Table 28: Severity Levels for Messages
Level Keywords emergencies alerts critical errors warnings notifications informational debugging
Level
0
1
2
3
4
5
6
7
Description
Unusable system
Need for immediate action
Critical condition
Error condition
Warning condition
Normal but significant condition
Informational message only
Debugging message
Syslog Definition
LOG_EMERG
LOG_ALERT
LOG_CRIT
LOG_ERR
LOG_WARNING
LOG_NOTICE
LOG_INFO
LOG_DEBUG
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the severity level of syslog messages logged to the buffer to notifications:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging buffered notifications
Related Commands
Command
Description
Clears messages from the logging buffer.
Displays syslog messages stored in the logging buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
351
Logging Services Commands logging console
logging console
To enable logging of system logging (syslog) messages logged to the console by severity level, use the logging
console command in Global Configuration modeXR Config mode. To return console logging to the default setting, use the no form of this command.
logging console {severity| disable} no logging console
Syntax Description severity disable
Severity level of messages logged to the console, including events of a higher severity level (numerically lower). The default is informational. Settings for the severity levels and their respective system conditions are listed in
Table 28: Severity Levels for Messages,
on page 351 under the “Usage Guidelines” section for the
command.
Removes the logging console command from the configuration file and disables logging to the console terminal.
Command Default By default, logging to the console is enabled.
severity: informational
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Added the disable keyword.
The command no logging console was changed to reset console logging to the default setting.
This command was introduced.
This command was introduced.
Usage Guidelines Use the logging console command to prevent debugging messages from flooding your screen.
The logging console is for the console terminal. The value specified for the severity argument causes messages at that level and at numerically lower levels (higher severity levels) to be displayed on the console.
352
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging console
Task ID
Use the logging console disable command to disable console logging completely.
Use the no logging console command to return the configuration to the default setting.
Use the
command to display syslog messages stored in the logging buffer.
Task ID logging
Operations read, write
Examples This example shows how to change the level of messages displayed on the console terminal to alerts (1), which means that alerts (1) and emergencies (0) are displayed:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging console alerts
This example shows how to disable console logging:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging console disable
This example shows how to return console logging to the default setting (the console is enabled, severity:
informational):
RP/0/0RP0RSP0/CPU0:router:hostname# no logging console
Related Commands
Command
Description
Displays syslog messages stored in the logging buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
353
Logging Services Commands logging console disable
logging console disable
To disable logging of system logging (syslog) messages logged to the console, use the logging console disable command in Global Configuration modeXR Config mode. To return logging to the default setting, use the
no form of this command.
logging consoledisable no logging consoledisable
Syntax Description This command has no keywords or arguments.
Command Default By default, logging is enabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.3.0
Release 3.3.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the logging console disable command to disable console logging completely.
Use the no logging console disable command to return the configuration to the default setting.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to disable syslog messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging console disable
354
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging events link-status
logging events link-status
To enable the logging of link-status system logging (syslog) messages for logical and physical links, use the
logging events link-status command in Global Configuration modeXR Config mode. To disable the logging of link status messages, use the no form of this command.
logging events link-status {disable| software-interfaces}
no logging events link-status [disable| software-interfaces]
Syntax Description disable software-interfaces
Disables the logging of link-status messages for all interfaces, including physical links.
Enables the logging of link-status messages for logical links as well as physical links.
Command Default The logging of link-status messages is enabled for physical links.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced
This command was introduced.
The logical and physical keywords were replaced by the
software-interfaces and disable keywords.
This command was introduced.
This command was introduced.
Usage Guidelines When the logging of link-status messages is enabled, the router can generate a high volume of link-status up and down system logging messages.
Use the no logging events link-status command to enable the logging of link-status messages for physical links only, which is the default behavior.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
355 OL-26517-02
Logging Services Commands logging events link-status
Task ID
Note Enabling the
logging events link-status (interface), on page 357
command on a specific interface overrides the global configurationXR Config set using the logging events link-status command described in this section.
Task ID logging
Operations read, write
Examples This example shows how to disable the logging of physical and logical link-status messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging events link-status disable
Related Commands
Command
logging events link-status (interface), on page 357
Description
Enables the logging of link-status system logging
(syslog) messages on a specific interface for virtual interfaces and subinterfaces.
356
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging events link-status (interface)
logging events link-status (interface)
To enable the logging of link-status system logging (syslog) messages on a specific interface for virtual interfaces and subinterfaces, use the logging events link-status command in the appropriate interface or subinterface mode. To disable the logging of link status messages, use the no form of this command.
logging events link-status no logging events link-status
Syntax Description This command has no keywords or arguments.
Command Default The logging of link-status messages is disabled for virtual interfaces and subinterfaces.
Command Modes Interface configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When the logging of link-status messages is enabled, the router can generate a high volume of link-status up and down system logging messages. The logging events link-status command enables messages for virtual interfaces and subinterfaces only.
The logging events link-status command allows you to enable and disable logging on a specific interface for bundles, tunnels, and VLANs.
Use the no logging events link-status command to disable the logging of link-status messages.
Note Enabling the logging events link-status command on a specific interface overrides the global configuration set using the
logging events link-status, on page 355
command in global configuration mode.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
357 OL-26517-02
Logging Services Commands logging events link-status (interface)
Examples This example shows the results of turning on logging for a bundle interface:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# int bundle-GigabitEthernet pos 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# logging events link-status
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# no shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
LC/0/4/CPU0:Jun 29 12:51:26.887 : ifmgr[142]:
%PKT_INFRA-LINK-3-UPDOWN : Interface GigabitEthernet0POS0/4/0/0, changed state to Up
LC/0/4/CPU0:Jun 29 12:51:26.897 : ifmgr[142]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface GigabitEthernet0POS0/4/0/0, changed state to Up
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)#
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
LC/0/4/CPU0:Jun 29 12:51:32.375 : ifmgr[142]:
%PKT_INFRA-LINK-3-UPDOWN : Interface GigabitEthernet0POS0/4/0/0, changed state to Down
LC/0/4/CPU0:Jun 29 12:51:32.376 : ifmgr[142]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface GigabitEthernet0POS0/4/0/0, changed state to Down
This example shows a sequence of commands for a tunnel interface with and without logging turned on:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# int tunnel-te 1
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# no shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# logging events link-status
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/RSP0RP00/CPU0:Jun 29 14:05:57.732 : ifmgr[176]:
%PKT_INFRA-LINK-3-UPDOWN : Interface tunnel-te1, changed state to Administratively Down
RP/0/RSP0RP00/CPU0:Jun 29 14:05:57.733 : ifmgr[176]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface tunnel-te1, changed state to
Administratively Down
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# no shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# commit
RP/0/RSP0RP00/CPU0:Jun 29 14:06:02.104 : ifmgr[176]:
%PKT_INFRA-LINK-3-UPDOWN : Interface tunnel-te1, changed state to Down
RP/0/RSP0RP00/CPU0:Jun 29 14:06:02.109 : ifmgr[176]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface tunnel-te1, changed state to
Down
This example shows the same process for a subinterface:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# int gigabitEthernet 0/5/0/0.1
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# no shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# logging events link-status
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# shutdown
358
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging events link-status (interface)
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
LC/0/5/CPU0:Jun 29 14:06:46.710 : ifmgr[142]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface GigabitEthernet0/5/0/0.1, changed state to Administratively Down
LC/0/5/CPU0:Jun 29 14:06:46.726 : ifmgr[142]:
%PKT_INFRA-LINK-3-UPDOWN : Interface GigabitEthernet0/5/0/0.1, changed state to
Administratively Down
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# no shutdown
RP/0/0RP0RSP0/CPU0:router:hostname(config-subif)# commit
LC/0/5/CPU0:Jun 29 14:06:52.229 : ifmgr[142]:
%PKT_INFRA-LINK-3-UPDOWN : Interface GigabitEthernet0/5/0/0.1, changed state to Up
LC/0/5/CPU0:Jun 29 14:06:52.244 : ifmgr[142]:
%PKT_INFRA-LINEPROTO-6-UPDOWN : Line protocol on Interface GigabitEthernet0/5/0/0.1, changed state to Down
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
359
Logging Services Commands logging facility
logging facility
To configure the type of syslog facility in which system logging (syslog) messages are sent to syslog servers, use the logging facility command in Global Configuration modeXR Config mode. To remove the logging
facility command from the configuration file and disable the logging of messages to any facility type, use the
no form of this command.
logging facility [ type ] no logging facility
Syntax Description type (Optional) Syslog facility type. The default is local7. Possible values are listed under
29: Facility Type Descriptions , on page 360
in the “Usage Guidelines” section.
Command Default type: local7
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines This table describes the acceptable options for the type argument.
Table 29: Facility Type Descriptions
Facility Type auth cron daemon kern
Description
Authorization system
Cron/at facility
System daemon
Kernel
360
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands
Task ID logging facility local5 local6 local7 lpr mail news sys9
Facility Type local0 local1 local2 local3 local4 sys10 sys11 sys12 sys13 sys14 syslog user uucp
Description
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Reserved for locally defined messages
Line printer system
Mail system
USENET news
System use
System use
System use
System use
System use
System use
System log
User process
UNIX-to-UNIX copy system
Use the
command to specify a syslog server host as a destination for syslog messages.
Task ID logging
Operations read, write
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
361
Logging Services Commands logging facility
Examples This example shows how to configure the syslog facility to the kern facility type:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging facility kern
Related Commands
Command
Description
Specifies a syslog server host as a destination for syslog messages.
362
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging history
logging history
To change the severity level of system logging (syslog) messages sent to the history table on the router and a Simple Network Management Protocol (SNMP) network management station (NMS), use the logging
history command in Global Configuration modeXR Config mode. To remove the logging history command from the configuration and return the logging of messages to the default level, use the no form of this command.
logging history severity no logging history
Syntax Description severity Severity level of messages sent to the history table on the router and an SNMP NMS, including events of a higher severity level (numerically lower). Settings for the severity levels and their respective system conditions are listed in
Table 28: Severity Levels for Messages, on page
351 under the “Usage Guidelines” section for the logging buffered command.
Command Default severity: warnings
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Logging of messages to an SNMP NMS is enabled by the snmp-server enable traps command. Because
SNMP traps are inherently unreliable and much too important to lose, at least one syslog message, the most recent message, is stored in a history table on the router.
Use the logging history command to reflect the history of last 500 syslog messages. For example, when this command is issued, the last 500 syslog messages with severity less than warning message are displayed in the output of show logging history command.
Use the
show logging history, on page 393
command to display the history table, which contains table size, message status, and message text data.
Use the
logging history size, on page 365
command to change the number of messages stored in the history table.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
363 OL-26517-02
Logging Services Commands logging history
Task ID
The value specified for the severity argument causes messages at that severity level and at numerically lower levels to be stored in the history table of the router and sent to the SNMP NMS. Severity levels are numbered 0 to 7, with 1 being the most important message and 7 being the least important message (that is, the lower the number, the more critical the message). For example, specifying the level critical with the critical keyword causes messages at the severity level of critical (2), alerts (1), and emergencies (0) to be stored in the history table and sent to the SNMP NMS.
The no logging history command resets the history level to the default.
Task ID logging
Operations read, write
Examples This example shows how to change the level of messages sent to the history table and to the SNMP server to
alerts (1), which means that messages at the severity level of alerts (1) and emergencies (0) are sent:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging history alerts
Related Commands
Command
logging history size, on page 365
show logging history, on page 393
Description
Changes the number of messages stored in the history table.
Displays information about the state of the syslog history table.
364
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging history size
logging history size
To change the number of system logging (syslog) messages that can be stored in the history table, use the
logging history size command in Global Configuration modeXR Config mode. To remove the logging history
size command from the configuration and return the number of messages to the default value, use the no form of this command.
logging history size number
no logging history number
Syntax Description number Number from 1 to 500 indicating the maximum number of messages that can be stored in the history table. The default is 1 message.
Command Default number: 1 message
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the logging history size command to change the number of messages that can be stored in this history table. When the history table is full (that is, when it contains the maximum number of messages specified with the command), the oldest message is deleted from the table to allow the new message to be stored.
Use the
command to change the severity level of syslog messages stored in the history file and sent to the SNMP server.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
365 OL-26517-02
Logging Services Commands logging history size
Examples This example shows how to set the number of messages stored in the history table to 20:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging history size 20
Related Commands
Command
show logging history, on page 393
Description
Changes the severity level of syslog messages stored in the history file and sent to the SNMP server.
Displays information about the state of the syslog history table.
366
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging hostnameprefix
logging hostnameprefix
To append a hostname prefix to system logging (syslog) messages logged to syslog servers, use the logging
hostnameprefix command in Global Configuration modeXR Config mode. To remove the logging
hostnameprefix command from the configuration file and disable the logging host name prefix definition, use the no form of this command.
logging hostnameprefix hostname no logging hostnameprefix
Syntax Description hostname Hostname that appears in messages sent to syslog servers.
Command Default No hostname prefix is added to the messages logged to the syslog servers.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the logging hostnameprefix command to append a hostname prefix to messages sent to syslog servers from the router. You can use these prefixes to sort the messages being sent to a given syslog server from different networking devices.
Use the
command to specify a syslog server host as a destination for syslog messages.
Task ID
Task ID logging
Operations read, write
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
367
Logging Services Commands logging hostnameprefix
Examples This example shows how to add the hostname prefix host1 to messages sent to the syslog servers from the router:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging hostnameprefix host1
Related Commands
Command
Description
Specifies a syslog server host as a destination for syslog messages.
368
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging ipv4/ipv6
logging ipv4/ipv6
To configure the differentiated services code point (DSCP) or the precedence value for the IPv4 or IPv6 header of the syslog packet in the egress direction, use the logging {ipv4 | ipv6} command in EXEC mode. To remove the configured DSCP or precedence value, use the no form of this command.
logging {ipv4| ipv6}{dscp dscp-value| precedence {number| name}}
no logging {ipv4| ipv6}{dscp dscp-value| precedence {number| name}}
Syntax Description
ipv4 / ipv6
dscp dscp-value
precedence {number |name}
Sets the DSCP or precedence bit for IPv4 or IPv6 packets.
Specifies differentiated services code point value or per hop behavior values (PHB). For more information on PHB values, see Usage Guideline section below. The range is from 0 to 63. The default value is 0.
Sets Type of Service (TOS) precedence value. You can specify either a precedence number or name. The range of argument number is between
0 to 7.
The name argument has following keywords:
• routine—Match packets with routine precedence ( 0)
• priority—Match packets with priority precedence (1)
• immediate—Match packets with immediate precedence (2)
• flash—Match packets with flash precedence (3)
• flash-override—Match packets with flash override precedence (4)
• critical—Match packets with critical precedence (5)
• internet—Match packets with internetwork control precedence (6)
• network—Match packets with network control precedence (7)
Command Default None.
Command Modes EXEC mode
Command History
Release
Release 5.1.1
Modification
The ipv4 and ipv6 keywords were added.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
369 OL-26517-02
Logging Services Commands logging ipv4/ipv6
Usage Guidelines By specifying PHB values you can further control the format of locally generated syslog traffic on the network.
You may provide these PHB values:
• af11—Match packets with AF11 DSCP (001010)
• af12—Match packets with AF12 dscp (001100)
• af13—Match packets with AF13 dscp (001110)
• af21— Match packets with AF21 dscp (010010)
• af22—Match packets with AF22 dscp (010100)
• af23—Match packets with AF23 dscp (010110)
• af31—Match packets with AF31 dscp (011010)
• af32—Match packets with AF32 dscp (011100)
• af33—Match packets with AF33 dscp (011110)
• af41—Match packets with AF41 dscp (100010)
• af42—Match packets with AF42 dscp (100100)
• af43— Match packets with AF43 dscp (100110)
• cs1—Match packets with CS1(precedence 1) dscp (001000)
• cs2—Match packets with CS2(precedence 2) dscp (010000)
• cs3—Match packets with CS3(precedence 3) dscp (011000)
• cs4—Match packets with CS4(precedence 4) dscp (100000)
• cs5—Match packets with CS5(precedence 5) dscp (101000)
• cs6—Match packets with CS6(precedence 6) dscp (110000)
• cs7—Match packets with CS7(precedence 7) dscp (111000)
• default—Match packets with default dscp (000000)
• ef—Match packets with EF dscp (10111)
Assured Forwarding (AF) PHB group is a means for a provider DS domain to offer different levels of forwarding assurances for IP packets. The Assured Forwarding PHB guarantees an assured amount of bandwidth to an
AF class and allows access to additional bandwidth, if obtainable.
For example AF PHB value af11 - Match packets with AF11 DSCP (001010), displays the DSCP values as
10 and 11. The DSCP bits are shown as 001010 and 001011 .
AF11 stands for:
• Assured forwarding class 1 (001)
• Drop priority 100 (1)
• Dropped last in AF1 class
370
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands
Task ID
Examples logging ipv4/ipv6
Similarly AF PHB value af12 - Match packets with AF12 dscp (001100), displays the DSCP values as 12 and
13. The DSCP bits are shown as 001100 and 001101.
AF12 stands for:
• Assured forwarding class 1 (001)
• Drop priority 100 (2)
• Dropped second in AF1 class
Class Selector (CS) provides backward compatibility bits,
CS PHB value cs1 - Match packets with CS1(precedence 1) dscp (001000)
CS1 stands for:
• CS1 DSCP bits are displayed as 001000 and 001001
• priority stated as 1
Expedited Forwarding (EF) PHB is defined as a forwarding treatment to build a low loss, low latency, assured bandwidth, end-to-end service. These characteristics are suitable for voice, video and other realtime services.
EF PHB Value ef - Match packets with EF dscp (101110) - this example states the recommended EF value
(used for voice traffic).
Task ID logging
Operation read, write
This example shows how to configure DSCP value as 1 for IPv4 header of syslog packet.
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging ipv4 dscp 1
This example shows how to configure DSCP value as 21 for IPv6 header of syslog packet.
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging ipv6 dscp 21
This example shows how to configure precedence value as 5 for IPv6 header of syslog packet.
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging ipv6 precedence 5
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
371
Logging Services Commands logging localfilesize
logging localfilesize
To specify the size of the local logging file, use the logging localfilesize command in Global Configuration modeXR Config mode. To remove the logging localfilesize command from the configuration file and restore the system to the default condition, use the no form of this command.
logging localfilesize bytes
no logging localfilesize bytes
Syntax Description bytes Size of the local logging file in bytes. Range is 0 to 4294967295. Default is 32000 bytes.
Command Default bytes: 32000 bytes
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the logging localfilesize command to set the size of the local logging file.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the local logging file to 90000 bytes:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging localfilesize 90000
372
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands
Related Commands
Command
logging localfilesize
Description
Displays syslog messages stored in the logging buffer.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
373
Logging Services Commands logging monitor
logging monitor
To specify terminal lines other than the console terminal as destinations for system logging (syslog) messages and limit the number of messages sent to terminal lines based on severity, use the logging monitor command in Global Configuration modeXR Config mode. To remove the logging monitor command from the configuration file and disable logging to terminal lines other than the console line, use the no form of this command.
logging monitor [ severity ] no logging monitor
Syntax Description severity (Optional) Severity level of messages logged to the terminal lines, including events of a higher severity level (numerically lower). The default is debugging. Settings for the severity levels and their respective system conditions are listed under
Table 28: Severity Levels for Messages,
on page 351 in the “Usage Guidelines” section for the logging buffered command.
Command Default severity: debugging
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging monitor is for the terminal monitoring. Use the logging monitor command to restrict the messages displayed on terminal lines other than the console line (such as virtual terminals). The value set for the severity argument causes messages at that level and at numerically lower levels to be displayed on the monitor.
Use the
command to enable the display of syslog messages for the current terminal session.
374
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging monitor
Task ID
Task ID logging
Operations read, write
Examples This example shows how to set the severity level of messages logged to terminal lines to errors:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging monitor errors
Related Commands
Command
Description
Enables the display of syslog messages for the current terminal session.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
375
Logging Services Commands logging source-interface
logging source-interface
To set all system logging (syslog) messages being sent to syslog servers to contain the same IP address, regardless of which interface the syslog message uses to exit the router, use the logging source-interface command in Global Configuration modeXR Config mode. To remove the logging source-interface command from the configuration file and remove the source designation, use the no form of this command.
logging source-interface type interface-path-id no logging source-interface
Syntax Description type interface-path-id
Interface type. For more information, use the question mark (?) online help function.
Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark (?) online help function.
Command Default No source IP address is specified.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Normally, a syslog message contains the IP address of the interface it uses to leave the networking device.
Use the logging source-interface command to specify that syslog packets contain the IP address of a particular interface, regardless of which interface the packet uses to exit the networking device.
Use the
command to specify a syslog server host as a destination for syslog messages.
376
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging source-interface
Task ID
Task ID logging
Operations read, write
Examples This example shows how to specify that the IP address for GigabitEthernet interface 0/1/0/1
Packet-over-SONET/SDH (POS) interface 0/1/0/1HundredGigE interface 0/1/0/0 be set as the source IP address for all messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging source-interface GigabitEthernet
0/1/0/1pos 0/1/0/1HundredGigE 0/1/0/0
Related Commands
Command
Description
Specifies a syslog server host as a destination for syslog messages.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
377
Logging Services Commands logging suppress deprecated
logging suppress deprecated
To prevent the logging of messages to the console to indicate that commands are deprecated, use the logging
suppress deprecated command in Global Configuration modeXR Config mode. To remove the logging
suppress deprecated command from the configuration file, use the no form of this command.
logging suppress deprecated no logging suppress deprecated
Syntax Description This command has no keywords or arguments.
Command Default Console messages are displayed when deprecated commands are used.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.5.0
Release 3.5.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines The logging suppress deprecated command affects messages to the console only.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to suppress the consecutive logging of deprecated messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress deprecated
378
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging suppress duplicates
logging suppress duplicates
To prevent the consecutive logging of more than one copy of the same system logging (syslog) message, use the logging suppress duplicates command in Global Configuration modeXR Config mode. To remove the
logging suppress duplicates command from the configuration file and disable the filtering process, use the
no form of this command.
logging suppress duplicates no logging suppress duplicates
Syntax Description This command has no keywords or arguments.
Command Default Duplicate messages are logged.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines If you use the logging suppress duplicates command during debugging sessions, you might not see all the repeated messages and could miss important information related to problems that you are attempting to isolate and resolve. In such a situation, you might consider disabling this command.
Task ID
Task ID logging
Operations read, write
Examples This example shows how to suppress the consecutive logging of duplicate messages:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging suppress duplicates
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
379 OL-26517-02
logging suppress duplicates
Related Commands
Command
Logging Services Commands
Description
Specifies a syslog server host as a destination for syslog messages.
Specifies the logging buffer as a destination for syslog messages, sets the size of the logging buffer, and limits the syslog messages sent to the logging buffer based on severity.
Specifies terminal lines other than the console terminal as destinations for syslog messages and limits the number of messages sent to terminal lines based on severity.
380
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands logging trap
logging trap
To specify the severity level of messages logged to snmp server, use the logging trap command in Global
Configuration modeXR Config mode. To restore the default behavior, use the no form of this command.
logging trap [ severity ] no logging trap
Syntax Description severity (Optional) Severity level of messages logged to the snmp server, including events of a higher severity level (numerically lower). The default is informational. Settings for the severity levels and their respective system conditions are listed under
in the “Usage Guidelines” section for the logging buffered command.
Command Default severity: informational
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.7.2
Release 4.3
Release 5.0.0
Modification
This command was introduced.
Change in the behavior of logging trap and logging severity for snmp and syslog servers.
This command was introduced.
Usage Guidelines Use the logging trap command to limit the logging of messages sent to snmp servers to only those messages at the specified level.
Table 28: Severity Levels for Messages, on page 351
under the “Usage Guidelines” section for the
command lists the syslog definitions that correspond to the debugging message levels.
Use the
command to specify a syslog server host as a destination for syslog messages.
The logging trap disable will disable the logging of messages to both snmp server and syslog servers.
Task ID
Task ID logging
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
381 OL-26517-02
Logging Services Commands logging trap
Examples This example shows how to restrict messages to notifications (5) and numerically lower levels.
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging trap notifications
Related Commands
Command
Description
Specifies a syslog server host as a destination for syslog messages.
382
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands service timestamps
service timestamps
To modify the time-stamp format for system logging (syslog) and debug messages, use the service timestamps command in Global Configuration modeXR Config mode. To revert to the default timestamp format, use the
no form of this command.
service timestamps [[debug| log] {datetime [localtime] [msec] [show-timezone] [year]| disable| uptime}]
no service timestamps [[debug| log] {datetime [localtime] [msec] [show-timezone] [year]| disable| uptime}]
Syntax Description debug log datetime localtime msec show-timezone year disable uptime
(Optional) Specifies the time-stamp format for debugging messages.
(Optional) Specifies the time-stamp format for syslog messages.
(Optional) Specifies that syslog messages are time-stamped with date and time.
(Optional) When used with the datetime keyword, includes the local time zone in time stamps.
(Optional) When used with the datetime keyword, includes milliseconds in the time stamp.
(Optional) When used with the datetime keyword, includes time zone information in the time stamp.
(Optional) Adds year information to timestamp.
(Optional) Causes messages to be time-stamped in the default format.
(Optional) Specifies that syslog messages are time-stamped with the time that has elapsed since the networking device last rebooted.
Command Default Messages are time-stamped in the month day hh:mm:ss by default.
The default for the service timestamps debug datetime and service timestamps log datetime forms of the command with no additional keywords is to format the time in Coordinated Universal Time (UTC) without milliseconds and time zone information.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Modification
This command was introduced.
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
383 OL-26517-02
Logging Services Commands service timestamps
Release
Release 3.7.2
Release 4.3
Release 5.0.0
Usage Guidelines Time stamps can be added to either debugging or syslog messages independently. The uptime keyword adds time stamps in the format hhhh:mm:ss, indicating the elapsed time in hours:minutes:seconds since the networking device last rebooted. The datetime keyword adds time stamps in the format mmm dd hh:mm:ss, indicating the date and time according to the system clock. If the system clock has not been set, the date and time are preceded by an asterisk (*), which indicates that the date and time have not been set and should be verified.
The no form of the service timestamps command causes messages to be time-stamped in the default format.
Entering the service timestamps form of this command without any keywords or arguments is equivalent to issuing the service timestamps debug uptime form of this command.
Task ID
Task ID logging
Operations read, write
Examples
Modification
This command was introduced.
The keyword year was added.
This command was introduced.
This example shows how to enable time stamps on debugging messages, which show the elapsed time since the networking device last rebooted:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# service timestamps debug uptime
This example shows how to enable time stamps on syslog messages, which show the current time and date relative to the local time zone, with the time zone name included:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# service timestamps log datetime localtime show-timezone
RP/0/0RP0RSP0/CPU0:router:hostname(config)# service timestamps log datetime year
384
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands severity
severity
To specify the filter level for logs, use the severity command in logging archive configuration mode. To return to the default, use the no form of this command.
severity {severity} no severity
Syntax Description severity Severity level for determining which messages are logged to the archive. Possible severity levels and their respective system conditions are listed under
in the “Usage Guidelines” section. The default is informational.
Command Default Informational
Command Modes Logging archive configuration
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the severity command to specify the filter level for syslog messages. All syslog messages higher in severity or the same as the configured value are logged to the archive.
Table 28: Severity Levels for Messages, on page 351
describes the acceptable severity levels for the severity argument.
Task ID
Task ID logging
Operations read, write
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
385
Logging Services Commands severity
Examples This example shows how to specify that warning conditions and higher-severity messages are logged to the archive:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# logging archive
RP/0/0RP0RSP0/CPU0:router:hostname(config-logging-arch)# severity warnings
386
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands show logging
show logging
To display the contents of the logging buffer, use the show logging command in EXEC modeXR EXEC mode.
show logging [[alarm-location location location]| [correlator options]| local location node-id| [location
node-id] [start month day hh : mm : ss] [process name] [string string] [end month day hh : mm :ss] [events
options] [history] [last entries] [suppress rule {rule_name| all}]]
Syntax Description
alarm-location trace location
correlatoroptions
(Optional) Displays the alarm-location information.
The trace option shows trace data for the alarm location components.
(Optional) Displays the content and information about correlation buffer. The various options available are:
• buffer: Displays the content of the correlation buffer.
• info: Displays information about event correlation.
• trace: Displays trace data for the alarm_logger component.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
387
show logging
end month day hh : mm : ss
events options history
Logging Services Commands
(Optional) Displays syslog messages with a time stamp equal to or lower than the time stamp specified with the monthday hh : mm : ss argument.
The ranges for the month day hh : mm : ss arguments are as follows:
• month—The month of the year. The values for the month argument are:
◦january
◦february
◦march
◦april
◦may
◦june
◦july
◦august
◦september
◦october
◦november
◦december
• day—Day of the month. Range is 01 to 31.
• hh :—Hours. Range is 00 to 23. You must insert a colon after the hh argument.
• mm :—Minutes. Range is 00 to 59. You must insert a colon after the mm argument.
• ss—Seconds. Range is 00 to 59.
Displays the content and information about event buffer.The various options available are:
• buffer: Displays the content of the event buffer.
• info: Displays information about events buffer.
• rule: Displays specified rules.
• ruleset: Displays rulesets.
• trace: Displays trace data for the correlation component.
Displays the contents of logging history.
388
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands
last entries
local location node-id
location node-id
start month day hh : mm : ss
OL-26517-02
process name show logging
Displays last <n> entries. The number of entries can range from 1 to 500.
(Optional) Displays system logging (syslog) messages from the specified local buffer. The node-id argument is entered in the rack/slot/modul e notation.
(Optional) Displays syslog messages from the designated node. The node-id argument is entered in the rack/slot/modul e notation.
(Optional) Displays syslog messages with a time stamp equal to or higher than the time stamp specified with the month day mm : hh : ss argument.
The ranges for the month day hh : mm : ss arguments are as follows:
• month—The month of the year. The values for the month argument are:
◦january
◦february
◦march
◦april
◦may
◦june
◦july
◦august
◦september
◦october
◦november
◦december
• day—Day of the month. Range is 01 to 31.
• hh :—Hours. Range is 00 to 23. You must insert a colon after the hh argument.
• mm :—Minutes. Range is 00 to 59. You must insert a colon after the mm argument.
• ss—Seconds. Range is 00 to 59.
(Optional) Displays syslog messages related to the specified process.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
389
Logging Services Commands show logging
string string
suppress rule{rule_name|all}
(Optional) Displays syslog messages that contain the specified string.
Displays the content and information about log suppression. The rule option shows specified rules.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Usage Guidelines Use the show logging command to display the state of syslog error and event logging on the processor console.
The information from the command includes the types of logging enabled and the size of the buffer.
Task ID
Task ID logging
Operations read
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
This is the sample output from the show logging command with the process keyword and name argument.
Syslog messages related to the init process are displayed in the sample output.
RP/0/0RP0RSP0/CPU0:router:hostname# show logging process init
Syslog logging: enabled (24 messages dropped, 0 flushes, 0 overruns)
Console logging: level warnings, 59 messages logged
Monitor logging: level debugging, 0 messages logged
Trap logging: level informational, 0 messages logged
Buffer logging: level debugging, 75 messages logged
Log Buffer (16384 bytes):
LC/0/1/CPU0:May 24 22:20:13.043 : init[65540]: %INIT-7-INSTALL_READY : total time 47.522
seconds
SP/0/1/SP:May 24 22:18:54.925 : init[65541]: %INIT-7-MBI_STARTED : total time 7.159 seconds
SP/0/1/SP:May 24 22:20:16.737 : init[65541]: %INIT-7-INSTALL_READY : total time 88.984
390
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands show logging seconds
SP/0/SM1/SP:May 24 22:18:40.993 : init[65541]: %INIT-7-MBI_STARTED : total time 7.194 seconds
SP/0/SM1/SP:May 24 22:20:17.195 : init[65541]: %INIT-7-INSTALL_READY : total time 103.415
seconds
SP/0/2/SP:May 24 22:18:55.946 : init[65541]: %INIT-7-MBI_STARTED : total time 7.152 seconds
SP/0/2/SP:May 24 22:20:18.252 : init[65541]: %INIT-7-INSTALL_READY : total time 89.473
seconds
This is the sample output from the show logging command using both the processname keyword argument pair and location node-id keyword argument pair. Syslog messages related to the “init” process emitted from node 0/1/CPU0 are displayed in the sample output.
RP/0/0RP0RSP0/CPU0:router:hostname# show logging process init location 0/1/CPU0
Syslog logging: enabled (24 messages dropped, 0 flushes, 0 overruns)
Console logging: level warnings, 59 messages logged
Monitor logging: level debugging, 0 messages logged
Trap logging: level informational, 0 messages logged
Buffer logging: level debugging, 75 messages logged
Log Buffer (16384 bytes):
LC/0/1/CPU0:May 24 22:20:13.043 : init[65540]: %INIT-7-INSTALL_READY : total time 47.522
seconds
This table describes the significant fields shown in the display.
Table 30: show logging Field Descriptions
Field
Syslog logging
Console logging
Monitor logging
Trap logging
Buffer logging
Description
If enabled, system logging messages are sent to a
UNIX host that acts as a syslog server; that is, the host captures and saves the messages.
If enabled, the level and the number of messages logged to the console are stated; otherwise, this field displays “disabled.”
If enabled, the minimum level of severity required for a log message to be sent to the monitor terminal
(not the console) and the number of messages logged to the monitor terminal are stated; otherwise, this field displays “disabled.”
If enabled, the minimum level of severity required for a log message to be sent to the syslog server and the number of messages logged to the syslog server are stated; otherwise, this field displays “disabled.”
If enabled, the level and the number of messages logged to the buffer are stated; otherwise, this field displays “disabled.”
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
391
show logging
Related Commands
Command
Logging Services Commands
Description
Clears messages from the logging buffer.
392
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands show logging history
show logging history
To display information about the state of the system logging (syslog) history table, use the show logging
history command in EXEC modeXR EXEC mode mode.
show logging history
Syntax Description This command has no keywords or arguments.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the show logging history command to display information about the syslog history table, such as the table size, the status of messages, and the text of messages stored in the table. Simple Network Management
Protocol (SNMP) configuration parameters and protocol activity also are displayed.
Use the
command to change the severity level of syslog messages stored in the history file and sent to the SNMP server.
Use the
logging history size, on page 365
to change the number of syslog messages that can be stored in the history table.
Task ID
Task ID logging
Operations read
Examples This is the sample output from the show logging history command:
RP/0/0RP0RSP0/CPU0:router:hostname# show logging history
Syslog History Table: '1' maximum table entries
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
393 OL-26517-02
Logging Services Commands show logging history saving level 'warnings' or higher
137 messages ignored, 0 dropped, 29 table entries flushed
SNMP notifications disabled
This table describes the significant fields shown in the display.
Table 31: show logging history Field Descriptions
Field maximum table entries saving level messages ignored
SNMP notifications
Description
Number of messages that can be stored in the history table. Set with the logging history size command.
Level of messages that are stored in the history table and sent to the SNMP server (if SNMP notifications are enabled). Set with the logging history command.
Number of messages not stored in the history table because the severity level is greater than that specified with the logging history command.
Status of whether syslog traps of the appropriate level are sent to the SNMP server. Syslog traps are either enabled or disabled through the snmp-server enable command.
Related Commands
Command
logging history size, on page 365
Description
Changes the severity level of syslog messages stored in the history file and sent to the SNMP server.
Changes the number of syslog messages that can be stored in the history table.
394
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Logging Services Commands terminal monitor
terminal monitor
To enable the display of debug command output and system logging (syslog) messages for the current terminal session, use the terminal monitor command in EXEC modeXR EXEC mode.
terminal monitor [disable]
Syntax Description disable (Optional) Disables the display of syslog messages for the current terminal session.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the terminal monitor command to enable the display of syslog messages for the current terminal session.
Task ID
Note Syslog messages are not sent to terminal lines unless the
is enabled.
Use the terminal monitor disable command to disable the display of logging messages for the current terminal session. If the display of logging messages has been disabled, use the terminal monitor command to re-enable the display of logging messages for the current terminal session.
The terminal monitor command is set locally, and does not remain in effect after a terminal session has ended; therefore, you must explicitly enable or disable the terminal monitor command each time that you would like to monitor a terminal session.
Task ID logging
Operations execute
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
395 OL-26517-02
Logging Services Commands terminal monitor
Examples This example shows how to enable the display syslog messages for the current terminal session:
RP/0/0RP0RSP0/CPU0:router:hostname# terminal monitor
Related Commands
Command
Description
Specifies terminal lines other than console terminal as destinations for syslog messages and limits the number of messages sent to terminal lines based on severity.
396
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Onboard Failure Logging Commands
This module describes the Cisco IOS XR software commands used to configure onboard failure logging
(OBFL) for system monitoring on the router. OBFL gathers boot, environmental, and critical hardware failure data OBFL gathers boot, and environmental factors failure data for field-replaceable units (FRUs), and stores the information in the nonvolatile memory of the FRU. This information is used for troubleshooting, testing, and diagnosis if a failure or other error occurs.
Because OBFL is on by default, data is collected and stored as soon as the card is installed. If a problem occurs, the data can provide information about historical environmental conditions, uptime, downtime, errors, and other operating conditions.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
Caution OBFL is activated by default in all cards and should not be deactivated. OBFL is used to diagnose problems in FRUs and to display a history of FRU data.
Related Documents
For detailed information about OBFL concepts, configuration tasks, and examples, see the Onboard Failure
Logging Services module in the Cisco IOS XR System Monitoring Configuration Guide for the
Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration Guide for the Cisco CRS
RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration GuideSystem
Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
For detailed information about logging concepts, configuration tasks, and examples, see the Implementing
Logging Services module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000
Series RouterCisco IOS XR System Monitoring Configuration Guide for the Cisco CRS RouterCisco ASR 9000
Series Aggregation Services Router System Monitoring Configuration GuideSystem Monitoring Configuration
Guide for Cisco NCS 6000 Series Routers.
For alarm management and logging correlation commands, see the Alarm Management and Logging
Correlation Commands module in the Cisco IOS XR System Monitoring Command Reference for the
Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Command Reference for the Cisco CRS
RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Command ReferenceSystem
Monitoring Command Reference for Cisco NCS 6000 Series Routers.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
397
Onboard Failure Logging Commands
For detailed information about alarm and logging correlation concepts, configuration tasks, and examples, see the Implementing Alarm Logs and Logging Correlation module in the Cisco IOS XR System Monitoring
Configuration Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration
Guide for the Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring
Configuration GuideSystem Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
show logging onboard, page 399
•
clear logging onboard, page 403
•
hw-module logging onboard disable, page 405
398
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Onboard Failure Logging Commands show logging onboard
show logging onboard
To display the onboard failure logging (OBFL) messages, use the show logging onboard command in Admin
EXEC modeSystem Admin EXEC mode.
show logging onboard [all| cbc common{dump-all| dump-range {start-address| end-address}| most-recent
{fans fan-tray-slot| [location node-id]}| diagnostic| environment| error| genstr| temperature| uptime|
voltage}] [all| continuous| historical| static-data] [detail| raw| summary] [location node-id] [verbose]
show logging onboard {fpd| inventory| temperature| uptime| voltage}[location node-id] [verbose]
Syntax Description all cbc common dump-all
dump-range {start-address |
end-address} most-recent
fans fan-tray-slot
location node-id diagnostic environment error temperature uptime voltage continuous historical static-data detail
Displays all file information.
Displays Can Bus Controller (CBC) OBFL commands.
Displays the generic OBFL message logging output of multiple clients from string application.
Displays all OBFL records.
Displays OBFL EEPROM data for a given range. Start and end address ranges are from 0 to 4294967295.
Displays the last five OBFL data records.
Displays a specific fan tray slot.
Displays OBFL messages from the designated node. The node-id argument is entered in the rack/slot/module notation.
Displays diagnostic information.
Displays system environment information.
Displays output from the message application.
Displays temperature information.
Displays the OBFL uptime.
Displays voltage information.
Displays continuous information.
Displays historical information.
Display system descriptor data.
Displays detailed logging information.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
399 OL-26517-02
Onboard Failure Logging Commands show logging onboard raw summary verbose
Displays raw OBFL data.
Displays a summary of OBFL logging information.
Displays internal debugging information.
Syntax Description fpd inventory temperature uptime voltage
Displays the OBFL FPD data information.
Displays the OBFL inventory data information.
Displays temperature information.
Displays the OBFL uptime.
Displays voltage information.
Command Default None
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.4.0
Release 3.4.1
Release 3.7.1
Release 5.0.0
Release 5.2.2
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
The keyword common was added for the OBFL generic message logging feature.
Usage Guidelines Use the show logging onboard command to display all logging messages for OBFL.
To narrow the output of the command, enter the show logging onboard command with one of the optional keywords.
Use the location node-id keyword and argument to display OBFL messages for a specific node.
400
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Onboard Failure Logging Commands show logging onboard
Task ID
Examples
OL-26517-02
Task ID logging
Operations read
This example displays uptime information from the OBFL feature: sysadmin-vm:0_RP0# show logging onboard uptime detail location 0/7
RP/0/0RP0RSP0/CPU0:router:hostname(admin)sysadmin-vm:0_RP0# show logging onboard uptime detail location 0/7/cpu0
-------------------------------------------------------------------------------
UPTIME CONTINUOUS DETAIL INFORMATION (Node: node0_7_CPU0)
-------------------------------------------------------------------------------
The first record
The last record
Number of records
File size
: 01/05/2007 00:58:41
: 01/17/2007 16:07:13
:
:
478
15288 bytes
Current reset reason : 0x00
Current uptime : 0 years 0 weeks 0 days 3 hours 0 minutes
-------------------------------------------------------------------------------
Time Stamp |
MM/DD/YYYY HH:MM:SS | Users operation
-------------------------------------------------------------------------------
01/05/2007 01:44:35 File cleared by user request.
-------------------------------------------------------------------------------
This example displays continuous information about the temperature:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)sysadmin-vm:0_RP0# show logging onboard temperature continuous
RP/0/RSP1/CPU0:ios(admin)#show logging onboard temperature continuous
Fri Dec 11 02:22:16.247 UTC
-------------------------------------------------------------------------------
TEMPERATURE CONTINUOUS INFORMATION (Node: node0_RSP0_CPU0)
-------------------------------------------------------------------------------
Sensor | ID |
-------------------------------------------------------------------------------
Inlet0 0x1
Hotspot0 0x2
-------------------------------------------------------------------------------
Time Stamp |Sensor Temperature C
MM/DD/YYYY HH:MM:SS | 1 2 3 4 5 6 7 8 9 10
-------------------------------------------------------------------------------
11/24/2009 20:55:28
11/24/2009 21:08:47
23 36
22 36
+32 minutes
+32 minutes
22 37
22 37
This example displays raw information about the temperature:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)sysadmin-vm:0_RP0# show logging onboard temperature raw
Feature: Temperature node: node0_2_CPU0, file name: nvram:/temp_cont, file size: 47525
00000000: 00 29 01 02 45 79 d8 a8 00 00 00 00 00 00 ba 37 .)..Ey.........7
00000010: aa 0d 00 00 45 79 d8 a8 1c 18 2b 2c 2f 1d 28 27 ....Ey....+,/.('
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
401
Onboard Failure Logging Commands show logging onboard
00000020: 1b 26 2a 20 27 00 00 fa fa 00 1f 01 02 45 79 da .&* '........Ey.
00000030: 2b 00 00 00 00 00 00 ba 38 ca 0d 00 06 00 00 00 +.......8.......
00000040: 0f 00 00 00 00 00 fa fa 00 1f 01 02 45 79 db ae ............Ey..
00000050: 00 00 00 00 00 00 ba 39 ca 0d 00 06 00 00 00 00 .......9........
00000060: 00 f0 00 00 00 fa fa 00 1f 01 02 45 79 dd 32 00 ...........Ey.2.
00000070: 00 00 00 00 00 ba 3a ca 0d 00 06 00 00 00 00 00 ......:.........
00000080: 00 00 00 00 fa fa 00 1f 01 02 45 79 de b8 00 00 ..........Ey....
00000090: 00 00 00 00 ba 3b ca 0d 00 06 00 00 00 00 00 10 .....;..........
000000a0: 00 00 00 fa fa 00 1f 01 02 45 79 e0 3c 00 00 00 .........Ey.<...
000000b0: 00 00 00 ba 3c ca 0d 00 06 00 00 01 00 00 00 00 ....<...........
000000c0: 00 00 fa fa 00 1f 01 02 45 79 e1 be 00 00 00 00 ........Ey......
000000d0: 00 00 ba 3d ca 0d 00 06 11 00 00 00 00 00 00 00 ...=............
000000e0: 00 fa fa 00 1f 01 02 45 79 e3 43 00 00 00 00 00 .......Ey.C.....
000000f0: 00 ba 3e ca 0d 00 06 ff 00 0f 00 00 00 00 00 00 ..>.............
00000100: fa fa 00 1f 01 02 45 79 e4 c6 00 00 00 00 00 00 ......Ey........
00000110: ba 3f ca 0d 00 06 00 00 00 00 00 00 00 00 00 fa .?..............
00000120: fa 00 1f 01 02 45 79 e6 49 00 00 00 00 00 00 ba .....Ey.I.......
00000130: 40 ca 0d 00 06 00 00 00 00 00 00 00 00 00 fa fa @...............
00000140: 00 1f 01 02 45 79 e7 cc 00 00 00 00 00 00 ba 41 ....Ey.........A
00000150: ca 0d 00 06 00 00 00 10 00 f0 00 00 00 fa fa 00 ................
00000160: 1f 01 02 45 79 e9 4f 00 00 00 00 00 00 ba 42 ca ...Ey.O.......B.
00000170: 0d 00 06 00 00 00 f0 00 10 00 00 00 fa fa 00 1f ................
00000180: 01 02 45 79 ea d2 00 00 00 00 00 00 ba 43 ca 0d ..Ey.........C..
00000190: 00 06 00 00 01 01 00 00 00 00 00 fa fa 00 1f 01 ................
000001a0: 02 45 79 ec 55 00 00 00 00 00 00 ba 44 ca 0d 00 .Ey.U.......D...
000001b0: 06 01 00 00 10 00 00 00 00 00 fa fa 00 1f 01 02 ................
000001c0: 45 79 ed d8 00 00 00 00 00 00 ba 45 ca 0d 00 06 Ey.........E....
000001d0: 0f 00 0f ff 00 00 00 00 00 fa fa 00 1f 01 02 45 ...............E
Related Commands
Command
clear logging onboard, on page 403
hw-module logging onboard disable, on page 405
Description
Clears OBFL logging messages from a node or from all nodes.
Enables or disables OBFL.
402
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Onboard Failure Logging Commands clear logging onboard
clear logging onboard
To clear OBFL logging messages from a node or from all nodes, use the clear logging onboard command in Admin EXEC modeSystem Admin EXEC mode.
clear logging onboard [all| cbc common{obfl {fans fan-tray-slot| [location node-id]}| corrupted-files|
diagnostic| environment| error| poweron-time| temperature| uptime| voltage}] [location node-id]
Syntax Description all cbc common obfl
fans fan-tray-slot
location node-id corrupted-files diagnostic environment error poweron-time temperature uptime voltage continuous historical
Clears all OBFL logs.
Clears commands for Can Bus Controller (CBC).
Clears the generic OBFL message logging output of multiple clients from string application.
Clears OBFL EEPROM.
Clears a specific fan tray slot.
(Optional) Clears OBFL messages from the designated node. The
node-id argument is entered in the rack/slot/module notation.
Clears corrupted file information.
Clears the online diagnostics information from the OBFL logs.
Clears the environmental information from the OBFL logs.
Clear syslog information.
Clears time of first customer power on.
Clears temperature information.
Clears uptime information.
Clears voltage information.
Clears continuous information.
Clears historical information.
Command Default All OBFL logging messages are cleared from all nodes.
Command Modes Admin EXEC modeSystem Admin EXEC mode
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
403 OL-26517-02
Onboard Failure Logging Commands clear logging onboard
Command History
Release
Release 3.4.0
Release 3.4.1
Release 3.7.2
Release 5.2.2
Modification
This command was introduced.
This command was introduced.
This command was introduced.
The keyword common was added for the OBFL generic message logging feature.
Usage Guidelines Use the clear logging onboard command to clear OBFL messages from all nodes. Use the clear logging
onboard command with the location node-id keyword and argument to clear OBFL messages for a specific node. If the specified node is not present, an error message is displayed.
Caution The clear logging onboard command permanently deletes all OBFL data for a node or for all nodes. Do not clear the OBFL logs without specific reasons, because the OBFL data is used to diagnose and resolve problems in FRUs.
Caution If OBFL is actively running on a card, issuing the clear logging onboard command can result in a corrupt or incomplete log at a later point in time. OBFL should always be disabled before this command is issued.
Task ID
Task ID logging
Operations read
Examples In the following example, the OBFL data is cleared for all nodes in the system:
RP/0/RSP0RP00/CPU0:router(admin)# clear logging onboard
Related Commands
Command
hw-module logging onboard disable, on page 405
show logging onboard, on page 399
Description
Enables or disables OBFL.
Displays the OBFL messages.
404
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Onboard Failure Logging Commands hw-module logging onboard disable
hw-module logging onboard disable
To disable onboard failure logging (OBFL), use the hw-module logging onboard disable command in Admin
Configuration modeSystem Admin Config mode. To enable OBFL again, use the no form of this command.
hw-module {all| subslot node-id} logging onboard [disable| severity {alerts| emergencies}]
no hw-module {all| subslot node-id} logging onboard [disable]
hw-module location node-id logging onboard disable
no hw-module location node-id logging onboard disable
Syntax Description all
subslot node-id disable severity alerts emergencies
Enables or disables OBFL for all nodes.
Enables or disables OBFL for the designated node. The node-id argument is entered in the rack/slot/module notation.
Enables or disables OBFL. See the Usage Guidelines for more information.
(Optional) Specifies the severity level for the syslog message that is logged into the OBFL storage device.
Specifies that both emergency and alert syslog messages are logged. The default is the alerts keyword.
Specifies that only the emergency syslog messages are logged.
Syntax Description
location node-id Enables or disables OBFL for the designated node.
The node-id argument is entered in the rack/slot notation.
Command Default By default, OBFL logging is enabled.
severity: 1 (alerts) and 0 (emergencies)
Command Modes Admin Configuration modeSystem Admin Config mode
Command History
Release
Release 3.4.0
Modification
This command was introduced.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
405 OL-26517-02
Onboard Failure Logging Commands hw-module logging onboard disable
Release
Release 3.4.1
Release 3.4.1
Release 3.7.2
Release 5.0.0
Usage Guidelines Use the hw-module logging onboard command to enable or disable OBFL.
• To disable OBFL use the disable keyword. OBFL is enabled by default.
hw-module {all | subslot node-id} logging onboard disable
• To enable OBFL, use the no form of the hw-module logging onboard command with the disable keyword. OBFL is enabled by default. Use this command only if you disabled OBFL:
no hw-module {all | subslot node-id} logging onboard disable
• To enable OBFL and return the configuration to the default message severity level, use the no form of the hw-module logging onboard command with the severity keyword:
no hw-module {all | subslot node-id} logging onboard severity
When the OBFL feature is disabled, existing OBFL logs are preserved. To resume OBFL data collection, enable the OBFL feature again.
Note If a new node is inserted, and OBFL is enabled for that slot, then OBFL is enabled for the new node. If a card is removed from a router and inserted into a different router, the card assumes the OBFL configuration for the new router.
Task ID
Task ID logging
Operations read, write
Task ID
Modification
The severity , alerts , and emergencies keywords were added.
This command was introduced.
This command was introduced.
This command was introduced.
Examples
Task ID logging root-lr
Operations read, write read, write
The following example shows how to disable OBFL for all cards:
406
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Onboard Failure Logging Commands hw-module logging onboard disable
RP/0/RSP0RP00/CPU0:router(admin-config)# hw-module all logging onboard disable
The following example shows how to disable OBFL for a card:
RP/0/RSP0RP00/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard disable
The following example shows how to enable OBFL again:
RP/0/RSP0RP00/CPU0:router(admin-config)# no hw-module all logging onboard disable
The following example shows how to save only the syslog message in which the severity level is set to 0
(emergency) to a storage device:
RP/0/RSP0RP00/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard severity emergencies
The following example shows how to save the syslog message in which the severity level is set to 0 (emergency) and 1 (alert) to a storage device:
RP/0/RSP0RP00/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard severity alerts
The following example shows how to disable OBFL for a card: sysadmin-vm:0_RP0# config sysadmin-vm:0_RP0(config)# hw-module location 0/1 logging onboard disable
Related Commands
Command
clear logging onboard, on page 403
show logging onboard, on page 399
Description
Clears OBFL logging messages from a node or from all nodes.
Displays the OBFL messages.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
407
hw-module logging onboard disable
Onboard Failure Logging Commands
408
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Performance Management Commands
This module describes the performance management and monitoring commands available on the router.
These commands are used to monitor, collect, and report statistics, and to adjust statistics gathering for
Border Gateway Protocol (BGP), Open Shortest Path First (OSPF) protocol, generic interfaces, and individual nodes.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
For detailed information about performance management concepts, configuration tasks, and examples, see the Implementing Performance Management module in the Cisco IOS XR System Monitoring Configuration
Guide for the Cisco XR 12000 Series RouterCisco IOS XR System Monitoring Configuration Guide for the
Cisco CRS RouterCisco ASR 9000 Series Aggregation Services Router System Monitoring Configuration
GuideSystem Monitoring Configuration Guide for Cisco NCS 6000 Series Routers.
•
monitor controller fabric, page 411
•
monitor controller sonet, page 413
•
•
performance-mgmt apply monitor, page 421
•
performance-mgmt apply statistics, page 424
•
performance-mgmt apply thresholds, page 428
•
performance-mgmt regular-expression, page 431
•
performance-mgmt resources dump local, page 432
•
performance-mgmt resources memory, page 433
•
performance-mgmt resources tftp-server, page 435
•
performance-mgmt statistics, page 437
•
performance-mgmt thresholds, page 440
•
show performance-mgmt bgp, page 452
•
show performance-mgmt interface , page 454
•
show performance-mgmt mpls, page 458
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
409
•
show performance-mgmt node, page 460
•
show performance-mgmt ospf, page 462
•
show running performance-mgmt, page 464
Performance Management Commands
410
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands monitor controller fabric
monitor controller fabric
To monitor controller fabric counters in real time, use the monitor controller fabric command in EXEC modeXR EXEC mode.
monitor controller fabric {plane-id| all}
Syntax Description plane-id all
Plane ID number of the fabric plane to be monitored. The range is 0 to 7.
Monitors all fabric planes.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the monitor controller fabric command to display controller fabric counters. The display refreshes every 2 seconds.
The interactive commands that are available during a controller fabric monitoring session are described in this table.
Table 32: Interactive Commands Available for the monitor controller fabric Command f t
Command c
Description
Resets controller fabric counters to 0.
Freezes the display screen, thereby suspending the display of fresh counters.
Thaws the display screen, thereby resuming the display of fresh counters.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
411 OL-26517-02
Performance Management Commands monitor controller fabric
Task ID
Examples
Command q s
Description
Terminates the controller fabric monitoring session.
Enables you to jump to a nonsequential fabric plane.
You are prompted to enter the plane ID of the fabric to be monitored.
Task ID fabric basic-services monitor
Operations read execute read
This is sample output from the monitor controller fabric command. The output in this example displays fabric controller counters from fabric plane 0.
RP/0/RSP0RP00/CPU0:router# monitor controller fabric 0 rack3-3 Monitor
Time: 00:00:24 SysUptime: 03:37:57 Controller fabric for 0x0 Controller Fabric Stats:
Delta In Cells 0 ( 0 per-sec) 0 Out Cells 0 ( 0 per-sec) 0 CE Cells 0 ( 0 per-sec) 0 UCE
Cells 0 ( 0 per-sec) 0 PE Cells 0 ( 0 per-sec) 0 Quit='q', Freeze='f', Thaw='t',
Clear='c', Select controller='s'
412
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands monitor controller sonet
monitor controller sonet
To monitor SONET controller counters, use the monitor controller sonet command in EXEC modeXR
EXEC mode.
monitor controller sonet interface-path-id
Syntax Description interface-path-id Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark ( ? ) online help function.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the monitor controller sonet command to display SONET controller counters. The display refreshes every 2 seconds.
The interactive commands that are available during a controller monitoring session are described in this table.
Table 33: Interactive Commands for the monitor controller sonet Command f t
Command c q
Description
Resets controller SONET counters to 0.
Freezes the display screen, thereby suspending the display of fresh counters.
Thaws the display screen, thereby resuming the display of fresh counters.
Terminates the controller SONET monitoring session.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
413 OL-26517-02
Performance Management Commands monitor controller sonet
Task ID
Examples
Command s
Description
Enables you to jump to a nonsequential SONET controller. You are prompted to enter the
SONETcontroller to be monitored.
Task ID fabric basic-services monitor
Operations read execute read
This is the sample output from the monitor controller sonet command. The output in this example displays counters from SONET controller 0/3/0/0.
RP/0/RSP0RP00/CPU0:router# monitor controller sonet 0/3/0/0 rack3-3
Monitor Time: 00:00:06 SysUptime: 01:23:56 Controller for SONET0_3_0_0 Controller
Stats:
Delta Path LOP 0 ( 0 per-sec) 0 Path AIS 0 ( 0 per-sec) 0 Path RDI 0 ( 0 per-sec)
0 Path
BIP 0 ( 0 per-sec) 0 Path FEBE 0 ( 0 per-sec) 0 Path NEWPTR 0 ( 0 per-sec) 0
Path PSE 0
( 0 per-sec) 0 Path NSE 0 ( 0 per-sec) 0 Line AIS 0 ( 0 per-sec) 0 Line RDI 0
( 0 per-sec) 0 Line BIP 0 ( 0 per-sec) 0 Line FEBE 0 ( 0 per-sec) 0 Section LOS 1
( 0 per-sec) 1 Section LOF 0 ( 0 per-sec) 0 Section BIP 0 ( 0 per-sec) 0 Quit='q',
Freeze='f', Thaw='t', Clear='c', Select controller='s'
414
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands monitor interface
monitor interface
To monitor interface counters in real time, use the monitor interface command in EXEC modeXR EXEC mode or Admin EXEC modeSystem Admin EXEC mode.
monitor interface [type1 interface-path-id1 [...[type32 interface-path-id32]]]
Syntax Description type interface-path-id
Interface type. For more information, use the question mark ( ? ) online help function.
Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark ( ? ) online help function.
Command Default Use the monitor interface command without an argument to display statistics for all interfaces in the system.
Command Modes EXEC modeXR EXEC mode
Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Support was added for multiple interfaces.
Support was added for default behavior to monitor all interfaces.
Support was added for wildcards in the interface syntax.
Support was added for additional display options.
Added summary enhancements for the AF aggregates.
This command was introduced.
This command was introduced.
Usage Guidelines Use the monitor interface command without any keywords or arguments to display interface counters for all interfaces. The display refreshes every 2 seconds.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
415 OL-26517-02
Performance Management Commands monitor interface
Use the monitor interface command with the type interface-path-id arguments to display counters for a single interface. For example: monitor interface pos0/2/0/0 interface hundredGigE0/1/0/8
To display more than one selected interface, enter the monitor interface command with multiple type
interface-path-id arguments. For example: monitor interface pos0/2/0/0 pos0/5/0/1 pos0/5/0/2hundredGigE0/2/0/0 hundredGigE0/5/0/1 hundredGigE0/5/0/2
To display a range of interfaces, enter the monitor interface command with a wildcard. For example:
monitor interface pos0/5/*interface hundredGigE0/5/*
You can display up to 32 specific interfaces and ranges of interfaces.
The interactive commands that are available during an interface monitoring session are described in this table.
Table 34: Interactive Commands Available for the monitor interface Command (Functional Summary)
Command Description
Use the following keys to suspend or resume the counter refresh: f t
Freezes the display screen, thereby suspending the display of fresh counters.
Thaws the display screen, thereby resuming the display of fresh counters.
Use the following key to reset the counters: c d
Resets interface counters to 0.
Use the following keys when displaying statistics for a single interface. These keys display counters
in normal or detailed view.
Changes the display mode for the interface monitoring session to display detailed counters. Use the b interactive command to return to the regular display mode.
r Displays the protocol divided by IPv4 or IPv6, and multicast and unicast. When the statistics are displayed using the r option, you can also use the k,
y, or o keys to display statistics in packets (“k”), bytes(“y”) or packets and bytes(“o”).
b Returns the interface monitoring session to the regular display mode for counters. Statistics are not divided by protocol.
Use the following keys when displaying statistics for multiple interfaces. These keys modify the display to show statistics in bytes, packets, or bytes and packets. k Displays statistics in packets (“k”).
416
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands monitor interface
Task ID
Examples y o i
Use the following keys to display statistics for a different interface:
Enables you to jump to a nonsequential interface. You are prompted to enter the interface type and interface path ID to be monitored.
p
(Default) Displays statistics in bytes (“y”).
Displays statistics in both bytes and packets (“o”).
n q
Displays the previous sequential interface in the list of available interfaces.
Displays the next sequential interface in the list of available interfaces.
Terminates the interface monitoring session.
Task ID basic-services monitor
Operations execute read
When more than one interface is specified, the statistics for each interface are displayed on a separate line.
This display format appears anytime more than one interface is specified. For example:
• To display statistics for all interfaces, enter the command monitor interface .
• To display all the interfaces for an interface type, such as all POStenGigE or hundredGigE interface, enter the command and wildcard monitor interface pos *monitor interface hundredGigE * .
• To display statistics for three specified interfaces, enter the command monitor interface pos0/2/0/0 pos0/5/0/1 pos0/5/0/2monitor interface hundredGigE0/2/0/0 hundredGigE0/5/0/1
hundredGigE0/5/0/2 .
This is the sample output for the monitor interface command entered without an argument. This command displays statistics for all interfaces in the system.
RP/0/RSP0RP00/CPU0:router# monitor interface Protocol:General
Rack6-1 Monitor Time: 00:00:01 SysUptime: 165:52:41 Interface In(bps) Out(bps)
InBytes/Delta OutBytes/Delta Mg0/0/CPU0/0 1500/ 0% 7635/ 0% 58.4M/420 8.1M/2138
0/ 0%
0%
350/ 0%
PO0/4/0/0 578/ 0% 535/ 0% 367.2M/162 377.5M/150 PO0/4/0/1 278/ 0% 0/ 0% 345.7M/78
360.1M/0 Gi0/5/0/1 3128/ 0% 2171/ 0% 382.8M/876 189.1M/608 Gi0/5/0/1.1 0/ 0%
824.6G/0 1.0T/0 Gi0/5/0/1.2 0/ 0% 0/ 0% 1.0T/0 824.6G/0 Gi0/5/0/1.3 678/ 0% 0/
1.0T/190 1.0T/0 Gi0/5/0/1.4 0/ 0% 0/ 0% 824.6G/0 824.6G/0 Gi0/5/0/1.5 0/ 0%
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
417
Performance Management Commands monitor interface
824.6G/0 1.0T/98 Gi0/5/0/1.6 327/ 0% 348/ 0% 824.6G/92 1.0T/98 Gi0/5/0/1.7 0/
0% 346/ 0%
824.6G/0 1.0T/98 Gi0/5/0/1.8 325/ 0% 0/ 0% 824.6G/92 1.0T/0 Quit='q', Clear='c',
Freeze='f', Thaw='t', Next set='n', Prev set='p', Bytes='y', Packets='k'
(General='g',
IPv4 Uni='4u', IPv4 Multi='4m', IPv6 Uni='6u', IPv6 Multi='6m') Rack6-1 Monitor
Time:
00:00:01 SysUptime: 165:52:41 Protocol:IPv4 Unicast Interface In(bps) Out(bps)
InBytes/Delta OutBytes/Delta Mg0/0/CPU0/0 0/ 0% 0/ 0% 85.3M/0 6.9M/0 PO0/4/0/0
0/ 0% 0/
0% 3.1G/0 224/0 PO0/4/0/1 0/ 0% 0/ 0% 3.0G/0 152582/0 Gi0/5/0/1 0/ 0% 0/ 0% 0/0
28168/0
Gi0/5/0/1.1 0/ 0% 0/ 0% 0/0 441174/0 Gi0/5/0/1.2 0/ 0% 0/ 0% 540/0 0/0 Gi0/5/0/1.3
0/ 0%
0/ 0% 13.4M/0 462549/0 Gi0/5/0/1.4 0/ 0% 0/ 0% 12.2M/0 0/0 Gi0/5/0/1.5 0/ 0%
0/ 0% 0/0
427747/0 Gi0/5/0/1.6 0/ 0% 0/ 0% 3072/0 500/0 Gi0/5/0/1.7 0/ 0% 0/ 0% 0/0
568654/0
Gi0/5/0/1.8 0/ 0% 0/ 0% 8192/0 5.1M/0 Quit='q', Clear='c', Freeze='f', Thaw='t',
Next set='n', Prev set='p', Bytes='y', Packets='k' (General='g', IPv4 Uni='4u', IPv4
Multi='4m', IPv6 Uni='6u', IPv6 Multi='6m') Rack6-1 Monitor Time: 00:00:03
SysUptime:
165:52:56 Protocol:IPv4 Multicast Interface In(bps) Out(bps) InBytes/Delta
OutBytes/Delta Mg0/0/CPU0/0 (statistics not available) PO0/4/0/0 (statistics not available) PO0/4/0/1 (statistics not available) Gi0/5/0/1 (statistics not available)
Gi0/5/0/1.1 (statistics not available) Gi0/5/0/1.2 (statistics not available)
Gi0/5/0/1.3 (statistics not available) Gi0/5/0/1.4 (statistics not available)
Gi0/5/0/1.5 (statistics not available) Gi0/5/0/1.6 (statistics not available)
Gi0/5/0/1.7 (statistics not available) Gi0/5/0/1.8 (statistics not available)
Quit='q',
Clear='c', Freeze='f', Thaw='t', Next set='n', Prev set='p', Bytes='y',
Packets='k'
(General='g', IPv4 Uni='4u', IPv4 Multi='4m', IPv6 Uni='6u', IPv6 Multi='6m')
Rack6-1
Monitor Time: 00:00:01 SysUptime: 165:53:04 Protocol:IPv6 Unicast Interface
In(bps)
Out(bps) InBytes/Delta OutBytes/Delta Mg0/0/CPU0/0 0/ 0% 0/ 0% 0/0 0/0 PO0/4/0/0
0/ 0%
0/ 0% 0/0 0/0 PO0/4/0/1 0/ 0% 0/ 0% 0/0 0/0 Gi0/5/0/1 0/ 0% 0/ 0% 0/0 0/0
Gi0/5/0/1.1 0/
0% 0/ 0% 0/0 0/0 Gi0/5/0/1.2 0/ 0% 0/ 0% 0/0 0/0 Gi0/5/0/1.3 0/ 0% 0/ 0% 0/0
0/0
Gi0/5/0/1.4 0/ 0% 0/ 0% 0/0 0/0 Gi0/5/0/1.5 0/ 0% 0/ 0% 0/0 0/0 Gi0/5/0/1.6 0/
0% 0/ 0%
0/0 0/0 Gi0/5/0/1.7 0/ 0% 0/ 0% 0/0 0/0 Gi0/5/0/1.8 0/ 0% 0/ 0% 0/0 0/0 Quit='q',
Clear='c', Freeze='f', Thaw='t', Next set='n', Prev set='p', Bytes='y',
Packets='k'
(General='g', IPv4 Uni='4u', IPv4 Multi='4m', IPv6 Uni='6u', IPv6 Multi='6m')
Rack6-1
Monitor Time: 00:00:00 SysUptime: 165:53:19 Protocol:IPv6 Multicast Interface
In(bps)
Out(bps) InBytes/Delta OutBytes/Delta Mg0/0/CPU0/0 (statistics not available)
PO0/4/0/0
(statistics not available) PO0/4/0/1 (statistics not available) Gi0/5/0/1
(statistics not available) Gi0/5/0/1.1 (statistics not available) Gi0/5/0/1.2 (statistics not available) Gi0/5/0/1.3 (statistics not available) Gi0/5/0/1.4 (statistics not available)
Gi0/5/0/1.5 (statistics not available) Gi0/5/0/1.6 (statistics not available)
Gi0/5/0/1.7 (statistics not available) Gi0/5/0/1.8 (statistics not available)
Quit='q',
Clear='c', Freeze='f', Thaw='t', Next set='n', Prev set='p', Bytes='y',
Packets='k'
(General='g', IPv4 Uni='4u', IPv4 Multi='4m', IPv6 Uni='6u', IPv6 Multi='6m')
418
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands monitor interface
This is the sample output for monitor interface pos *interface hundredGigE * command that displays statistics for all POS hundredGigE interfaces:
RP/0/RSP0RP00/CPU0:router# monitor interface pos 0/*
Protocol:General router Monitor Time: 00:00:02 SysUptime: 186:37:44 Interface
In(bps)
Out(bps) InBytes/Delta OutBytes/Delta POS0/1/0/0 1263/ 0% 0/ 0% 5.3M/330 1.4M/0
POS0/1/0/1 84/ 0% 0/ 0% 274.8M/22 274.6M/0 POS0/6/0/0 1275/ 0% 0/ 0% 5.3M/330
1.4M/0
POS0/6/0/1 85/ 0% 0/ 0% 2.6M/22 1.4M/0 POS0/6/4/4 0/ 0% 0/ 0% 15.1M/0 1.4M/0
POS0/6/4/5
85/ 0% 0/ 0% 2.6M/22 1.4M/0 POS0/6/4/6 0/ 0% 0/ 0% 1.3M/0 1.4M/0 POS0/6/4/7 85/
0% 0/ 0%
2.6M/22 1.4M/0 Quit='q', Clear='c', Freeze='f', Thaw='t', Next set='n', Prev set='p',
Bytes='y', Packets='k' (General='g', IPv4 Uni='4u', IPv4 Multi='4m', IPv6
Uni='6u', IPv6
Multi='6m')
RP/0/RSP0RP00/CPU0:router# monitor interface hundredGigE 0/*
Protocol:General router Monitor Time: 00:00:02 SysUptime: 186:37:44 Interface
In(bps)
Out(bps) InBytes/Delta OutBytes/Delta hundredGigE0/1/0/0 1263/ 0% 0/ 0% 5.3M/330
1.4M/0 hundredGigE0/1/0/1 84/ 0% 0/ 0% 274.8M/22 274.6M/0 hundredGigE0/6/0/0 1275/ 0%
0/ 0% 5.3M/330 1.4M/0 hundredGigE0/6/0/1 85/ 0% 0/ 0% 2.6M/22 1.4M/0 hundredGigE0/6/4/4 0/ 0% 0/ 0%
15.1M/0 1.4M/0 hundredGigE0/6/4/5
85/ 0% 0/ 0% 2.6M/22 1.4M/0 hundredGigE0/6/4/6 0/ 0% 0/ 0% 1.3M/0 1.4M/0 hundredGigE0/6/4/7 85/ 0% 0/ 0%
2.6M/22 1.4M/0 Quit='q', Clear='c', Freeze='f', Thaw='t', Next set='n', Prev set='p',
Bytes='y', Packets='k' (General='g', IPv4 Uni='4u', IPv4 Multi='4m', IPv6
Uni='6u', IPv6
Multi='6m')
This is the sample output for a single interface using the monitor interface command with the type
interface-path-id argument. In this example, the output displays interface counters from POStenGigE or hundredGigE interface 0/6/4/4. By default, statistics are displayed in “Brief” state (statistics are not divided by protocol).
RP/0/RSP0RP00/CPU0:router# monitor interface pos0/6/4/4 router
Monitor Time: 00:00:24 SysUptime: 186:43:04 POS0/6/4/4 is up, line protocol is up
Encapsulation HDLC Traffic Stats:(2 second rates) Delta Input Packets: 232450
0 Input pps: 0 Input Bytes: 15179522 0 Input Kbps (rate): 0 ( 0%) Output Packets: 67068
0 Output pps: 0 Output Bytes: 1475484 0 Output Kbps (rate): 0 ( 0%) Errors Stats: Input
Total:
2146 0 Input CRC: 2134 0 Input Frame: 2135 0 Input Overrun: 0 0 Output Total:
0 0 Output
Underrun: 0 0 Quit='q', Freeze='f', Thaw='t', Clear='c', Interface='i', Next='n',
Prev='p' Brief='b', Detail='d', Protocol(IPv4/IPv6)='r'
RP/0/RSP0RP00/CPU0:router# monitor interface hundredGigE0/6/4/4 router
Monitor Time: 00:00:24 SysUptime: 186:43:04 hundredGigE0/6/4/4 is up, line protocol is up
Encapsulation HDLC Traffic Stats:(2 second rates) Delta Input Packets: 232450
0 Input pps: 0 Input Bytes: 15179522 0 Input Kbps (rate): 0 ( 0%) Output Packets: 67068
0 Output pps: 0 Output Bytes: 1475484 0 Output Kbps (rate): 0 ( 0%) Errors Stats: Input
Total:
2146 0 Input CRC: 2134 0 Input Frame: 2135 0 Input Overrun: 0 0 Output Total:
0 0 Output
Underrun: 0 0 Quit='q', Freeze='f', Thaw='t', Clear='c', Interface='i', Next='n',
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
419
Performance Management Commands monitor interface
Prev='p' Brief='b', Detail='d', Protocol(IPv4/IPv6)='r'
This is the sample output from the monitor interface command in the protocol state for the POStenGigE or hundredGigE interface 0/6/4/4. Use the r key to display statics by protocol:
RP/0/RSP0RP00/CPU0:router# monitor interface pos0/6/4/4 monitor interface hundredGigE0/6/4/4 router
Monitor Time: 00:00:02 SysUptime: 186:49:15 POShundredGigE0/6/4/4 is up, line protocol is up
Encapsulation HDLC Traffic Stats:(2 second rates) Delta Input Bytes: 15188186
0 Input
Kbps (rate): 0 ( 0%) Output Bytes: 1476298 0 Output Kbps (rate): 0 ( 0%) IPv4
Unicast
Input Bytes: 0 0 Input Kbps (rate): 0 ( 0%) Output Bytes: 0 0 Output Kbps (rate):
0 (
0%) IPv4 Multicast Input Bytes: 10160304 66 Input Kbps (rate): 0 ( 0%) Output
Bytes: 0 0
Output Kbps (rate): 0 ( 0%) IPv6 Unicast Input Bytes: 0 0 Input Kbps (rate): 0
( 0%)
Output Bytes: 0 0 Output Kbps (rate): 0 ( 0%) IPv6 Multicast Input Bytes: 0 0
Input Kbps
(rate): 0 ( 0%) Output Bytes: 0 0 Output Kbps (rate): 0 ( 0%) Errors Stats:
Input Total:
2146 0 Input CRC: 2134 0 Input Frame: 2135 0 Input Overrun: 0 0 Output Total:
0 0 Output
Underrun: 0 0 Quit='q', Freeze='f', Thaw='t', Clear='c', Interface='i', Next='n',
Prev='p' Brief='b', Detail='d', Protocol(IPv4/IPv6)='r' (Additional options in
'Protocol'): Bytes='y', Packets='k', Both of bytes/packets='o'
420
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt apply monitor
performance-mgmt apply monitor
To apply a statistics template to gather a sampling-size set of samples for a particular instance, use the
performance-mgmt apply monitor command in Global Configuration modeXR Config mode. To stop monitoring statistics, use the no form of this command.
performance-mgmt apply monitor entity {ip-address | type | interface-path-id | node-id | node-id process-id
| process-name} {template-name| default} no performance-mgmt apply monitor
Syntax Description entity Specifies an entity for which you want to apply the statistics template:
• bgp—Applies a template for monitoring a Border Gateway Protocol (BGP) neighbor.
• interface basic-counters—Applies a template for monitoring basic counters on an interface. If you enter this keyword, supply values for the type and
interface-path-id arguments.
• interface data-rates—Applies a template for monitoring data rates on an interface.
If you enter this keyword, supply values for the type and interface-path-id arguments.
• interface generic-counters—Applies a template for monitoring generic counters on an interface. If you enter this keyword, supply values for the type and
interface-path-id arguments.
• mpls ldp—Applies a template for monitoring an MPLS Label Distribution Protocol
(LDP) neighbor.
• node cpu—Applies a template for monitoring the central processing unit (CPU) on a node. Use the node-id argument with this entity.
• node memory —Applies a template for monitoring memory utilization on a node.
Use the location keyword and node-id argument with this entity.
• node process—Applies a template for monitoring a process on a node. Use the
node-id and process-id arguments with this entity.
• ospf v2protocol—Applies a template for monitoring an Open Shortest Path First v2 (OSPFv2) process instance.
• ospf v3protocol—Applies a template for monitoring an OSPFv3 process instance.
ip-address type
IP or neighbor address. Used with the bgp or ldp keyword.
Interface type. For more information, use the question mark (?) online help function.
interface-path-id Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark (?) online help function.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
421 OL-26517-02
Performance Management Commands performance-mgmt apply monitor node-id node-id process-id process-name template-name default
Designated node. Used with the node cpu or node memory keyword. The node-id argument is entered in the rack/slot/module notation.
Designated node and process ID. Used with the node process keyword. The node-id argument is entered in the rack/slot/module notation.
Process name of the OSPF instance. Used with the ospfv2protocol and ospfv3protocol keywords.
Name of a predefined template used for statistics collection. A template name can be any combination of alphanumeric characters, and may include the underscore character (_).
Use the show running performance-mgmt command to display a list of available templates.
Applies the default template.
Command Default Monitoring is disabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The enable keyword was replaced by the apply keyword. In previous releases, this command was referred to as performance-mgmt enable
monitor .
The disable keyword was deprecated.
The ospf v2protocol and ospf v3protocol keywords were introduced to support the monitoring of OSPF entity instances.
Removed support for MPLS interfaces.
This command was introduced.
The interface basic-counters keyword was added to support the monitoring of basic counters on the interface.
This command was introduced.
Usage Guidelines Use the performance-mgmt apply monitor command to apply a statistics template and enable monitoring.
This command captures one cycle of a sample to analyze an instance of an entity. Rather than collect statistics
422
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt apply monitor
Task ID for all instances, which is the purpose of the performance-mgmt apply statistics command, the
performance-mgmt apply monitor command captures statistics for a specific entity instance for one sampling period.
The type and interface-path-id arguments are only to be used with the interface data-rates or interface
generic-counter keyword.
For information about creating templates, see the
performance-mgmt apply statistics, on page 424
command.
Task ID monitor
Operations read, write, execute
Examples This example shows how to enable the BGP protocol monitoring using the criterion set in the default template:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt apply monitor bgp 10.0.0.0
default
This example shows how to enable monitoring for data rates according to the criterion set in the default template:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt apply monitor interface data-rates pos 0/2/0/0 default
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt apply monitor interface data-rates hundredGigE 0/2/0/0 default
This example shows how to enable memory monitoring based on the criterion set in the default template:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt apply monitor node memory location 0/1/cpu0 default
This example shows how to enable monitoring for counters according to the criterion set in the default template:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt apply monitor interface basic-counters hundredGigE 0/2/0/0 default
Related Commands
Command
performance-mgmt apply statistics, on page 424
performance-mgmt statistics, on page 437
show running performance-mgmt, on page 464
Description
Applies a statistics template and enables statistics collection.
Creates a template to use for collecting performance management statistics.
Displays a list of templates and the template being applied.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
423
Performance Management Commands performance-mgmt apply statistics
performance-mgmt apply statistics
To apply a statistics template and enable statistics collection, use the performance-mgmt apply statistics command in Global Configuration modeXR Config mode. To stop statistics collection, use the no form of this command.
performance-mgmt apply statistics entity location {all | node-id} {template-name | default} no performance-mgmt apply statistics
Syntax Description entity Specifies an entity for which you want to apply a statistics template:
• bgp—Applies a statistics collection template for Border Gateway Protocol (BGP).
• interface basic-counters—Applies a statistics collection template for basic counters.
• interface data-rates—Applies a statistics collection template for data rates.
• interface generic-counters—Applies a statistics collection template for generic counters.
• mpls ldp—Applies a template for monitoring an MPLS Label Distribution Protocol
(LDP) neighbor.
• node cpu—Applies a statistics collection template for the central processing unit (CPU).
Use the location keyword with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• node memory—Applies a statistics collection template for memory utilization. Use the location keyword with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• node process—Applies a statistics collection template for processes. Use the location keyword with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• ospf v2protocol—Applies a statistics collection template for Open Shortest Path First v2 (OSPFv2) process instances.
• ospf v3protocol—Applies a statistics collection template for OSPFv3 process instances.
location {all |
node-id}
Specifies all nodes or a particular node.
Specify the location all keywords for all nodes, or the node-id argument to specify a particular node. The node-id argument is entered in the rack/slot/module notation. You must specify either the location all keywords or the location keyword and node-id argument with the
node cpu, node memory, or node process entity.
template-name Name of a predefined template used for statistics collection. A template name can be any combination of alphanumeric characters, and may include the underscore character (_). Use the
show running performance-mgmt, on page 464
command to display a list of available templates.
424
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt apply statistics default Applies the default template.
Command Default Statistics collection is disabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The enable keyword was replaced by the apply keyword. In previous releases, this command was referred to as performance-mgmt enable
statistics .
The disable keyword was deprecated.
The ospf v2protocol and ospf v3protocol keywords were introduced to support the enabling of statistics collection templates for the OSPF entity.
The location keyword was added.
The global keyword was deprecated and replaced by the location all keywords.
Removed support for MPLS interfaces.
This command was introduced.
The interface basic-counters keyword was added to support the enabling of statistics collection template for the basic counters.
This command was introduced.
Usage Guidelines Use the performance-mgmt apply statistics command to apply a statistics template and enable statistics collection. Only one template for each entity can be enabled at a time. After samples are taken, the data is sent to a directory on an external TFTP server, and a new collection cycle starts. The directory where data is copied to is configured using the
performance-mgmt resources tftp-server, on page 435
command. The statistics data in the directory contains the type of entity, parameters, instances, and samples. They are in binary format and must be viewed using a customer-supplied tool, or they can be queried as they are being collected using
XML.
Use the performance-mgmt apply statistics command to collect data for all the instances on a continuous basis. To analyze a particular instance for a limited period of time, use the
performance-mgmt apply monitor,
on page 421 command.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
425
Performance Management Commands performance-mgmt apply statistics
Task ID
Use the no form of the command to disable statistics collection. Because only one performance management statistics collection can be enabled for any given entity at any given time, you are not required to specify the template name with the default keyword or template keyword and template-name argument when disabling a performance management statistics collection.
For information about creating templates, see the
performance-mgmt statistics, on page 437
command.
Caution Each particular collection enabled requires a certain amount of resources. These resources are allocated for as long as the collection is enabled.
Task ID monitor
Operations read, write, execute
Examples This example shows how to start statistics collection for BGP using the template named bgp1:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply statistics bgp template bgp1
This example shows how to enable statistics collection for generic counters using the default template:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply statistics interface generic-counters default
This example shows how to enable CPU statistics collection based on the settings set in the default template:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply statistics node cpu location all default
This example shows how to enable statistics collection for basic counters using the default template:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply statistics interface basic-counters default
Related Commands
Command
performance-mgmt apply monitor, on page 421
Description
Applies a statistics template to gather one sampling-size set of samples for a particular instance.
performance-mgmt apply thresholds, on page 428
Applies a threshold template and enables threshold monitoring.
performance-mgmt resources tftp-server, on page
435
Configures a destination TFTP server for statistics collections.
426
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt apply statistics
Command
performance-mgmt statistics, on page 437
show running performance-mgmt, on page 464
Description
Creates a template to use for collecting performance management statistics.
Displays a list of templates and the template being applied.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
427
Performance Management Commands performance-mgmt apply thresholds
performance-mgmt apply thresholds
To apply a thresholds template and enable threshold collection, use the performance-mgmt apply thresholds command in Global Configuration modeXR Config mode. To stop threshold collection, use the no form of this command.
performance-mgmt apply thresholds entity location {all | node-id} {template-name | default} no performance-mgmt apply thresholds
Syntax Description entity Specifies an entity for which you want to apply a threshold template:
• bgp—Applies a threshold monitoring template for Border Gateway Protocol (BGP).
• interface basic-counters—Applies a threshold monitoring template for basic counters.
• interface data-rates—Applies a threshold monitoring template for data rates.
• interface generic-counters—Applies a threshold monitoring template for generic counters.
• mpls ldp—Applies a template for monitoring an MPLS Label Distribution Protocol
(LDP) neighbor.
• node cpu—Applies a threshold monitoring template for central processing unit (CPU) utilization. Use the location keyword in conjugation with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• node memory—Applies a threshold monitoring template for memory utilization. Use the location keyword in conjugation with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• node process—Applies a threshold monitoring template for processes. Use the location keyword in conjugation with the all keyword or node-id argument when enabling a statistics collection template for this entity.
• ospf v2protocol—Applies a threshold monitoring template for OSPFv2.
• ospf v3protocol—Applies a threshold monitoring template for OSPFv3.
location {all |
node-id}
Specifies all nodes or a particular node.
Specify the location all keywords for all nodes, or the node-id argument to specify a particular node. The node-id argument is entered in the rack/slot/module notation. You must specify either the location all keywords or the location keyword and node-id argument with the
node cpu, node memory, or node process entity.
template-name Name of a predefined template used for threshold collection. A template name can be any combination of alphanumeric characters, and may include the underscore character (_). Use the
show running performance-mgmt, on page 464
command to display a list of available templates.
default Applies the default template.
428
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt apply thresholds
Command Default Threshold collection is disabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
The enable keyword was replaced by the apply keyword. In previous releases, this command was referred to as performance-mgmt enable
thresholds .
The disable keyword was deprecated.
The ospf v2protocol and ospf v3protocol keywords were introduced to support the enabling of threshold monitoring templates for the OSPF entity.
The location keyword was added. The global keyword was deprecated and replaced by the location all keywords.
Removed support for MPLS interfaces.
This command was introduced.
The interface basic-counters keyword was added to support the enabling of threshold monitoring template for the basic counter.
This command was introduced.
Usage Guidelines Use the performance-mgmt apply thresholds command to apply a threshold template and enable threshold collection. Several templates can be configured, but only one template for each entity can be enabled at a time.
Use the no form of the command to disable threshold collection. Because only one performance management threshold monitoring template can be enabled for any given entity at any given time, you are not required to specify the template name with the default keyword or template keyword and template-name argument when disabling a performance management statistics collection.
For information about creating threshold templates, see the
performance-mgmt thresholds, on page 440
command.
Task ID
Task ID monitor
Operations read, write, execute
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
429
Performance Management Commands performance-mgmt apply thresholds
Examples This example shows how to start threshold collection for BGP using a template named stats1:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply thresholds bgp stats1
This example shows how to enable threshold collection for generic counters using a template named stats2:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply thresholds interface generic-counters stats2
This example shows how to enable CPU threshold collection using the template named cpu12:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply thresholds node cpu global cpu12
This example shows how to enable threshold checking for basic counters using a template named stats3:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt apply thresholds interface basic-counters stats3
Related Commands
Command
performance-mgmt thresholds, on page 440
show running performance-mgmt, on page 464
Description
Creates a template to use for threshold collection.
Displays a list of templates and the template being applied.
430
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt regular-expression
performance-mgmt regular-expression
To apply a defined regular expression group to one or more statistics or threshold template, use the
performance-mgmt regular-expression regular-expression-name command in Global Configuration modeXR
Config mode. To stop the usage of regular expression, use the no form of this command.
performance-mgmt regular-expression regular-expression-name index number regular-expression-string
no performance-mgmt regular-expression regular-expression-name
Syntax Description regular-expression-string index
Specifies a defined regular expression group to one or more statistics or threshold template.
Specifies a regular expression index. Range is 1 to 100.
Command Default No regular expression is configured by default.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operation read, write
Examples This is the sample output from the performance-mgmt regular-expression command:
RP/0/0RP0RSP0/CPU0:router:hostname#
performance-mgmt regular-expression reg1 index 10
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
431 OL-26517-02
Performance Management Commands performance-mgmt resources dump local
performance-mgmt resources dump local
To configure the local filesystem on which the statistics data is dumped, use the performance-mgmt resources
dumplocal command in Global Configuration modeXR Config mode. To stop dumping of statistics data on the local filesystem, use the no form of this command.
performance-mgmt resources dump local no performance-mgmt resources dump local
Syntax Description dump local
Configures data dump parameters.
Sets the local filesystem on which statistics data is dumped.
Note You can also dump the statistics data on the TFTP server location. But the configuration is rejected if you configure both local dump and TFTP server at the same time.
Command Default Local filesystem is disabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operation read, write
Examples This is the sample output for the performance-mgmt resources dumplocal command:
RP/0/0RP0RSP0/CPU0:router:hostname# performance-mgmt resources dump local
432
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt resources memory
performance-mgmt resources memory
To configure memory consumption limits for performance management (PM), use the performance-mgmt
resources memory command in Global Configuration modeXR Config mode. To restore the default memory consumption limits, use the no form of this command.
performance-mgmt resources memory max-limit kilobytes min-reserved kilobytes no performance-mgmt resources memory
Syntax Description
max-limit kilobytes Specifies the maximum amount of memory (specified with the kilobytes argument) that the PM statistics collector can use for serving data collection requests. Range is 0 to 4294967295 kilobytes.The default is 50000 kilobytes.
min-reserved kilobytes Specifies a minimum amount of memory (specified with the kilobytes argument) that must remain available in the system after allowing a new PM data collection request. Range is 0 to 4294967295 kilobytes. The default is 10000 kilobytes.
Command Default
max-limit—50000 kilobytes
min-reserved—10000 kilobytes
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the performance-mgmt resource memory command to ensure that the total memory consumed by data buffers in PM does not exceed a maximum limit and that any new PM data request does not cause available memory in the system to fall below a certain threshold.
Task ID
Task ID monitor
Operations read, write
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
433 OL-26517-02
Performance Management Commands performance-mgmt resources memory
Examples This example shows how to ensure that the total memory consumed by PM data buffers does not exceed
30,000 kilobytes and that any new PM data request does not cause available memory in the system to fall below 5000 kilobytes:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt resources memory max-limit 30000 min-reserved 5000
434
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt resources tftp-server
performance-mgmt resources tftp-server
To configure a destination TFTP server for PM statistics collections, use the performance-mgmt resources
tftp-server command in Global Configuration modeXR Config mode. To disable the resource, use the no form of this command.
performance-mgmt resources tftp-server ip-address {directory| dir-name}{vrf| {vrf_name| default}|
{directory| dir-name}} no performance-mgmt resources tftp-server
Syntax Description
tftp-server ip-address
directory dir-name
vrf vrf_name default
Specifies the IP address of the TFTP server.
Specifies the directory where performance management statistics will be copied.
Specifies the name of the VRF instance.
Specifies the default VRF.
Command Default A destination TFTP server is not configured and data is not copied out of the system after a collection cycle
(sampling-size) ends.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the performance-mgmt resources tftp-server command to configure a TFTP resource for performance management. By creating a directory name on the TFTP server, you create a place where statistics can be collected when statistics collection is enabled.
Use the no form of this command to disable the TFTP resource.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
435 OL-26517-02
Performance Management Commands performance-mgmt resources tftp-server
Task ID
Note 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 is transferred, without requiring users to manually create them at the TFTP server host in advance.
Task ID monitor
Operations read, write
Examples This example shows how to specify a TFTP server with the IP address 192.168.134.254 as the performance management resource and a directory named /user/perfmgmt/tftpdump as the destination for PM statistic collections:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt resources tftp-server 192.168.134.254
directory /user/perfmgmt/tftpdump
Related Commands
Command
performance-mgmt apply statistics, on page 424
Description
Applies a statistics template and enables statistics collection.
performance-mgmt apply thresholds, on page 428
Applies a threshold template and enables threshold monitoring.
436
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt statistics
performance-mgmt statistics
To create a template to use for collecting performance management statistics, use the performance-mgmt
statistics command in Global Configuration modeXR Config mode. To remove a template, use the no form of this command.
performance-mgmt statistics entity {template template-name | default} [sample-size size] [sample-interval
minutes]history-persistent regular-expression no performance-mgmt statistics
Syntax Description entity template
Specify an entity for which you want to create a statistics template:
• bgp—Creates a statistics collection template for
Border Gateway Protocol (BGP).
• interface basic-counters—Creates a statistics collection template for basic counters.
• interface data-rates—Creates a statistics collection template for data rates.
• interface generic-counters—Creates a statistics collection template for generic counters.
• mpls ldp—Applies a template for monitoring an
MPLS Label Distribution Protocol (LDP) neighbor.
• node cpu—Creates a statistics collection template for the central processing unit (CPU).
• node memory—Creates a statistics collection template for memory utilization.
• node process—Creates a statistics collection template for processes.
• ospf v2protocol—Creates a statistics template for
Open Shortest Path First v2 (OSPFv2) protocol instances.
• ospf v3protocol—Creates a statistics template for
OSPFv3 protocol instances.
Specifies that a template will be used for collection.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
437 OL-26517-02
Performance Management Commands performance-mgmt statistics template-name default
A template name can be any combination of alphanumeric characters, and may include the underscore character (_).
Use the
show running performance-mgmt, on page 464
to display information about templates, and to display the templates that are being used.
Applies the settings of the default template. The default template contains the following statistics and values.
Values are in minutes.
Each entity has a default template. In each default template, the sample interval is 10 minutes, and the default sample count is 5.
sample-size size
sample-interval minutes
(Optional) Sets the number of samples to be taken.
(Optional) Sets the frequency of each sample, in minutes.
history-persistent (Optional) Maintains the history of statistics collections persistently.
regular-expressionregular-expression-group-name (Optional) Sets instance filtering by regular expression.
Command Default Statistics collections for all entities is disabled.
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 4.0.1
Modification
This command was introduced.
This command was introduced.
The ospf v2protocol and ospf v3protocol keywords were introduced to support the creation of statistics collection templates for the OSPF entity.
Removed support for MPLS interfaces.
This command was introduced.
The interface basic-counters keyword was added to support the creation of statistics collection templates for the basic counters. The
history-persistent and regular-expression keywords were added.
438
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt statistics
Release
Release 5.0.0
Modification
This command was introduced.
Usage Guidelines If you have not yet created a directory for the statistics, use the
performance-mgmt resources tftp-server, on
page 435 command to create a directory on an external TFTP server. When you apply the template and enable statistics collection with the
performance-mgmt apply statistics, on page 424
command, the samples are collected and sent to that directory for later retrieval.
The statistics collected contain type of entity, parameters, instances, and samples. The collection files on the
TFTP server are in binary format and must be viewed using a customer-supplied tool or they can be queried as they are being collected using XML.
Task ID
Task ID monitor
Operations read, write
Examples This example shows how to create a template named int_data_rates for data rate statistics collection, how to set the sample size to 25, and how to set the sample interval to 5 minutes:
RP/0/RSP0RP00/CPU0:router(config)# performance-mgmt statistics interface data-rates int_data_rates
RP/0/RSP0RP00/CPU0:router(config_stats-if-rate)# sample-size 25
RP/0/RSP0RP00/CPU0:router(config_stats-if-rate)# sample-interval 5
Related Commands
Command
performance-mgmt apply statistics, on page 424
performance-mgmt resources tftp-server, on page
435
performance-mgmt thresholds, on page 440
show running performance-mgmt, on page 464
Description
Applies a statistics template and enables statistics collection.
Configures resources for the performance management system that are independent of any particular entity.
Configures a template for collecting threshold statistics.
Displays a list of templates and the template being applied.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
439
Performance Management Commands performance-mgmt thresholds
performance-mgmt thresholds
To configure a template for threshold checking, use the performance-mgmt thresholds command in Global
Configuration modeXR Config mode. To remove a threshold template, use the no form of this command.
performance-mgmt thresholds entity {template template-name| default} attribute operation value [ value2 ]
[ percent ] [rearm {toggle| window window-size}] no performance-mgmt thresholds
Syntax Description entity Specify an entity for which you want to create a template:
• bgp —Creates a template for threshold collection for Border Gateway Protocol
(BGP).
• interface basic-counters —Creates a threshold monitoring template for basic counters.
• interface data-rates —Creates a threshold monitoring template for data rates.
• interface generic-counters —Creates a threshold monitoring template for generic counters.
• mpls ldp —Applies a template for monitoring an MPLS Label Distribution Protocol
(LDP) neighbor.
• node cpu —Creates a threshold monitoring template for the central processing unit
(CPU).
• node memory —Creates a threshold monitoring template for memory utilization.
• node process —Creates a threshold monitoring template for processes.
• ospf v2protocol —Creates a threshold monitoring template for Open Shortest Path
First v2 (OSPFv2) process instances.
• ospf v3protocol —Creates a threshold monitoring template for OSPFv3 process instances.
template template-name default attribute
Specifies that a template will be used for collection.
Name of a predefined template used for threshold collection. A template name can be any combination of alphanumeric characters, and may include the underscore character
(_). Use the
show running performance-mgmt, on page 464
to display information about templates, and to display the templates that are being used.
Applies the settings of the default template.
The attributes for the entity. See
Table 36: Attribute Values, on page 442
for a list of attributes.
440
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt thresholds operation A limiting operation for thresholding that includes:
• EQ —Equal to.
• GE —Greater than or equal to.
• GT —Greater than.
• LE —Less than or equal to.
• LT —Less than.
• NE —Not equal to.
• RG —Not in range.
value value2
The base value against which you want to sample.
(Optional) This value can only be used with the operator RG . For example, if you use
RG for the operation argument value, you create a range between value and value2 .
percent
rearm {toggle |
window} window-size
(Optional) Specifies a value relative to the previous sample interval value. See the “Usage
Guidelines” section for more information.
(Optional) It can be used to reduce the number of events by suppressing redundant events from being reported. Normally, every time a condition is met in a sample interval, a syslog error is generated. Using the toggle keyword works in this manner: If a condition is true, a syslog error message is generated, but it is not generated again until the condition becomes false, and then true again. In this way, only “fresh” events are seen when the threshold is crossed.
Use the window keyword to specify that an event be sent only once for each window.
If a condition is true, a syslog error message is generated. You set your window size by using the window keyword and specify the number of intervals. With a window size, you specify that you want event notification at that number of intervals. For example, if you window size is 2 and your sample interval is 10, you would want notification of the event (for each instance in an entity) only every 20 minutes when the condition has been met.
The number of intervals to use with the rearm keyword.
Command Default None
Command Modes Global Configuration modeXR Config mode
Command History
Release
Release 2.0
Modification
This command was introduced.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
441
Performance Management Commands performance-mgmt thresholds
Release
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Release 4.0.1
Release 5.0.0
Modification
This command was introduced.
The ospf v2protocol and ospf v3protocol keywords were introduced to support the creation of OSPF threshold monitoring templates. OSPF attribute values were introduced for threshold monitoring.
Removed support for MPLS interfaces.
This command was introduced.
The interface basic-counters keyword was added to support the creation of threshold monitoring template for the basic counter.
This command was introduced.
Usage Guidelines Use the percent argument to specify a value that is relative to the previous sample's interval value. When you use the percent argument with a value of 50, the calculation is performed in this manner, assuming that your current sampled value is sample1 (S1) and the value sampled in the previous sampling period is sample 0 (S0):
(S1 - S0) GT 50% of S0
For example, if you wanted to check for an increase of 50 percent in the counter BGPInputErrors, you could use the following attribute and operation with the percent argument:
BGPInputErrors GT 50
This table shows threshold behavior, assuming the values for BGPInputErrors are at consecutive samplings.
Table 35: Threshold Behavior
Value
10
16
20
35
Calculation
—
16 - 10 = 6, which is > than 50 percent of 10
Event
—
Generate event
20 - 16 = 4, which is not > than 50 percent of 16
No event generated
35 - 20 = 15, which is > than 50 percent of 20
Generate event
This table shows the attribute values supported by the entities.
442
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt thresholds
Table 36: Attribute Values
Entity bgp interface basic-counters
Attributes
ConnDropped
ConnEstablished
ErrorsReceived
ErrorsSent
InputMessages
InputUpdateMessages
OutputMessages
OutputUpdateMessages
InOctets
InPackets
InputQueueDrops
InputTotalDrops
InputTotalErrors
OutOctets
OutPackets
OutputQueueDrops
OutputTotalDrops
OutputTotalErrors
Description
Number of times the connection was dropped.
Number of times the connection was established.
Number of error notifications received on the connection.
Number of error notifications sent on the connection.
Number of messages received.
Number of update messages received.
Number of messages sent.
Number of update messages sent.
Bytes received (64-bit).
Packets received (64-bit).
Input queue drops (64-bit).
Inbound correct packets discarded
(64-bit).
Inbound incorrect packets discarded (64-bit).
Bytes sent (64-bit).
Packets sent (64-bit).
Output queue drops (64-bit).
Outbound correct packets discarded
(64-bit).
Outbound incorrect packets discarded (64-bit).
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
443
performance-mgmt thresholds
Entity interface data-rates
Attributes
Bandwidth
InputDataRate
InputPacketRate
InputPeakRate
InputPeakPkts
OutputDataRate
OutputPacketRate
OutputPeakPkts
OutputPeakRate
Performance Management Commands
Description
Bandwidth, in kbps.
Input data rate in kbps.
Input packets per second.
Peak input data rate.
Peak input packet rate.
Output data rate in kbps.
Output packets per second.
Peak output packet rate.
Peak output data rate.
444
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands
Entity interface generic-counters
Attributes
InBroadcastPkts
InMulticastPkts
InOctets
InPackets
InputCRC
InputFrame
InputOverrun
InputQueueDrops
InputTotalDrops
InputTotalErrors
InUcastPkts
InputUnknownProto
OutBroadcastPkts
OutMulticastPkts
OutOctets
OutPackets
OutputTotalDrops
OutputTotalErrors
OutUcastPkts
OutputUnderrun performance-mgmt thresholds
Description
Broadcast packets received.
Multicast packets received.
Bytes received.
Packets received.
Inbound packets discarded with incorrect CRC.
Inbound framing errors.
Input overruns.
Input queue drops.
Inbound correct packets discarded.
Inbound incorrect packets discarded.
Unicast packets received.
Inbound packets discarded with unknown proto.
Broadcast packets sent.
Multicast packets sent.
Bytes sent.
Packets sent.
Outbound correct packets discarded.
Outbound incorrect packets discarded.
Unicast packets sent.
Output underruns.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
445
performance-mgmt thresholds
Entity mpls ldp node cpu node memory
Performance Management Commands
Attributes
AddressMsgsRcvd
AddressMsgsSent
AddressWithdrawMsgsRcvd
AddressWithdrawMsgsSent
InitMsgsSent
InitMsgsRcvd
KeepaliveMsgsRcvd
KeepaliveMsgsSent
LabelMappingMsgsRcvd
LabelMappingMsgsSent
LabelReleaseMsgsRcvd
LabelReleaseMsgsSent
LabelWithdrawMsgsRcvd
LabelWithdrawMsgsSent
NotificationMsgsRcvd
NotificationMsgsSent
TotalMsgsRcvd
TotalMsgsSent
AverageCPUUsed
NoProcesses
CurrMemory
PeakMemory
Description
Address messages received.
Address messages sent.
Address withdraw messages received.
Address withdraw messages sent.
Initial messages sent.
Initial messages received.
Keepalive messages received.
Keepalive messages sent.
Label mapping messages received.
Label mapping messages sent.
Label release messages received.
Label release messages sent.
Label withdraw messages received.
Label withdraw messages sent.
Notification messages received.
Notification messages sent.
Total messages received.
Total messages sent.
Average system percent CPU utilization.
Number of processes.
Current application memory (in bytes) in use.
Maximum system memory (in MB) used since bootup.
446
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands
Entity node process
Attributes
AverageCPUUsed
NumThreads
PeakMemory performance-mgmt thresholds
Description
Average percent CPU utilization.
Number of threads.
Maximum dynamic memory (in
KB) used since startup time.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
447
Performance Management Commands performance-mgmt thresholds
Entity ospf v2protocol
Attributes
InputPackets
OutputPackets
InputHelloPackets
OutputHelloPackets
InputDBDs
InputDBDsLSA
OutputDBDs
OutputDBDsLSA
InputLSRequests
InputLSRequestsLSA
OutputLSRequests
OutputLSRequestsLSA
InputLSAUpdates
InputLSAUpdatesLSA
OutputLSAUpdates
OutputLSAUpdatesLSA
InputLSAAcks
InputLSAAcksLSA
OutputLSAAcks
OutputLSAAcksLSA
Description
Total number of packets received
Total number of packets sent
Number of Hello packets received
Number of Hello packets sent
Number of DBD packets received
Number of LSA received in DBD packets
Number of DBD packets sent.
Number of LSA sent in DBD packets
Number of LS requests received.
Number of LSA received in LS requests.
Number of LS requests sent.
Number of LSA sent in LS requests.
Number of LSA updates received.
Number of LSA received in LSA updates.
Number of LSA updates sent.
Number of LSA sent in LSA updates.
Number of LSA acknowledgements received.
Number of LSA received in LSA acknowledgements.
Number of LSA acknowledgements sent.
Number of LSA sent in LSA acknowledgements.
448
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands
Entity Attributes
ChecksumErrors performance-mgmt thresholds
Description
Number of packets received with checksum errors.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
449
Performance Management Commands performance-mgmt thresholds
Entity ospf v3protocol
Attributes
InputPackets
OutputPackets
InputHelloPackets
OutputHelloPackets
InputDBDs
InputDBDsLSA
OutputDBDs
OutputDBDsLSA
InputLSRequests
InputLSRequestsLSA
OutputLSRequests
OutputLSRequestsLSA
InputLSAUpdates
InputLSRequestsLSA
OutputLSAUpdates
OutputLSAUpdatesLSA
InputLSAAcks
InputLSAAcksLSA
OutputLSAAcks
OutputLSAAcksLSA
Description
Total number of packets received.
Total number of packets sent.
Number of Hello packets received.
Number of Hello packets sent.
Number of DBD packets received.
Number of LSA received in DBD packets.
Number of DBD packets sent.
Number of LSA sent in DBD packets.
Number of LS requests received.
Number of LSA received in LS requests.
Number of LS requests sent.
Number of LSA sent in LS requests.
Number of LSA updates received.
Number of LSA received in LS requests.
Number of LSA updates sent.
Number of LSA sent in LSA updates.
Number of LSA acknowledgements received.
Number of LSA received in LSA acknowledgements.
Number of LSA acknowledgements sent
Number of LSA sent in LSA acknowledgements.
450
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands performance-mgmt thresholds
Task ID
Task ID monitor
Operations read, write
Examples This example shows how to create a template for monitoring BGP thresholds, which checks if the number of connections dropped exceeds 50 for any BGP peers. The toggle rearm keywords are included so that once the threshold is passed, the event will not be reported unless the value of ConnDropped is reset:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt thresholds bgp template bgp_thresh1
RP/0/0RP0RSP0/CPU0:router:hostname(config-threshold-bgp)# ConnDropped GT 50 rearm toggle
This example shows how to create a template for monitoring node CPU utilization that checks if there is a 25 percent increase at any given interval:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt thresholds node cpu template cpu_thresh1
RP/0/0RP0RSP0/CPU0:router:hostname(config-threshold-bgp)# AverageCPUUsed GT 25percent
This example shows how to create a template for monitoring the input CRC errors for interfaces. The rule checks whether the number of errors reach or exceed 1000 for any given interface:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# performance-mgmt thresholds interface generic_ctr template intf_crc_thresh1
RP/0/0RP0RSP0/CPU0:router:hostname(config-threshold-bgp)# InputCRC GE 1000
Related Commands
Command
performance-mgmt apply thresholds, on page 428
Description
Enables threshold monitoring for BGP.
performance-mgmt resources tftp-server, on page
435
show running performance-mgmt, on page 464
Configures a TFTP resource for performance management.
Displays a list of templates and the template being applied.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
451
Performance Management Commands show performance-mgmt bgp
show performance-mgmt bgp
To display performance management (PM) data from Border Gateway Protocol (BGP) entity instance monitoring or statistics collections, use the show performance-mgmt bgp command in EXEC modeXR
EXEC mode.
show performance-mgmt {monitor| statistics} bgp {ip-address| all} {sample-id| all-samples| last-sample}
Syntax Description monitor statistics ip-address all sample-id all-samples last-sample
Displays the data collected for an entity instance monitoring collection. The data gathered is from one sample cycle of a BGP statistics collection template.
The data is available only as the monitor data is enabled.
Displays the data collected from statistics collection samples.
IP address of a BGP peer.
Displays all BGP peer instances.
Note This option is available only with the statistics keyword. It is not available with the monitor keyword because an entity instance monitoring collection captures data from an entity instance for one sampling cycle.
Sample ID of the monitoring or statistics collection to be displayed.
Displays all collected samples.
Displays the last collected samples.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
452
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt bgp
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples This is the sample output from the show performance-mgmt bgp command:
RP/0/0RP0RSP0/CPU0:router:hostname# show performance-mgmt monitor bgp 10.0.0.0 all-samples
BGP Neighbor: 10.0.0.0 Sample no: 1
----------------------------------------------
InputMessages: 0 OutputMessages: 0
InputUpdateMessages: 0 OutputUpdateMessages: 0 ConnEstablished: 0 ConnDropped: 0
ErrorsReceived: 0 ErrorsSent: 0 BGP Neighbor: 10.0.0.0 Sample no: 2
---------------------------------------------- InputMessages: 0 OutputMessages: 0
InputUpdateMessages: 0 OutputUpdateMessages: 0 ConnEstablished: 0 ConnDropped: 0
ErrorsReceived: 0 ErrorsSent: 0 BGP Neighbor: 10.0.0.0 Sample no: 3
--------------------------------------------------- InputMessages: 0 OutputMessages: 0
InputUpdateMessages: 0 OutputUpdateMessages: 0 ConnEstablished: 0 ConnDropped: 0
ErrorsReceived: 0 ErrorsSent: 0
This table describes the significant fields in the display.
Table 37: show performance-mgmt bgp Field Descriptions
Field
ConnDropped
ConnEstablished
ErrorsReceived
ErrorsSent
InputMessages
InputUpdateMessages
OutputMessages
OutputUpdateMessages
Description
Number of times the connection was dropped.
Number of times the connection was established.
Number of error notifications received on the connection.
Number of error notifications sent on the connection.
Number of messages received.
Number of update messages received.
Number of messages sent.
Number of update messages sent.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
453
Performance Management Commands show performance-mgmt interface
show performance-mgmt interface
To display performance management (PM) data from interface entity instance monitoring or statistics collections, use the show performance-mgmt interface command in EXEC modeXR EXEC mode.
show performance-mgmt {monitor| statistics} interface {basic-counters| data-rates| generic-counters}
{type interface-path-id| all} {sample-id| all-samples| last-sample}
Syntax Description monitor statistics basic-counters data-rates generic-counters type interface-path-id all sample-id all-samples last-sample
Displays the data collected for an entity instance monitoring collection. The data gathered is from one sample cycle from one instance of an interface data entity collection template.
Note The data is available to be display only as the monitor data is collected.
Displays the data collected from statistics collection samples.
Displays data from interface basic counters entity collections.
Displays data from interface data rates entity collections.
Displays data from interface generic counters entity collections.
(Optional) Interface type. For more information, use the question mark ( ?
) online help function.
(Optional) Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark
( ? ) online help function.
Displays all interface instances.
Note This option is available only with the statistics keyword. It is not available with the monitor keyword because a entity instance monitoring collection captures data from an entity instance for one sampling cycle.
Sample ID of the monitoring collection or statistics collection to be displayed.
Displays all collected samples.
Displays the last collected samples.
Command Default None
454
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt interface
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 4.0.1
Release 5.0.0
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
The basic-counters keyword was added to support basic counters entity collections.
This command was introduced.
This is sample output from the show performance-mgmt interface command:
RP/0/0RP0RSP0/CPU0:router:hostname# show performance-mgmt monitor interface generic-counters pos 0/3/0/0 all-samplesshow performance-mgmt monitor interface generic-counters hundredGigE
0/3/0/0 all-samples
Interface: POS0_3_0_0HundredGigE0_3_0_0 Sample no: 1
------------------------------------------------
InPackets: 0 OutPackets: 0 InOctets: 0
OutOctets: 0 InUcastPkts: 0 OutUcastPkts: 0 InMulticastPkts: 0 OutMulticastPkts: 0
InBroadcastPkts: 0 OutBroadcastPkts: 0 InputTotalDrops: 0 OutputTotalDrops: 0
InputTotalErrors: 0 OutputTotalErrors: 0 InputOverrun: 0 OutputUnderrun: 0
InputQueueDrops: 0 InputUnknownProto: 0 InputCRC: 0 InputFrame: 0 Interface:
POS0_3_0_0HundredGigE0_3_0_0
Sample no: 2 ------------------------------------------------ InPackets: 0 OutPackets: 0
InOctets: 0 OutOctets: 0 InUcastPkts: 0 OutUcastPkts: 0 InMulticastPkts: 0
OutMulticastPkts: 0 InBroadcastPkts: 0 OutBroadcastPkts: 0 InputTotalDrops: 0
OutputTotalDrops: 0 InputTotalErrors: 0 OutputTotalErrors: 0 InputOverrun: 0
OutputUnderrun: 0 InputQueueDrops: 0 InputUnknownProto: 0 InputCRC: 0 InputFrame: 0
RP/0/0RP0RSP0/CPU0:router:hostname# show performance-mgmt monitor interface generic-counters hundredGigE 0/3/0/0 all-samples
Interface: HundredGigE0_3_0_0 Sample no: 1
------------------------------------------------
InPackets: 0 OutPackets: 0 InOctets: 0
OutOctets: 0 InUcastPkts: 0 OutUcastPkts: 0 InMulticastPkts: 0 OutMulticastPkts: 0
InBroadcastPkts: 0 OutBroadcastPkts: 0 InputTotalDrops: 0 OutputTotalDrops: 0
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
455
Performance Management Commands show performance-mgmt interface
Field
InBroadcastPkts
InMulticast Pkts
InOctets
InPackets
InputCRC
InputFrame
InputOverrun
InputQueueDrops
InputTotalDrops
InputTotalErrors
InUcastPkts
InputUnknownProto
OutBroadcastPkts
OutMulticastPkts
OutOctets
OutPackets
OutputTotalDrops
OutputTotalErrors
OutUcastPkts
OutputUnderrun
InputTotalErrors: 0 OutputTotalErrors: 0 InputOverrun: 0 OutputUnderrun: 0
InputQueueDrops: 0 InputUnknownProto: 0 InputCRC: 0 InputFrame: 0 Interface:
HundredGigE0_3_0_0
Sample no: 2 ------------------------------------------------ InPackets: 0 OutPackets: 0
InOctets: 0 OutOctets: 0 InUcastPkts: 0 OutUcastPkts: 0 InMulticastPkts: 0
OutMulticastPkts: 0 InBroadcastPkts: 0 OutBroadcastPkts: 0 InputTotalDrops: 0
OutputTotalDrops: 0 InputTotalErrors: 0 OutputTotalErrors: 0 InputOverrun: 0
OutputUnderrun: 0 InputQueueDrops: 0 InputUnknownProto: 0 InputCRC: 0 InputFrame: 0
This table describes the significant fields shown in the display.
Table 38: show performance-mgmt interface Field Descriptions
Description
Broadcast packets received.
Multicast packets received.
Bytes received.
Packets received.
Inbound packets discarded with incorrect CRC.
Inbound framing errors.
Input overruns.
Input queue drops.
Inbound correct packets discarded.
Inbound incorrect packets discarded.
Unicast packets received.
Inbound packets discarded with unknown proto.
Broadcast packets sent.
Multicast packets sent.
Bytes sent.
Packets sent.
Outbound correct packets discarded.
Outbound incorrect packets discarded.
Unicast packets sent.
Output underruns.
456
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt interface
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
457
Performance Management Commands show performance-mgmt mpls
show performance-mgmt mpls
To display performance management (PM) data for Multiprotocol Label Switching (MPLS) entity instance monitoring and statistics collections, use the show performance-mgmt mpls command in EXEC modeXR
EXEC mode.
show performance-mgmt {monitor| statistics} mpls ldp {ip-address| all} {first-sample-id| all-samples|
last-sample}
Syntax Description monitor statistics ldp ip-address all first-sample-id all-samples last-sample
Displays the data collected for an entity instance monitoring collection. The data gathered is from one sample cycle from one instance of an MPLS entity collection template.
Note The data is available to be displayed only as the monitor data is collected.
Displays the data collected from statistics collection samples.
Displays data from MPLS Label Distribution Protocol (LDP) collections.
IP address of LDP session instance.
Displays data from all LDP session instances.
Note This option is available only with the statistics keyword. It is not available with the monitor keyword because a entity instance monitoring collection captures data from an entity instance for one sampling cycle.
Sample ID of the monitoring or statistics collection to be displayed.
Displays all collected samples.
Displays the last collected samples.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.2
Release 3.2
Release 3.3.0
Modification
This command was introduced.
This command was introduced.
Removed support for MPLS interfaces.
458
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt mpls
Release
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples This is sample output from the show performance-mgmt mpls command:
RP/0/0RP0RSP0/CPU0:router:hostname# show performance-mgmt monitor mpls ldp 192.0.2.45
last-sample
LDP Neighbor: 192.0.2.45 Sample no: 2
-------------------------------------------------------
TotalMsgsSent: 131,
TotalMsgsRcvd: 131 InitMsgsSent: 1, InitMsgsRcvd: 1 AddressMsgsSent: 1, AddressMsgsRcvd:
1 AddressWithdrawMsgsSent: 0, AddressWithdrawMsgsRcvd: 0 LabelMappingMsgsSent: 6,
LabelMappingMsgsRcvd: 7 LabelWithdrawMsgsSent: 0, LabelWithdrawMsgsRcvd: 0
LabelReleaseMsgsSent: 0, LabelReleaseMsgsRcvd: 0 NotificationMsgsSent: 0
NotificationMsgsRcvd: 0
This table describes the significant fields shown in the display.
Table 39: show performance-mgmt mpls Field Descriptions
Field
InitMsgsSent
InitMsgsRcvd
TotalMsgsSent
TotalMsgsRcvd
AddressMsgsSent
Description
Initial messages sent.
Initial messages received.
Total messages sent.
Total messages received.
Address messages sent.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
459
Performance Management Commands show performance-mgmt node
show performance-mgmt node
To display performance management (PM) data for node entity monitoring and statistics collections, use the
show performance-mgmt node command in EXEC modeXR EXEC mode.
show performance-mgmt {monitor| statistics} node {cpu| memory| process} location {node-id| all}
{sample-id| all-samples| last-sample}
Syntax Description monitor statistics cpu memory process location node-id all sample-id all-samples last-sample
Displays the data collected for an entity instance monitoring collection. The data gathered is from one sample cycle from one instance of a node entity collection template.
Note The data is only available to be displayed as the monitor data is collected.
Displays the data collected from statistics collection samples.
Displays data from the central processing unit (CPU).
Displays data from memory.
Displays data from processes.
Specifies the location of data origination.
Location of the node. The node-id argument is entered in the rack/slot/module notation.
Displays data from all LDP session instances.
Note This option is available only with the statistics keyword. It is not available with the monitor keyword because a entity instance monitoring collection captures data from an entity instance for one sampling cycle.
Sample ID of the monitoring or statistics collection to be displayed.
Displays all collected samples.
Displays the last collected samples.
Command Default None
Command Modes EXEC modeXR EXEC mode
460
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt node
Command History
Release
Release 3.2
Release 3.2
Release 3.7.2
Release 5.0.0
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read
Examples
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
This is sample output from the show performance-mgmt node command:
RP/0/0RP0RSP0/CPU0:router:hostname# show performance-mgmt monitor node process location
0/RSP1RP1/CPU0 process
614587 last-sample
Node ID: 0_RSP1_CPU0 0_RP1_CPU0
Sample no: 1 ---------------------------------------------- Process ID: 614587
---------------------------------------------- PeakMemory: 908 AverageCPUUsed: 0
NoThreads: 5
This table describes the significant fields shown in the display.
Table 40: show performance-mgmt node Field Descriptions
Field
PeakMemory
AverageCPUused
NoThreads
Description
Maximum system memory (in MB) used since bootup.
Average system percent CPU utilization.
Number of threads.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
461
Performance Management Commands show performance-mgmt ospf
show performance-mgmt ospf
To display performance management (PM) data for Open Shortest Path First (OSPF) entity instance monitoring and statistics collections, use the show performance-mgmt ospf command in EXEC modeXR EXEC mode.
show performance-mgmt {monitor| statistics} ospf {v2protocol| v3protocol} instance {sample-id|
all-samples| last-sample}
Syntax Description monitor statistics v2protocol v3protocol sample-id all-samples last-sample
Displays the data collected for an entity instance monitoring collection. The data gathered is from one sample cycle from one instance of an OSPF entity collection template.
Note The data is available to be displayed only as the monitor data is collected.
Displays the data collected from statistics collection samples.
Displays counters for an OSPF v2 protocol instance.
Displays counters for an OSPF v3 protocol instance.
Sample ID of the monitoring or statistics collection to be displayed.
Displays all collected samples.
Displays the last collected samples.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 3.7.0
Release 3.7.0
Release 3.7.2
Release 5.0.0
Modification
This command was introduced
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
462
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show performance-mgmt ospf
Task ID
Examples
Task ID monitor
Operations read, write
This is sample output from the show performance-mgmt ospf command:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# show performance-mgmt statistics ospf v2protocol
100 all-samples
Mon Aug 3 06:41:15.785 PST
OSPF Instance: 100 Sample no: 1
------------------------------------------------------------------------
InputPackets: 12323 OutputPackets: 12045
InputHelloPackets: 11281 OutputHelloPackets: 11276
InputDBDs: 18 OutputDBDs: 20
InputDBDsLSA: 508 OutputDBDsLSA: 530
InputLSRequests: 1 OutputLSRequests: 2
InputLSRequestsLSA: 11 OutputLSRequestsLSA: 0
InputLSAUpdates: 989 OutputLSAUpdates: 109
InputLSAUpdatesLSA: 28282 OutputLSAUpdatesLSA: 587
InputLSAAcks: 34 OutputLSAAcks: 638
InputLSAAcksLSA: 299 OutputLSAAcksLSA: 27995
ChecksumErrors: 0
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
463
Performance Management Commands show running performance-mgmt
show running performance-mgmt
To display a list of configured templates and the template being applied, use the show running
performance-mgmt command in EXEC modeXR EXEC mode.
show running performance-mgmt [apply| regular-expression| resources| statistics| thresholds]
Syntax Description apply regular-expression resources statistics thresholds
(Optional) Displays the list of apply template commands in the current configuration.
(Optional) Displays the list of regular expression commands in the current configuration.
(Optional) Displays the existing resource configuration commands applied.
(Optional) Displays the list of configured statistics templates.
(Optional) Displays the list of configured threshold templates.
Command Default None
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID monitor
Operations read, write
464
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Performance Management Commands show running performance-mgmt
Examples This example shows the list of statistic and threshold templates, the configuration of each template, and at the end, which templates are enabled for collection:
RP/0/0RP0RSP0/CPU0:router:hostname(config)# show running performance-mgmt performance-mgmt resources tftp-server 192.168.134.254 directory muckier/jagrelo/pmtest performance-mgmt statistics bgp template template3 sample-size 5
!
sample-interval 60 performance-mgmt statistics node cpu template template4 sample-size 30
!
sample-interval 2 performance-mgmt statistics interface generic-counters template template2 sample-size 3 sample-interval 10
!
performance-mgmt statistics interface data-rates template template1
!
sample-size 10 sample-interval 5 performance-mgmt statistics node memory template template5 sample-size 30
!
sample-interval 2 performance-mgmt statistics node process template template6 sample-size 10 sample-interval 5
!
performance-mgmt thresholds node cpu template template20
AverageCpuUsed GT 75 sample-interval 5
!
performance-mgmt apply statistics interface generic-counters template2 performance-mgmt apply statistics node memory global template5 performance-mgmt apply statistics node process 0/0/CPU0 template6 performance-mgmt apply thresholds node cpu global template20
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
465
show running performance-mgmt
Performance Management Commands
466
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Statistics Service Commands
This module describes the Cisco IOS XR software commands related to the collection of interface statistics
(StatsD) for system monitoring on the router. Interface statistics on the router are found in hardware (most of the time) and software (exception packets). The counters are always local (relative to the CPU) to the node on which the interface is homed. The Cisco IOS XR software provides an efficient mechanism to collect these counters from various application-specific integrated circuits (ASICs) or NetIO and assemble an accurate set of statistics for an interface. After the statistics are produced, they can be exported to interested parties (command-line interface [CLI], Simple Network Management Protocol [SNMP], and so forth).
The Cisco IOS XR software statistics collection system provides a common framework to be used by all interface owners to export the statistics for interfaces they own. The system also defines a common set of statistics that are relevant to all interfaces and thereby provides a consistent and constant set of counters that are always associated and maintained with any interface on the router.
The statistics collection system includes the statistics manager, the statistics server, one or more statistics collectors, and the necessary libraries. Each node on a router houses one statistics server.
In addition to the statistics server, each node (that has interfaces) has one or more statistics collectors. Statistics collectors are platform specific and can obtain various hardware and software counters to satisfy requests from the statistics server.
The statistics manager does not attempt to produce statistics for interfaces for which no statistics collector has registered. Requests for statistics on interfaces for which no statistics collector has registered results in an error returned to the requestor by the statistics manager.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
•
•
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
467
Statistics Service Commands clear counters
clear counters
To clear the interface counters, use the clear counters command in EXEC modeXR EXEC mode mode.
clear counters [all| type interface-path-id]
Syntax Description all type interface-path-id
(Optional) Clears counters on all interfaces.
(Optional) Interface type. For more information, use the question mark (?) online help function.
(Optional) Physical interface or virtual interface.
Note Use the show interfaces command to see a list of all interfaces currently configured on the router.
For more information about the syntax for the router, use the question mark (?) online help function.
Command Default Counters for all interfaces are cleared.
Command Modes EXEC modeXR EXEC mode
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines Use the clear counters command to clear all the statistics counters displayed by the show interfaces command.
If no optional arguments are supplied or if the all keyword is specified, then the counters for all interfaces are cleared. If an interface type is specified, then only the counters for that interface are cleared.
The clear counters command with the all option clears counters on all interfaces. When you enter this command, the system prompts you for confirmation. You must then press Enter or the y key for the clear
counters command to take effect.
468
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Statistics Service Commands clear counters
Task ID
Note This command does not clear counters retrieved using Simple Network Management Protocol (SNMP), but only those counters displayed with the show interfaces command.
Task ID interface
Operations execute
Examples This example shows how to clear counters on all interfaces:
RP/0/0RP0RSP0/CPU0:router:hostname# clear counters all
Clear "show interface" counters on all interfaces [confirm]
This example shows how to clear the interface counters for Packet-over-SONET/SDH (POS) interface 0/1/0/0:
RP/0/0RP0RSP0/CPU0:router:hostname# clear counters POS 0/1/0/0
Clear "show interface" counters on this interface [confirm]
Related Commands
Command show interfaces
Description
Displays statistics for all interfaces configured on the networking device.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
469
Statistics Service Commands load-interval
load-interval
To specify the interval for load calculation of an interface, use the load-interval command in interface configuration mode. To reset the load interval to the default setting, use the no form of this command.
load-interval seconds
no load-interval seconds
Syntax Description seconds Number of seconds for load calculation of an interface. The value range is from 0 to
600 seconds and in increments of 30 (such as 30, 60, 90, and so on). The default is 300 seconds.
Command Default seconds: 300 seconds (5 minutes)
Command Modes Interface configuration
Command History
Release
Release 2.0
Release 3.2
Release 3.7.2
Release 5.0.0
Modification
This command was introduced.
This command was introduced.
This command was introduced.
This command was introduced.
Usage Guidelines When load interval is set to zero, load calculation is disabled. If you set the load interval, you must use a multiple of 30 (up to 600 seconds).
Task ID
Task ID interface
Operations read/write
Examples This example shows how to configure the load interval to 30 seconds:
RP/0/0RP0RSP0/CPU0:router:hostname# configure
RP/0/0RP0RSP0/CPU0:router:hostname(config)# interface pos 0/1/0/0interface hundredGigE
0/1/0/0
470
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Statistics Service Commands
RP/0/0RP0RSP0/CPU0:router:hostname(config-if)# load-interval 30 load-interval
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
471
load-interval
Statistics Service Commands
472
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
OL-26517-02
Diagnostics Commands
This module provides command line interface (CLI) commands for configuring diagnostics on your router.
To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your
AAA administrator for assistance.
•
•
•
diagnostic monitor interval, page 478
•
diagnostic monitor syslog, page 480
•
diagnostic monitor threshold, page 481
•
diagnostic ondemand action-on-failure, page 483
•
diagnostic ondemand iterations, page 485
•
•
•
•
diagnostic test-parameters, page 494
•
•
ping (administration EXEC), page 498
•
•
show diagnostic bootup level, page 513
•
show diagnostic content, page 515
•
show diagnostic ondemand settings, page 520
•
show diagnostic result, page 521
•
show diagnostic schedule, page 529
•
show diagnostic status, page 531
•
show run diagnostic monitor, page 533
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
473
Diagnostics Commands diagnostic load
diagnostic load
To load an offline diagnostic image for integrated field diagnostics, use the diagnostic load command in
Admin EXEC modeSystem Admin EXEC mode.
diagnostic load location node-id [autostart {all| basic}]
Syntax Description
location node-id
autostart {all | basic}
Loads an offline diagnostic image for a specified location. The node-id argument is entered in the rack/slot/module notation. All modules in the specified slot are loaded with the offline diagnostic image.
(Optional) Starts running the diagnostic tests after the image has loaded. The following options are available:
• all—Runs all tests.
• basic—Runs basic tests
Command Default None
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.4.0
Modification
This command was introduced.
Usage Guidelines Use the diagnostic load command to load an offline diagnostic image used for integrated field diagnostics.
Loading a diagnostic image places the specified card out of service.
The time it takes to load a diagnostic image varies depending on the card. Use the show platform command to determine if the image has been loaded and if the card has been placed out of service.
Note The distributed route processor (DRP) does not support the automatic running of tests when the image is loaded for CPU0 and CPU1. After the diagnostic image is loaded, use the diagnostic start location node-id
test {id | all | basic | non-disruptive} command to execute the tests.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
474
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic load
Task ID
Task ID diag
Operations execute
Examples The following example shows how to load an offline diagnostic image:
RP/0/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# diagnostic load location 0/0/CPU0 autostart basic diagnostic load will bring requested slot out of service. [confirm(y/n)] y
User has confirmed diagnostic load request
Preparing UUT for Diagnostics software.
Downloading IDS diagnostics image /pkg/ucode/hfr-diag-l3sp-fdiags
Downloading IDS diagnostics image /pkg/ucode/hfr-diag-l3-fdiags
Please wait for UUT image downloading ...
diagnostic load in progress.
Related Commands
Command show platform
Description
Displays information and status of each node in the system.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
475
Diagnostics Commands diagnostic monitor
diagnostic monitor
To configure the health-monitoring diagnostic testing for a specified location, use the diagnostic monitor command in administration configuration mode. To remove the specified command from the configuration file and restore the system to its default condition, use the no form of this command.
diagnostic monitor location node-id test {id| test-name} [disable]
no diagnostic monitor location node-id test {id| test-name} [disable]
Syntax Description node-id
test {id | test-name} disable
Location to enable diagnostic monitoring. The node-id argument is entered in the
rack/slot/module notation.
Specifies diagnostic test selection. The following test selections are available:
• id—Test ID, as shown in the show diagnostic content command .
• test-name—Name of the test.
Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
Disables diagnostic monitoring for a specified location.
Command Default To view the default value for each test, use the show diagnostic content command in administration EXEC mode when the diagnostic image is first installed. The default may be different for each test.
Command Modes Administration configuration
Command History
Release
Release 3.4.0
Modification
This command was introduced.
Usage Guidelines Use the diagnostic monitor command to enable or disable health-monitoring diagnostic testing for a specified test at the specified location.
Use the disable keyword to disable a health-monitoring diagnostic test that is enabled by default. For example, if test 1 is enabled by default, the disable keyword disables the diagnostic test. If the no form of the command is used, the test is set to the default condition, which is enabled.
476
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic monitor
Task ID
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
Task ID diag
Operations read, write
Examples The following example shows how to enable health-monitoring diagnostic testing for 0/1/cpu0:
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic monitor location 0/1/cpu0 test
1
Related Commands
Command Description
show diagnostic content, on page 515
Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all components.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
477
Diagnostics Commands diagnostic monitor interval
diagnostic monitor interval
To configure the health-monitoring diagnostic testing for a specified interval for a specified location, use the
diagnostic monitor interval command in administration configuration mode. To remove the specified command from the configuration file and restore the system to its default condition, use the no form of this command.
diagnostic monitor interval location node-id test {id| test-name} number-of-days hour : minutes : seconds
. milliseconds
no diagnostic monitor interval location node-id test {id| test-name} number-of-days hour : minutes : seconds
. milliseconds
Syntax Description
location node-id
test {id | test-name}
Specifies a location. The node-id argument is entered in the
rack/slot/module notation.
Specifies diagnostic test selection. The following test selections are available:
• id—Test ID.
• test-name—Test name , as shown in the show diagnostic content command..
Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
number-of-days
hour:minutes:seconds.milliseconds
Interval between each test run.
The number-of-days argument specifies the number of days between testing. The range is from 0 through 20.
The hour:minutes:seconds.milliseconds argument specifies the interval, where hour is a number in the range from 0 through 23, minutes is a number in the range from 0 through 59, seconds is a number in the range from 0 through 59, and milliseconds is a number in the range from 0 through 999.
Command Default To view the default value for each test, use the show diagnostic content command in administration EXEC mode when the diagnostic image is first installed. The default may be different for each test.
Command Modes Administration configuration
Command History
Release
Release 3.4.0
Modification
This command was introduced.
478
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic monitor interval
Release
Release 3.7.2
Modification
This command was introduced.
Usage Guidelines Use the diagnostic monitor interval command to set the health-monitoring interval of a specified test at the specified location. The no version of the command resets the interval to the default setting. The diagnostic
monitor command is used to enable health-monitoring.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
Task ID
Task ID diag
Operations read, write
Examples The following example shows how to set the health-monitoring diagnostic testing at an interval of 1 hour, 2 minutes, 3 seconds, and 4 milliseconds for 0/1/cpu0:
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic monitor interval location
0/1/cpu0 test 1 0 1:2:3.4
Related Commands
Command
diagnostic monitor, on page 476
show diagnostic content, on page 515
Description
Configures the health-monitoring diagnostic testing for a specified location.
Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all components.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
479
Diagnostics Commands diagnostic monitor syslog
diagnostic monitor syslog
To enable the generation of a syslog message when any health monitoring test fails, use the diagnostic monitor
syslog command in administration configuration mode. To remove the specified command from the configuration file and restore the system to its default condition, use the no form of this command.
diagnostic monitor syslog no diagnostic monitor syslog
Syntax Description This command has no keywords or arguments.
Command Default Syslog is disabled.
Command Modes Administration configuration
Command History
Release
Release 3.4.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the diagnostic monitor syslog command to enable the generation of a syslog message when a health-monitoring test fails.
Task ID
Task ID diag
Operations read, write
Examples The following example shows how to enable the generation of syslog messages:
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic monitor syslog
Related Commands
Command Description
show diagnostic content, on page 515
Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all components.
480
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic monitor threshold
diagnostic monitor threshold
To configure the health-monitoring diagnostic testing failure threshold, use the diagnostic monitor threshold command in administration configuration mode. To remove the specified command from the configuration file and restore the system to its default condition, use the no form of this command.
diagnostic monitor threshold location node-id test {id| test-name} failure count failures
no diagnostic monitor threshold location node-id test {id| test-name} failure count failures
Syntax Description
location node-id
test {id | test-name}
failure count failures
Specifies a location. The node-id argument is entered in the rack/slot/module notation.
Specifies diagnostic test selection. The following test selections are available:
• id—Test ID.
• test-name—Test name , as shown in the show diagnostic content command. .
Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
Specifies the number of allowable test failures. Range is 1 to 99.
Command Default To view the default value for each test, use the show diagnostic content command in administration EXEC mode when the diagnostic image is first installed. The default can be different for each test.
Command Modes Administration configuration
Command History
Release
Release 3.4.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the diagnostic monitor threshold command to specify health-monitoring diagnostic testing failure threshold.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
481 OL-26517-02
Diagnostics Commands diagnostic monitor threshold
Task ID
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
Task ID diag
Operations read, write
Examples The following example shows how to set the failure threshold to 35 test failures for test 1 all tests for 0/1/cpu0:
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic monitor threshold location
0/1/cpu0 test 1 all failure count 35
Related Commands
Command Description
show diagnostic content, on page 515
Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all components.
482
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic ondemand action-on-failure
diagnostic ondemand action-on-failure
To set when to stop test execution for a diagnostic start command, use the diagnostic ondemand
action-on-failure command in Admin EXEC modeSystem Admin EXEC mode. This command is used in conjunction with the diagnostic ondemand iteration command.
diagnostic ondemand action-on-failure {continue failure-count| stop}
diagnostic ondemand action-on-failure {continue [ failure-count ]| stop}
Syntax Description
continue failure-count Specifies that test execution continue until the number of failures reaches the specified failure-count. Range is 0 to 65534. A failure-count of 0 indicates to not stop execution until all iterations are complete, no matter how many failures are encountered.
stop Stops execution immediately when the first test failure occurs.
Syntax Description continue failure-count stop
Specifies that test execution continues until all iterations are complete, no matter how many failures are encountered.
(Optional) Specifies that test execution continues until the number of failures reaches the specified failure-count. Range is 0 to 65534. A failure-count of 0 indicates to not stop execution until all iterations are complete, no matter how many failures are encountered.
Stops execution immediately when the first test failure occurs.
Command Default failure-count: 0
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the diagnostic ondemand action-on-failure command to specify whether or when to stop test execution if a test fails. This command is used in conjunction with the diagnostic ondemand iterations command.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
483 OL-26517-02
Diagnostics Commands diagnostic ondemand action-on-failure
Task ID
Task ID diag
Operations read, writeexecute
Examples The following example shows how to set the test failure action to stop:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic ondemand action-on-failure stop
Related Commands
Command
diagnostic ondemand iterations, on page 485
Description
Sets the number of times to repeat execution of the diagnostic test.
Runs a specified diagnostic test.
484
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic ondemand iterations
diagnostic ondemand iterations
To set the number of times to repeat execution of the tests specified by the diagnostic start command, use the diagnostic ondemand iterations command in Admin EXEC modeSystem Admin EXEC mode.
diagnostic ondemand iterations count
Syntax Description count Number of times to repeat the specified on-demand tests. Range is 1 to 999.
Command Default count: 1
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the diagnostic ondemand iterations command to specify the number of times the specified on-demand tests run. The on-demand tests are specified using the diagnostic start command.
Task ID
Task ID diag
Operations read, write execute
Examples The following example shows how to set the number of iterations to 12:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic ondemand iterations 12
Related Commands
Command Description
diagnostic ondemand action-on-failure, on page 483
Sets when to stop test execution for a diagnostic test.
Runs a specified diagnostic test.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
485 OL-26517-02
Diagnostics Commands diagnostic schedule
diagnostic schedule
To configure a diagnostic schedule, use the diagnostic schedule command in Admin Configuration modeSystem
Admin Config mode. To disable the diagnostic schedule, use the no form of this command.
diagnostic schedule location node-id test {id| test-name| all| basic| complete| minimal| non-disruptive|
per-device} [device number| all] {daily| on month day year| weekly day-of-week} hour:minute
no diagnostic schedule location node-id test {id| test-name| all| basic| complete| minimal| non-disruptive|
per-device} [device number| all] {daily| on month day year| weekly day-of-week} hour:minute
diagnostic schedule location node-id test {id| all| non-disruptive} {daily| on month day year| weekly
day-of-week} hour:minute
no diagnostic schedule location node-id test {id| all} {daily| on month day year| weekly day-of-week}
hour:minute
Syntax Description
location node-id test id all non-disruptive daily
on month day year
weekly day-of-week
hour:minute
Schedules a diagnostic test for a specified location. The node-id argument is entered in the rack/slot/module notation.
Specifies a specific diagnostic test, or all diagnostic tests.
Test ID or list of test IDs, as shown in the show diagnostic content command.
Multiple tests can be listed if separated by semicolons (;) and a range of dates can be listed if separated by a hyphen (-), as follows:
• x;y-z (for example: 1; 3-4 or 1;3;4)
Specifies all tests.
Specifies the nondisruptive test suite [Attribute = N].
Specifies a daily schedule.
Schedules an exact date.
Specifies a weekly schedule with a set day of the week. Enter the name of a day of the week or a number that specifies a day of the week in the range from 0 through 6, where 0 is today.
Scheduled start time, where hour is a number in the range from 0 through 23, and minute is a number in the range from 0 through 59.
Syntax Description
location node-id test
Schedules a diagnostic test for a specified location. The node-id argument is entered in the rack/slot/module notation.
Specifies a specific diagnostic test, or all diagnostic tests.
486
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic schedule id test-name all basic complete minimal non-disruptive per-device
device number | all daily
on month day year
weekly day-of-week
hour:minute
Specifies a test ID or list of test IDs. Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
Multiple tests can be listed if separated by semicolons (;) as follows:
• x;y-z (for example: 1; 3-4 or 1;3;4)
Specifies the name of a test. Use the show diagnostic content command in administration EXEC mode to see a list of test names.
Specifies all tests.
Specifies the basic on-demand test suite [Attribute = B].
Specifies the complete bootup test suite [Attribute = C].
Specifies the minimal bootup test suite [Attribute = M].
Specifies the non-disruptive test suite [Attribute = N].
Specifies the per-device test suite [Attribute = V].
Note This string works only with the all, basic, complete, minimal,
non-disruptive, and per-device keywords.
(Optional) Specifies the devices on which the diagnostic tests should run. The following options are available:
• number—Runs tests on one or more devices. The range is 1 through 8. To specify multiple devices, you can use hyphens (-) and semicolons (;); for example, 1; 3-4 or 1;3;4).
• all—Runs tests on all devices.
Specifies a daily schedule.
Schedules an exact date.
Specifies a weekly schedule with a set day of the week. Enter the name of a day of the week or a number that specifies a day of the week in the range from 0 through 6.
Scheduled start time, where hour is a number in the range from 0 through 23, and minute is a number in the range from 0 through 59.
Command Default No default behavior or values
Command Modes Admin Configuration modeSystem Admin Config mode
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
487
Diagnostics Commands diagnostic schedule
Command History
Release
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Task ID
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Task ID diag
Operations read, write
Examples The following example shows how to schedule a diagnostic test:
The following example shows how to schedule all diagnostic tests for location 0/0/CPU0 every day at 12:30 pm:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# configure
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic schedule location 0/0/CPU0 test all daily 12:30
The following example shows how to schedule all bootup tests for device 1 every Sunday at 12:30 pm:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# configure
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic schedule location 0/0/CPU0 test all daily complete device 1 weekly 12:30
Related Commands
Command
show diagnostic schedule, on page 529
Description
Displays the current scheduled diagnostic tasks.
488
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic start
diagnostic start
To run a specified diagnostic test, use the diagnostic start command in Admin EXEC modeSystem Admin
EXEC mode.
diagnostic start location node-id test {id| test-name| all| basic| complete| minimal| non-disruptive|
per-device} [device number| all]
diagnostic start location node-id test {id| all| non-disruptive}
Syntax Description
location node-id test id all non-disruptive
Runs diagnostic testing for a specified location. The node-id argument is entered in the rack/slot/module notation.
Specifies a specific diagnostic test, or all diagnostic tests.
Test ID or list of test IDs, as shown in the show diagnostic content command.
Multiple tests can be listed if separated by semicolons (;) a range of dates can be listed if separated by a hyphen (-), as follows:
• x;y-z (for example: 1; 3-4 or 1;3;4)
Specifies all tests.
Specifies the nondisruptive test suite [Attribute = N].
Syntax Description
location node-id test id test-name all basic complete minimal
Runs diagnostic testing for a specified location. The node-id argument is entered in the rack/slot/module notation.
Specifies a specific diagnostic test, or all diagnostic tests.
Test ID or list of test IDs. Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
Multiple tests can be listed if separated by semicolons (;) as follows:
• x;y-z (for example: 1; 3-4 or 1;3;4)
Name of the test. Use the show diagnostic content command in administration
EXEC mode to see a list of test names.
Specifies all tests.
Specifies the basic on-demand test suite [Attribute = B].
Specifies the complete bootup test suite [Attribute = C].
Specifies the minimal bootup test suite [Attribute = M].
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
489 OL-26517-02
Diagnostics Commands diagnostic start non-disruptive per-device
device number | all
Specifies the nondisruptive test suite [Attribute = N].
Specifies the per-device test suite [Attribute = V].
Note This string works only with the all, basic, complete, minimal,
non-disruptive, and per-device keywords.
(Optional) Specifies the devices on which the diagnostic tests should start. The following options are available:
• number—Start tests on one or more devices. The range is 1 through 8. To specify multiple devices, you can use hyphens (-) and semicolons (;); for example, 1; 3-4 or 1;3;4).
• all—Starts tests on all devices.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
The per-device keyword was added.
This command was introduced.
Usage Guidelines Use the diagnostic start command to run a diagnostic test on a specified card.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
490
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic start
Task ID
Task ID diag
Operations execute
Examples The following example shows how to start a suite of basic diagnostic tests for a specified location:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic start location 0/0/CPU0 test basic
The following example shows how to start a suite of minimal bootup tests for devices 1 through 7 at the specified location:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic start location 0/0/CPU0 test minimal devices 1-7
The following example shows how to run a complete suite of diagnostic tests for a specified location:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic start location 0/0/CPU0 test all
Related Commands
Command
Description
Stops the diagnostic testing in progress on a node.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
491
Diagnostics Commands diagnostic stop
diagnostic stop
To stop the diagnostic testing in progress on a node, use the diagnostic stop command in Admin EXEC modeSystem Admin EXEC mode.
diagnostic stop location node-id
Syntax Description
location node-id Stops diagnostic testing for a specified location. The node-id argument is entered in the rack/slot/module notation.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the diagnostic stop command to stop a diagnostic test on a specified node. The command is used for scheduled tests, a test that is causing errors, or a test that does not finish.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Task ID
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Task ID diag
Operations execute
492
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic stop
Examples
Task ID
The following example shows how to stop the diagnostic test process:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic stop location 0/0/CPU0
Related Commands
Command
Description
Runs a specified diagnostic test.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
493
Diagnostics Commands diagnostic test-parameters
diagnostic test-parameters
The FabricUcastMcastTest diagnostic test is used to periodically verify the fabric connectivity to all fabric destinations (RP, LC, DRP nodes) in a single or multi-chassis system. Automatic reload and shutdown as a result of a single -node failure is disabled by default. To enable this feature, set the parameters of the
FabricUcastMcast test by setting one or more of the optional parameters of the diagnostic test-parameters
FabricUcastMcastTest command in Admin EXEC modeSystem Admin EXEC mode.
diagnostic test-parameters
FabricUcastMcastTest[single-DRP-node-failure|single-LC-node-failure|single-RP-node-failure]<failure-type| reload threshold | shutdown threshold>
Syntax Description single-DRP-node-failure (Optional) Enters the mode to set the parameters for the FabricUcastMcast Test when a single node failure occurs as a result of a DRP failure.
single-LC-node-failure (Optional) Enters the mode to set the parameters for the FabricUcastMcast Test when a single node failure occurs as a result of a line card (LC) failure.
single-RP-node-failure (Optional) Enters the mode to set the parameters for the FabricUcastMcast Test when a single node failure occurs as a result of a route processor (RP) failure.
failure-type (Optional) Specifies the type of ping result to use for triggering node reload or shutdown. Options are:
• unicast-only-Multicast ping results are ignored.
• multicast-only-Unicast ping results are ignored.
reload threshold shutdown threshold
Default is both unicast and multicast ping results are used.
(Optional) Specifies the number of consecutive single-node failures that trigger the reload of a node. Range is 2 through 255. This value must be less than the
shutdown threshold for the same node type.
(Optional) Specifies the number of consecutive single-node failures that trigger the shutdown of a node. Range is 2 through 255. This value must be greater than the reload threshold for the same node type.
Command Default None
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 4.2.1
Modification
This command was introduced.
494
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands diagnostic test-parameters
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID diag
Operations read, write
Examples The following example shows how to set a node for automatic reload and shutdown when the
FabricUcastMcastTest results return single node failure. This is a result of line card failures for only multicast traffic:
RP/0/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# configuration
RP/0/RP0/CPU0:router(admin-config)# diagnostic test-parameters
RP/0/RP0/CPU0:router(admin-config-diag-test-params)#FabricUcastMcastTest
RP/0/RP0/CPU0:router(admin-config-FabricUcastMcastTest)#single-LC-node-failure
RP/0/RP0/CPU0:router(admin-config-FabricUcastMcastTest-LC)failure-type multicast-only
RP/0/RP0/CPU0:router(admin-config-FabricUcastMcastTest-LC)reload threshold 5
RP/0/RP0/CPU0:router(admin-config-FabricUcastMcastTest-LC)shutdown threshold 6
RP/0/RP0/CPU0:router(admin-config-FabricUcastMcastTest-LC)commit
When a single-node failure is detected, the following syslog messages are logged:
RP/0/RP1/CPU0:Jan 27 07:58:58.364 : online_diag_rp[276]: %DIAG-XR_DIAG-3-ERROR : (U)
Fabric Ping Failure, 1 of 3 nodes failed(L): 0/3/CPU0
RP/0/RP1/CPU0:Jan 27 07:58:58.802 : online_diag_rp[276]: %DIAG-XR_DIAG-3-ERROR : (U) FIM: single-node failure detected - 0/3/CPU0consecutive ucast/mcast failures: 15/0
When the reload threshold is reached, the following syslog message is logged prior to the reload:
RP/0/RP1/CPU0:Jan 27 07:58:58.803 : online_diag_rp[276]: %DIAG-XR_DIAG-6-INFO :reload threshold 15 crossed, reloading 0/3/CPU0
When the shutdown threshold is reached, the following syslog messages are logged:
RP/0/RP1/CPU0:Jan 27 08:11:02.104 : online_diag_rp[276]: %DIAG-XR_DIAG-6-INFO : shutdown threshold 10 crossed, shutting down 0/3/CPU0
RP/0/RP1/CPU0:Jan 27 08:11:02.137 : online_diag_rp[276]:
%PLATFORM-SHELFMGR-6-BRINGDOWN_REQUEST_LIB : Requesting node 0/3/CPU0 to be shutdown.
reason: [diag fabric ping failure]
RP/0/RP0/CPU0:Jan 27 08:11:02.136 : shelfmgr[306]: %PLATFORM-SHELFMGR-6-BRINGDOWN_REQUEST
: process online_diag_rp running on node0_RP1_CPU0 requested node 0/3/CPU0 to be shutdown.
reason: [diag fabric ping failure]
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
495
Diagnostics Commands diagnostic unload
diagnostic unload
To unload an offline diagnostic image, use the diagnostic unload command in Admin EXEC modeSystem
Admin EXEC mode.
diagnostic unload location node-id
Syntax Description
location node-id Unloads an offline diagnostic image for a specified location. The node-id argument is entered in the rack/slot/module notation. The diagnostic image is unloaded for all modules in the specified slot.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Modification
This command was introduced.
Usage Guidelines Use the diagnostic unload command to unload an offline diagnostic image used for integrated field diagnostics.
Unloading the image returns the specified card to service.
Use the show platform command to determine if the card has been placed back into service.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Task ID
Task ID diag
Operations execute
Examples The following example shows how to unload a diagnostic image:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# diagnostic unload location 0/0/CPU0
496
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands
Related Commands
Command
show platform diagnostic unload
Description
Loads a diagnostic test.
Displays information and status of each node in the system.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
497
Diagnostics Commands ping (administration EXEC)
ping (administration EXEC)
To send internal echo messages from one node to another, use the ping command in administration EXEC mode.
ping {control-eth| fabric} {fgid id| location node-id} [count pings] [debug] [interval milliseconds] [pattern
random] [queue priority] [retries number] [size payload_size] [timeout seconds] [tlate seconds] [uc]
[via-egressq] [via-fabricq-1]
Syntax Description control-eth fabric
fgid id
location node-id
Specifies a control ethernet ping test.
Specifies a fabric ping test.
Specifies that a multicast ping is sent over a fabric to nodes with the fabric group identifier (FGID) of 1024 through 1000000. Nodes that receive the ping respond with a unicast packet.
Specifies that a unicast ping is sent a node. The node-id argument is entered in the
rack/slot/module notation.
count pings debug
(Optional) Number of pings to send each time the command is run. The test reports results and statistics after all pings have been sent and received (or timed out). Range is from 0 through 4294967295. The default is 1.
Note This keyword is available only if you specified the fgid keyword.
(Optional) Specifies verbose debugging of the multicast ping utility.
interval milliseconds (Optional) Hold-off time between each ping in milliseconds. Range is from 0 through
4294967295. The total test time is as follows:
(count-1) * (RTT + interval) + RTT
RTT = Round Trip Time for the ping.
pattern random
queue priority
retries number
size payload_size
(Optional) Specifies a data pattern for the ping packet payload.
Note This keyword is available only if you specified the fgid keyword.
(Optional) Specifies the priority of the queue. The priority can be 0 or 1.
(Optional) Maximum number of times a failed ping transmission is sent before the packet transmission is considered a failure. Range is from 0 through 4294967295.
Note Packet transmission failure is usually an indication of a server software transient. In this case, we recommend that you run the ping command again.
(Optional) Specifies the payload size for each ping packet size. Range is from 0 through 4294967295 bytes. The maximum payload size allowed may be limited, depending on the transport type that is used (fabric or control-ethernet).
498
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands ping (administration EXEC)
timeout seconds
tlate seconds uc via-egressq via-fabricq-1
(Optional) Specifies the maximum time to wait for response to a ping. Range is from
0 through 4294967295 seconds.
If a ping does not receive a response before the configured timeout expires, the ping statistics reflect it as a discrepancy between the “Sent:” and “Rec'd:” packet count, and the test is considered failed. Because of this, we recommend that you do not set the timeout to 0.
Note This keyword is available only if you specified the fgid keyword.
(Optional) Specifies the amount of time to wait for a response to a multicast ping.
The amount of time you specify must be less than the value of the timeout keyword.
Range is from 0 through 4294967295 seconds.
Note This keyword is available only if you specified the fgid keyword.
(Optional) Specifies that unicast pings (instead of multicast pings) are sent to nodes with the specified FGID.
(Optional) Specifies that a unicast or multicast ping packet is routed to the first fabricq
ASIC (instance 0); then, to the egressq ASIC, and finally to the destination CPU.
By default, a unicast ping is routed to the first fabricq ASIC (instance 0), then to the destination CPU. A multicast ping is routed to the constituent fabricq ASIC instances, then to the destination CPU.
Note This keyword is available if you specified the location keyword, or both the
fgid and uc keywords.
(Optional) Specifies that a unicast ping is routed to the current fabricq ASIC (instance
1), then to the egressq ASIC, and finally, to the destination CPU.
By default, a unicast ping is routed to the first fabricq ASIC (instance 0), then to the destination CPU.
Command Default No default behavior or values
Command Modes Administration EXEC
Command History
Release
Release 3.3.0
Release 3.6.0
Release 3.8.0
Modification
This command was introduced.
The fgid keyword was added.
The via-egressq and via-fabricq-1 keywords were added.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
499
Diagnostics Commands ping (administration EXEC)
Usage Guidelines When you enter the ping command, a ping is sent to the node at the specified location or to nodes with the specified FGID. The received response is compared byte-by-byte to the sent packet. If a ping response is not received before the specified time-out, or if the ping response does not match the transmitted ping, the ping is considered failed.
A node that is unreachable or intermittently working impacts the total run time for the test as follows:
(received_packet_count * RTT + lost_packet_count * timeout + (count-1) * interval)
Line cards have two fabricq ASICs and an egressq ASIC. From the first fabricq ASIC (instance 0), the CPU can be reached directly or via the egressq ASIC. From the second fabricq ASIC (instance 1), the CPU can be reached only via the egressq ASIC. In other words, no direct packet path exists between instance 1 and the
CPU.
The route processor (RP) and distributed route processor (DRP) cards have only one fabricq ASIC per node
(CPU) and no egressq ASIC. Therefore, a fabric ping on an RP or DRP destination specified with the
via-egressq or via-fabricq-1 keyword fails.
Task ID
Task ID diag
Operations execute
Examples The following example shows sample output from a control-ethernet ping to an SP node in slot 0/0:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping control-eth location 0/0/SP count 5
Src node:
Dest node:
Local node:
529 : 0/RP0/CPU0
0 : 0/0/SP
529 : 0/RP0/CPU0
Packet cnt: 5 Packet size: 128 Payload ptn type: default (0)
Hold-off (ms): 300 Time-out(s): 2 Max retries: 5
Destination node has MAC addr 5246.4800.0000
Running CE node ping.
Please wait...
Src: 529:, Dest: 0, Sent: 5, Rec'd: 5, Mismatched: 0
Min/Avg/Max RTT: 0/200/1000
CE node ping succeeded for node: 0
The following example shows a fabric ping from the active RP to the active RP. In this example, the ping contains 72 packets of 1 kilobyte each. This command performs a good coverage test of the entire switch fabric:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping fabric location 0/RP0/CPU0 count 72 size
1024
Src node:
Dest node:
Local node:
529 : 0/RP0/CPU0
529 : 0/RP0/CPU0
529 : 0/RP0/CPU0
Packet cnt: 72 Packet size: 1024 Payload ptn type: default (0)
Hold-off (ms): 300 Time-out(s): 2 Max retries: 5
Running Fabric node ping.
500
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands ping (administration EXEC)
Please wait...
Src: 529:, Dest: 529, Sent: 72, Rec'd: 72, Mismatched: 0
Min/Avg/Max RTT: 3000/3013/4000
Fabric node ping succeeded for node: 529
The following example shows a ping to a control Ethernet node that has a problem or does not exist:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping control-eth location 0/1/CPU0 count 3
Src node:
Dest node:
Local node:
Packet cnt:
529
17
529
3
:
:
:
0/RP0/CPU0
0/1/CPU0
0/RP0/CPU0
Packet size: 128 Payload ptn type: default (0)
Hold-off (ms): 300 Time-out(s): 2 Max retries: 5
Destination node has MAC addr 5246.4800.0011
Running CE node ping.
Please wait...
Src: 529:, Dest: 17, Sent: 3, Rec'd: 0, Mismatched: 0
Requested ping failed for node: 17
The following example shows how to send a multicast fabric ping to nodes with the FGID of 1024. The node that sent the multicast ping waits 1 second for a response from each node.
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping fabric fgid 1024 tlate 1
Src node: fgid:
Local node:
Packet cnt:
Hold-off (ms):
DelayTimeout:
513 : 0/RP0/CPU0
1 Packet size: 128 Payload ptn type: default (0)
1 Time-out(s):
1 Priority:
Running Fabric node ping.
2
High
Max retries: 5
Please wait...
513 : 0/RP0/CPU0
1024
Multicast (Pinging fgid) ...
Node Sent Rcv.
Late
______________________________________________________________
0/1/CPU0 (0x11:17) 1 1 0
0/4/CPU0 (0x41:65)
0/4/CPU1 (0x42:66)
0/6/CPU0 (0x61:97)
0/RP0/CPU0 (0x201:513)
0/RP1/CPU0 (0x211:529) diag_ping: All 6 nodes responded to all 1 pings
1
1
1
1
1
1
1
1
1
1
0
0
0
0
0
Lost
0
0
0
0
0
0
The following example shows how to send a multicast fabric ping to nodes with the FGID of 1024. The ping packets are routed from the first fabricq ASIC (instance 0) to the destination CPU via the egressq ASIC. The pings to the two line cards (0/1/CPU0 and 0/6/CPU0) succeeded, while the pings to the RPs (0/RP0/CPU0 and 0/RP1/CPU0) and DRPs (0/4/CPU0 and 0/4/CPU1) failed because they do not have an egressq ASIC.
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping fabric fgid 1024 count 10 via-egressq
Src node: fgid:
Local node:
513 : 0/RP0/CPU0
1024
513 : 0/RP0/CPU0
Packet cnt:
Hold-off (ms):
10 Packet size: 128 Payload ptn type: default (0)
1 Time-out(s): 2 Max retries: 5
DelayTimeout: 1 Priority: High
Reaching destination CPUs via egressq
Running Fabric node ping.
Please wait...
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
501
Diagnostics Commands ping (administration EXEC)
Multicast (Pinging fgid) ...
Node Sent Rcv.
Late
______________________________________________________________
0/1/CPU0 (0x11:17) 10 10 0
Lost
0/4/CPU0 (0x41:65)
0/4/CPU1 (0x42:66)
0/6/CPU0 (0x61:97)
0/RP0/CPU0 (0x201:513)
10
10
10
10
0
0
10
0
0
0
0
0
0
10
10
0
10
0/RP1/CPU0 (0x211:529) 10 0 0 10 diag_ping: Out of 6 node(s), 2 node(s) responded to all 10 pings, 4 node(s) hads
The following example shows how to send a unicast ping to nodes with the FGID of 1024. The ping packets are routed from the second fabricq ASIC (instance 1) to the destination CPU via the egressq ASIC. The pings to the two line cards (0/1/CPU0 and 0/6/CPU0) succeeded, while the pings to the RPs (0/RP0/CPU0 and
0/RP1/CPU0) and DRPs (0/4/CPU0 and 0/4/CPU1) failed because they do not have a second fabricq ASIC nor an egressq ASIC.
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# ping fabric fgid 1024 count 10 uc via-fabricq-1
Src node: fgid:
513 : 0/RP0/CPU0
1024
Local node:
Packet cnt:
Hold-off (ms):
DelayTimeout:
513 : 0/RP0/CPU0
10 Packet size: 128 Payload ptn type: default (0)
1 Time-out(s):
1 Priority:
Using other fabricq instance
2
High
Max retries: 5
Running Fabric node ping.
Please wait...
Multicast (Pinging Individual Sponge Ids) ...
Node Sent Rcv.
Late
______________________________________________________________
0/1/CPU0 (0x11:17)
0/4/CPU0 (0x41:65)
0/4/CPU1 (0x42:66)
10
10
10
10
0
0
0
0
0
Lost
0
10
10
0/6/CPU0 (0x61:97)
0/RP0/CPU0 (0x201:513)
10
10
10
0
0
0
0
10
0/RP1/CPU0 (0x211:529) 10 0 0 10 diag_ping: Out of 6 node(s), 2 node(s) responded to all 10 pings, 4 node(s) hads
502
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diag
show diag
To display details about the hardware and software on each node in a router, use the show diag command in the appropriate mode.
EXEC Mode
show diag [ node-id ] [details| eeprom-info| power-regs| summary]
Administration EXEC Mode
show diag [ node-id ] [chassis| fans| power-supply] [details| eeprom-info| power-regs| summary]
show diag [ node-id ] [chassis-info| details| summary]
EXEC Mode
show diag [ node-id ] [details| eeprom-info| power-regs| summary]
Administration EXEC Mode
show diag [ node-id ] [chassis| fans| power-supply] [details| eeprom-info| power-regs| summary]
Syntax Description node-id details eeprom-info power-regs summary chassis-info fans power-supply
(Optional) Identifies the node whose information you want to display. The
node-id argument is expressed in the rack/slot/module notation.
Follow the node-id argument with one of the following optional keywords to specify specific test results:
• details
• eeprom-info
• power-regs
• summary
(Optional) Displays detailed diagnostics information for the current node.
(Optional) Displays field diagnostics results from the EEPROM.
(Optional) Displays field diagnostics results from the power registers.
(Optional) Displays summarized diagnostics results for all nodes in the system.
(Optional) Displays information about the chassis.
(Optional) Displays information about the fans tray.
(Optional) Displays information about the power supply.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
503 OL-26517-02
Diagnostics Commands show diag
Syntax Description details summary node-id eeprom-info power-regs chassis chassis-info fans power-supply
(Optional) Displays detailed hardware and diagnostics information.
Note Specifying the details keyword displays EEPROM information for the chassis or specified node.
(Optional) Displays a summary of the installed hardware.
(Optional) Identifies the node for which you want to display information. The
node-id argument is expressed in the rack/slot/module notation.
(Optional) Displays EEPROM information for the specified node or component
(chassis, fan, or power supply).
(Optional) Displays power register information for the specified node.
(Optional) Displays information about the chassis.
(Optional) Displays information about the fan trays.
(Optional) Displays information about the power supply.
Command Default Diagnostics for all nodes installed in the router are displayed.
Hardware and software information for all nodes installed in the router is displayed
Command Modes EXEC
Administration EXEC
Command History
Release
Release 2.0
Release 3.2
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
Command output was modified to display the last diagnostic result for a card.
The chassis-info keyword was introduced.
This command was introduced.
Usage Guidelines The show diag command displays detailed information on the hardware components for each node, and on the status of the software running on each node.
504
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diag
Task ID
Examples
OL-26517-02
Task ID sysmgr
Operations read
The following example shows excerpts of output from the show diag details command:
RP/0/RP0/CPU0:router# show diag details
CARD 0/1/* : Cisco CRS-1 Series Modular Services Card
MAIN: board type 500060
800-25021-05 rev B0 dev 079239
S/N SAD0925050J
PCA: 73-7648-08 rev B0
PID: CRS-MSC
VID: V02
CLEI: IPUCAC1BAA
ECI: 132502
RMA: Test Hist: ab, RMA#: 00-00-00, RMA Hist: 00
DIAGNOSTICS RESULTS:
ENTRY 1: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
ENTRY 2: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
ENTRY 3: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
PLIM 0/PL1/* : Cisco Carrier Routing System SPA Interface Processor Card
MAIN: board type 580070
800-23819-03 rev C0 dev N/A
S/N SAD09410538
PCA: 73-8982-06 rev C0
PID: CRS1-SIP-800
VID: V01
CLEI: COUIAAMCAA
ECI: 134912
RMA: Test Hist: ab, RMA#: 00-00-00, RMA Hist: 00
DIAGNOSTICS RESULTS:
ENTRY 1: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
ENTRY 2: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
505
Diagnostics Commands show diag
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
ENTRY 3: 0
TIMESTAMP: 00/00/0000 00:00:00
VERSION: v0.0
PARAM1: 0 PARAM2: n/a
TESTNUM: 0
RESULT: 0 (PASS)
ERRCODE: 0
Interface port config: 0 Ports
Optical reach type: Unknown
Connector type: MT-P
NODE 0/1/CPU0
Node State : IOS XR RUN
PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A
MONLIB: QNXFFS Monlib Version 3.1
ROMMON: Version 1.51(20080807:092259) [CRS-1 ROMMON]
CPU0: ASMP, CPU1: N/A
SPEED: OSC Speed: 100 Mhz, CPU Speed: 800 Mhz
BUS Speed: 100 Mhz, MEM Speed: 100 Mhz
MEM Size: 1024 Mbytes
SPA 0/1/0 : 4-port OC3/STM1 POS Shared Port Adapter
MAIN: board type 0440
68-2169-01 rev C0 dev N/A
S/N JAB093305VC
PCA: 73-9313-04 rev B0
PID: SPA-4XOC3-POS
VID: V01
CLEI: IPUIAFNRAA
Node State : OK
...
The output displayed for the show diag details command is the most comprehensive output displayed for
show diag command variations. All other variations show a subset of the fields displayed except for the show
diag chassis, show diag fans, and show diag power-supply commands, which also enable you to display
EEPROM information.
Rack 0 - Cisco CRS-1 Series 8 Slots Line Card Chassis
00: 03 00 01 E4 43 52 53 2D 38 2D 4C 43 43 00 00 00 ....CRS-8-LCC...
10: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
20: 49 50 4D 45 5A 31 30 42 52 41 06 CF B3 00 00 00 IPMEZ10BRA......
30: 00 00 00 00 00 00 00 15 63 58 B9 00 08 00 00 00 ........cX......
40: 00 49 00 21 F8 03 50 03 20 00 5A E7 04 78 00 01 .I.!..P. .Z..x..
50: 54 42 41 30 39 33 36 30 30 39 30 00 00 00 00 00 TBA09360090.....
60: 01 2B DB 00 00 00 00 00 00 00 00 00 00 00 00 00 .+..............
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 43 49 53 .............CIS
D0: 43 4F 20 53 59 53 54 45 4D 53 2C 20 49 4E 43 2E CO SYSTEMS, INC.
E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
RP/0/5/CPU0:router# show diag details
SLOT 0 (RP/LC 0): Cisco 12000 Series - Multi-Service Blade
MAIN: type 150, 800-25972-02 rev A0 dev 0
HW config: 0x00 SW key: 00-00-00
PCA: 73-9289-04 rev A0 ver 3
HW version 1.0 S/N SAD11360218
MBUS: Embedded Agent
Test hist: 0x00 RMA#: 00-00-00 RMA hist: 0x00
DIAG: Test count: 0x00000000 Test results: 0x00000000
EEPROM contents (hex):
Release Modification
Release 3.3.0 The chassis-info keyword was added to the show diags command on the
Cisco XR 12000 Series Router.
506
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diag
OL-26517-02
Task ID Operations sysmgr read
00: 01 00 0C 00 00 00 00 00 00 00 00 00 00 00 00 00
10: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
20: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
30: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
40: 00 96 01 00 00 49 00 24 49 04 50 03 FE 01 00 03
50: 03 20 00 65 74 02 50 00 00 00 00 0A 01 00 00 00
60: 53 41 44 31 31 33 36 30 32 31 38 00 00 00 00 00
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 DA 00 00
C0: 58 52 2D 31 32 4B 2D 4D 53 42 00 00 00 00 00 00
D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
E0: 02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
FRU: Linecard/Module: 12000-ServEngCard
L3 Engine: Service Engine - ISE OC192 (10 Gbps)
MBUS Agent Software version 4.4 (RAM) (ROM version is 4.4)
Using CAN Bus A
ROM Monitor version 1.3
Fabric Downloader version used 3.2 (ROM version is 3.2)
Primary clock is CSC0
Board State is IOS-XR RUN
Last Reset Reason: Card graceful reboot
Insertion time: Fri Oct 10 22:34:58 2008 (4w2d ago)
DRAM size: 2147483648 bytes
FrFab SDRAM size: 1610612736 bytes
ToFab SDRAM size: 268435456 bytes
0 resets since restart/fault forgive
...
SLOT 2 (RP/LC 2): Cisco 12000 Series SPA Interface Processor- 601
MAIN: type 149, 68-2647-01 rev A0 dev 85437
HW config: 0x20 SW key: 00-00-00
PCA: 73-9607-04 rev A0 ver 4
HW version 1.0 S/N SAD10330441
MBUS: Embedded Agent
Test hist: 0x00 RMA#: 00-00-00 RMA hist: 0x00
DIAG: Test count: 0x00000000 Test results: 0x00000000
EEPROM contents (hex):
00: 01 00 0C 00 00 00 00 00 00 00 00 00 00 00 00 00
10: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
20: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
30: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
40: 00 95 01 00 00 49 00 25 87 04 50 04 FE 01 00 00
50: 00 44 00 0A 57 01 50 01 4D BD 20 09 01 00 00 00
60: 53 41 44 31 30 33 33 30 34 34 31 00 00 00 00 00
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
A0: 00 01 40 98 00 00 00 00 00 00 00 00 00 00 00 00
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 DA 00 00
C0: 31 32 30 30 30 2D 53 49 50 2D 36 30 31 00 00 00
D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
E0: 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
F0: B8 07 A4 1F 8A 52 6D 1F 9A CE AE CF BF F4 00 00
FRU: Linecard/Module: 12000-SIP-601
Route Memory: MEM-LC5-2048=
Packet Memory: MEM-LC5-PKT-512=
L3 Engine: 5 (MultiRate) - ISE OC192 (10 Gbps)
Operational rate mode: 10 Gbps
MBUS Agent Software version 4.4 (RAM) (ROM version is 4.2)
Using CAN Bus A
ROM Monitor version 17.1
Fabric Downloader version used 4.7 (ROM version is 4.7)
Primary clock is CSC0
Board State is IOS-XR RUN
Last Reset Reason: Reload initiated by user
Insertion time: Wed Nov 5 17:39:51 2008 (5d01h ago)
DRAM size: 2147483648 bytes
FrFab SDRAM size: 268435456 bytes
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
507
show diag
Diagnostics Commands
ToFab SDRAM size: 268435456 bytes
0 resets since restart/fault forgive
SPA Information: subslot 0/2/0: SPA-4XOC3-POS-V2 (0x526), status is ok subslot 0/2/1: SPA-IPSEC-2G-2 (0x549), status is ok subslot 0/2/2: SPA-8X1FE (0x4c5), status is ok subslot 0/2/3: Empty
...
SLOT 5 (RP/LC 5): Cisco 12000 Series Performance Route Processor 2
MAIN: type 96, 800-23469-06 rev A0 dev 84610
HW config: 0x10 SW key: 00-00-00
PCA: 73-8812-09 rev A0 ver 7
HW version 0.0 S/N SAD103003M7
MBUS: MBUS Agent (1) 73-8048-07 rev A0 dev 0
HW version 0.1 S/N SAL1026THV9
Test hist: 0x00 RMA#: 00-00-00 RMA hist: 0x00
DIAG: Test count: 0x00000000 Test results: 0x00000000
EEPROM contents (hex):
00: 01 00 01 00 49 00 1F 70 07 50 00 00 00 00 00 00
10: 53 41 4C 31 30 32 36 54 48 56 39 00 00 00 00 00
20: 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00
30: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
40: 00 60 00 00 00 49 00 22 6C 09 50 07 00 02 00 00
50: 03 20 00 5B AD 06 50 01 4A 82 10 00 01 00 00 00
60: 53 41 44 31 30 33 30 30 33 4D 37 00 00 00 00 00
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
B0: 00 00 00 00 00 00 00 00 00 00 00 00 32 DA 00 00
C0: 50 52 50 2D 32 00 00 00 00 00 00 00 00 00 00 00
D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
E0: 04 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
FRU: Linecard/Module: PRP-2
Route Memory: MEM-PRP/LC-2048=
MBUS Agent Software version 4.4 (RAM) (ROM version is 4.2)
Using CAN Bus A
ROM Monitor version 1.16dev(0.1)
Primary clock is CSC0
Board State is IOS-XR RUN
Insertion time: Fri Oct 10 21:19:10 2008 (4w2d ago)
DRAM size: 2147483648 bytes
0 resets since restart/fault forgive
The output displayed for the show diag details command is the most comprehensive output displayed for
show diag command variations. All other variations show a subset of the fields displayed except for the show
diag details chassis-info and show diag summary chassis-info commands, which show different information.
RP/0/RSP0/CPU0:router# show diag details
NODE module 0/RSP0/CPU0 : ASR9K Fabric, Controller, 4G memory
MAIN board type 0x100302 S/N: FOC1229801R
Top Assy. Number68-3160-04PID A9K-RSP-4GUDI_VIDHwRev: V4.8New Deviation NumberCLEI
TBDTBDBoard State IOS XR RUNBoard State IOS XR RUN PLD: Motherboard: N/A, Processor:
0x8004 (rev: 2.2), Power: N/A
MONLIBQNXFFS Monlib Version 32ROMMONVersion 1(20081208:173612) [ASR9K ROMMON] Board
FPGA/CPLD/ASIC Hardware Revision:
CompactFlash V1.0XbarSwitch0 V1.3 XbarSwitch1 V1.3 XbarArbiter V1.0XbarInterface
V18.4IntCtrl V114ClkCtrl V1.13PuntFPGA V1.4HD V3.USB0 V17.USB1 V17CPUCtrl V1.17UTI
V1.6LIU V1.MLANSwitch V0.EOBCSwitch V2CBC (active partition) v1.1CBC (inactive partition) v1.More--
This table describes the significant fields shown in the display.
508
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands
Table 41: show diag Field Descriptions
Field
MAIN
PCA
PID
VID
CLEI
ECI
Board State
PLD
SPEED
MEM Size
RMA show diag
Description
Provides the following general information about the hardware:
• Board type
• Revision
• Device identifier
• Serial number
Cisco printed circuit assembly (PCA) hardware and revision number.
Displays the product identifier (PID) revision for the specified node.
Displays the version identifier (VID) for the specified node.
Displays the common language equipment identifier
(CLEI) for the specified node.
Displays the equipment catalog item (ECI) for the specified node.
Displays the current software on the board and whether or not the board is running.
Displays the information about the following programmable logic device (PLD) components on the current module:
• Processor
• Power
• MONLIB
Displays speed information for the various components of the specified node, in megahertz.
Displays the memory size of the specified node, in megabytes.
Displays returned material adjustment (RMA) information for the specified node.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
509
show diag
Field
DIAGNOSTICS RESULTS
Table 42: show diags Field Descriptions
Field
SLOT
MAIN
PCA
MBUS
DIAG
EEPROM contents
FRU
MBUS Agent Software version
ROM Monitor version
Diagnostics Commands
Description
Provides the following information about the last diagnostics test that was run on the specified node:
• ENTRY 1
• TIMESTAMP—Time stamp for the last diagnostic test that was run on the node.
• VERSION
• PARAM1
• PARAM2
• TESTNUM—Identifies the test that was run on the node.
• RESULT—Displays whether the last diagnostic test passed or failed.
• ERRCODE
Description
Physical slot number of the line card.
General information about the hardware.
Cisco Protection Channel Access (PCA) hardware and revision number.
Provides version information for the Mbus agent.
Results of the last diagnostics test, in hexadecimal format.
EEPROM contents, in hexadecimal, of the component.
Information about the Field-replaceable Units (FRUs) associated with the nodes that are installed in the router.
Mbus agent software version currently running on the router.
Version of monitor library used by ROMMON.
510
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diag
OL-26517-02
Field
Fabric Downloader version
Primary clock
Board State
Last Reset Reason
Insertion time
DRAM size
number resets since restart/fault forgive
SPA Information
Description
Version of fabric downloader used.
Primary clock source configured on the router.
Current software on the board, and whether or not the board is running.
Reason the card was last reset.
Time at which the last diagnostics test was executed.
Dynamic Random-Access Memory (DRAM) size in bytes.
Number of resets since the card was last restarted.
Subslot in which SPA is installed, name of SPA, and current status of SPA.
The following example shows how to display EEPROM information:
RP/0/RP0/CPU0:router(admin)# show diag chassis eeprom-info
Rack 0 - Cisco CRS-1 Series 8 Slots Line Card Chassis
00: 03 00 01 E4 43 52 53 2D 38 2D 4C 43 43 00 00 00 ....CRS-8-LCC...
10: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
20: 49 50 4D 45 5A 31 30 42 52 41 06 CF B3 00 00 00 IPMEZ10BRA......
30: 00 00 00 00 00 00 00 15 63 58 B9 00 08 00 00 00 ........cX......
40: 00 49 00 21 F8 03 50 03 20 00 5A E7 04 78 00 01 .I.!..P. .Z..x..
50: 54 42 41 30 39 33 36 30 30 39 30 00 00 00 00 00 TBA09360090.....
60: 01 2B DB 00 00 00 00 00 00 00 00 00 00 00 00 00 .+..............
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 43 49 53 .............CIS
D0: 43 4F 20 53 59 53 54 45 4D 53 2C 20 49 4E 43 2E CO SYSTEMS, INC.
E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
RP/0/RSP15/CPU0:router# show diag chassis eeprom-info
Rack 0 - ASR-9010 Chassis, Includes Accessories
Controller Family HW config: 0x20 SW key: ef Controller Type
: 2fePID ASR9010AC Version Identifier : 0UDI Name chassis ASR-9010-ACUDI Description ASR9010, AC Chassis Part Number (68-bbbb-vv)
: 68-1234-56
Part Revision : 0.1
PCB Serial Number : FOX1232H67MPCA Number (73-bbbb-vv) : 73-1159-02 PCA
Revision : 0.
Deviation Number # 1 0 CLEI Code : NOCLEI
Manufacturing Test Data : 00 00 00 00 00 00 00 00
Base MAC Address : 001d.e5eb.bfa8
MAC Address block size : 264
Hardware Revision : 0.100
Capabilities : 00
Field Diagnostics Data 00 00 00 00 00 00 00 00 Device values :
Power Usage (10mW units) : 0
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
511
Diagnostics Commands show diag
ENVMON Information 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0
0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0
The following example shows how to display detailed information for a chassis:
RP/0/5/CPU0:router# show diag details chassis-info
Backplane NVRAM [version 0x20] Contents -
Chassis: type 12406 Fab Ver: 2
Chassis S/N: TBM10421465
PCA: 73-5796-2 rev: C0 dev: 0 HW ver: 1.0
Backplane S/N: TBM10402356
MAC Addr: base 0019.aaa3.3a00
block size: 1024
RMA Number: 0x00-0x00-0x00 code: 0x00 hist: 0x00
Backplane NVRAM (hex)
00: 20 00 00 49 16 a4 00 02 00 60 00 02 01 00 00 07
10: 54 42 4d 31 30 34 30 32 33 35 36 00 00 00 00 00
20: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
30: 54 42 4d 31 30 34 32 31 34 36 35 00 00 00 00 00
40: 00 19 aa a3 3a 00 04 00 00 00 00 00 00 00 00 00
50: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
60: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Table 43: show diags details chassis-info Field Descriptions
Field
Chassis
Chassis S/N
PCA
Backplane S/N
MAC Addr
RMA Number
Backplane NVRAM
Description
Type and fabrication version of the chassis.
Serial number of the chassis.
Cisco Protection Channel Access (PCA) hardware and revision number.
Serial number of the backplane.
MAC address and block size of the chassis.
RMA information for the chassis.
Contents of the backplane NVRAM, in hexadecimal.
Related Commands
Command show platform show version
Description
Displays information and status for each node in the system.
Displays details on the hardware and software status of the system.
512
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic bootup level
show diagnostic bootup level
To display the current diagnostic bootup level, use the show diagnostic bootup level command in Admin
EXEC modeSystem Admin EXEC mode.
show diagnostic bootup level location node-id
Syntax Description
location node-id Specifies a card. The node-id argument is entered in the rack/slot/module notation.
Command Default No default behavior or values.
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.4.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the show diagnostic bootup level command to display the current diagnostic bootup level for a specified card.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
Task ID
Task ID diag
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
513 OL-26517-02
Diagnostics Commands show diagnostic bootup level
Examples The following example shows how to display the current diagnostic bootup level for 0/1/cpu0:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show diagnostic bootup level location 0/1/cpu0
Current bootup diagnostic level for LC 0/1/CPU0: minimal
514
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic content
show diagnostic content
To display test information including test ID, test attributes, and supported coverage test levels for each test and for all components, use the show diagnostic content command in Admin EXEC modeSystem Admin
EXEC mode.
show diagnostic content location node-id
Syntax Description
location node-id Displays the diagnostic content for a specified location. The node-id argument is entered in the rack/slot/module notation.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the show diagnostic content command to display diagnostic test information for a specific location. The test information includes the supported tests and attributes.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
515 OL-26517-02
Diagnostics Commands show diagnostic content
Task ID
Examples
Task ID diag
Operations read
The following example shows how to display the test information for a specified location:
For a route switch processor:
RP/0/RSP0/CPU0:router(admin)# show diagnostic content location 0/rsp0/cpuo
Wed Feb 16 09:17:07.293 PST
RP 0/RSP0/CPU0:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
ID
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
Test Name Attributes
Test Interval Thre-
(day hh:mm:ss.ms shold)
==== ================================== ============ ================= =====
1) PuntFPGAScratchRegister ---------> ***N****A 000 00:01:00.000 1
2) FIAScratchRegister --------------> ***N****A 000 00:01:00.000 1
3) ClkCtrlScratchRegister ----------> ***N****A
4) IntCtrlScratchRegister ----------> ***N****A
5) CPUCtrlScratchRegister ----------> ***N****A
6) FabSwitchIdRegister -------------> ***N****A
000 00:01:00.000 1
000 00:01:00.000 1
000 00:01:00.000 1
000 00:01:00.000 1
7) EccSbeTest ----------------------> ***N****I
8) SrspStandbyEobcHeartbeat --------> ***NS***A
9) SrspActiveEobcHeartbeat ---------> ***NS***A
10) FabricLoopback ------------------> M**N****A
11) PuntFabricDataPath --------------> ***N****A
12) FPDimageVerify ------------------> ***N****I
000 00:01:00.000 3
000 00:00:05.000 3
000 00:00:05.000 3
000 00:01:00.000 3
000 00:01:00.000 3
001 00:00:00.000 1
RP/0/0RP0RSP0/CPU0:router:hostname(admin): show diagnostic content location 0/rp0/cpu0
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
ID
A/I - Monitoring is active / Monitoring is inactive
Test Name Attributes
Test Interval Thre-
(day hh:mm:ss.ms shold)
516
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic content
OL-26517-02
==== ================================== ============ ================= =====
1) ControlEthernetPingTest ---------> *B*N*X**I
2) SelfPingOverFabric --------------> *B*N*X**I
3) FabricPingTest ------------------> *B*N*X**I
001 00:00:00.000 1
001 00:00:00.000 1
001 00:00:00.000 1
4) ControlEthernetInactiveLinkTest -> *B*NS***I
5) RommonRevision ------------------> *B*N*X**I
6) FabricDiagnosisTest -------------> *B*NS***I
7) FilesystemBasicDisk0 ------------> *B*N****I
001 00:00:00.000 1
001 00:00:00.000 1
000 00:02:00.000 1
003 00:00:00.000 1
8) FilesystemBasicDisk1 ------------> *B*N****I
9) FilesystemBasicHarddisk ---------> *B*N****I
10) ScratchRegisterTest -------------> CBVN****I
11) FabricMcastTest -----------------> *B*NS***I
12) ControlEthernetIntraSwitchTest --> *B*N****I
13) FabricUcastMcastTest ------------> *B*N****A
003 00:00:00.000 1
003 00:00:00.000 1
001 00:00:00.000 1
000 00:02:00.000 1
000 00:00:02.000 3
000 00:01:00.000 1
For a line card:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show diagnostic content location 0/1/cpu0
Wed Feb 16 09:27:01.424 PST
MSC 0/1/CPU0:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
ID Test Name Attributes
Test Interval Thre-
(day hh:mm:ss.ms shold)
==== ================================== ============ ================= =====
1) ControlEthernetPingTest ---------> *B*N*X**I 001 00:00:00.000 1
2) SelfPingOverFabric --------------> *B*N*X**I
3) RommonRevision ------------------> *B*N*X**I
4) ScratchRegisterTest -------------> CBVN****I
001 00:00:00.000 1
001 00:00:00.000 1
001 00:00:00.000 1
5) TcamFullScanTest ----------------> *BVN****I
6) EgressqMemoryBISTTest -----------> **VD*X**I
7) IngressqMemoryBISTTest ----------> **VD*X**I
8) FabricqMemoryBISTTest -----------> **VD*X**I
001 00:00:00.000 1
001 00:00:00.000 1
001 00:00:00.000 1
001 00:00:00.000 1
RP/0/RSP0/CPU0:router(admin)# show diagnostic content location 0/1/cpu0
A9K-40GE-L 0/1/CPU0:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NAab
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
ID
A/I - Monitoring is active / Monitoring is inactive
Test Name Attributes
Test Interval Thre-
(day hh:mm:ss.ms shold)
==== ================================== ============ ================= =====
1) PHYCtrlScratchRegister ----------> ***N****A 000 00:01:00.000 1
2) PortCtrlScratchRegister ---------> ***N****A
3) CPUCtrlScratchRegister ----------> ***N****A
4) NPScratchRegister ---------------> ***N****A
5) BridgeScratchRegister -----------> ***N****A
6) FIAScratchRegister --------------> ***N****A
000 00:01:00.000 1
000 00:01:00.000 1
000 00:01:00.000 1
000 00:01:00.000 1
000 00:01:00.000 1
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
517
Diagnostics Commands show diagnostic content
7) EccSbeTest ----------------------> ***N****I
8) LcEobcHeartbeat -----------------> ***N****A
9) NPULoopback ---------------------> ***N****A
10) FPDimageVerify ------------------> ***N****I
000 00:01:00.000 3
000 00:00:05.000 3
000 00:01:00.000 3
001 00:00:00.000 1
Here is an example of show diagnostic content location command for FabricUcastMcast Test.
RP/0/RP0/CPU0:router(admin)#show diagnostic content location 0/0/CPU0
Thu Mar 3 13:45:26.115 PST
DRP 0/0/CPU0:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
ID Test Name Attributes
Test Interval Thre-
(day hh:mm:ss.ms shold)
==== ================================== ============ ================= =====
1) ControlEthernetPingTest ---------> *B*N*X**I 001 00:00:00.000 1
2) SelfPingOverFabric --------------> *B*N*X**I
3) FabricPingTest ------------------> *B*N*X**I
001 00:00:00.000 1
001 00:00:00.000 1
4) ControlEthernetInactiveLinkTest -> *B*NS***I
5) RommonRevision ------------------> *B*N*X**I
6) FabricDiagnosisTest ------------> *B*NS***I
7) FilesystemBasicDisk0 ------------> *B*N****I
8) FilesystemBasicDisk1 ------------> *B*N****I
9) FilesystemBasicHarddisk ---------> *B*N****I
10) ScratchRegisterTest -------------> CBVN****I
11) FabricMcastTest -----------------> *B*NS***A
12) ControlEthernetIntraSwitchTest --> ***N****I
13) FabricUcastMcastTest ------------> *B*N****A
001 00:00:00.000 1
001 00:00:00.000 1
000 00:02:00.000 1
003 00:00:00.000 1
003 00:00:00.000 1
003 00:00:00.000 1
001 00:00:00.000 1
000 00:02:00.000 1
000 00:00:02.000 3
000 00:01:00.000 1
Table 44: show diagnostic content Field Descriptions, on page 518
describes the significant fields shown in the display.
Table 44: show diagnostic content Field Descriptions
Field Description
M/C/* - Minimal bootup level test / Complete bootup level test / NA
Minimal bootup test or complete bootup test.
B/* - Basic ondemand test / NA Basic on-demand test.
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
Test is per port or device.
Test is disruptive or nondisruptive.
Test is available for standby node only.
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
Test is not a health-monitoring test.
Test is a fixed monitoring interval test.
Test is an always enabled monitoring test.
Test is active or inactive.
518
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic content
Field
ID
Test Name
Attributes
Test Interval
Threshold
Description
ID of the test.
Name of the test.
Attributes for the test.
Interval of the test.
Failure threshold of the text.
Related Commands
Command
diagnostic monitor interval, on page 478
diagnostic schedule, on page 486
diagnostic unload, on page 496
Description
Loads an offline diagnostic image for integrated field diagnostics.
Configures the health-monitoring diagnostic testing for a specified interval for a specified location.
Configures a diagnostic schedule.
Runs a specified diagnostic test.
Unloads an offline diagnostic image.
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
519
Diagnostics Commands show diagnostic ondemand settings
show diagnostic ondemand settings
To display the current on-demand settings, use the show diagnostic ondemand settings command in Admin
EXEC modeSystem Admin EXEC mode .
show diagnostic ondemand settings
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID diag
Operations read
Examples The following example shows how to display the on-demand settings:
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show diagnostic ondemand settings
Test iterations = 45
Action on test failure = continue until test failure limit reaches 25
520
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic result
show diagnostic result
To display diagnostic test results, use the show diagnostic result command in Admin EXEC modeSystem
Admin EXEC mode.
show diagnostic result location node-id[test {id| test-name| all}] [detail]
Syntax Description
location node-id
test {id | test-name |
all}
Displays the diagnostic test results for a specified location. The node-id argument is entered in the rack/slot/module notation.
(Optional) Specifies diagnostic test selection. The following test selections are available:
• id—Test ID or list of test IDs , as shown in the show diagnostic content command . Multiple tests can be listed if separated by semicolons (;) as follows:
◦x;y-z (for example: 1; 3-4 or 1;3;4) detail
• test-name—Test name.
• all—Specifies all tests.
Use the show diagnostic content command in administration EXEC mode to see a list of test names and their associated IDs.
(Optional) Specifies detailed results.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the show diagnostic result command to display diagnostic results for a specific location.
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
521 OL-26517-02
Diagnostics Commands show diagnostic result
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Task ID
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Task ID diag
Operations read
Examples The following example shows how to display detailed diagnostic test results:
RP/0/RSP0/CPU0:router(admin)# show diagnostic result loc 0/RSP0/CPU0 test 1
Current bootup diagnostic level for RP 0/RSP0/CPU0: minimal
Test results: (. = Pass, F = Fail, U = Untested)
1 ) PuntFPGAScratchRegister ---------> .
RP/0/RSP0/CPU0:router(admin)#
RP/0/RSP0/CPU0:router(admin)# show diagnostic result loc 0/RSP0/CPU0 test all
Current bootup diagnostic level for RP 0/RSP0/CPU0: minimal
Test results: (. = Pass, F = Fail, U = Untested)
1 ) PuntFPGAScratchRegister ---------> .
2 ) XbarInterfaceScratchRegister ----> .
3 ) ClkCtrlScratchRegister ----------> .
4 ) IntCtrlScratchRegister ----------> .
5 ) CPUCtrlScratchRegister ----------> .
6 ) XbarSwitchIdRegister ------------> .
7 ) EccSbeTest ----------------------> U
8 ) SrspStandbyEobcHeartbeat --------> U
9 ) SrspActiveEobcHeartbeat ---------> U
10 ) FabricLoopback ------------------> .
11 ) PuntFabricDataPath --------------> .
12 ) FPDimageVerify ------------------> .
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show diagnostic result location 0/3/CPU0 test 1 detail
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1 ) Control Ethernet Ping Test ------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test execution time ----> Thu Aug 11 18:13:38.918 2005
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Thu Aug 11 18:13:38.918 2005
Total failure count ---------> 0
Consecutive failure count ---> 0
522
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic result
Here is an example of the show diagnostic results detail command run on the route switch processor labeled
RSP0:
RP/0/RSP0/CPU0:router(admin)# show diagnostic result loc 0/RSP0/CPU0 detail
Current bootup diagnostic level for RP 0/RSP0/CPU0: minimal
RP 0/RSP0/CPU0:
Overall diagnostic result: PASS
Diagnostic level at card bootup: minimal
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1 ) PuntFPGAScratchRegister ---------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 265
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
___________________________________________________________________________
2 ) XbarInterfaceScratchRegister ----> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 265
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
___________________________________________________________________________
3 ) ClkCtrlScratchRegister ----------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 265
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
___________________________________________________________________________
4 ) IntCtrlScratchRegister ----------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 265
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
___________________________________________________________________________
5 ) CPUCtrlScratchRegister ----------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 264
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
523
Diagnostics Commands show diagnostic result
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
___________________________________________________________________________
6 ) XbarSwitchIdRegister ------------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 264
Last test execution time ----> Tue Mar 10 16:31:43 2009
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Mar 10 16:31:43 2009
Total failure count ---------> 0
Consecutive failure count ---> 0
Here is an example of show diagnostic result command to view the results of the FabricUcastMcast Test.
RP/1/RP0/CPU0:router(admin)#show diagnostic result location 0/rp1/cpu0 test
FabricUcastMcastTest detail
Fri Mar 4 11:21:01.153 UTC
Current bootup diagnostic level for RP 0/RP1/CPU0: bypass
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
13 ) FabricUcastMcastTest ------------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 17
Last test execution time ----> Fri Mar 4 11:20:54 2011
First test failure time -----> Fri Mar 4 11:19:47 2011
Last test failure time ------> Fri Mar 4 11:19:47 2011
Last test pass time ---------> Fri Mar 4 11:20:54 2011
Total failure count ---------> 1
Consecutive failure count ---> 0
Unicast Results dest: ret_code: rx_ret_code:
(all nodes) session_id:
0 (No error)
0 (No error)
48 tx_ret_code: min_rtt_ms: ping_mode_mask: inter_packet_delay: late_timeout_ms: flags: pkt_size:
0 (No error)
2 max_rtt_ms:
0x00000099 fplane_bitmap:
0 max_timeout_ms:
1500 priority:
0x00000000 pkt_cnt:
1000 num_nodes:
63
0x000000ff
1500
0
10
15 tx_start_ts: 11:20:54.488 UTC Fri Mar 04 2011 modes: 0 - LP/fabricq0, 3 - LP/fabricq1, 4 - HP/fabricq0, 7 - HP/fabricq1 node[mode] req'ed rx_good tx_good tx_unrea tx_err rx_unexp rx_corr
============== ======== ======== ======== ======== ======== ======== ========
0/0/CPU0[0]
0/0/CPU0[3]
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0/0/CPU0[4]
0/0/CPU0[7]
0/4/CPU0[0]
0/4/CPU0[3]
0/4/CPU0[4]
0/4/CPU0[7]
0/5/CPU0[0]
0/5/CPU0[3]
0/5/CPU0[4]
0/5/CPU0[7]
0/6/CPU0[0]
0/6/CPU0[3]
0/6/CPU0[4]
0/6/CPU0[7]
0/8/CPU0[0]
0/8/CPU0[4]
0/RP0/CPU0[0]
0/RP0/CPU0[4]
0/RP1/CPU0[0]
0/RP1/CPU0[4]
1/3/CPU0[0]
1/3/CPU0[3]
1/3/CPU0[4]
1/3/CPU0[7]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
524
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic result
1/4/CPU0[0]
1/4/CPU0[3]
1/4/CPU0[4]
1/4/CPU0[7]
1/7/CPU0[0]
1/7/CPU0[4]
1/9/CPU0[0]
1/9/CPU0[3]
1/9/CPU0[4]
1/9/CPU0[7]
1/14/CPU0[0]
1/14/CPU0[3]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/14/CPU0[4]
1/14/CPU0[7]
1/15/CPU0[0]
1/15/CPU0[4]
1/RP0/CPU0[0]
1/RP0/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/RP1/CPU0[0]
1/RP1/CPU0[4]
10
10
10
10
10
10
0
0
0
0
0
0
0
0
============== ======== ======== ======== ======== ======== ======== ========
Global 460 460 460 0 0 0 0
Unicast Results (Last Failure) dest: ret_code:
(all nodes) session_id: 30
606182912 ('FAB_SVR' detected the 'informational' condition
0
0
0
0
0
0
0
0
0
0
0
0
'Timed out waiting for all ping replies.') rx_ret_code: tx_ret_code: min_rtt_ms: ping_mode_mask:
0 (No error)
0 (No error)
2 max_rtt_ms:
0x00000099 fplane_bitmap: inter_packet_delay: late_timeout_ms: flags: pkt_size: tx_start_ts:
0 max_timeout_ms:
1500 priority:
0x00000000 pkt_cnt:
1000 num_nodes:
11:19:47.167 UTC Fri Mar 04 2011
61
0x000000ff
1500
0
10
15 modes: 0 - LP/fabricq0, 3 - LP/fabricq1, 4 - HP/fabricq0, 7 - HP/fabricq1 node[mode] req'ed rx_good tx_good tx_unrea tx_err rx_unexp rx_corr
============== ======== ======== ======== ======== ======== ======== ========
0/0/CPU0[0] 10 0 10 0 0 0 0
0/0/CPU0[3]
0/0/CPU0[4]
10
10
0
0
10
10
0
0
0
0
0
0
0
0
0/0/CPU0[7]
0/4/CPU0[0]
0/4/CPU0[3]
0/4/CPU0[4]
0/4/CPU0[7]
0/5/CPU0[0]
0/5/CPU0[3]
0/5/CPU0[4]
0/5/CPU0[7]
0/6/CPU0[0]
0/6/CPU0[3]
0/6/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
0
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0/6/CPU0[7]
0/8/CPU0[0]
0/8/CPU0[4]
0/RP0/CPU0[0]
0/RP0/CPU0[4]
0/RP1/CPU0[0]
0/RP1/CPU0[4]
1/3/CPU0[0]
1/3/CPU0[3]
1/3/CPU0[4]
1/3/CPU0[7]
1/4/CPU0[0]
1/4/CPU0[3]
1/4/CPU0[4]
1/4/CPU0[7]
1/7/CPU0[0]
1/7/CPU0[4]
1/9/CPU0[0]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
525
Diagnostics Commands show diagnostic result
1/9/CPU0[3]
1/9/CPU0[4]
1/9/CPU0[7]
1/14/CPU0[0]
1/14/CPU0[3]
1/14/CPU0[4]
1/14/CPU0[7]
1/15/CPU0[0]
1/15/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/RP0/CPU0[0]
1/RP0/CPU0[4]
1/RP1/CPU0[0]
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
1/RP1/CPU0[4] 10 10 10 0 0 0 0
============== ======== ======== ======== ======== ======== ======== ========
Global
Multicast Results
460 420 460 0 0 0 0
FGID 49
0
0
0
0
0
0 dest: ret_code: rx_ret_code: tx_ret_code:
1023 session_id:
0 (No error)
0 (No error)
0 (No error) min_rtt_ms: ping_mode_mask: inter_packet_delay: late_timeout_ms: flags: pkt_size: tx_start_ts:
13 max_rtt_ms:
0x00000011 fplane_bitmap:
0 max_timeout_ms:
1500 priority:
0x00000000 pkt_cnt:
1000 num_nodes:
11:20:54.492 UTC Fri Mar 04 2011
58
0x000000ff
1500
0
10
15 modes: 0 - LP/fabricq0, 4 - HP/fabricq0 node[mode] req'ed rx_good tx_good tx_unrea tx_err rx_unexp rx_corr
============== ======== ======== ======== ======== ======== ======== ========
0
0
0
0
0
0
0
0
0
0/0/CPU0[0]
0/0/CPU0[4]
0/4/CPU0[0]
0/4/CPU0[4]
0/5/CPU0[0]
0/5/CPU0[4]
0/6/CPU0[0]
0/6/CPU0[4]
0/8/CPU0[0]
0/8/CPU0[4]
0/RP0/CPU0[0]
0/RP0/CPU0[4]
0/RP1/CPU0[0]
0/RP1/CPU0[4]
1/3/CPU0[0]
1/3/CPU0[4]
1/4/CPU0[0]
1/4/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/7/CPU0[0]
1/7/CPU0[4]
1/9/CPU0[0]
1/9/CPU0[4]
1/14/CPU0[0]
1/14/CPU0[4]
1/15/CPU0[0]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/15/CPU0[4]
1/RP0/CPU0[0]
1/RP0/CPU0[4]
1/RP1/CPU0[0]
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
1/RP1/CPU0[4] 10 10 10 0 0 0 0
============== ======== ======== ======== ======== ======== ======== ========
Global 300 300 300 0 0 0 0
0
0
0
0
0
0
0
0
0
0
0
Multicast Results (Last Failure) dest: ret_code: rx_ret_code: tx_ret_code: min_rtt_ms: ping_mode_mask:
FGID inter_packet_delay:
1023 session_id:
0 (No error)
0 (No error)
0 (No error)
14 max_rtt_ms:
0x00000011 fplane_bitmap:
0 max_timeout_ms: late_timeout_ms: flags: pkt_size:
1500 priority:
0x00000000 pkt_cnt:
1000 num_nodes:
31
58
0x000000ff
1500
0
10
15
526
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic result tx_start_ts: 11:19:47.171 UTC Fri Mar 04 2011 modes: 0 - LP/fabricq0, 4 - HP/fabricq0 node[mode] req'ed rx_good tx_good tx_unrea tx_err rx_unexp rx_corr
============== ======== ======== ======== ======== ======== ======== ========
0/0/CPU0[0] 10 10 10 0 0 0 0
0/0/CPU0[4]
0/4/CPU0[0]
0/4/CPU0[4]
0/5/CPU0[0]
0/5/CPU0[4]
0/6/CPU0[0]
0/6/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0/8/CPU0[0]
0/8/CPU0[4]
0/RP0/CPU0[0]
0/RP0/CPU0[4]
0/RP1/CPU0[0]
0/RP1/CPU0[4]
1/3/CPU0[0]
1/3/CPU0[4]
1/4/CPU0[0]
1/4/CPU0[4]
1/7/CPU0[0]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/7/CPU0[4]
1/9/CPU0[0]
1/9/CPU0[4]
1/14/CPU0[0]
1/14/CPU0[4]
1/15/CPU0[0]
1/15/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
1/RP0/CPU0[0]
1/RP0/CPU0[4]
1/RP1/CPU0[0]
1/RP1/CPU0[4]
10
10
10
10
10
10
10
10
10
10
10
10
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
============== ======== ======== ======== ======== ======== ======== ========
Global 300 300 300 0 0 0 0
0
0
0
0
0
0
0
Here is an example to display detailed diagnostic test results for the FabSRCC Test: show diagnostic result <location> test FabSRCCTest detail
RP/0/RP0/CPU0:router(admin)#show diagnostic result location 0/4/cpu0 test FabSRCCTest detail
Tue Jun 1 21:07:38.974 UTC
Current bootup diagnostic level for MSC-140G 0/4/CPU0: bypass
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
9 ) FabSRCCTest -------------------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test execution time ----> Tue Jun 1 21:05:00 2010
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Tue Jun 1 21:05:00 2010
Total failure count ---------> 0
Consecutive failure count ---> 0
Table 45: show diagnostic result Field Descriptions
Field
Test results :
Description
Test result options:
• .—Pass
• F—Fail
• U—Untested
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
527
Diagnostics Commands show diagnostic result
Field
Error code
Total run count
Last test execution time
First test failure time
Last test failure time
Last test pass time
Total failure count
Consecutive failure count
Related Commands
Command
diagnostic schedule, on page 486
Description
Code for the error. DIAG_SUCCESS is indicated if there were no code errors. DIAG_FAILURE is indicated for any failure. DIAG_SKIPPED is indicated if the test was stopped.
Number of times the test has run.
Last time the test was run.
First time the test failed.
Last time the test failed.
Last time the test passed.
Number of times the test has failed.
Number of consecutive times the test has failed.
Description
Loads an offline diagnostic image for integrated field diagnostics.
Configures a diagnostic schedule.
Runs a specified diagnostic test.
528
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic schedule
show diagnostic schedule
To display the current scheduled diagnostic tasks, use the show diagnostic schedule command in Admin
EXEC modeSystem Admin EXEC mode.
show diagnostic schedule location node-id
Syntax Description
location node-id Displays the diagnostic schedule for a specified location. The node-id argument is entered in the rack/slot/module notation.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.3.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines Use the show diagnostic schedule command to display scheduled diagnostic tasks for a specific location.
Note To specify a node using the node-id argument, use the rack/slot/module notation. For example, 0/0/CPU0 is a fully qualified location specification for a line card, 0/2/CPU0 is a fully qualified location specification for a line card, 0/7/CPU0 is a fully qualified location specification for a line card, 0/RSP0/CPU0 is a fully qualified location specification for a Route Switch Processor, and 0/RSP0/CPU0 is also a fully qualified location specification for a Route Switch Processor.
Task ID
Note To specify a physical layer interface module (PLIM) node using the node-id argument, use the following notation: rack/PLslot-number/SP. For example, 0/PL1/SP. PLIM diagnostic tests are supported.
For more information about running Cisco IOS XR diagnostics, refer to Cisco IOS XR Diagnostics.
Task ID diag
Operations read
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
529 OL-26517-02
Diagnostics Commands show diagnostic schedule
Examples The following example shows how to display scheduled diagnostic tasks:
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show diagnostic schedule location 0/3/CPU0
Current Time = Tue Sep 27 12:41:24 2005
Diagnostic for LC 0/3/CPU0:
Schedule #1:
To be run daily 14:40
Test ID(s) to be executed: 1 .
Table 46: show diagnostic schedule Field Descriptions
Field
Current Time
Diagnostic for
Schedule
To be run
Test ID(s) to be executed
Description
Current system time.
Card for which the diagnostic is scheduled.
Schedule number.
Time at which the diagnostics are scheduled to run.
Tests to be run at scheduled time.
Related Commands
Command
diagnostic schedule, on page 486
Description
Configures a diagnostic schedule.
530
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show diagnostic status
show diagnostic status
To display the current running tests, use the show diagnostic status command in Admin EXEC modeSystem
Admin EXEC mode.
show diagnostic status
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes Admin EXEC modeSystem Admin EXEC mode
Command History
Release
Release 3.5.0
Release 3.7.2
Modification
This command was introduced.
This command was introduced.
Usage Guidelines No specific guidelines impact the use of this command.
Task ID
Task ID diag
Operations read
Examples The following example shows how to display the current running tests:
RP/0/RSP0/CPU0:router(admin)# show diagnostic status
<BU> - Bootup Diagnostics, <HM> - Health Monitoring Diagnostics, <OD> - OnDemand
Diagnostics, <SCHD> - Scheduled Diagnostics
==================================== =============================== ======
Card Description Current Running Test Run by
------------------------------------ ------------------------------- ------
RP 0/RSP0/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
RP 0/RSP1/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
A9K-8T/4-B 0/2/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
A9K-40GE-E 0/7/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
A9K-40GE-B 0/0/CPU0 N/A N/A
==================================== =============================== ======
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
531 OL-26517-02
Diagnostics Commands show diagnostic status
RP/0/RP0/CPU0:router(admin)# show diagnostic status
<BU> - Bootup Diagnostics, <HM> - Health Monitoring Diagnostics,
<OD> - OnDemand Diagnostics, <SCHD> - Scheduled Diagnostics
==================================== =============================== ======
Card Description Current Running Test Run by
------------------------------------ ------------------------------- ------
RP 0/RP0/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
RP 0/RP1/CPU0 N/A N/A
------------------------------------ ------------------------------- ------
DRP 0/4/CPU1 N/A N/A
------------------------------------ ------------------------------- ------
DRP 0/4/CPU0 SelfPingOverFabric <OD>
DRP-ACC 0/PL4/SP N/A N/A
------------------------------------ ------------------------------- ------
MSC 0/1/CPU0 N/A N/A
JACKET CARD 0/PL1/SP N/A N/A
------------------------------------ ------------------------------- ------
MSC 0/6/CPU0 N/A N/A
JACKET CARD 0/PL6/SP N/A N/A
------------------------------------ ------------------------------- ------
FC/S 0/SM0/SP N/A N/A
------------------------------------ ------------------------------- ------
FC/S 0/SM3/SP N/A N/A
------------------------------------ ------------------------------- ------
FC/S 0/SM2/SP N/A N/A
------------------------------------ ------------------------------- ------
FC/S 0/SM1/SP N/A N/A
------------------------------------ ------------------------------- ------
DRP 0/4/SP N/A N/A
------------------------------------ ------------------------------- ------
MSC 0/1/SP N/A N/A
------------------------------------ ------------------------------- ------
MSC 0/6/SP N/A N/A
==================================== =============================== =====
532
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Diagnostics Commands show run diagnostic monitor
show run diagnostic monitor
To display the card type of a line card or a Shared Port Adapter (SPA), use the show run diagnostic monitor command in the Admin Configuration modeSystem Admin Config mode.
show run diagnostic monitor
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes Admin Configuration modeSystem Admin Config mode
Command History
Release
Release 3.8.0
Modification
This command was introduced.
Usage Guidelines You need to be aware of the card type when you configure a slot or swap a card, and the configuration must re-apply. If the card type is different, the configuration does not re-apply. You can display the card type using the show run diagnostic monitor command in the administration configuration mode.
Task ID
Task ID diag
Operations read, write
Examples
RP/0/0RP0RSP0/CPU0:router:hostname# admin
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# config
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# diagnostic monitor location 0/RP1/CPU0 test FabricDiagnosisTest
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# commit
RP/0/0RP0RSP0/CPU0:router:hostname(admin-config)# end
RP/0/0RP0RSP0/CPU0:router:hostname(admin)# show run diagnostic monitor diagnostic monitor location 0/RP1/CPU0 test FabricDiagnosisTest card-type 100006
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
533
show run diagnostic monitor
Diagnostics Commands
534
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
I N D E X
A access-list command
action (IP SLA) command
ageout command
alarm command
all-alarms command
all-of-router command
archive-length command
archive-size command
B buckets (history) command
buckets (statistics hourly) command
buckets (statistics interval) command
C clear counters command
clear logging command
clear logging correlator delete command
clear logging events delete command
clear logging events reset command
clear logging onboard command
context-correlation command
control disable command
D datasize request command
destination address (IP SLA) command
destination port command
device command
diagnostic load command
diagnostic monitor command
diagnostic monitor interval command
diagnostic monitor syslog command
OL-26517-02 diagnostic monitor threshold command
diagnostic ondemand action-on-failure command
diagnostic ondemand iterations command
diagnostic schedule command
diagnostic start command
diagnostic stop command
diagnostic test-parameters
diagnostic unload command
distribution count command
distribution interval command
E event manager directory user command
event manager environment command
event manager policy command
event manager refresh-time command
event manager run command
event manager scheduler suspend command
exp command
F file-size command
filter command
force explicit-null command
frequency (IP SLA) command
frequency (logging) command
H history command
hw-module logging onboard command
hw-module logging onboard disable command
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
IN-1
Index
I interval command
ipsla command
maximum paths (IP SLA) command
monitor command
monitor controller fabric command
monitor controller sonet command
monitor interface command
mpls discovery vpn command
mpls lsp-monitor command
K key-chain command
L life command
lives command
load-interval command
logging archive command
logging buffered command
logging command
logging console command
logging console disable command
logging correlator apply rule command
logging correlator apply ruleset command
logging correlator buffer-size command
logging correlator rule command
logging correlator ruleset command
logging events buffer-size command
logging events display-location command
logging events level command
logging events link-status (interface) command
logging events link-status command
logging events threshold command
logging facility command
logging history command
logging history size command
logging hostnameprefix command
logging localfilesize command
logging monitor command
logging source-interface
logging source-interface command
logging suppress apply rule command
logging suppress deprecated command
logging suppress duplicates command
logging suppress rule command
logging trap command
low-memory command
lsp selector ipv4 command
lsr-path command
M maximum hops command
N nonrootcause command
O operation command
output interface command
output nexthop command
P packet count command
packet interval command
path discover command
path discover echo command
path discover path command
path discover scan command
path discover session command
performance-mgmt apply monitor command
performance-mgmt apply statistics command
performance-mgmt apply thresholds command
performance-mgmt regular-expression command
performance-mgmt resources dump local command
performance-mgmt resources memory command
performance-mgmt resources tftp-server command
performance-mgmt statistics command
performance-mgmt thresholds command
ping (administration EXEC) command
R react command
react lpd command
reaction monitor command
reaction operation command
reaction trigger command
recurring command
reissue-nonbistate command
reparent command
reply dscp command
IN-2
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
Index reply mode command
responder command
rootcause command
S samples command
scan delete-factor command
scan interval command
schedule monitor command
schedule operation command
schedule period command
service timestamps command
severity command
show diag command
show diagnostic bootup level command
show diagnostic content command
show diagnostic ondemand settings command
show diagnostic result command
show diagnostic schedule command
show diagnostic status command
show event manager directory user command
show event manager environment command
show event manager metric hardware command
show event manager metric process command
show event manager policy available command
show event manager policy registered command
show event manager refresh-time command
show event manager scheduler thread
show event manager statistics-table command
show ipsla application command
show ipsla history command
show ipsla mpls discovery vpn command
show ipsla mpls lsp-monitor lpd command
show ipsla mpls lsp-monitor scan-queue command
show ipsla mpls lsp-monitor summary command
show ipsla responder statistics ports command
show ipsla statistics aggregated command
show ipsla statistics command
show ipsla statistics enhanced aggregated command
show logging command
show logging correlator buffer command
show logging correlator info command
show logging correlator rule command
show logging correlator ruleset command
show logging events buffer command
show logging events info command
show logging history command
show logging onboard command
show logging suppress rule command
show performance-mgmt bgp command
show performance-mgmt interface command
show performance-mgmt mpls command
show performance-mgmt node command
show performance-mgmt ospf command
show run diagnostic monitor command
show running performance-mgmt command
show snmp correlator buffer command
show snmp correlator info command
show snmp correlator rule command
show snmp correlator ruleset command
source address command
source command
source port command
start-time command
statistics command
T tag (IP SLA) command
target ipv4 command
target pseudowire command
target traffic-eng command
terminal monitor command
threshold command
threshold type average command
threshold type consecutive command
threshold type immediate command
threshold type xofy command
timeout command
timeout-rootcause command
tos command
ttl command
type icmp echo command
type icmp path-echo command
type icmp path-jitter command
type mpls lsp ping command
type mpls lsp trace command
type udp echo command
type udp ipv4 address command
type udp jitter command
V verify-data command
vrf (IP SLA MPLS LSP monitor) command
vrf (IP SLA) command
OL-26517-02
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
IN-3
Index
IN-4
Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
OL-26517-02
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement
Table of contents
- 1 Cisco IOS XR System Monitoring Command Reference for the Cisco CRS Router, Release 4.2.x
- 3 Contents
- 11 Preface
- 11 Changes to This Document
- 12 Obtaining Documentation and Submitting a Service Request
- 13 Alarm Management and Logging Correlation Commands
- 15 alarm
- 17 all-alarms
- 18 all-of-router
- 19 clear logging correlator delete
- 21 clear logging events delete
- 25 clear logging events reset
- 27 context-correlation
- 29 logging correlator apply rule
- 32 logging correlator apply ruleset
- 35 logging correlator buffer-size
- 37 logging correlator rule
- 40 logging correlator ruleset
- 42 logging events buffer-size
- 44 logging events display-location
- 47 logging events level
- 49 logging events threshold
- 51 logging suppress apply rule
- 53 logging suppress rule
- 55 nonrootcause
- 57 reissue-nonbistate
- 59 reparent
- 61 rootcause
- 63 show logging correlator buffer
- 66 show logging correlator info
- 68 show logging correlator rule
- 71 show logging correlator ruleset
- 74 show logging events buffer
- 79 show logging events info
- 81 show logging suppress rule
- 83 show snmp correlator buffer
- 85 show snmp correlator info
- 86 show snmp correlator rule
- 87 show snmp correlator ruleset
- 88 source
- 90 timeout
- 92 timeout-rootcause
- 95 Embedded Event Manager Commands
- 97 event manager directory user
- 99 event manager environment
- 101 event manager policy
- 105 event manager refresh-time
- 107 event manager run
- 109 event manager scheduler suspend
- 111 show event manager directory user
- 113 show event manager environment
- 115 show event manager metric hardware
- 117 show event manager metric process
- 121 show event manager policy available
- 123 show event manager policy registered
- 127 show event manager refresh-time
- 129 show event manager statistics-table
- 132 show event manager scheduler thread
- 135 IP Service Level Agreement Commands
- 139 access-list
- 141 action (IP SLA)
- 144 ageout
- 146 buckets (history)
- 148 buckets (statistics hourly)
- 150 buckets (statistics interval)
- 152 control disable
- 154 datasize request
- 157 destination address (IP SLA)
- 159 destination port
- 161 distribution count
- 163 distribution interval
- 165 exp
- 167 filter
- 169 force explicit-null
- 171 frequency (IP SLA)
- 173 history
- 175 interval
- 177 ipsla
- 179 key-chain
- 181 life
- 183 lives
- 185 low-memory
- 187 lsp selector ipv4
- 189 lsr-path
- 191 maximum hops
- 193 maximum paths (IP SLA)
- 195 monitor
- 197 mpls discovery vpn
- 199 mpls lsp-monitor
- 201 operation
- 203 output interface
- 205 output nexthop
- 207 packet count
- 209 packet interval
- 211 path discover
- 212 path discover echo
- 214 path discover path
- 216 path discover scan
- 218 path discover session
- 220 react
- 223 react lpd
- 225 reaction monitor
- 227 reaction operation
- 229 reaction trigger
- 231 responder
- 233 recurring
- 235 reply dscp
- 237 reply mode
- 239 responder twamp
- 240 samples
- 242 scan delete-factor
- 244 scan interval
- 246 schedule monitor
- 248 schedule operation
- 250 schedule period
- 252 server twamp
- 253 show ipsla application
- 256 show ipsla history
- 259 show ipsla mpls discovery vpn
- 261 show ipsla mpls lsp-monitor lpd
- 263 show ipsla mpls lsp-monitor scan-queue
- 265 show ipsla mpls lsp-monitor summary
- 268 show ipsla responder statistics
- 270 show ipsla statistics
- 274 show ipsla statistics aggregated
- 284 show ipsla statistics enhanced aggregated
- 288 show ipsla twamp connection
- 289 show ipsla twamp session
- 290 show ipsla twamp standards
- 291 source address
- 293 source port
- 295 start-time
- 298 statistics
- 301 tag (IP SLA)
- 303 target ipv4
- 305 target pseudowire
- 307 target traffic-eng
- 309 threshold
- 311 threshold type average
- 313 threshold type consecutive
- 315 threshold type immediate
- 317 threshold type xofy
- 319 timeout (IP SLA)
- 321 tos
- 323 ttl
- 325 type icmp echo
- 327 type icmp path-echo
- 329 type icmp path-jitter
- 331 type mpls lsp ping
- 333 type mpls lsp trace
- 335 type udp echo
- 337 type udp jitter
- 339 type udp ipv4 address
- 341 verify-data
- 343 vrf (IP SLA)
- 345 vrf (IP SLA MPLS LSP monitor)
- 347 Logging Services Commands
- 349 archive-length
- 350 archive-size
- 351 clear logging
- 353 device
- 355 file-size
- 356 frequency (logging)
- 357 logging
- 360 logging archive
- 362 logging buffered
- 364 logging console
- 366 logging console disable
- 367 logging events link-status
- 369 logging events link-status (interface)
- 372 logging facility
- 375 logging history
- 377 logging history size
- 379 logging hostnameprefix
- 381 logging ipv4/ipv6
- 384 logging localfilesize
- 386 logging monitor
- 388 logging source-interface
- 390 logging suppress deprecated
- 391 logging suppress duplicates
- 393 logging trap
- 395 service timestamps
- 397 severity
- 399 show logging
- 405 show logging history
- 407 terminal monitor
- 409 Onboard Failure Logging Commands
- 411 show logging onboard
- 415 clear logging onboard
- 417 hw-module logging onboard disable
- 421 Performance Management Commands
- 423 monitor controller fabric
- 425 monitor controller sonet
- 427 monitor interface
- 433 performance-mgmt apply monitor
- 436 performance-mgmt apply statistics
- 440 performance-mgmt apply thresholds
- 443 performance-mgmt regular-expression
- 444 performance-mgmt resources dump local
- 445 performance-mgmt resources memory
- 447 performance-mgmt resources tftp-server
- 449 performance-mgmt statistics
- 452 performance-mgmt thresholds
- 464 show performance-mgmt bgp
- 466 show performance-mgmt interface
- 470 show performance-mgmt mpls
- 472 show performance-mgmt node
- 474 show performance-mgmt ospf
- 476 show running performance-mgmt
- 479 Statistics Service Commands
- 480 clear counters
- 482 load-interval
- 485 Diagnostics Commands
- 486 diagnostic load
- 488 diagnostic monitor
- 490 diagnostic monitor interval
- 492 diagnostic monitor syslog
- 493 diagnostic monitor threshold
- 495 diagnostic ondemand action-on-failure
- 497 diagnostic ondemand iterations
- 498 diagnostic schedule
- 501 diagnostic start
- 504 diagnostic stop
- 506 diagnostic test-parameters
- 508 diagnostic unload
- 510 ping (administration EXEC)
- 515 show diag
- 525 show diagnostic bootup level
- 527 show diagnostic content
- 532 show diagnostic ondemand settings
- 533 show diagnostic result
- 541 show diagnostic schedule
- 543 show diagnostic status
- 545 show run diagnostic monitor
- 547 INDEX