-
Cisco IOS XR System Monitoring Command Reference, Release 3.7
-
Preface
-
Alarm Management and Logging Correlation Commands on Cisco IOS XR Software
-
Embedded Event Manager Commands on Cisco IOS XR Software
-
IP Service Level Agreement Commands on Cisco IOS XR Software
-
Logging Services Commands on Cisco IOS XR Software
-
Onboard Failure Logging Commands on Cisco IOS XR Software
-
Performance Management Commands on Cisco IOS XR Software
-
Statistics Service Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
Alarm Management and Logging Correlation Commands on Cisco IOS XR Software
clear logging correlator delete
logging correlator apply ruleset
logging correlator buffer-size
show logging correlator buffer
show logging correlator ruleset
Alarm Management and Logging Correlation Commands on Cisco IOS XR Software
This chapter describes the commands used to manage alarms and configure logging correlation rules.
From the Cisco IOS XR System Monitoring Configuration Guide, you can obtain detailed information about the following:
•
For alarm management and logging correlation concepts, configuration tasks, and examples, refer to the Implementing and Monitoring Alarms and Logging Correlation on Cisco IOS XR Software module.
•
•
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}
Syntax Description
Command Modes
EXEC
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the show logging correlator buffer command to confirm that records have been cleared.
Task ID
Examples
The following example shows how to clear all records from the logging correlator buffer:
RP/0/RP0/CPU0:router# clear logging correlator delete all-in-bufferRelated 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 {[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
Command Modes
EXEC
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command to verify that events have been cleared from the logging events buffer.
Task ID
Examples
The following example shows how to delete all messages from the logging events buffer:
RP/0/RP0/CPU0:router# clear logging events delete all-in-bufferRelated 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}
Syntax DescriptionDescription
Usage
Command Modes
EXEC
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command to display messages in the logging events buffer.
Task ID
Examples
The following example shows how to reset all bi-alarms in the logging events buffer:
RP/0/RP0/CPU0:router# clear logging events reset all-in-bufferRelated Commands
Deletes all bi-state alarm messages, or messages specified by correlation ID, from the logging events buffer.
Displays messages in the logging events buffer.
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 arguments or keywords.
Defaults
Correlation on context is not enabled.
Command Modes
Stateful correlation rule configuration
Nonstateful correlation rule configurationCommand History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.7.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command to show the current setting for the context-correlation flag.
Task ID
Examples
The following example shows how to enable correlation on context for a stateful correlation rule:
RP/0/RP0/CPU0:router(config)# logging correlator rule stateful_rule type statefulRP/0/RP0/CPU0:router(config-corr-rule-st)# context-correlationRP/0/RP0/CPU0:router(config-corr-rule-st)#Related Commands
Defines the rules for correlating messages.
Displays one or more predefined logging correlator rules.
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]
Syntax Description
Defaults
No correlation rules are applied.
Command Modes
Global configuration
Command History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.7.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command to show the current apply settings for a given rule.
Tip
Tip
The logging correlator apply rule command allows you to enter submode (config-corr-apply-rule) to apply and activate rules:
RP/0/RP0/CPU0:router(config)# logging correlator apply rule stateful1RP/0/RP0/CPU0:router(config-corr-apply-rule)#?all-of-router Apply the rule to all of the routerclear Clear the uncommitted configurationclear Clear the configurationcommit Commit the configuration changes to runningcontext Apply rule to specified contextdescribe Describe a command without taking real actionsdo Run an exec commandexit Exit from this submodelocation Apply rule to specified locationno Negate a command or set its defaultspwd Commands used to reach current submoderoot Exit to the global configuration modeshow Show contents of configurationRP/0/RP0/CPU0:router(config-corr-apply-rule)#While in the submode, you can negate keyword options:
RP/0/RP0/CPU0:router(config-corr-apply-rule)#? no all-of-routerRP/0/RP0/CPU0:router(config-corr-apply-rule)#? no contextRP/0/RP0/CPU0:router(config-corr-apply-rule)#? no location
Task ID
Examples
The following example shows how to apply a predefined correlator rule to a location:
RP/0/RP0/CPU0:router(config)# logging correlator apply rule rule1RP/0/RP0/CPU0:router(config-corr-apply-rule)# location 0/2/CPU0Related Commands
Defines the rules for correlating messages.
Displays one or more predefined logging correlator rules.
Displays one or more predefined logging correlator rule sets.
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]
Syntax Description
Defaults
No correlation rule sets are applied.
Command Modes
Global configuration
Command History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.7.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command to show the current apply settings for a given rule set.
Tip
Tip
The logging correlator apply ruleset command allows you to enter the submode (config-corr-apply-ruleset) to apply and activate rule sets:
RP/0/RP0/CPU0:router(config)# logging correlator apply ruleset ruleset1RP/0/RP0/CPU0:router(config-corr-apply-ruleset)#?all-of-router Apply the rule to all of the routerclear Clear the uncommitted configurationclear Clear the configurationcommit Commit the configuration changes to runningcontext Apply rule to specified contextdescribe Describe a command without taking real actionsdo Run an exec commandexit Exit from this submodelocation Apply rule to specified locationno Negate a command or set its defaultspwd Commands used to reach current submoderoot Exit to the global configuration modeshow Show contents of configurationRP/0/RP0/CPU0:router(config-corr-apply-ruleset)#
While in the submode, you can negate keyword options:
RP/0/RP0/CPU0:router(config-corr-apply-ruleset)#? no all-of-routerRP/0/RP0/CPU0:router(config-corr-apply-ruleset)#? no contextRP/0/RP0/CPU0:router(config-corr-apply-ruleset)#? no locationTask ID
Examples
The following example shows how to apply a predefined correlator rule set to the entire router:
RP/0/RP0/CPU0:router(config)# logging correlator apply ruleset ruleset1RP/0/RP0/CPU0:router(config-corr-apply-rule)# all-of-routerRelated Commands
logging correlator buffer-size
To configure the logging correlator buffer size, use the logging correlator buffer-size command in global configuration 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
Defaults
bytes: 81920 bytes
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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:
•
•
Use the show logging correlator info command to confirm the size of the buffer and the percentage of buffer space that is currently used. The show logging events buffer all-in-buffer command can be used to show the details of the buffer contents.
Task ID
Examples
The following example shows how to set the logging correlator buffer size to 90000 bytes:
RP/0/RP0/CPU0:router(config)# logging correlator buffer-size 90000Related Commands
Displays the logging correlator buffer size and the percentage of the buffer occupied by correlated messages
logging correlator rule
To define the rules for correlating messages, use the logging correlator rule command in global configuration 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
Defaults
No rules are defined.
Command Modes
Global configuration
Command History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and the Cisco XR 12000 Series Router.
Release 3.7.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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. Non-stateful rules result in correlations that are fixed and immutable after the correlation occurs.
Below are the rule parameters that are available while in stateful correlation rule configuration mode:
RP/0/RP0/CPU0:router(config-corr-rule-st)# ?context-correlation Specify enable correlation on contextnonrootcause nonrootcause alarmreissue-nonbistate Specify reissue of non-bistate alarms on parent clearreparent Specify reparent of alarm on parent clearrootcause Specify root cause alarm: Category/Group/Code combostimeout Specify timeouttimeout-rootcause Specify timeout for root-causeRP/0/RP0/CPU0:routerconfig-corr-rule-st)#Below are the rule parameters that are available while in non-stateful correlation rule configuration mode:
RP/0/RP0/CPU0:router(config-corr-rule-nonst)# ?context-correlation Specify enable correlation on contextnonrootcause nonrootcause alarmroot Exit to the global configuration moderootcause Specify root cause alarm: Category/Group/Code combostimeout Specify timeouttimeout-rootcause Specify timeout for root-causeRP/0/RP0/CPU0:router(config-corr-rule-nonst)#
Note
Note
Use the show logging correlator buffer to display messages stored in the logging correlator buffer.
Use the show logging correlator rule command to verify correlation rule settings.
Task ID
Examples
The following 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/RP0/CPU0:router(config)# logging correlator rule state_rule type statefulRP/0/RP0/CPU0:router(config-corr-rule-st)# timeout 50000Related Commands
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 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
Name of the correlation rule set to be applied.
rulename
Specifies the correlation rule name.
correlation-rulename
Name of the correlation rule name to be applied.
Defaults
No rule sets are defined.
Command Modes
Global configuration
Command History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and the Cisco XR 12000 Series Router.
Release 3.7.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 command.
Examples
The following example shows how to specify a logging correlator rule set:
RP/0/RP0/CPU0:router(config)# logging correlator ruleset ruleset_1RP/0/RP0/CPU0:router(config-corr-ruleset)# rulename state_ruleRP/0/RP0/CPU0:router(config-corr-ruleset)# rulename state_rule2Related Commands
logging events buffer-size
To configure the size of the logging events buffer, use the logging events buffer-size command in global configuration 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.
Defaults
bytes: 43200
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Note
Use the show logging events info command to confirm the size of the logging events buffer.
Task ID
Examples
The following example shows how to increase the logging events buffer size to 50000 bytes:
RP/0/RP0/CPU0:router(config)# logging events buffer-size 50000Related Commands
logging events level
To specify a severity level for logging alarm messages, use the logging events level command in global configuration 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 1 lists severity levels and their respective system conditions.
Defaults
All severity levels (from 0 to 6) are logged.
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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
Table 1 lists the system severity levels and their corresponding numeric values, and describes the corresponding system condition.
Task ID
Examples <
