Cisco Catalyst 2960 Series, Configuration Manual

Page: 1955 / 2288

event_register_cli
Registers for a CLI event. Use this Tcl command extension to run a policy when a CLI command of a specific
pattern is entered based on pattern matching performed against an expanded CLI command.
The user can enter an abbreviated CLI command, such as sh mem summary , and the parser will expand
the command to
show memory summary
to perform the matching.
Note
The functionality provided in the CLI event detector only allows a regular expression pattern match on a
valid IOS CLI command itself. This does not include text after a pipe character when redirection is used.
Note
Syntax
event_register_cli [tag ?] sync yes|no skip yes|no
[occurs ?] [period ?] pattern ? [default ?] [enter] [questionmark] [tab] [mode]
[queue_priority low|normal|high|last] [maxrun ?] [nice 0|1]
Arguments
(Optional) String identifying a tag that can be used
with the trigger Tcl command extension to support
multiple event statements within a Tcl script. tag
(Mandatory) A "yes" means that the policy (the event
publish) will run synchronously with the CLI
command; a "no" means that the event publish will
be performed asynchronously with the CLI command.
The event detector will be notified when the policy
completes running. The exit status of the policy
indicates whether or not the CLI command should be
executed: if the exit status is zero, which means that
the policy is executed successfully, the CLI command
will not be executed; otherwise, the CLI command
will be executed. sync
Mandatory if the sync argument is "no" and should
not exist if the sync argument is "yes." If the skip
argument is "yes," it means that the CLI command
should not be executed. If the skip argument is "no,"
it means that the CLI command should be executed.
When the skip argument is "yes,"
unintended results may be produced if the
pattern match is made for configuration
commands because the CLI command that
matches the regular expression will not
be executed. Caution
skip
Consolidated Platform Configuration Guide, Cisco IOS Release 15.2(4)E (Catalyst 2960-X Switches)
1873
event_register_cli