Displays EEM policies that are available to be registered.

Choose the appropriate event_register Tcl command extension for the event that you want to detect, and add it to the policy. The following are valid Event Registration Tcl Command Extensions:

• event_register_appl

• event_register_counter

• event_register_stat

• event_register_wdsysmon

• event_register_oir

• event_register_process

• event_register_syslog

• event_register_timer

• event_register_timer_subscriber

• event_register_hardware

• event_register_none

Policy developers can use the new namespace ::cisco in Tcl policies to group all the extensions used by Cisco IOS XR EEM. There are two namespaces under the ::cisco hierarchy. The following are the namespaces and the EEM Tcl command extension categories that belongs under each namespace:

• ::cisco::eem

  • EEM event registration

  • EEM event information

  • EEM event publish

  • EEM action

  • EEM utility

  • EEM context library

  • EEM system information

  • CLI library

• ::cisco::lib

  • SMTP library

  Note	Ensure that the appropriate namespaces are imported, or use the qualified command names when using the preceding commands.

This is an optional step. Must defines is a section of the policy that tests whether any EEM environment variables that are required by the policy are defined before the recovery actions are taken. The must defines section is not required if the policy does not use any EEM environment variables. EEM environment variables for EEM scripts are Tcl global variables that are defined external to the policy before the policy is run. To define an EEM environment variable, use the EEM configuration command event manager environment . By convention, all Cisco EEM environment variables begin with "_" (an underscore). To avoid future conflict, customers are urged not to define new variables that start with "_".

For example, EEM environment variables defined by the sample policies include e-mail variables. The sample policies that send e-mail must have the following variables set in order to function properly. The following are the e-mail-specific environment variables used in the sample EEM policies.

• _email_server—A Simple Mail Transfer Protocol (SMTP) mail server used to send e-mail (for example, mailserver.example.com)

• _email_to—The address to which e-mail is sent (for example, engineering@example.com)

• _email_from—The address from which e-mail is sent (for example, devtest@example.com)

• _email_cc—The address to which the e-mail must be copied (for example, manager@example.com)

In this section of the script, you can define any of the following:

• The event_reqinfo event information Tcl command extension that is used to query the EEM for information about the detected event.

• The action Tcl command extensions, such as action_syslog, that are used to specify actions specific to EEM.

• The system information Tcl command extensions, such as sys_reqinfo_routername, that are used to obtain general system information.

• The context_save and context_retrieve Tcl command extensions that are used to save Tcl variables for use by other policies.

• Use of the SMTP library (to send e-mail notifications) or the CLI library (to run CLI commands) from a policy.

If the prior policy is successful, the current policy may or may not require execution. Entry status designations may use one of three possible values: 0 (previous policy was successful), Not=0 (previous policy failed), and Undefined (no previous policy was executed).

A value of zero means that the default action should not be performed. A value of nonzero means that the default action should be performed. The exit status is passed to subsequent policies that are run for the same event.

Some EEM Tcl command extensions set a Cisco Error Number Tcl global variable _cerrno. Whenever _cerrno is set, four other Tcl global variables are derived from _cerrno and are set along with it (_cerr_sub_num, _cerr_sub_err, , and _cerr_str).

Embedded Event Manager policy filenames adhere to the following specification:

• An optional prefix—Mandatory.—indicating, if present, that this is a system policy that should be registered automatically at boot time if it is not already registered. For example: Mandatory.sl_text.tcl.

• A filename body part containing a two-character abbreviation (see Table 1) for the first event specified, an underscore character part, and a descriptive field part further identifying the policy.

• A filename suffix part defined as .tcl.

For more details, see theCisco File Naming Convention for Embedded Event Manager.

Copy the file to the harddisk on the router—typically harddisk:/EEM/.

Enters global configuration mode.

Specifies a directory to use for storing user library files or user-defined EEM policies.

Registers the EEM policy to be run when the specified event defined within the policy occurs.

commit —Saves the configuration changes and remains within the configuration session.

The following example files can be used to create a tclIndex on a workstation running the Tcl shell:

lib1.tcl

proc test1 {} {
  puts "In procedure test1"
}
proc test2 {} {
  puts "In procedure test2"
}

lib2.tcl

proc test3 {} {
  puts "In procedure test3"
}

Enters the Tcl shell.

Use the auto_mkindex command to create the tclIndex file. The tclIndex file contains a directory of all the procedures contained in the Tcl library files. We recommend that you run auto_mkindex inside a directory, because there can be only a single tclIndex file in any directory and you may have other Tcl files to be grouped together. Running auto_mkindex in a directory determines which Tcl source file or files are indexed using a specific tclIndex.

The following sample TclIndex is created when the lib1.tcl and lib2.tcl files are in a library file directory and the auto_mkindex command is run:

tclIndex

# Tcl autoload index file, version 2.0
# This file is generated by the "auto_mkindex" command
# and sourced to set up indexing information for one or
# more commands.  Typically each line is a command that
# sets an element in the auto_index array, where the
# element name is the name of a command and the value is
# a script that loads the command.
set auto_index(test1) [list source [file join $dir lib1.tcl]]
set auto_index(test2) [list source [file join $dir lib1.tcl]]
set auto_index(test3) [list source [file join $dir lib2.tcl]]

The directory can be the same directory used in step 4.

The following example user-defined EEM policy can be used to test the Tcl library support in EEM:

libtest.tcl

::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
global auto_index auto_path
puts [array names auto_index]
if { [catch {test1} result]} {
  puts "calling test1 failed result = $result $auto_path"
}
if { [catch {test2} result]} {
  puts "calling test2 failed result = $result $auto_path"
}
if { [catch {test3} result]} {
  puts "calling test3 failed result = $result $auto_path"
}

Enters mode.

Specifies the EEM user library directory; this is the directory to which the files in step 4 were copied.

Specifies the EEM user policy directory; this is the directory to which the file in step 5 was copied.

Registers a user-defined EEM policy.

Manually runs an EEM policy.

commit —Saves the configuration changes and remains within the configuration session.

—

Enters the Tcl shell.

Use the pkg_mkindex command to create the pkgIndex file. The pkgIndex file contains a directory of all the packages contained in the Tcl library files. We recommend that you run the pkg_mkindex command inside a directory, because there can be only a single pkgIndex file in any directory and you may have other Tcl files to be grouped together. Running the pkg_mkindex command in a directory determines which Tcl package file or files are indexed using a specific pkgIndex.

The following example pkgIndex is created when some Tcl package files are in a library file directory and the pkg_mkindex command is run:

pkgIndex

# Tcl package index file, version 1.1
# This file is generated by the "pkg_mkIndex" command
# and sourced either when an application starts up or
# by a "package unknown" script. It invokes the
# "package ifneeded" command to set up package-related
# information so that packages will be loaded automatically
# in response to "package require" commands. When this
# script is sourced, the variable $dir must contain the
# full path name of this file's directory.
package ifneeded xmlrpc 0.3 [list source [file join $dir xmlrpc.tcl]]

The directory can be the same directory used in step 4.

The following example user-defined EEM policy can be used to test the Tcl library support in EEM:

packagetest.tcl

::cisco::eem::event_register_none maxrun 1000000.000
#
# test if xmlrpc available
#
#
# Namespace imports
#
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
#
package require xmlrpc
puts "Did you get an error?"

Enters mode.

Specifies the EEM user library directory; this is the directory to which the files in step 4 were copied.

Specifies the EEM user policy directory; this is the directory to which the file in step 5 was copied.

Registers a user-defined EEM policy.

Manually runs an EEM policy.

commit —Saves the configuration changes and remains within the configuration session.