Cisco IOS XR System Monitoring Command Reference for the Cisco

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

timeout-rootcause, on page 80

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