Event Control Commands

event-control

Syntax

event-control application-id [event-name | event-number] generate [severity-level] [throttle] [specific-throttle-rate events-limit interval seconds |disable-specific-throttle]

event-control application-id [event-name | event-number] suppress

no event-control application-id [event-name | event-number]

Context

config>log

Description

This command is used to specify that a particular event, or all events associated with an application, are either generated or suppressed.

Events are generated by an application and contain an event number and a description of the cause of the event. Each event has a default designation that directs it to be generated or suppressed.

Events are generated with a default severity level that can be modified by using the severity-level option. For example, to change event reporting for an external alarm output on the chassis, do the following:

  1. Specify the application by using the config>log>event-control>chassis command.
  2. Specify the event name or number by using the config>log>event-control>chassis> extAlarmInput1Detectedcommand.
  3. Specify whether the event is generated or suppressed by using the config>log>event-control>chassis> extAlarmInput1Detected>generate command.
  4. Change the severity level (for example, major severity) by using the config>log>event-control>chassis> extAlarmInput1Detected>generate>major command.
Note:

To display a list of events, use the show>log>event-control command.

Events that are suppressed by default are typically used for debugging purposes. Events are suppressed at the time the application requests the event's generation. No event log entry is generated regardless of the destination. While this feature can save processor resources, there may be a negative effect on the ability to troubleshoot problems if the logging entries are not generated. However, the generation of too many events may cause excessive overhead.

The throttle parameter enables event throttling for these events. The throttling rate is set globally for all events with the throttle-rate command. The throttling rate can also be configured independently for each log event by using the specific-throttle-rate parameter; this rate overrides the globally configured throttle rate for the specified log event.

The no form of the command resets the parameters to the default setting for events for the application or a specific event within the application. The severity-level, generate, and suppress options will also be reset to the initial values.

Default

Each event has a default suppress or generate state. To display a list of all events and the current configuration use the event-control command.

Parameters

application-id

the application whose events are affected by this event control filter

Values

A valid application name. To display a list of valid application names, use the applications command. Valid applications are:

aps, atm, bgp, cflowd, chassis, debug, dhcp, dhcps, efm_oam, ering, eth_cfm, filter, firewall, igmp, igmp_snooping, ip, ipsec, isis, lag, lcr, ldp, lldp, logger, mcpath, mc_redundancy, mirror, mld, mld_snooping, mpls, msdp, mwmgr, ntp, oam, ospf, pcap, pim, pim_snooping, port, ppp, ptp, radius, rip, rip_ng, route_policy, rsvp, scada, security, snmp, stp, svcmgr, system, tss, user, vrrp, vrtr

Default

none; this parameter must be explicitly specified

event-name | event-number

to generate, suppress, or revert to default for a single event, enter the specific number or event short name. If no event number or name is specified, the command applies to all events in the application. To display a list of all event short names use the show>log>event-control command.

Values

event name: 32 characters maximum

event number: 0 to 4294967295

Default

n/a

generate

specifies that a log event is created when this event occurs. The generate keyword can be used with two optional parameters: severity-level and throttle.

Default

generate

severity-level

An ASCII string representing the severity level to associate with the specified generated events

Values

one of: cleared, indeterminate, critical, major, minor, warning

Default

the system-assigned severity level

throttle

specifies whether events of this type will be throttled

Default

By default, event throttling is off for each specific event type. It must be explicitly enabled for each event type where throttling is needed. This makes backwards compatibility easier to manage.

suppress

indicates that the specified events will not be logged. If the suppress keyword is not specified, then the events are generated by default.

Default

generate

specific-throttle-rate events-limit

configures an independent log event throttling rate for each log event, which overrides the globally configured throttle rate for the specified log event

Values

1 to 20000

seconds

the number of seconds that the specific throttling interval lasts

Values

1 to 1200

disable-specific-throttle

specifies to disable the specific-throttle-rate

throttle-rate

Syntax

throttle-rate events [intervalseconds]

no throttle-rate

Context

config>log

Description

This command configures an event throttling rate.

Parameters

events

specifies the number of log events that can be logged within the specified interval for a specific event. When the limit has been reached, any additional events of that type will be dropped, and the event drop count will be incremented. At the end of the throttle interval, if any events have been dropped, a trap notification will be sent.

Values

1 to 20000

Default

2000

seconds

specifies the number of seconds that an event throttling interval lasts

Values

1 to 1200

Default

1