Event Trigger Commands

Context

config>log

Description

This command enables the context to configure log events as triggers for event handlers in the EHS.

Context

config>log>event-trigger

Description

This command defines a specific log event that triggers the associated event handler. Further matching criteria can be applied (with the log-filter command) to only trigger certain handlers with certain instances of the log event.

The log event consists of an application ID and event ID.

The no form of the command removes the specified log event.

Parameters

application-id

the type of application that triggers the event

Values

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

event-name-id

the numerical identifier or name of the event

Values

0 to 4294967295 | event-name: 32 characters maximum

Context

config>log>event-trigger>event

Description

This command configures a trigger entry for the specified log event. A trigger entry references a previously configured event handler. One or more trigger entries can be configured for the event.

Trigger entries can also be configured with a previously configured log filter.

The no form of the command removes the specified trigger entry.

Parameters

entry-id

the identifier of the event trigger entry

Values

1 to 1500

Context

config>log>event-trigger>event>trigger-entry

Description

This command configures how many times the specified log event occurs before an action is triggered (for example, an EHS script). The number of occurrences of the event can be optionally bounded by a time window. If no time window is specified, the action is triggered every specified Nth event.

Triggering occurs at the specified Nth event, not at the end of the time window.

Default

no debounce

Parameters

occurrences

the number of times the event must occur in order for EHS to trigger an action

Values

2 to 15

seconds

the time window, in seconds, in which the specified number of occurrences must happen in order for EHS to trigger an action

Values

1 to 604800

Context

config>log>event-trigger>event>trigger-entry

Description

This command specifies the event handler to be used for this trigger entry. The event handler must have already been configured under the config>log>event-handling>handler context.

If the log event occurs and matches the criteria configured in the log filter (see log-filter), the event handler is triggered. When the event handler is triggered, the script that is referenced by the script policy that is in turn referenced by the event handler, is executed.

Parameters

event-handler

the name of the event handler

Context

config>log>event-trigger>event>trigger-entry

Description

This command specifies the log filter to be used for this trigger entry. The log filter must have already been configured under the config>log>filter context.

The log filter defines the matching criteria that must be met in order for the log event to trigger the event handler. The log filter is applied to the log event, and if the filtering decision results in a forward action, the event handler is triggered.

Parameters

filter-id

the log filter identifier

Values

1 to 1500