Cisco XR 1200 series Command Reference Manual
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
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-24735-01
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 PARTICULARPURPOSE 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)
©
2014 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
CHAPTER 1
Preface xi
Changes to This Document xi
Obtaining Documentation and Submitting a Service Request xi
Alarm Management and Logging Correlation Commands 1
alarm 3
all-alarms 4
all-of-router 5
clear logging correlator delete 6
clear logging events delete 7
clear logging events reset 11
context-correlation 13
logging correlator apply rule 15
logging correlator apply ruleset 18
logging correlator buffer-size 20
logging correlator rule 22
logging correlator ruleset 25
logging events buffer-size 27
logging events display-location 29
logging events level 31
logging events threshold 33
logging suppress apply rule 35
logging suppress rule 37
nonrootcause 39
reissue-nonbistate 41
reparent 43
rootcause 45
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 iii
Contents
show logging correlator buffer 47
show logging correlator info 50
show logging correlator rule 52
show logging correlator ruleset 55
show logging events buffer 57
show logging events info 62
show logging suppress rule 64
show snmp correlator buffer 66
show snmp correlator info 68
show snmp correlator rule 69
show snmp correlator ruleset 70
source 71
timeout 72
CHAPTER 2
timeout-rootcause 74
Embedded Event Manager Commands 77
event manager directory user 78
event manager environment 80
event manager policy 82
event manager refresh-time 85
event manager run 86
event manager scheduler suspend 88
show event manager directory user 90
show event manager environment 92
show event manager metric hardware 94
show event manager metric process 96
show event manager policy available 100
show event manager policy registered 102
show event manager refresh-time 105
show event manager statistics-table 107
CHAPTER 3
IP Service Level Agreement Commands 111
access-list 115
action (IP SLA) 117
ageout 119
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
iv OL-24735-01
Contents
buckets (history) 121
buckets (statistics hourly) 123
buckets (statistics interval) 125
control disable 126
datasize request 128
destination address (IP SLA) 130
destination port 132
distribution count 134
distribution interval 136
exp 138
filter 140
force explicit-null 142
frequency (IP SLA) 144
history 146
interval 148
ipsla 150
key-chain 152
life 154
lives 156
low-memory 158
lsp selector ipv4 160
lsr-path 162
maximum hops 164
maximum paths (IP SLA) 166
monitor 168
mpls discovery vpn 170
mpls lsp-monitor 172
operation 174
output interface 175
output nexthop 177
packet count 179
packet interval 181
path discover 183
path discover echo 184
path discover path 186
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 v
Contents
path discover scan 188
path discover session 190
react 192
react lpd 195
reaction monitor 197
reaction operation 199
reaction trigger 201
responder 203
recurring 204
reply dscp 205
reply mode 207
scan delete-factor 209
scan interval 211
schedule monitor 213
schedule operation 215
schedule period 217
show ipsla application 219
show ipsla history 221
show ipsla mpls discovery vpn 224
show ipsla mpls lsp-monitor lpd 226
show ipsla mpls lsp-monitor scan-queue 228
show ipsla mpls lsp-monitor summary 230
show ipsla responder statistics ports 233
show ipsla statistics 235
show ipsla statistics aggregated 238
show ipsla statistics enhanced aggregated 247
source address 250
source port 252
start-time 253
statistics 256
tag (IP SLA) 259
target ipv4 261
target pseudowire 263
target traffic-eng 265
threshold 267
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
vi OL-24735-01
Contents
threshold type average 269
threshold type consecutive 271
threshold type immediate 273
threshold type xofy 275
timeout (IP SLA) 277
tos 279
ttl 281
type icmp echo 283
type icmp path-echo 284
type icmp path-jitter 285
type mpls lsp ping 286
type mpls lsp trace 288
CHAPTER 4
type udp echo 290
type udp jitter 291
type udp ipv4 address 292
verify-data 294
vrf (IP SLA) 295
vrf (IP SLA MPLS LSP monitor) 297
Logging Services Commands 299
archive-length 301
archive-size 302
clear logging 303
device 305
file-size 306
frequency (logging) 307
logging 308
logging archive 310
logging buffered 312
logging console 314
logging console disable 316
logging events link-status 317
logging events link-status (interface) 319
logging facility 322
logging history 325
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 vii
Contents
logging history size 327
logging hostnameprefix 329
logging localfilesize 331
logging monitor 332
logging source-interface 334
logging suppress deprecated 336
logging suppress duplicates 337
logging trap 339
service timestamps 341
severity 343
show logging 344
show logging history 348
terminal monitor 350
CHAPTER 5
CHAPTER 6
Onboard Failure Logging Commands 353
clear logging onboard 354
hw-module logging onboard 356
show logging onboard 358
Performance Management Commands 361
monitor controller fabric 362
monitor controller sonet 364
monitor interface 366
performance-mgmt apply monitor 371
performance-mgmt apply statistics 374
performance-mgmt apply thresholds 377
performance-mgmt regular-expression 380
performance-mgmt resources dump local 381
performance-mgmt resources memory 382
performance-mgmt resources tftp-server 384
performance-mgmt statistics 386
performance-mgmt thresholds 389
show performance-mgmt bgp 400
show performance-mgmt interface 402
show performance-mgmt mpls 405
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
viii OL-24735-01
Contents
show performance-mgmt node 407
show performance-mgmt ospf 409
show running performance-mgmt 411
CHAPTER 7
Statistics Service Commands 413
clear counters 414
load-interval 416
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 ix
Contents
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
x OL-24735-01
Preface
The Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router preface
contains these sections:
Changes to This Document, page xi
•
Obtaining Documentation and Submitting a Service Request, page xi
•
Changes to This Document
Table 1 lists the technical changes made to this document since it was first printed.
Table 1: Changes to This Document
Change SummaryDateRevision
Initial release of this document.April 2011OL-24735-01
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, at: http://
www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical
documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The
RSS feeds are a free service.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 xi
Obtaining Documentation and Submitting a Service Request
Preface
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
xii OL-24735-01
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.
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 Router.
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 Router.
alarm, page 3
•
all-alarms, page 4
•
all-of-router, page 5
•
clear logging correlator delete, page 6
•
clear logging events delete, page 7
•
clear logging events reset, page 11
•
context-correlation, page 13
•
logging correlator apply rule, page 15
•
logging correlator apply ruleset, page 18
•
logging correlator buffer-size, page 20
•
logging correlator rule, page 22
•
logging correlator ruleset, page 25
•
logging events buffer-size, page 27
•
logging events display-location, page 29
•
logging events level, page 31
•
logging events threshold, page 33
•
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 1
logging suppress apply rule, page 35
•
logging suppress rule, page 37
•
nonrootcause, page 39
•
reissue-nonbistate, page 41
•
reparent, page 43
•
rootcause, page 45
•
show logging correlator buffer, page 47
•
show logging correlator info, page 50
•
show logging correlator rule, page 52
•
show logging correlator ruleset, page 55
•
show logging events buffer, page 57
•
show logging events info, page 62
•
Alarm Management and Logging Correlation Commands
show logging suppress rule, page 64
•
show snmp correlator buffer, page 66
•
show snmp correlator info, page 68
•
show snmp correlator rule, page 69
•
show snmp correlator ruleset, page 70
•
source, page 71
•
timeout, page 72
•
timeout-rootcause, page 74
•
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
2 OL-24735-01
Alarm Management and Logging Correlation Commands
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
alarm
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
Task ID
msg-category
group-name
msg-code
No alarm types are configured by default.
Logging suppression rule configuration
Message category of the root message.
Group name of the root message.
Message code of the root message.
ModificationRelease
This command was introduced.Release 3.8.0
OperationsTask ID
read, writelogging
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/0/CPU0:router(config)# logging suppress rule commit
RP/0/0/CPU0:router(config-suppr-rule)# alarm MBGL COMMIT SUCCEEDED
Related Commands
DescriptionCommand
Creates a logging suppression rule.logging suppress rule, on page 37
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 3
all-alarms
all-alarms
Alarm Management and Logging Correlation Commands
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
Command Default
Command Modes
Command History
Usage Guidelines
Task ID
Examples
This command has no keywords or arguments.
No alarm types are configured by default.
Logging suppression rule configuration
ModificationRelease
This command was introduced.Release 3.8.0
OperationsTask ID
read, writelogging
This example shows how to configure the logging suppression rule commit to suppress all alarms:
RP/0/0/CPU0:router(config)# logging suppress rule commit
RP/0/0/CPU0:router(config-suppr-rule)# all-alarms
Related Commands
DescriptionCommand
Creates a logging suppression rule.logging suppress rule, on page 37
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
4 OL-24735-01
Alarm Management and Logging Correlation Commands
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
all-of-router
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
Task ID
Examples
This command has no keywords or arguments.
No scope is configured by default.
Logging suppression apply rule configuration
ModificationRelease
This command was introduced.Release 3.8.0
OperationsTask ID
executelogging
This example shows how to apply the logging suppression rule “commit” to all locations on the router:
RP/0/0/CPU0:router(config)# logging suppress apply rule commit
RP/0/0/CPU0:router(config-suppr-apply-rule)# all-of-router
Related Commands
DescriptionCommand
Applies and activates a logging suppression rule.logging suppress apply rule, on page 35
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 5
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 mode.
clear logging correlator delete {all-in-buffer| correlation-id}
Alarm Management and Logging Correlation Commands
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
Clears all messages in the logging correlator buffer.all-in-buffer
correlation-id
No messages are automatically deleted unless buffer capacity is reached.
EXEC
Use the show logging correlator buffer, on page 47 command to confirm that records have been cleared.
Use the logging correlator buffer-size, on page 20 command to configure the capacity of 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.
ModificationRelease
This command was introduced.Release 3.2
Task ID
Examples
Related Commands
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
6 OL-24735-01
This example shows how to clear all records from the logging correlator buffer:
RP/0/0/CPU0:router# clear logging correlator delete all-in-buffer
OperationsTask ID
executelogging
DescriptionCommand
Displays messages in the logging correlator buffer.show logging correlator buffer, on page 47
Alarm Management and Logging Correlation Commands
clear logging events delete
To delete messages from the logging events buffer, use the clear logging events delete command in EXEC
mode.
clear logging events delete
clear logging events delete
Syntax Description
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
Deletes only events at the administrative level.admin-level-only
Deletes all event IDs from the logging events buffer.all-in-buffer
Deletes bi-state alarms in the SET state.bistate-alarms-set
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.
message message-code
severity-hi-limit
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 7
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.
clear logging events delete
Alarm Management and Logging Correlation Commands
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.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
8 OL-24735-01
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
◦
Command Default
Command Modes
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.
No messages are automatically deleted unless buffer capacity is reached.
EXEC
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 9
clear logging events delete
Alarm Management and Logging Correlation Commands
Command History
Usage Guidelines
Task ID
Examples
ModificationRelease
This command was introduced.Release 3.2
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 57 command to verify that events have been cleared from the
logging events buffer.
Use the logging events buffer-size, on page 27 command to configure the capacity of the logging events
buffer.
OperationsTask ID
executelogging
This example shows how to delete all messages from the logging events buffer:
RP/0/0/CPU0:router# clear logging events delete all-in-buffer
Related Commands
DescriptionCommand
Resets bi-state alarms.clear logging events reset, on page 11
Displays messages in the logging events buffer.show logging events buffer, on page 57
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
10 OL-24735-01
Alarm Management and Logging Correlation Commands
clear logging events reset
To reset bi-state alarms, use the clear logging events reset command in EXEC mode.
clear logging events reset {all-in-buffer| event-id}
clear logging events reset
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
Resets all bi-state alarm messages in the event logging buffer.all-in-buffer
event-id
None
EXEC
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 57 command to display messages in the logging events 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.
ModificationRelease
This command was introduced.Release 3.2
Task ID
Examples
OL-24735-01 11
This example shows how to reset all bi-alarms in the logging events buffer:
RP/0/0/CPU0:router# clear logging events reset all-in-buffer
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OperationsTask ID
executelogging
clear logging events reset
Alarm Management and Logging Correlation Commands
Related Commands
clear logging events delete, on page 7
DescriptionCommand
Deletes all bi-state alarm messages, or messages
specified by correlation ID, from the logging events
buffer.
Displays messages in the logging events buffer.show logging events buffer, on page 57
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
12 OL-24735-01
Alarm Management and Logging Correlation Commands
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
context-correlation
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
This command has no keywords or arguments.
Correlation on context is not enabled.
Stateful correlation rule configuration
Nonstateful correlation rule configuration
ModificationRelease
This command was introduced.Release 3.6.0
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 52 command to show the current setting for the
context-correlation flag.
Task ID
OperationsTask ID
read, writelogging
Examples
Related Commands
This example shows how to enable correlation on context for a stateful correlation rule:
RP/0/0/CPU0:router(config)# logging correlator rule stateful_rule type stateful
RP/0/0/CPU0:router(config-corr-rule-st)# context-correlation
DescriptionCommand
Defines the rules for correlating messages.logging correlator rule, on page 22
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 13
context-correlation
Alarm Management and Logging Correlation Commands
DescriptionCommand
show logging correlator rule, on page 52
Displays one or more predefined logging correlator
rules.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
14 OL-24735-01
Alarm Management and Logging Correlation Commands
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 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]
logging correlator apply rule
Syntax Description
Command Default
Command Modes
Command History
correlation-rule
context name
location node-id
No correlation rules are applied.
Global configuration
Name of the correlation rule to be applied.
(Optional) Applies the correlation rule to the entire router.all-of-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.
ModificationRelease
This command was introduced.Release 3.6.0
Usage Guidelines
OL-24735-01 15
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.
Use the show logging correlator rule, on page 52 command to show the current apply settings for a given
rule.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
logging correlator apply rule
When a rule is applied (or if a rule set that contains this rule is applied), then the rule definition cannot be
Tip
modified through the configuration until the rule or rule set is once again unapplied.
It is possible to configure apply settings at the same time for both a rule and zero or more rule sets that
Tip
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/0/CPU0:router(config)# logging correlator apply rule stateful1
RP/0/0/CPU0:router(config-corr-apply-rule)#?
all-of-router Apply the rule to all of the router
clear Clear the uncommitted configuration
clear Clear the configuration
commit Commit the configuration changes to running
context Apply rule to specified context
describe Describe a command without taking real actions
do Run an exec command
exit Exit from this submode
location Apply rule to specified location
no Negate a command or set its defaults
pwd Commands used to reach current submode
root Exit to the global configuration mode
show Show contents of configuration
RP/0/0/CPU0:router(config-corr-apply-rule)#
While in the submode, you can negate keyword options:
Alarm Management and Logging Correlation Commands
Task ID
Examples
Related Commands
RP/0/0/CPU0:router(config-corr-apply-rule)# no all-of-router
RP/0/0/CPU0:router(config-corr-apply-rule)# no context
RP/0/0/CPU0:router(config-corr-apply-rule)# no location
OperationsTask ID
read, writelogging
This example shows how to apply a predefined correlator rule to a location:
RP/0/0/CPU0:router(config)# logging correlator apply rule rule1
RP/0/0/CPU0:router(config-corr-apply-rule)# location 0/2/CPU0
DescriptionCommand
Defines the rules for correlating messages.logging correlator rule, on page 22
show logging correlator rule, on page 52
Displays one or more predefined logging correlator
rules.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
16 OL-24735-01
Alarm Management and Logging Correlation Commands
logging correlator apply rule
DescriptionCommand
show logging correlator ruleset, on page 55
Displays one or more predefined logging correlator
rule sets.
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
OL-24735-01 17
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 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]
Alarm Management and Logging Correlation Commands
Syntax Description
Command Default
Command Modes
Command History
correlation-ruleset
context name
location node-id
No correlation rule sets are applied.
Global configuration
Name of the correlation rule set to be applied.
(Optional) Applies the correlation rule set to the entire router.all-of-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.
ModificationRelease
This command was introduced.Release 3.6.0
Usage Guidelines
Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router, Release 4.1
18 OL-24735-01
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.
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 55 command to show the current apply settings for a given
rule set.
Loading...