The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Cisco IOS XR Software Embedded Event Manager (EEM) functions as the central clearing house for the events detected by any portion of the Cisco IOS XR Software processor failover services. The EEM is responsible for detection of fault events, fault recovery, and process reliability statistics in a Cisco IOS XR Software system. The EEM events are notifications that something significant has occurred within the system, such as:
Operating or performance statistics outside the allowable values (for example, free memory dropping below a critical threshold).
Online insertion or removal (OIR).
Termination of a process.
The EEM relies on software agents or event detectors to notify it when certain system events occur. When the EEM has detected an event, it can initiate corrective actions. Actions are prescribed in routines called policies. Policies must be registered before an action can be applied to collected events. No action occurs unless a policy is registered. A registered policy informs the EEM about a particular event that is to be detected and the corrective action to be taken if that event is detected. When such an event is detected, the EEM enables the corresponding policy. You can disable a registered policy at any time.
The EEM monitors the reliability rates achieved by each process in the system, allowing the system to detect the components that compromise the overall reliability or availability.
This module describes the tasks you need to perform to configure and manage EEM policies on your network and write and customize the EEM policies using Tool Command Language (Tcl) scripts to handle faults and events.
You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Embedded Event Manager (EEM) in the Cisco IOS XR Software system essentially involves system event management. An event can be any significant occurrence (not limited to errors) that has happened within the system. The Cisco IOS XR Software EEM detects those events and implements appropriate responses.
The EEM enables a system administrator to specify appropriate action based on the current state of the system. For example, a system administrator can use EEM to request notification by e-mail when a hardware device needs replacement.
The EEM interacts with routines, “event detectors,” that actively monitor the system for events. The EEM relies on an event detector that it has provided to syslog to detect that a certain system event has occurred. It uses a pattern match with the syslog messages and also relies on a timer event detector to detect that a certain time and date has occurred.
When the EEM has detected an event, it can initiate actions in response. These actions are contained in routines called policy handlers. Policies are defined by Tcl scripts (EEM scripts) written by the user through a Tcl API. While the data for event detection is collected, no action occurs unless a policy for responding to that event has been registered. At registration, a policy informs the EEM that it is looking for a particular event. When the EEM detects the event, it enables the policy.
The EEM monitors the reliability rates achieved by each process in the system. These metrics can be used during testing to determine which components do not meet their reliability or availability goals so that corrective action can be taken.
When the EEM receives an event notification, it takes these actions:
Notifies the processes that have subscribed for event notification.
Records reliability metric data for each process in the system.
Provides access to EEM-maintained system information through an application program interface (API).
When the EEM has detected an event, it can initiate corrective actions prescribed in routines called policies. Policies must be registered before any action can be applied to collected events. No action occurs unless a policy is registered. A registered policy informs the EEM about a particular event to detect and the corrective action to take if that event is detected. When such an event is detected, the EEM runs the policy. Tool Command Language (Tcl) is used as the scripting language to define policies and all Embedded Event Manager scripts are written in Tcl. EEM scripts are identified to the EEM using the event manager policy configuration command. An EEM script remains available to be scheduled by the EEM until the no event manager policy command is entered.
In addition the onboard Tcl scripts that come with the IOS XR operating system, users may write their own TCL-based policies. Cisco provides enhancements to the Tcl language in the form of Tcl command extensions that facilitate the writing of EEM policies. For more information about EEM Tcl command extensions, see Embedded Event Manager Policy Tcl Command Extension Categories.
Writing an EEM script includes the following steps:
Selecting the event Tcl command extension that establishes the criteria used to determine when the policy is run.
Defining the event detector options associated with detecting the event.
Choosing the actions to implement recovery or respond to the detected event.
Regular EEM scripts are used to implement policies when an EEM event is published. EEM scripts are identified to the EEM using the event manager policy configuration command. An EEM script remains available to be scheduled by the EEM until the no event manager policy command is entered.
The first executable line of code within an EEM script must be the eem event register keyword. This keyword identifies the EEM event for which that script should be scheduled. The keyword is used by the event manager policy configuration command to register to handle the specified EEM event.
When an EEM script exits, it is responsible for setting a return code that is used to tell the EEM whether to run the default action for this EEM event (if any) or no other action. If multiple event handlers are scheduled for a given event, the return code from the previous handler is passed into the next handler, which can leave the value as is or update it.
 Note |
An EEM script cannot register to handle an event other than the event that caused it to be scheduled. |
This table lists the different categories of EEM policy Tcl command extensions.
|
Category |
Definition |
|---|---|
|
EEM event Tcl command extensions(three types: event information, event registration, and event publish) |
These Tcl command extensions are represented by the event_register _xxx family of event-specific commands. There is a separate event information Tcl command extension in this category as well: event_reqinfo . This is the command used in policies to query the EEM for information about an event. There is also an EEM event publish Tcl command extension event_publish that publishes an application-specific event. |
|
EEM action Tcl command extensions |
These Tcl command extensions (for example, action_syslog ) are used by policies to respond to or recover from an event or fault. In addition to these extensions, developers can use the Tcl language to implement any action desired. |
|
EEM utility Tcl command extensions |
These Tcl command extensions are used to retrieve, save, set, or modify application information, counters, or timers. |
|
EEM system information Tcl command extensions |
These Tcl command extensions are represented by the sys_reqinfo _xxx family of system-specific information commands. These commands are used by a policy to gather system information. |
|
EEM context Tcl command extensions |
These Tcl command extensions are used to store and retrieve a Tcl context (the visible variables and their values). |
All EEM policy names, policy support files (for example, e-mail template files), and library filenames are consistent with the Cisco file-naming convention. In this regard, EEM policy filenames adhere to the following specifications:
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 below) for the first event specified; an underscore part; and a descriptive field part that further identifies the policy.
A filename suffix part defined as .tcl.
EEM e-mail template files consist of a filename prefix of email_template, followed by an abbreviation that identifies the usage of the e-mail template.
EEM library filenames consist of a filename body part containing the descriptive field that identifies the usage of the library, followed by _lib, and a filename suffix part defined as .tcl.
|
Two-Character Abbreviation |
Specification |
|---|---|
|
ap |
event_register_appl |
|
no |
event_register_none |
|
oi |
event_register_oir |
|
pr |
event_register_process |
|
sl |
event_register_syslog |
|
tm |
event_register_timer |
|
ts |
event_register_timer_subscriber |
EEM built-in actions can be requested from EEM handlers when the handlers run.
This table describes each EEM handler request or action.
|
Embedded Event Manager Built-In Action |
Description |
|---|---|
|
Log a message to syslog |
Sends a message to the syslog. Arguments to this action are priority and the message to be logged. |
|
Execute a CLI command |
Writes the command to the specified channel handler to execute the command by using the cli_exec command extension. |
|
Generate a syslog message |
Logs a message by using the action_syslog Tcl command extension. |
|
Manually run an EEM policy |
Runs an EEM policy within a policy while the event manager run command is running a policy in XR EXEC mode. |
|
Publish an application-specific event |
Publishes an application-specific event by using the event_publish appl Tcl command extension. |
|
Reload the Cisco IOS software |
Causes a router to be reloaded by using the EEM action_reload command. |
|
Request system information |
Represents the sys_reqinfo_xxx family of system-specific information commands by a policy to gather system information. |
|
Send a short e-mail |
Sends the e-mail out using Simple Mail Transfer Protocol (SMTP). |
|
Set or modify a counter |
Modifies a counter value. |
EEM handlers require the ability to run CLI commands. A command is available to the Tcl shell to allow execution of CLI commands from within Tcl scripts.
Any Cisco IOS XR Software application can define and publish application-defined events. Application-defined events are identified by a name that includes both the component name and event name, to allow application developers to assign their own event identifiers. Application-defined events can be raised by a Cisco IOS XR Software component even when there are no subscribers. In this case, the EEM dismisses the event, which allows subscribers to receive application-defined events as needed.
An EEM script that subscribes to receive system events is processed in the following order:
This CLI configuration command is entered: event manager policy scriptfilename username username .
The EEM scans the EEM script looking for an eem event event_type keyword and subscribes the EEM script to be scheduled for the specified event.
The Event Detector detects an event and contacts the EEM.
The EEM schedules event processing, causing the EEM script to be run.
The EEM script routine returns.
EEM is a flexible, policy-driven framework that supports in-box monitoring of different components of the system with the help of software agents known as event detectors. Event detectors are separate programs that provide an interface between other Cisco IOS XR Software components and the EEM. Event detectors (event publishers) screen events and publish them when there is a match on an event specification that is provided by event subscribers (policies). Event detectors notify the EEM server when an event of interest occurs.
An EEM event is defined as a notification that something significant has happened within the system. Two categories of events exist:
System EEM events
Application-defined events
System EEM events are built into the EEM and are grouped based on the fault detector that raises them. They are identified by a symbolic identifier defined within the API.
Some EEM system events are monitored by the EEM whether or not an application has requested monitoring. These are called built-in EEM events. Other EEM events are monitored only if an application has requested EEM event monitoring. EEM event monitoring is requested through an EEM application API or the EEM scripting interface.
Some event detectors can be distributed to other hardware cards within the same secure domain router (SDR) or within the administration plane to provide support for distributed components running on those cards.
These event detectors are supported:
The System Manager Event Detector has four roles:
Records process reliability metric data.
Screens for processes that have EEM event monitoring requests outstanding.
Publishes events for those processes that match the screening criteria.
Asks the System Manager to perform its default action for those events that do not match the screening criteria.
The System Manager Event Detector interfaces with the System Manager to receive process startup and termination notifications. The interfacing is made through a private API available to the System Manager. To minimize overhead, a portion of the API resides within the System Manager process space. When a process terminates, the System Manager invokes a helper process (if specified in the process.startup file) before calling the Event Detector API.
Processes can be identified by component ID, System Manager assigned job ID, or load module pathname plus process instance ID. Process instance ID is an integer assigned to a process to differentiate it from other processes with the same pathname. The first instance of a process is assigned an instance ID value of 1, the second 2, and so on.
The System Manager Event Detector handles EEM event monitoring requests for the EEM events shown in this table.
|
Embedded Event Manager Event |
Description |
|---|---|
|
Normal process termination EEM event—built in |
Occurs when a process matching the screening criteria terminates. |
|
Abnormal process termination EEM event—built in |
Occurs when a process matching the screening criteria terminates abnormally. |
|
Process startup EEM event—built in |
Occurs when a process matching the screening criteria starts. |
When System Manager Event Detector abnormal process termination events occur, the default action restarts the process according to the built-in rules of the System Manager.
The relationship between the EEM and System Manager is strictly through the private API provided by the EEM to the System Manager for the purpose of receiving process start and termination notifications. When the System Manager calls the API, reliability metric data is collected and screening is performed for an EEM event match. If a match occurs, a message is sent to the System Manager Event Detector. In the case of abnormal process terminations, a return is made indicating that the EEM handles process restart. If a match does not occur, a return is made indicating that the System Manager should apply the default action.
The Timer Services Event Detector implements time-related EEM events. These events are identified through user-defined identifiers so that multiple processes can await notification for the same EEM event.
The Timer Services Event Detector handles EEM event monitoring requests for the Date/Time Passed EEM event. This event occurs when the current date or time passes the specified date or time requested by an application.
The syslog Event Detector implements syslog message screening for syslog EEM events. This routine interfaces with the syslog daemon through a private API. To minimize overhead, a portion of the API resides within the syslog daemon process.
Screening is provided for the message severity code or the message text fields.
The Syslog Event Detector handles EEM event monitoring requests for the events are shown in this table.
|
Embedded Event Manager Event |
Description |
|---|---|
|
Syslog message EEM event |
Occurs for a just-logged message. It occurs when there is a match for either the syslog message severity code or the syslog message text pattern. Both can be specified when an application requests a syslog message EEM event. |
|
Process event manager EEM event—built in |
Occurs when the event-processed count for a specified process is either greater than or equal to a specified maximum or is less than or equal to a specified minimum. |
The None Event Detector publishes an event when the Cisco IOS XR7 software event manager run CLI command executes an EEM policy. EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. An EEM policy must be identified and registered to be permitted to run manually before the event manager run command will execute.
Event manager none detector provides user the ability to run a tcl script using the CLI. The script is registered first before running. Cisco IOS XR7 software version provides similar syntax with Cisco IOS EEM (refer to the applicable EEM Documentation for details), so scripts written using Cisco IOS EEM is run on Cisco IOS XR7 software with minimum change.
Cisco IOS XR Software components that interface to EEM event detectors and that have substantially independent implementations running on a distributed hardware card should have a distributed EEM event detector. The distributed event detector permits scheduling of EEM events for local processes without requiring that the local hardware card to the EEM communication channel be active.
These event detectors run on a Cisco IOS XR Software line card:
System Manager Fault Detector
When an EEM handler is scheduled, it runs under the context of the process that creates the event request (or for EEM scripts under the Tcl shell process context). For events that occur for a process running an EEM handler, event scheduling is blocked until the handler exits. The defined default action (if any) is performed instead.
The EEM Server maintains queues containing event scheduling and notification items across client process restarts, if requested.
Reliability metric data for the system is maintained by the EEM. The data is periodically written to checkpoint. Reliability metric data is kept for each hardware card and for each process handled by the System Manager.
Hardware card reliability metric data is recorded in a table indexed by disk ID.
Data maintained by the hardware card is as follows:
Most recent start time
Most recent normal end time (controlled switchover)
Most recent abnormal end time (asynchronous switchover)
Most recent abnormal type
Cumulative available time
Cumulative unavailable time
Number of times hardware card started
Number of times hardware card shut down normally
Number of times hardware card shut down abnormally
Reliability metric data is kept for each process handled by the System Manager. This data includes standby processes running on either the primary or backup hardware card. Data is recorded in a table indexed by hardware card disk ID plus process pathname plus process instance for those processes that have multiple instances.
Process terminations include the following cases:
Normal termination—Process exits with an exit value equal to 0.
Abnormal termination by process—Process exits with an exit value not equal to 0.
Abnormal termination by Linux—Linux operating system terminates the process.
Abnormal termination by kill process API—API kill process terminates the process.
Data to be maintained by process is as follows:
Most recent process start time
Most recent normal process end time
Most recent abnormal process end time
Most recent abnormal process end type
Previous ten process end times and types
Cumulative process available time
Cumulative process unavailable time
Cumulative process run time (the time when the process is actually running on the CPU)
Number of times started
Number of times ended normally
Number of times ended abnormally
Number of abnormal failures within the past 60 minutes
Number of abnormal failures within the past 24 hours
Number of abnormal failures within the past 30 days
EEM environmental variables are Tcl global variables that are defined external to the policy before the policy is run. The EEM policy engine receives notifications when faults and other events occur. EEM policies implement recovery, based on the current state of the system and actions specified in the policy for a given event. Recovery actions are triggered when the policy is run.
By convention, the names of all environment variables defined by Cisco begin with an underscore character to set them apart; for example, _show_cmd.
You can configure the environment variable and values by using the event manager environmentvar-name var-value command.
Use the show event manager environment command to display the name and value of all EEM environment variables before and after they have been set using the event manager environment command.
This example shows how to define a set of EEM environment variables.
RP/0/RP0/CPU0:Router# configure
RP/0/RP0/CPU0:Router(config)# event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7
RP/0/RP0/CPU0:Router(config)# event manager environment _email_from beta@cisco.com
RP/0/RP0/CPU0:Router(config)# event manager environment _email_to beta@cisco.com
RP/0/RP0/CPU0:Router(config)# commit
RP/0/RP0/CPU0:Router(config)# end
RP/0/RP0/CPU0:Router# show event manager environment
No. Name Value
1 _email_to beta@cisco.com
2 _cron_entry 0-59/2 0-23/1 * * 0-7
3 _email_from beta@cisco.com
RP/0/RP0/CPU0:Router#
You should register an EEM policy to run a policy when an event is triggered. Registering an EEM policy is performed with the event manager policy command. An EEM script is available to be scheduled by the EEM until the no form of this command is entered. Prior to registering a policy, display EEM policies that are available to be registered with the show event manager policy available command.
The EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When the event manager policy command is invoked, the EEM examines the policy and registers it to be run when the specified event occurs.
Note |
AAA authorization (such as the aaa authorization eventmanager command) must be configured before EEM policies can be registered. See the Configuring AAA Services module of Configuring AAA Services on Cisco IOS XR7 software for more information about AAA authorization configuration. |
Once policies have been registered, their registration can be verified through the show event manager policy registered command.
This example shows how to register a user defined EEM policy.
RP/0/RP0/CPU0:Router# show event manager policy available
RP/0/RP0/CPU0:Router# configure
RP/0/RP0/CPU0:Router(config)# event manager policy cron.tcl username tom type user
RP/0/RP0/CPU0:Router# show event manager policy registered
This section provides information on how to write and customize Embedded Event Manager (EEM) policies using Tool Command Language (Tcl) scripts to handle Cisco IOS XR7 software faults and events.
This section contains these tasks:
Perform this task to configure environment variables and register an EEM policy. EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When an EEM policy is registered, the software examines the policy and registers it to be run when the specified event occurs.
Note |
A policy must be available that is written in the Tcl scripting language. Sample policies are stored in the system policy directory. |
This example shows how to register and define an EEM policy.
RP/0/RP0/CPU0:Router# show event manager environment all
RP/0/RP0/CPU0:Router# configure
RP/0/RP0/CPU0:Router(config)# event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7
RP/0/RP0/CPU0:Router(config)# event manager policy tm_cli_cmd.tcl username user_a type system
RP/0/RP0/CPU0:Router(config)# commit
RP/0/RP0/CPU0:Router# show event manager policy registered system Note |
To unregister an EEM policy, use the no event manager policy command. This command removes an EEM policy from the running configuration file. |
Perform this optional task to display EEM registered policies.
| Command or Action | Purpose |
|---|---|
|
show event manager policy registered [ event-type type ] [ system | user ] [ time-ordered | name-ordered ] Example: |
Displays information about currently registered policies.
|
Perform this task to remove an EEM policy from the running configuration file. Execution of the policy is canceled.
| Command or Action | Purpose | |
|---|---|---|
|
Step 1 |
show event manager policy registered [ event-type type ] [ system | user ] [ time-ordered | name-ordered ] Example: |
Displays information about currently registered policies.
|
|
Step 2 |
configure Example: |
Enters mode. |
|
Step 3 |
no event manager policy policy-name Example: |
Removes the EEM policy from the configuration, causing the policy to be unregistered. |
|
Step 4 |
Use the commit or end command. |
commit —Saves the configuration changes and remains within the configuration session.
|
|
Step 5 |
Repeat step 1 to ensure that the policy has been removed. |
|
Suspending policies, instead of unregistering them, might be necessary for reasons of temporary performance or security. If required, you can immediately suspend the execution of all EEM policies by using the event manager scheduler suspend command.
This example shows how to suspend the execution of all EEM policies.
RP/0/RP0/CPU0:Router# show event manager policy registered system
RP/0/RP0/CPU0:Router# configure
RP/0/RP0/CPU0:Router(config)# event manager scheduler suspend
RP/0/RP0/CPU0:Router(config)# commit
A directory is essential to store the user-defined policy files or user library files. If you do not plan to write EEM policies, you do not have to create the directory. The EEM searches the user policy directory when you enter the event manager policy policy-name user command. To create a user policy directory before identifying it to the EEM, use the mkdir command. After creating the user policy directory, use the copy command to copy the policy files into the user policy directory. You can use the show event manager directory user [ library | policy ] command to display the directory to use for EEM user library files or user-defined policy files.
This example shows how to specify a directory to use for storing user-library files .
RP/0/RP0/CPU0:Router# show event manager directory user library
RP/0/RP0/CPU0:Router# configure
RP/0/RP0/CPU0:Router(config)# event manager directory user library harddisk:/mirror/usr/lib/tcl
RP/0/RP0/CPU0:Router(config)# commit
Cisco IOS XR7 software contains some sample policies in the images that contain the EEM. Developers of EEM policies may modify these policies by customizing the event for which the policy is to be run and the options associated with logging and responding to the event. In addition, developers may select the actions to be implemented when the policy runs.
The Cisco IOS XR7 software includes a set of sample policies (see Sample EEM Policy Descriptions table). The sample policies can be copied to a user directory and then modified. Tcl is currently the only scripting language supported by Cisco for policy creation. Tcl policies can be modified using a text editor such as Emacs. Policies must execute within a defined number of seconds of elapsed time, and the time variable can be configured within a policy. The default is 20 seconds.
Show event manager policy available system
This table describes the sample EEM policies.
|
Name of Policy |
Description |
|---|---|
|
periodic_diag_cmds.tcl |
This policy is triggered when the _cron_entry_diag cron entry expires.Then, the output of this fixed set is collect for the fixed set of commands and the output is sent by email. |
|
periodic_proc_avail.tcl |
This policy is triggered when the _cron_entry_procavail cron entry expires. Then the output of this fixed set is collect for the fixed set of commands and the output is sent by email. |
|
periodic_sh_log.tcl |
This policy is triggered when the _cron_entry_log cron entry expires, and collects the output for the show log command and a few other commands. If the environment variable _log_past_hours is configured, it collects the log messages that are generated in the last _log_past_hours hours. Otherwise, it collects the full log. |
|
sl_sysdb_timeout.tcl |
This policy is triggered when the script looks for the sysdb timeout ios_msgs and obtains the output of the show commands. The output is written to a file named after the blocking process. |
|
tm_cli_cmd.tcl |
This policy runs using a configurable CRON entry. It executes a configurable CLI command and e-mails the results. |
|
tm_crash_hist.tcl |
This policy runs at midnight each day and e-mails a process crash history report to a specified e-mail address. |
| Command or Action | Purpose | |
|---|---|---|
|
Step 1 |
show event manager policy available [system | user] Example: |
Displays EEM policies that are available to be registered. |
|
Step 2 |
configure Example: |
Enters mode. |
|
Step 3 |
event manager directory user {library path | policy path} Example: |
Specifies a directory to use for storing user library files or user-defined EEM policies. |
|
Step 4 |
event manager policy policy-name username username [persist-time [seconds | infinite] | type [system | user]] Example: |
Registers the EEM policy to be run when the specified event defined within the policy occurs. |
|
Step 5 |
Use the commit or end command. |
commit —Saves the configuration changes and remains within the configuration session.
|
Perform this task to help you program a policy using Tcl command extensions. We recommend that you copy an existing policy and modify it. There are two required parts that must exist in an EEM Tcl policy: the event_register Tcl command extension and the body. For detailed information about the Tcl policy structure and requirements, see EEM Policies Using TCL: Details
| Command or Action | Purpose | |||
|---|---|---|---|---|
|
Step 1 |
show event manager policy available [system | user] Example: |
Displays EEM policies that are available to be registered. |
||
|
Step 2 |
Cut and paste the contents of the sample policy displayed on the screen to a text editor. |
|
||
|
Step 3 |
Define the required event_register Tcl command extension. |
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:
|
||
|
Step 4 |
Add the appropriate namespace under the ::cisco hierarchy. |
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:
|
||
|
Step 5 |
Program the must defines section to check for each environment variable that is used in this policy. |
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.
|
||
|
Step 6 |
Program the body of the script. |
In this section of the script, you can define any of the following:
|
||
|
Step 7 |
Check the entry status to determine if a policy has previously run for this event. |
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). |
||
|
Step 8 |
Check the exit status to determine whether or not to apply the default action for this event, if a default action exists. |
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. |
||
|
Step 9 |
Set Cisco Error Number (_cerrno) Tcl global variables. |
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). |
||
|
Step 10 |
Save the Tcl script with a new filename, and copy the Tcl script to the router. |
Embedded Event Manager policy filenames adhere to the following specification:
For more details, see the Cisco File Naming Convention for Embedded Event Manager. Copy the file to the file system on the router—typically harddisk:/mirror/. |
||
|
Step 11 |
configure |
Enters global configuration mode. |
||
|
Step 12 |
event manager directory user {library path | policy path} Example: |
Specifies a directory to use for storing user library files or user-defined EEM policies. |
||
|
Step 13 |
event manager policy policy-name username username [persist-time [seconds | infinite] | type [system | user]] Example: |
Registers the EEM policy to be run when the specified event defined within the policy occurs. |
||
|
Step 14 |
Use the commit or end command. |
commit —Saves the configuration changes and remains within the configuration session.
|
||
|
Step 15 |
Cause the policy to execute, and observe the policy. |
|
||
|
Step 16 |
Use debugging techniques if the policy does not execute correctly. |
|
Perform this task to create an index file that contains a directory of all the procedures contained in a library of Tcl files. This task allows you to test library support in EEM Tcl. In this task, a library directory is created to contain the Tcl library files, the files are copied into the directory, and an index tclIndex) is created that contains a directory of all the procedures in the library files. If the index is not created, the Tcl procedures are not found when an EEM policy that references a Tcl procedure is run.
| Command or Action | Purpose | |
|---|---|---|
|
Step 1 |
On your workstation (UNIX, Linux, PC, or Mac) create a library directory and copy the Tcl library files into the directory. |
The following example files can be used to create a tclIndex on a workstation running the Tcl shell: lib1.tcl lib2.tcl |
|
Step 2 |
tclsh Example: |
Enters the Tcl shell. |
|
Step 3 |
auto_mkindex directory_name *.tcl Example: |
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 |
|
Step 4 |
Copy the Tcl library files from step 1 and the tclIndex file from step 3 to the directory used for storing user library files on the target router. |
|
|
Step 5 |
Copy a user-defined EEM policy file written in Tcl to the directory used for storing user-defined EEM policies on the target router. |
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 |
|
Step 6 |
configure Example: |
Enters mode. |
|
Step 7 |
event manager directory user library path Example: |
Specifies the EEM user library directory; this is the directory to which the files in step 4 were copied. |
|
Step 8 |
event manager directory user policy path Example: |
Specifies the EEM user policy directory; this is the directory to which the file in step 5 was copied. |
|
Step 9 |
event manager policy policy-name username username [persist-time [seconds | infinite] | type [system | user]] Example: |
Registers a user-defined EEM policy. |
|
Step 10 |
event manager run policy [argument] Example: |
Manually runs an EEM policy. |
|
Step 11 |
Use the commit or end command. |
commit —Saves the configuration changes and remains within the configuration session.
|
Perform this task to create a Tcl package index file that contains a directory of all the Tcl packages and version information contained in a library of Tcl package files. Tcl packages are supported using the Tcl package keyword.
Tcl packages are located in either the EEM system library directory or the EEM user library directory. When a package require Tcl command is executed, the user library directory is searched first for a pkgIndex.tcl file. If the pkgIndex.tcl file is not found in the user directory, the system library directory is searched.
In this task, a Tcl package directory—the pkgIndex.tcl file—is created in the appropriate library directory using the pkg_mkIndex command to contain information about all the Tcl packages contained in the directory along with version information. If the index is not created, the Tcl packages are not found when an EEM policy that contains a package require Tcl command is run.
Using the Tcl package support in EEM, users can gain access to packages such as XML_RPC for Tcl. When the Tcl package index is created, a Tcl script can easily make an XML-RPC call to an external entity.
Note |
Packages implemented in C programming code are not supported in EEM. |
| Command or Action | Purpose | |
|---|---|---|
|
Step 1 |
On your workstation (UNIX, Linux, PC, or Mac) create a library directory and copy the Tcl package files into the directory. |
|
|
Step 2 |
tclsh Example: |
Enters the Tcl shell. |
|
Step 3 |
pkg_mkindex directory_name *.tcl Example: |
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 |
|
Step 4 |
Copy the Tcl package files from step 1 and the pkgIndex file from step 3 to the directory used for storing user library files on the target router. |
|
|
Step 5 |
Copy a user-defined EEM policy file written in Tcl to the directory used for storing user-defined EEM policies on the target router. |
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 |
|
Step 6 |
configure Example: |
Enters mode. |
|
Step 7 |
event manager directory user library path Example: |
Specifies the EEM user library directory; this is the directory to which the files in step 4 were copied. |
|
Step 8 |
event manager directory user policy path Example: |
Specifies the EEM user policy directory; this is the directory to which the file in step 5 was copied. |
|
Step 9 |
event manager policy policy-name username username [persist-time [seconds | infinite] | type [system | user]] Example: |
Registers a user-defined EEM policy. |
|
Step 10 |
event manager run policy [argument] Example: |
Manually runs an EEM policy. |
|
Step 11 |
Use the commit or end command. |
commit —Saves the configuration changes and remains within the configuration session.
|
This section provides detailed conceptual information about programming EEM policies using TCL.
All EEM policies share the same structure, shown in the below figure. There are two parts of an EEM policy that are required: the event_register Tcl command extension and the body. The remaining parts of the policy are optional: environmental must defines, namespace import, entry status, and exit status.
The start of every policy must describe and register the event to detect using an event_register Tcl command extension. This part of the policy schedules the running of the policy. The following example Tcl code shows how to register the event_register_timer Tcl command extension:
::cisco::eem::event_register_timer cron name crontimer2 cron_entry $_cron_entry maxrun 240
The following example Tcl code shows how to check for, and define, some environment variables:
# Check if all the env variables that we need exist.
# If any of them does not exist, print out an error msg and quit.
if {![info exists _email_server]} {
set result \
"Policy cannot be run: variable _email_server has not been set"
error $result $errorInfo
}
if {![info exists _email_from]} {
set result \
"Policy cannot be run: variable _email_from has not been set"
error $result $errorInfo
}
if {![info exists _email_to]} {
set result \
"Policy cannot be run: variable _email_to has not been set"
error $result $errorInfo
)
The namespace import section is optional and defines code libraries. The following example Tcl code shows how to configure a namespace import section:
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
The body of the policy is a required structure and might contain 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.
Use of the SMTP library (to send e-mail notifications) or the CLI library (to run CLI commands) from a policy.
The context_save and con text_retrieve Tcl command extensions that are used to save Tcl variables for use by other policies.
The entry status part of an EEM policy is used to determine if a prior policy has been run for the same event, and to determine the exit status of the prior policy. If the _entry_status variable is defined, a prior policy has already run for this event. The value of the _entry_status variable determines the return code of the prior policy.
Entry status designations may use one of three possible values:
0 (previous policy was successful)
Not=0 (previous policy failed),
Undefined (no previous policy was executed).
When a policy finishes running its code, an exit value is set. The exit value is used by the EEM to determine whether or not to apply the default action for this event, if any. 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 known as _cerrno. Whenever the _cerrno variable is set, the other Tcl global variables are derived from _cerrno and are set along with it (_cerr_sub_num, _cerr_sub_err, and _cerr_str).
The _cerrno variable set by a command can be represented as a 32-bit integer of the following form:
XYSSSSSSSSSSSSSEEEEEEEEPPPPPPPPP
This 32-bit integer is divided up into the variables shown in this table.
|
Variable |
Description |
|---|---|
|
XY |
The error class (indicates the severity of the error). This variable corresponds to the first two bits in the 32-bit error return value; 10 in the preceding case, which indicates CERR_CLASS_WARNING: See #__ for the four possible error class encodings specific to this variable. |
|
SSSSSSSSSSSSSS |
The subsystem number that generated the most recent error(13 bits = 8192 values). This is the next 13 bits of the 32-bit sequence, and its integer value is contained in $_cerr_sub_num. |
|
EEEEEEEE |
The subsystem specific error number (8 bits = 256 values). This segment is the next 8 bits of the 32-bit sequence, and the string corresponding to this error number is contained in $_cerr_sub_err. |
For example, the following error return value might be returned from an EEM Tcl command extension:
862439AE
This number is interpreted as the following 32-bit value:
10000110001001000011100110101110
The variable, XY, references the possible error class encodings shown in this table.
|
Error Return Value |
Error Class |
|---|---|
|
00 |
CERR_CLASS_SUCCESS |
|
01 |
CERR_CLASS_INFO |
|
10 |
CERR_CLASS_WARNING |
|
11 |
CERR_CLASS_FATAL |
An error return value of zero means SUCCESS.
The configuration example features one sample EEM policy. The tm_cli_cmd.tcl runs using a configurable CRON entry. This policy executes a configurable CLI command and e-mails the results.
Some EEM policies must be unregistered and then reregistered if an EEM environment variable is modified after the policy is registered. The event_register_ xxx statement that appears at the start of the policy contains some of the EEM environment variables, and this statement is used to establish the conditions under which the policy is run. If the environment variables are modified after the policy has been registered, the conditions may become invalid. To avoid any errors, the policy must be unregistered and then reregistered. The following variables are affected:
_cron_entry in the tm_cli_cmd.tcl policy
_syslog_pattern in the sl_intf_down.tcl policy
To allow e-mail to be sent from the Embedded Event Manager (EEM), the hostname and domain-name commands must be configured. The EEM environment variables must also be set. After a Cisco IOS XR7 software image has been booted, use the following initial configuration, substituting appropriate values for your network:
hostname cpu
example.com
event manager environment _email_server ms.example.net
event manager environment _email_to username@example.net
event manager environment _email_from engineer@example.net
event manager environment _email_cc projectgroup@example.net
event manager environment _cron_entry 0-59/2 0-23/1 * * 0-7
event manager environment _show_cmd show event manager policy registered
event manager environment _syslog_pattern .*UPDOWN.*FastEthernet0/0
event manager environment _config_cmd1 interface Ethernet1/0
event manager environment _config_cmd2 no shutdown
event manager environment _crash_reporter_debug 1
event manager environment _crash_reporter_url
http://www.example.com/fm/interface_tm.cgi
end
This section documents the following EEM policy Tcl command extension categories:
Note |
For all EEM Tcl command extensions, if there is an error, the returned Tcl result string contains the error information. |
Note |
Arguments for which no numeric range is specified take an integer from -2147483648 to 2147483647, inclusive. |
The following conventions are used for the syntax documented on the Tcl command extension pages:
An optional argument is shown within square brackets, for example:
[type ?]
A question mark ? represents a variable to be entered.
Choices between arguments are represented by pipes, for example:
[queue_priority low|normal|high]
The following EEM event registration Tcl command extensions are supported:
Registers for an application event. Use this Tcl command extension to run a policy when an application event is triggered following another policy's execution of an event_publish Tcl command extension; the event_publish command extension publishes an application event.
To register for an application event, a subsystem must be specified. Either a Tcl policy or the internal EEM API can publish an application event. If the event is being published by a policy, the sub_system argument that is reserved for a policy is 798.
event_register_appl [sub_system ?] [type ?] [queue_priority low|normal|high] [maxrun ?]
[nice 0|1]
|
sub_system |
(Optional) Number assigned to the EEM policy that published the application event. The number is set to 798, because all other numbers are reserved for Cisco use. If this argument is not specified, all components are matched. |
|
type |
(Optional) Event subtype within the specified event. The sub_system and type arguments uniquely identify an application event. If this argument is not specified, all types are matched. If you specify this argument, you must choose an integer between 1 and 4294967295, inclusive. There must be a match of component and type between the event_publish command extension and the event_register_appl command extension for the publishing and registration to work. |
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
If multiple conditions exist, the application event is raised when all the conditions are satisfied.
None
No
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. This will be implemented as a new process in IOS-XR which will be dlrsc_tracker. This ED will not do pattern match on admin commands of XR.
Note |
You 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. The functionality provided in the CLI event detector only allows a regular expression pattern match on a valid XR CLI command itself. This does not include text after a pipe character when redirection is used. |
event_register_cli [tag ?]
[occurs ?] [period ?] pattern ? [default ?] [queue_priority low|normal|high|last] [maxrun ?] [nice 0|1]
|
tag |
(Optional) String identifying a tag that can be used with the trigger Tcl command extension to support multiple event statements within a Tcl script. |
|
occurs |
(Optional) The number of occurrences before the event is raised. If this argument is not specified, the event is raised on the first occurrence. If this argument is specified, it must be an integer between 1 and 4294967295, inclusive. |
|
period |
(Optional) Specifies a backward looking time window in which all CLI events must occur (the occurs clause must be satisfied) in order for an event to be published (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the most recent event is used. |
|
pattern |
(Mandatory) Specifies the regular expression used to perform the CLI command pattern match. |
|
default |
(Optional) The time period during which the CLI event detector waits for the policy to exit (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If the default time period expires before the policy exits, the default action will be executed. The default action is to run the command. If this argument is not specified, the default time period is set to 30 seconds. |
If multiple conditions are specified, the CLI event will be raised when all the conditions are matched.
None
No
Registers for a change in running configuration. Use this Tcl command extension to trigger a policy when there is any configuration change. This will be implemented as a new process in IOS-XR which will be dlrsc_tracker. This ED will not check for admin config changes in XR.
event_register_config
[queue_priority low|normal|high|last]
[maxrun ?] [nice 0|1]
|
queue_priority |
(Optional) Priority level at which the script will be queued:
If more than one script is registered with the "queue_priority_last" argument set, these scripts will execute in the order in which the events are published.
If this argument is not specified, the default queuing priority is normal. |
||
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
||
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
If multiple conditions are specified, the syslog event will be raised when all the conditions are matched.
None
No
Registers for an event that is triggered by the event manager run command. These events are handled by the None event detector that screens for this event.
event_register_none [queue_priority low|normal|high] [maxrun ?] [nice 0|1]
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
None
No
Registers for an online insertion and removal (OIR) event. Use this Tcl command extension to run a policy on the basis of an event raised when a hardware card OIR occurs. These events are handled by the OIR event detector that screens for this event.
event_register_oir [queue_priority low|normal|high] [maxrun ?] [nice 0|1]
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
None
No
Registers for a process event. Use this Tcl command extension to run a policy on the basis of an event raised when a Cisco IOS XR7 software modularity process starts or stops. These events are handled by the system manager event detector that screens for this event. This Tcl command extension is supported only in software modularity images.
event_register_process abort|term|start
[job_id ?] [instance ?] [path ?] [node ?]
[queue_priority low|normal|high] [maxrun ?] [nice 0|1] [tag?]
|
abort |
(Mandatory) Abnormal process termination. Process may terminate because of exiting with a nonzero exit status, receiving a kernel-generated signal, or receiving a SIGTERM or SIGKILL signal that is not sent because of user request. |
|
term |
(Mandatory) Normal process termination. |
|
start |
(Mandatory) Process start. |
|
job_id |
(Optional) Number assigned to the EEM policy that published the process event. Number is set to 798, because all other numbers are reserved for Cisco use. |
|
instance |
(Optional) Process instance ID. If specified, this argument must be an integer between 1 and 4294967295, inclusive. |
|
path |
(Optional) Process pathname (regular expression string). |
|
node |
(Optional) The node name is a string that consists of the word "node" followed by two fields separated by a slash (/), using the following format: node<slot-number>/<cpu-number> The slot-number is the hardware slot number. The cpu-number is the hardware CPU number. For example, the SP CPU in a Supervisor card on a Cisco Catalyst 6500 series switch located in slot 0 would be specified as node0/0. The RP CPU in a Supervisor card on a Cisco Catalyst 6500 series switch located in slot 0 would be addressed as node0/1. If the node argument is not specified, the default node specification is always the regular expression pattern match of * representing all applicable nodes. |
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
|
tag |
Tag is acceptable but ignored. Cisco IOS EEM scripts with the tag option can run in an Cisco IOS XR7 software environment without any error. Since Cisco IOS XR7 software does not support multiple events, the tag has no effect. |
If an optional argument is not specified, the event matches all possible values of the argument. If multiple arguments are specified, the process event will be raised when all the conditions are matched.
None
No
Registers for a Simple Network Management Protocol (SNMP) notification trap event. Use this Tcl command extension to run a policy when an SNMP trap with the specified SNMP object ID (oid) is encountered on a specific interface or address. The snmp-server manager CLI command must be enabled for the SNMP notifications to work using Tcl policies.
event_register_snmp_notification [tag ?] oid ? oid_val ?
op {gt|ge|eq|ne|lt|le}
[src_ip_address ?]
[dest_ip_address ?]
[queue_priority {normal|low|high|last}]
[maxrun ?]
[nice {0|1}]
[default ?]
[direction {incoming|outgoing}]
[msg_op {drop|send}]
|
tag |
(Optional) String identifying a tag that can be used with the trigger Tcl command extension to support multiple event statements within a Tcl script. |
|
oid |
(Mandatory) OID number of the data element in SNMP dot notation (for example, 1.3.6.1.2.1.2.1.0). If the specified OID ends with a dot (.), then all OIDs that start with the OID number before the dot are matched. It supports all OID supported by SNMP in XR. |
|
oid_val |
(Mandatory) OID value with which the current OID data value should be compared to decide if the SNMP event should be raised. |
|
op |
(Mandatory) Comparison operator used to compare the current OID data value with the SNMP Protocol Data Unit (PDU) OID data value; if this is true, an event is raised. |
|
src_ip_address |
(Optional) Source IP address where the SNMP notification trap originates. The default is all; it is set to receive SNMP notification traps from all IP addresses. This option will not be supported in XR as src_ip_address is only for incoming trap which is not supported in EEM XR. |
|
dest_ip_address |
(Optional) Destination IP address where the SNMP notification trap is sent. The default is all; it is set to receive SNMP traps from all destination IP addresses. |
|
default |
(Optional) Specifies the time period in seconds during which the snmp notification event detector waits for the policy to exit. Thetime periodis specified in ssssssssss[.mmm] format, where ssssssssss must be an integer representing seconds between 0 and 4294967295 and mmm must be an integer representing milliseconds between 0 and 999 |
|
direction |
(Optional) The direction of the incoming or outgoing SNMP trap or inform PDU to filter. The default value is outgoing. For XR direction incoming will not be supported and policy registration will fail if user provides direction as incoming. |
|
msg_op |
(Optional) The action to be taken on the SNMP PDU (drop it or send it) once the event is triggered. The default value is send. For XR msg_op drop will not be supported and policy registration will fail if user provides msg_op as drop. |
None
No
Registers for a syslog event. Use this Tcl command extension to trigger a policy when a syslog message of a specific pattern is logged after a certain number of occurrences during a certain period of time.
event_register_syslog [occurs ?] [period ?] pattern ?
[priority all|emergencies|alerts|critical|errors|warnings|notifications|
informational|debugging|0|1|2|3|4|5|6|7]
[queue_priority low|normal|high]
[severity_fatal] [severity_critical] [severity_major]
[severity_minor] [severity_warning] [severity_notification]
[severity_normal] [severity_debugging]
[maxrun ?] [nice 0|1]
|
occurs |
(Optional) Number of occurrences before the event is raised; if not specified, the event is raised on the first occurrence. If specified, the value must be greater than 0. |
|
period |
(Optional) Time interval, in seconds and milliseconds, during which the one or more occurrences must take place in order to raise an event (specified in SSSSSSSSSS[.MMM] format where SSSSSSSSSS must be an integer number representing seconds between 0 and 4294967295, inclusive, and where MMM represents milliseconds and must be an integer number between 0 and 999). If this argument is not specified, no period check is applied. |
|
pattern |
(Mandatory) Regular expression used to perform syslog message pattern match. This argument is what the policy uses to identify the logged syslog message. |
|
priority |
(Optional) Message priority to be screened. If this argument is specified, only messages that are at the specified logging priority level, or lower, are screened. If this argument is not specified, the default priority is 0. |
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
If multiple conditions are specified, the syslog event is raised when all the conditions are matched.
|
Severity Keyword |
Syslog Priority |
Description |
|---|---|---|
|
severity_fatal |
LOG_EMERG (0) |
System is unusable. |
|
severity_critical |
LOG_ALERT (1) |
Critical conditions, immediate attention required. |
|
severity_major |
LOG_CRIT (2) |
Major conditions. |
|
severity_minor |
LOG_ERR (3) |
Minor conditions. |
|
severity_warning |
LOG_WARNING (4) |
Warning conditions. |
|
severity_notification |
LOG_NOTICE (5) |
Basic notification, informational messages. |
|
severity_normal |
LOG_INFO (6) |
Normal event, indicates returning to a normal state. |
|
severity_debugging |
LOG_DEBUG (7) |
Debugging messages. |
None
No
Creates a timer and registers for a timer event as both a publisher and a subscriber. Use this Tcl command extension when there is a need to trigger a policy that is time specific or timer based. This event timer is both an event publisher and a subscriber. The publisher part indicates the conditions under which the named timer is to go off. The subscriber part identifies the name of the timer to which the event is subscribing.
Note |
Both the CRON and absolute time specifications work on local time. |
event_register_timer watchdog|countdown|absolute|cron
[name ?] [cron_entry ?]
[time ?]
[queue_priority low|normal|high] [maxrun ?]
[nice 0|1]
|
watchdog |
(Mandatory) Watchdog timer. |
|
countdown |
(Mandatory) Countdown timer. |
|
absolute |
(Mandatory) Absolute timer. |
|
cron |
(Mandatory) CRON timer. |
|
name |
(Optional) Name of the timer. |
|
cron_entry |
(Optional) Entry must be specified if the CRON timer type is specified. Must not be specified if any other timer type is specified. A cron_entry is a partial UNIX crontab entry (the first five fields) as used with the UNIX CRON daemon. A cron_entry specification consists of a text string with five fields. The fields are separated by spaces. The fields represent the time and date when CRON timer events will be triggered. The fields are described in Table 1. Ranges of numbers are allowed. Ranges are two numbers separated with a hyphen. The specified range is inclusive. For example, 8-11 for an hour entry specifies execution at hours 8, 9, 10, and 11. A field may be an asterisk (*), which always stands for "first-last." Lists are allowed. A list is a set of numbers (or ranges) separated by commas. Examples: "1,2,5,9" and "0-4,8-12". Step values can be used in conjunction with ranges. Following a range with "/<number>" specifies skips of the number's value through the range. For example, "0-23/2" is used in the hour field to specify an event that is triggered every other hour. Steps are also permitted after an asterisk, so if you want to say "every two hours", use "*/2". Names can also be used for the month and the day of week fields. Use the first three letters of the particular day or month (case does not matter). Ranges or lists of names are not allowed. The day on which a timer event is triggered can be specified by two fields: day of month and day of week. If both fields are restricted (that is, are not *), an event will be triggered when either field matches the current time. For example, "30 4 1,15 * 5" would cause an event to be triggered at 4:30 a.m. on the 1st and 15th of each month, plus every Friday. Instead of the first five fields, one of seven special strings may appear. These seven special strings are described in Table 2 Example 1: "0 0 1,15 * 1" would trigger an event at midnight on the 1st and 15th of each month, as well as on every Monday. To specify days by only one field, the other field should be set to *; "0 0 * * 1" would trigger an event at midnight only on Mondays. Example 2: "15 16 1 * *" would trigger an event at 4:15 p.m. on the first day of each month. Example 3: "0 12 * * 1-5" would trigger an event at noon on Monday through Friday of each week. Example 4: "@weekly" would trigger an event at midnight once a week on Sunday. |
|
time |
(Optional) Time must be specified if a timer type other than CRON is specified. Must not be specified if the CRON timer type is specified. For watchdog and countdown timers, the number of seconds and milliseconds until the timer expires; for the absolute timer, the calendar time of the expiration time. Time is specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999. An absolute expiration date is the number of seconds and milliseconds since January 1, 1970. If the date specified has already passed, the timer expires immediately. |
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
|
Field |
Allowed Values |
|---|---|
|
minute |
0-59 |
|
hour |
0-23 |
|
day of month |
1-31 |
|
month |
1-12 (or names, see Table 2) |
|
day of week |
0-7 (0 or 7 is Sun, or names; see Table 2) |
|
String |
Meaning |
|---|---|
|
@yearly |
Trigger once a year, "0 0 1 1 *". |
|
@annually |
Same as @yearly. |
|
@monthly |
Trigger once a month, "0 0 1 * *". |
|
@weekly |
Trigger once a week, "0 0 * * 0". |
|
@daily |
Trigger once a day, "0 0 * * *". |
|
@midnight |
Same as @daily. |
|
@hourly |
Trigger once an hour, "0 * * * *". |
None
No
Registers for a timer event as a subscriber. Use this Tcl command extension to identify the name of the timer to which the event timer, as a subscriber, wants to subscribe. The event timer depends on another policy or another process to actually manipulate the timer. For example, let policyB act as a timer subscriber policy, but policyA (although it does not need to be a timer policy) uses register_timer, timer_arm, or timer_cancel Tcl command extensions to manipulate the timer referenced in policyB.
event_register_timer_subscriber watchdog|countdown|absolute|cron
name ? [queue_priority low|normal|high] [maxrun ?] [nice 0|1]
|
watchdog |
(Mandatory) Watchdog timer. |
|
countdown |
(Mandatory) Countdown timer. |
|
absolute |
(Mandatory) Absolute timer. |
|
cron |
(Mandatory) CRON timer. |
|
name |
(Mandatory) Name of the timer. |
|
queue_priority |
(Optional) Priority level at which the script will be queued; normal priority is greater than low priority but less than high priority. The priority here is not execution priority, but queuing priority. If this argument is not specified, the default priority is normal. |
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
Note |
An EEM policy that registers for a timer event or a counter event can act as both publisher and subscriber. |
None
No
Registers for a report event from the Object Tracking component in XR. Use this Tcl command extension to trigger a policy on the basis of a Object Tracking component report for a specified track. This will be implemented as a new process in IOS-XR which will be dlrsc_tracker. Please note that the manageability package should be installed for the track ED to be functional.
event_register_track ? [tag ?] [state up|down|any] [queue_priority low|normal|high|last]
[maxrun ?]
[nice 0|1]
|
? (represents a string) |
(Mandatory) Tracked object name. |
||
|
tag |
(Optional) String identifying a tag that can be used with the trigger Tcl command extension to support multiple event statements within a Tcl script. |
||
|
state |
(Optional) Specifies that the tracked object transition will cause an event to be raised. If up is specified, an event will be raised when the tracked object transitions from a down state to an up state. If down is specified, an event will be raised when the tracked object transitions from an up state to a down state. If any is specified, an event will be raised when the tracked object transitions to or from any state. |
||
|
queue_priority |
(Optional) Priority level at which the script will be queued:
If more than one script is registered with the "queue_priority_last" argument set, these scripts will execute in the order in which the events are published.
If this argument is not specified, the default queuing priority is normal. |
||
|
maxrun |
(Optional) Maximum run time of the script (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). If this argument is not specified, the default 20-second run-time limit is used. |
||
|
nice |
(Optional) Policy run-time priority setting. When the nice argument is set to 1, the policy is run at a run-time priority that is less than the default priority. The default value is 0. |
If an optional argument is not specified, the event matches all possible values of the argument.
None
No
The following EEM Event Information Tcl Command Extensions are supported:
Queries information for the event that caused the current policy to run.
event_reqinfo
None
If the policy runs successfully, the characteristics for the event that triggered the policy will be returned. The following sections show the characteristics returned for each event detector.
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"sub_system 0x%x type %u data1 {%s} data2 {%s} data3 {%s} data4 {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
The time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
sub_system |
Number assigned to the EEM policy that published the application event. Number is set to 798 because all other numbers are reserved for Cisco use. |
|
type |
Event subtype within the specified component. |
|
data1data2data3data4 |
Argument data that is passed to the application-specific event when the event is published. The data is character text, an environment variable, or a combination of the two. |
"event_id %u event_type %u event_type_string {%s} %u event_pub_sec %u event_pub_msec %u"
"name {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
The time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
name |
Counter name. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"slot %u event %s"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event ID. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
slot |
Slot number for the affected card. |
|
event |
Indicates a string, removed or online, that represents either an OIR removal event or an OIR insertion event. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"sub_system 0x%x instance %u process_name {%s} path {%s} exit_status 0x%x"
"respawn_count %u last_respawn_sec %ld last_respawn_msec %ld fail_count %u"
"dump_count %u node_name {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
sub_system |
Number assigned to the EEM policy that published the application-specific event. Number is set to 798 because all other numbers are reserved for Cisco use. |
|
instance |
Process instance ID. |
|
process_name |
Process name. |
|
path |
Process absolute name including path. |
|
exit_status |
Process last exit status. |
|
respawn_count |
Number of times that the process was restarted. |
|
last_respawn_seclast_respawn_msec |
Calendar time when the last restart occurred. |
|
fail_count |
Number of restart attempts of the process that failed. This count will be reset to 0 when the process is successfully restarted. |
| Event Type | Description |
|
dump_count |
Number of core dumps taken of the process. |
|
node_name |
Name of the node that the process is on. The node name is a string that consists of the word “node” followed by two fields separated by a slash character using the following format: node<slot-number>/<cpu-number> The slot-number is the hardware slot number. The cpu-number is the hardware CPU number. |
"event_id %u event_type %u event_type_string {%s} %u event_pub_sec %u event_pub_msec %u"
"event {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
event |
RF progression or status event notification that caused this event to be published. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"msg {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
msg |
Last syslog message that matches the pattern. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"timer_type %s timer_time_sec %ld timer_time_msec %ld"
"timer_remain_sec %ld timer_remain_msec %ld"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
timer_type |
Type of the timer. Can be one of the following:
|
|
timer_time_sectimer_time_msec |
Time when the timer expired. |
|
timer_remain_sectimer_remain_msec |
Remaining time before the next expiration. |
"event_id %u event_type %u event_type_string {%s} event_pub_sec %u event_pub_msec %u"
"timer_type {%s} timer_time_sec %ld timer_time_msec %ld"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
timer_type |
Type of the timer. |
|
timer_time_sectimer_time_msec |
Time when the timer expired. |
"event_id %u event_type %u event_type_string {%s} %u event_pub_sec %u event_pub_msec %u"
"track_number {%u} track_state {%s}"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event ID. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
track_number |
Number of the tracked object that caused the event to be triggered. |
|
track_state |
State of the tracked object when the event was triggered; valid states are up or down. |
"event_id %u event_type %u event_type_string {%s} %u event_pub_sec %u event_pub_msec %u"
"num_subs %u"
|
Event Type |
Description |
|---|---|
|
event_id |
Unique number that indicates the ID for this published event. Multiple policies may be run for the same event, and each policy will have the same event_id. |
|
event_type |
Type of event. |
|
event_type_string |
ASCII string that represents the name of the event for this event type. |
|
event_pub_secevent_pub_msec |
Time, in seconds and milliseconds, when the event was published to the Embedded Event Manager. |
|
num_subs |
Subevent number. |
Where the subevent info string is for a deadlock subevent:
"{type %s num_entries %u entries {entry 1, entry 2, ...}}"
|
Subevent Type |
Description |
|---|---|
|
type |
Type of wdsysmon subevent. |
|
num_entries |
Number of processes and threads in the deadlock. |
|
entries |
Information of processes and threads in the deadlock. |
Where each entry is:
"{node {%s} procname {%s} pid %u tid %u state %s b_node %s b_procname %s b_pid %u
b_tid %u}"
Assume that the entry describes the scenario in which Process A thread m is blocked on process B thread n:
|
Subevent Type |
Description |
|---|---|
|
node |
Name of the node that process A thread m is on. |
|
procname |
Name of process A. |
|
pid |
Process ID of process A. |
|
tid |
Thread ID of process A thread m. |
|
state |
Thread state of process A thread m. Can be one of the following:
|
|
b_node |
Name of the node that process B thread is on. |
|
b_procname |
Name of process B. |
|
b_pid |
Process ID of process B. |
|
b_tid |
Thread ID of process B thread n; 0 means that process A thread m is blocked on all threads of process B. |
"{type %s node {%s} procname {%s} pid %u value %u sec %ld msec %ld}"
|
Subevent Type |
Description |
||
|---|---|---|---|
|
type |
Type of wdsysmon subevent. |
||
|
node |
Name of the node that the POSIX process is on. |
||
|
procname |
POSIX process name for this subevent. |
||
|
pid |
POSIX process ID for this subevent.
|
||
|
value |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the number of events processed by the dispatch manager is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the total number of events processed by this dispatch manager is in the given time window. |
||
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
"{type %s node {%s} procname {%s} pid %u value %u sec %ld msec %ld}"
|
Subevent Type |
Description |
||
|---|---|---|---|
|
type |
Type of wdsysmon subevent. |
||
|
node |
Name of the node that the POSIX process is on. |
||
|
procname |
POSIX process name for this subevent. |
||
|
pid |
POSIX process ID for this subevent.
|
||
|
value |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the process CPU utilization is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged process CPU utilization is in the given time window. |
||
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
"{type %s node {%s} value %u sec %ld msec %ld}"
|
Subevent Type |
Description |
|---|---|
|
type |
Type of wdsysmon subevent. |
|
node |
Name of the node on which the total CPU utilization is being monitored. |
|
value |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the total CPU utilization is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged total CPU utilization is in the given time window. |
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
"{type %s node {%s} procname {%s} pid %u is_percent %s value %u diff %d sec %ld msec %ld}"
|
Subevent Type |
Description |
||
|---|---|---|---|
|
type |
Type of wdsysmon subevent. |
||
|
node |
Name of the node that the POSIX process is on. |
||
|
procname |
POSIX process name for this subevent. |
||
|
pid |
POSIX process ID for this subevent.
|
||
|
is_percent |
Can be either TRUE or FALSE. TRUE means that the value is a percentage value; FALSE means that the value is an absolute value (may be an averaged value). |
||
|
value |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the process used memory is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged process used memory utilization is in the given time window. |
||
| Subevent Type | Description | ||
|
diff |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the diff is the percentage difference between the first process used memory sample ever collected and the latest process used memory sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the diff is the percentage difference between the oldest and latest process used memory utilization in the specified time window. |
||
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
If the is_percent argument is FALSE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
value is the process used memory in the latest sample.
diff is 0.
sec and msec are both 0.
If the is_percent argument is FALSE, and a time window is specified as greater than zero in the event registration Tcl command extension:
value is the averaged process used memory sample value in the specified time window.
diff is 0.
sec and msec are both the actual time difference between the time stamps of the oldest and latest samples in this time window.
If the is_percent argument is TRUE, and a time window is specified as greater than zero in the event registration Tcl command extension:
value is 0.
diff is the percentage difference between the oldest and latest process used memory samples in the specified time window.
sec and msec are the actual time difference between the time stamps of the oldest and latest process used memory samples in this time window.
If the is_percent argument is TRUE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
value is 0.
diff is the percentage difference between the first process used memory sample ever collected and the latest process used memory sample.
sec and msec are the actual time difference between the time stamps of the first process used memory sample ever collected and the latest process used memory sample.
"{type %s node {%s} is_percent %s used %u avail %u diff %d sec %ld msec %ld}"
|
Subevent Type |
Description |
|---|---|
|
type |
Type of wdsysmon subevent. |
|
node |
Name of the node for which the total available memory is being monitored. |
|
is_percent |
Can be either TRUE or FALSE. TRUE means that the value is a percentage value; FALSE means that the value is an absolute value (may be an averaged value). |
|
used |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the total used memory is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged total used memory utilization is in the given time window. |
|
avail |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the avail is in the latest total available memory sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the avail is the total available memory utilization in the specified time window. |
|
diff |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the diff is the percentage difference between the first total available memory sample ever collected and the latest total available memory sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the diff is the percentage difference between the oldest and latest total available memory utilization in the specified time window. |
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, they are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
If the is_percent argument is FALSE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
used is the total used memory in the latest sample.
avail is the total available memory in the latest sample.
diff is 0.
sec and msec are both 0.
If the is_percent argument is FALSE, and a time window is specified as greater than zero in the event registration Tcl command extension:
used is 0.
avail is the averaged total available memory sample value in the specified time window.
diff is 0.
sec and msec are both the actual time difference between the time stamps of the oldest and latest total available memory samples in this time window.
If the is_percent argument is TRUE, and a time window is specified as greater than zero in the event registration Tcl command extension:
used is 0.
avail is 0.
diff is the percentage difference between the oldest and latest total available memory samples in the specified time window.
sec and msec are both the actual time difference between the time stamps of the oldest and latest total available memory samples in this time window.
If the is_percent argument is TRUE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
used is 0.
avail is 0.
diff is the percentage difference between the first total available memory sample ever collected and the latest total available memory sample.
sec and msec are the actual time difference between the time stamps of the first total available memory sample ever collected and the latest total available memory sample.
"{type %s node {%s} is_percent %s used %u avail %u diff %d sec %ld msec %ld}"
|
Subevent Type |
Description |
|---|---|
|
type |
Type of wdsysmon subevent. |
|
node |
Name of the node for which the total used memory is being monitored. |
|
is_percent |
Can be either TRUE or FALSE. TRUE means that the value is a percentage value; FALSE means that the value is an absolute value (may be an averaged value). |
|
used |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the total used memory is in the latest sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the averaged total used memory utilization is in the given time window. |
|
avail |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the avail is in the latest total used memory sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the avail is the total used memory utilization in the specified time window. |
|
diff |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, the diff is the percentage difference between the first total used memory sample ever collected and the latest total used memory sample. If a time window is specified and is greater than zero in the event registration Tcl command extension, the diff is the percentage difference between the oldest and latest total used memory utilization in the specified time window. |
|
secmsec |
If the sec and msec variables are specified as 0 or are unspecified in the event registration Tcl command extension, they are both 0. If a time window is specified and is greater than zero in the event registration Tcl command extension, the sec and msec variables are the actual time difference between the time stamps of the oldest and latest samples in this time window. |
If the is_percent argument is FALSE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
used is the total used memory in the latest sample,
avail is the total available memory in the latest sample,
diff is 0,
sec and msec are both 0,
If the is_percent argument is FALSE, and a time window is specified as greater than zero in the event registration Tcl command extension:
used is the averaged total used memory sample value in the specified time window,
avail is 0,
diff is 0,
sec and msec are both the actual time difference between the time stamps of the oldest and latest total used memory samples in this time window,
If the is_percent argument is TRUE, and a time window is specified as greater than zero in the event registration Tcl command extension:
used is 0.
avail is 0.
diff is the percentage difference between the oldest and latest total used memory samples in the specified time window.
sec and msec are both the actual time difference between the time stamps of the oldest and latest total used memory samples in this time window.
If the is_percent argument is TRUE, and the sec and msec arguments are specified as 0 or are unspecified in the event registration Tcl command extension:
used is 0.
avail is 0.
diff is the percentage difference between the first total used memory sample ever collected and the latest total used memory sample.
sec and msec are the actual time difference between the time stamps of the first total used memory sample ever collected and the latest total used memory sample.
Yes
Starts, restarts, or kills a Software Modularity process. This Tcl command extension is supported only in Software Modularity images.
action_process start|restart|kill [job_id ?]
[process_name ?] [instance ?]
|
start |
(Mandatory) Specifies that a process is to be started. |
|
restart |
(Mandatory) Specifies that a process is to be restarted. |
|
kill |
(Mandatory) Specifies that a process is to be stopped (killed). |
|
job_id |
(Optional) System manager assigned job ID for the process. If you specify this argument, it must be an integer between 1 and 4294967295, inclusive. |
|
process_name |
(Optional) Process name. Either job_id must be specified or process_name and instance must be specified. |
|
instance |
(Optional) Process instance ID. If you specify this argument, it must be an integer between 1 and 4294967295, inclusive. |
None
Yes
(_cerr_sub_err = 14) FH_ENOSUCHACTION (unknown action type)
This error means that the action command requested was unknown.
(_cerr_sub_num = 425, _cerr_sub_err = 1) SYSMGR_ERROR_INVALID_ARGS (Invalid arguments passed)
This error means that the arguments passed in were invalid.
(_cerr_sub_num = 425, _cerr_sub_err = 2) SYSMGR_ERROR_NO_MEMORY (Could not allocate required memory)
This error means that an internal SYSMGR request for memory failed.
(_cerr_sub_num = 425, _cerr_sub_err = 5) SYSMGR_ERROR_NO_MATCH (This process is not known to sysmgr)
This error means that the process name was not known.
(_cerr_sub_num = 425, _cerr_sub_err = 14) SYSMGR_ERROR_TOO_BIG (outside the valid limit)
This error means that an object size exceeded its maximum.
(_cerr_sub_num = 425, _cerr_sub_err = 15) SYSMGR_ERROR_INVALID_OP (Invalid operation for this process)
This error means that the operation was invalid for the process.
Allows a Tcl script to run a POSIX process (program), optionally with a given argument string, environment string, Standard Input (stdin) pathname, Standard Output (stdout) pathname, or Standard Error (stderr) pathname. This Tcl command extension is supported only in Software Modularity images.
action_program path ? [argv ?] [envp ?] [stdin ?] [stdout ?] [stderr ?]
|
path |
(Mandatory) Pathname of a program to run. |
|
argv |
(Optional) Argument string of the program. |
|
envp |
(Optional) Environment string of the program. |
|
stdin |
(Optional) Pathname for stdin. |
|
stdout |
(Optional) Pathname for stdout. |
|
stderr |
(Optional) Pathname for stderr. |
None
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 14) FH_ENOSUCHACTION (unknown action type)
This error means that the action command requested was unknown.
(_cerr_sub_err = 34) FH_EMAXLEN (maximum length exceeded)
This error means that the object length or number exceeded the maximum.
Allows a Tcl script to enable or disable the execution of all Tcl scripts (enables or disables the script scheduler).
action_script [status enable|disable]
|
status |
(Optional) Flag to indicate script execution status. If this argument is set to enable, script execution is enabled; if this argument is set to disable, script execution is disabled. |
None
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 14) FH_ENOSUCHACTION (unknown action type)
This error means that the action command requested was unknown.
(_cerr_sub_err = 52) FH_ECONFIG (configuration error)
This error means that a configuration error has occurred.
Switches to the given node to enable subsequent EEM commands to be performed on that node. The following EEM commands use action_setnode to set their target node:
action_process
sys_reqinfo_proc
sys_reqinfo_proc_all
sys_reqinfo_crash_history
sys_reqinfo_proc_version
action_setnode [node ?]
|
node |
(Mandatory) Name of the node. |
None
Yes
Logs a message.
action_syslog [priority emerg|alert|crit|err|warning|notice|info|debug]
[msg ?]
|
priority |
(Optional) Action_syslog message facility level. If this argument is not specified, the default priority is LOG_INFO. |
|
msg |
(Optional) Message to be logged. |
None
Yes
(_cerr_sub_err = 14) FH_ENOSUCHACTION (unknown action type)
This error means that the action command requested was unknown.
Reads Embedded Event Manager (EEM) application volatile data. This Tcl command extension provides support for reading EEM application volatile data. EEM application volatile data can be published by a Cisco IOS XR7 software process that uses the EEM application publish API. EEM application volatile data cannot be published by an EEM policy.
Note |
Currently there are no Cisco IOS XR software processes that publish application volatile data. |
appl_read name ? length ?
|
name |
(Mandatory) Name of the application published string data. |
|
length |
(Mandatory) Length of the string data to read. Must be an integer number between 1 and 4294967295, inclusive. |
data %s
Where data is the application published string data to be read.
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 7) FH_ENOSUCHKEY (could not find key)
This error means that the application event detector info key or other ID was not found.
(_cerr_sub_err = 9) FH_EMEMORY (insufficient memory for request)
This error means that an internal EEM request for memory failed.
Retrieves previously saved information from the Embedded Event Manager (EEM). This Tcl command extension provides support for retrieving information from EEM that has been previously saved with a unique key, which must be specified in order to retrieve the information. Note that retrieving the information deletes it from EEM. It must be resaved if it is to be retrieved again.
appl_reqinfo key ?
|
key |
(Mandatory) String key of the data. |
data %s
Where data is the application string data to be retrieved.
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 7) FH_ENOSUCHKEY (could not find key)
This error means that the application event detector info key or other ID was not found.
Saves information in the EEM. This Tcl command extension provides support for saving information in the EEM that can be retrieved later by the same policy or by another policy. A unique key must be specified. This key allows the information to be retrieved later.
appl_setinfo key ? data ?
|
key |
(Mandatory) String key of the data. |
|
data |
(Mandatory) Application string data to save. |
None
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 8) FH_EDUPLICATEKEY (duplicate appl info key)
This error means that the application event detector info key or other ID was a duplicate.
(_cerr_sub_err = 9) FH_EMEMORY (insufficient memory for request)
This error means that an internal EEM request for memory failed.
(_cerr_sub_err = 34) FH_EMAXLEN (maximum length exceeded)
This error means that the object length or number exceeded the maximum.
(_cerr_sub_err = 43) FH_EBADLENGTH (bad API length)
This error means that the API message length was invalid.
Modifies a counter value.
counter_modify event_id ? val ? op nop|set|inc|dec
|
event_id |
(Mandatory) Counter event ID returned by the register_counter Tcl command extension. Must be an integer between 0 and 4294967295, inclusive. |
|
val |
(Mandatory)
|
|
op |
(Mandatory)
|
val_remain %d
Where val_remain is the current value of the counter.
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 11) FH_ENOSUCHESID (unknown event specification ID)
This error means that the event specification ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt.
(_cerr_sub_err = 22) FH_ENULLPTR (event detector internal error - ptr is null)
This error means that an internal EEM event detector pointer was null when it should have contained a value.
(_cerr_sub_err = 30) FH_ECTBADOPER (bad counter threshold operator)
This error means that the counter event detector set or modify operator was invalid.
Arms a timer. The type could be CRON, watchdog, countdown, or absolute.
timer_arm event_id ? cron_entry ?|time ?
|
event_id |
(Mandatory)Timer event ID returned by the register_timer command extension. Must be an integer between 0 and 4294967295, inclusive. |
|
cron_entry |
(Mandatory) Must exist if the timer type is CRON. Must not exist for other types of timer. CRON timer specification uses the format of the CRON table entry. |
|
time |
(Mandatory) Must exist if the timer type is not CRON. Must not exist if the timer type is CRON. For watchdog and countdown timers, the number of seconds and milliseconds until the timer expires; for an absolute timer, the calendar time of the expiration time (specified in SSSSSSSSSS[.MMM] format, where SSSSSSSSSS must be an integer representing seconds between 0 and 4294967295, inclusive, and where MMM must be an integer representing milliseconds between 0 and 999). An absolute expiration date is the number of seconds and milliseconds since January 1, 1970. If the date specified has already passed, the timer expires immediately. |
sec_remain %ld msec_remain %ld
Where sec_remain and msec_remain are the remaining time before the next expiration of the timer.
Note |
A value of 0 is returned for the sec_remain and msec_remain arguments if the timer type is CRON. |
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 6) FH_EBADEVENTTYPE (unknown EEM event type)
This error means that the event type specified in the internal event specification was invalid.
(_cerr_sub_err = 9) FH_EMEMORY (insufficient memory for request)
This error means that an internal EEM request for memory failed.
(_cerr_sub_err = 11) FH_ENOSUCHESID (unknown event specification ID)
This error means that the event specification ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt.
(_cerr_sub_err = 12) FH_ENOSUCHEID (unknown event ID)
This error means that the event ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt.
(_cerr_sub_err = 22) FH_ENULLPTR (event detector internal error - ptr is null)
This error means that an internal EEM event detector pointer was null when it should have contained a value.
(_cerr_sub_err = 27) FH_ETMDELAYZR (zero delay time)
This error means that the time specified to arm a timer was zero.
(_cerr_sub_err = 42) FH_ENOTREGISTERED (request for event spec that is unregistered)
This error means that the event was not registered.
(_cerr_sub_err = 54) FH_EFDUNAVAIL (connection to event detector unavailable)
This error means that the event detector was unavailable.
(_cerr_sub_err = 56) FH_EFDCONNERR (event detector connection error)
This error means that the EEM event detector that handles this request is not available.
Cancels a timer.
timer_cancel event_id ?
|
event_id |
(Mandatory) Timer event ID returned by the register_timer command extension. Must be an integer between 0 and 4294967295, inclusive. |
sec_remain %ld msec_remain %ld
Where sec_remain and msec_remain are the remaining time before the next expiration of the timer.
Note |
A value of 0 will be returned for sec_remain and msec_remain if the timer type is CRON. |
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 6) FH_EBADEVENTTYPE (unknown EEM event type)
This error means that the event type specified in the internal event specification was invalid.
(_cerr_sub_err = 7) FH_ENOSUCHKEY (could not find key)
This error means that the application event detector info key or other ID was not found.
(_cerr_sub_err = 11) FH_ENOSUCHESID (unknown event specification ID)
This error means that the event specification ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt.
(_cerr_sub_err = 12) FH_ENOSUCHEID (unknown event ID)
This error means that the event ID could not be matched when the event was being registered or that an event detector internal event structure is corrupt.
(_cerr_sub_err = 22) FH_ENULLPTR (event detector internal error - ptr is null)
This error means that an internal EEM event detector pointer was null when it should have contained a value.
(_cerr_sub_err = 54) FH_EFDUNAVAIL (connection to event detector unavailable)
This error means that the event detector was unavailable.
(_cerr_sub_err = 56) FH_EFDCONNERR (event detector connection error)
This error means that the EEM event detector that handles this request is not available.
Note |
All EEM system information commands—sys_reqinfo _xxx—have the Set _cerrno section set to yes. |
Queries the CPU utilization of the top processes (both POSIX processes and IOS processes) during a specified time period and in a specified order. This Tcl command extension is supported only in Software Modularity images.
sys_reqinfo_cpu_all order cpu_used [sec ?] [msec ?] [num ?]
|
order |
(Mandatory) Order used for sorting the CPU utilization of processes. |
|
cpu_used |
(Mandatory) Specifies that the average CPU utilization, for the specified time window, will be sorted in descending order. |
|
secmsec |
(Optional) Time period, in seconds and milliseconds, during which the average CPU utilization is calculated. Must be integers in the range from 0 to 4294967295. If not specified, or if both sec and msec are specified as 0, the most recent CPU sample is used. |
|
num |
(Optional) Number of entries from the top of the sorted list of processes to be displayed. Must be an integer in the range from 1 to 4294967295. Default value is 5. |
rec_list {{process CPU info string 0},{process CPU info string 1}, ...}
Where each process CPU info string is:
pid %u name {%s} cpu_used %u
|
rec_list |
Marks the start of the process CPU information list. |
|
pid |
Process ID. |
|
name |
Process name. |
|
cpu_used |
Specifies that if sec and msec are specified with a number greater than zero, the average percentage is calculated from the process CPU utilization during the specified time period. If sec and msec are both zero or not specified, the average percentage is calculated from the process CPU utilization in the latest sample. |
Yes
Queries the crash information of all processes that have ever crashed. This Tcl command extension is supported only in Software Modularity images.
sys_reqinfo_crash_history
None
rec_list {{crash info string 0},{crash info string 1}, ...}
Where each crash info string is:
job_id %u name {%s} respawn_count %u fail_count %u dump_count %u
inst_id %d exit_status 0x%x exit_type %d proc_state {%s} component_id 0x%x
crash_time_sec %ld crash_time_msec %ld
|
job_id |
System manager assigned job ID for the process. An integer between 1 and 4294967295, inclusive. |
|
name |
Process name. |
|
respawn_count |
Total number of restarts for the process. |
|
fail_count |
Number of restart attempts of the process. This count is reset to zero when the process is successfully restarted. |
|
dump_count |
Number of core dumps performed. |
|
inst_id |
Process instance ID. |
|
exit_status |
Last exit status of the process. |
|
exit_type |
Last exit type. |
|
proc_state |
Sysmgr process states. One of the following: error, forced_stop, hold, init, ready_to_run, run, run_rnode, stop, waitEOltimer, wait_rnode, wait_spawntimer, wait_tpl. |
|
component_id |
Version manager assigned component ID for the component to which the process belongs. |
|
crash_time_sec crash_time_msec |
Seconds and milliseconds since January 1, 1970, which represent the last time the process crashed. |
Yes
Queries the memory usage of the top processes (both POSIX and IOS) during a specified time period and in a specified order. This Tcl command extension is supported only in Software Modularity images.
sys_reqinfo_mem_all order allocates|increase|used [sec ?] [msec ?] [num ?]
|
order |
(Mandatory) Order used for sorting the memory usage of processes. |
|
allocates |
(Mandatory) Specifies that the memory usage is sorted by the number of process allocations during the specified time window, and in descending order. |
|
increase |
(Mandatory) Specifies that the memory usage is sorted by the percentage of process memory increase during the specified time window, and in descending order. |
|
used |
(Mandatory) Specifies that the memory usage is sorted by the current memory used by the process. |
|
secmsec |
(Optional) Time period, in seconds and milliseconds, during which the process memory usage is calculated. Must be integers in the range from 0 to 4294967295. If both sec and msec are specified and are nonzero, the number of allocations is the difference between the number of allocations in the oldest and latest samples collected in the time period. The percentage is calculated as the the percentage difference between the memory used in the oldest and latest samples collected in the time period. If not specified, or if both sec and msec are specified as 0, the first sample ever collected is used as the oldest sample; that is, the time period is set to be the time from startup until the current moment. |
|
num |
(Optional) Number of entries from the top of the sorted list of processes to be displayed. Must be an integer in the range from 1 to 4294967295. Default value is 5. |
rec_list {{process mem info string 0},{process mem info string 1}, ...}
Where each process mem info string is:
pid %u name {%s} delta_allocs %d initial_alloc %u current_alloc %u percent_increase %d
|
rec_list |
Marks the start of the process memory usage information list. |
|
pid |
Process ID. |
|
name |
Process name. |
|
delta_allocs |
Specifies the difference between the number of allocations in the oldest and latest samples collected in the time period. |
|
initial_alloc |
Specifies the amount of memory, in kilobytes, used by the process at the start of the time period. |
|
current_alloc |
Specifies the amount of memory, in kilobytes, currently used by the process. |
|
percent_increase |
Specifies the percentage difference between the memory used in the oldest and latest samples collected in the time period. The percentage difference can be expressed as current_alloc minus initial_alloc times 100 and divided by initial_alloc. |
Yes
Queries the information about a single POSIX process. This Tcl command extension is supported only in Software Modularity images.
sys_reqinfo_proc job_id ?
|
job_id |
(Mandatory) System manager assigned job ID for the process. Must be an integer between 1 and 4294967295, inclusive. |
job_id %u component_id 0x%x name {%s} helper_name {%s} helper_path {%s} path {%s}
node_name {%s} is_respawn %u is_mandatory %u is_hold %u dump_option %d
max_dump_count %u respawn_count %u fail_count %u dump_count %u
last_respawn_sec %ld last_respawn_msec %ld inst_id %u proc_state %s
level %d exit_status 0x%x exit_type %d
|
job_id |
System manager assigned job ID for the process. An integer between 1 and 4294967295, inclusive. |
|
component_id |
Version manager assigned component ID for the component to which the process belongs. |
|
name |
Process name. |
|
helper_name |
Helper process name. |
|
helper_path |
Executable path of the helper process. |
|
path |
Executable path of the process. |
|
node_name |
System manager assigned node name for the node to which the process belongs. |
|
is_respawn |
Flag that specifies that the process can be respawned. |
|
is_mandatory |
Flag that specifies that the process must be alive. |
|
is_hold |
Flag that specifies that the process is spawned until called by the API. |
|
dump_option |
Core dumping options. |
|
max_dump_count |
Maximum number of core dumping permitted. |
|
respawn_count |
Total number of restarts for the process. |
|
fail_count |
Number of restart attempts of the process. This count is reset to zero when the process is successfully restarted. |
|
dump_count |
Number of core dumps performed. |
|
last_respawn_seclast_respawn_msec |
Seconds and milliseconds in POSIX timer units since January 1, 1970, which represent the last time the process was started. |
|
inst_id |
Process instance ID. |
|
proc_state |
Sysmgr process states. One of the following: error, forced_stop, hold, init, ready_to_run, run, run_rnode, stop, waitEOltimer, wait_rnode, wait_spawntimer, wait_tpl. |
|
level |
Process run level. |
|
exit_status |
Last exit status of the process. |
|
exit_type |
Last exit type. |
Yes
Queries the information of all POSIX processes. This Tcl command extension is supported only in Software Modularity images.
sys_reqinfo_proc_all
None
rec_list {{process info string 0}, {process info string 1},...}
Where each process info string is the same as the result string of the sysreq_info_proc Tcl command extension.
Yes
Queries the version of the given process.
sys_reqinfo_proc_version [job_id ?]
|
job_id |
(Mandatory) System manager assigned job ID for the process. The integer number must be inclusively between 1 and 2147483647. |
version_id %02d.%02d.%04d
Where version_id is the version manager that is assigned the version number of the process.
Yes
Queries the router name.
sys_reqinfo_routername
None
routername %s
Where routername is the name of the router.
Yes
Queries the frequency information of all syslog events.
sys_reqinfo_syslog_freq
None
rec_list {{event frequency string 0}, {log freq str 1}, ...}
Where each event frequency string is:
time_sec %ld time_msec %ld match_count %u raise_count %u occurs %u
period_sec %ld period_msec %ld pattern {%s}
|
time_sectime_msec |
Seconds and milliseconds in POSIX timer units since January 1, 1970, which represent the time the last event was raised. |
|
match_count |
Number of times that a syslog message matches the pattern specified by this syslog event specification since event registration. |
|
raise_count |
Number of times that this syslog event was raised. |
|
occurs |
Number of occurrences needed in order to raise the event; if not specified, the event is raised on the first occurrence. |
|
period_secperiod_msec |
Number of occurrences must occur within this number of POSIX timer units in order to raise the event; if not specified, the period check does not apply. |
|
pattern |
Regular expression used to perform syslog message pattern matching. |
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 9) FH_EMEMORY (insufficient memory for request)
This error means that an internal EEM request for memory failed.
(_cerr_sub_err = 22) FH_ENULLPTR (event detector internal error - ptr is null)
This error means that an internal EEM event detector pointer was null when it should have contained a value.
(_cerr_sub_err = 45) FH_ESEQNUM (sequence or workset number out of sync)
This error means that the event detector sequence or workset number was invalid.
(_cerr_sub_err = 46) FH_EREGEMPTY (registration list is empty)
This error means that the event detector registration list was empty.
(_cerr_sub_err = 54) FH_EFDUNAVAIL (connection to event detector unavailable)
This error means that the event detector was unavailable.
Queries the history of the specified syslog message.
sys_reqinfo_syslog_history
None
rec_list {{log hist string 0}, {log hist str 1}, ...}
Where each log hist string is:
time_sec %ld time_msec %ld msg {%s}
|
time_sec time_msec |
Seconds and milliseconds since January 1, 1970, which represent the time the message was logged. |
|
msg |
Syslog message. |
Yes
(_cerr_sub_err = 2) FH_ESYSERR (generic/unknown error from OS/system)
This error means that the operating system reported an error. The POSIX errno value that is reported with the error should be used to determine the cause of the operating system error.
(_cerr_sub_err = 22) FH_ENULLPTR (event detector internal error - ptr is null)
This error means that an internal EEM event detector pointer was null when it should have contained a value.
(_cerr_sub_err = 44) FH_EHISTEMPTY (history list is empty)
This error means that the history list was empty.
(_cerr_sub_err = 45) FH_ESEQNUM (sequence or workset number out of sync)
This error means that the event detector sequence or workset number was invalid.
(_cerr_sub_err = 54) FH_EFDUNAVAIL (connection to event detector unavailable)
This error means that the event detector was unavailable.
Queries the value of the statistic entity that is specified by name, and optionally the first modifier and the second modifier.
sys_reqinfo_stat [name ?][mod1 ?][mod2 ?]
|
name |
(Mandatory) Statistics data element name. |
|
mod_1 |
(Optional) Statistics data element modifier 1. |
|
mod_2 |
(Optional) Statistics data element modifier 2. |
name %s value %s
|
name |
Statistics data element name. |
|
value |
Value string of the statistics data element. |
Yes
Queries the value of the entity specified by a Simple Network Management Protocol (SNMP) object ID.
sys_reqinfo_snmp oid ? get_type exact|next|
oid |
(Mandatory) SNMP OID in dot notation (for example, 1.3.6.1.2.1.2.1.0). |
|
get_type |
(Mandatory) Type of SNMP get operation that needs to be applied to the specified oid. If the get_type is "exact," the value of the specified oid is retrieved; if the get_type is "next," the value of the lexicographical successor to the specified oid is retrieved. |
oid {%s} value {%s}|
oid |
SNMP OID. |
|
value |
Value string of the associated SNMP data element. |
All Simple Mail Transfer Protocol (SMTP) library command extensions belong to the ::cisco::lib namespace.
To use this library, the user needs to provide an e-mail template file. The template file can include Tcl global variables so that the e-mail service and the e-mail text can be configured through the event manager environment Cisco IOS XR7 software command-line interface (CLI) configuration command. There are commands in this library to substitute the global variables in the e-mail template file and to send the desired e-mail context with the To address, CC address, From address, and Subject line properly configured using the configured e-mail server.
The e-mail template file has the following format:
Mailservername:<space><the list of candidate SMTP server addresses>
From:<space><the e-mail address of sender>
To:<space><the list of e-mail addresses of recipients>
Cc:<space><the list of e-mail addresses that the e-mail will be copied to>
Subject:<subject line>
<a blank line>
<body>
Note |
The template normally includes Tcl global variables to be configured. |
The following is a sample e-mail template file:
Mailservername: $_email_server
From: $_email_from
To: $_email_to
Cc: $_email_cc
Subject: From router $routername: Process terminated
process name: $process_name
subsystem: $sub_system
exit status: $exit_status
respawn count: $respawn_count
Given the text of an e-mail template file with all global variables already substituted, sends the e-mail out using Simple Mail Transfer Protocol (SMTP). The e-mail template specifies the candidate mail server addresses, To addresses, CC addresses, From address, subject line, and e-mail body.
Note |
A list of candidate e-mail servers can be provided so that the library will try to connect the servers on the list one by one until it can successfully connect to one of them. |
smtp_send_email text
|
text |
(Mandatory) Text of an e-mail template file with all global variables already substituted. |
None
Wrong 1st line format—Mailservername:list of server names.
Wrong 2nd line format—From:from-address.
Wrong 3rd line format—To:list of to-addresses.
Wrong 4th line format—CC:list of cc-addresses.
Error connecting to mail server:—$sock closed by remote server (where $sock is the name of the socket opened to the mail server).
Error connecting to mail server:—$sock reply code is $k instead of the service ready greeting (where $sock is the name of the socket opened to the mail server; $k is the reply code of $sock).
Error connecting to mail server:—cannot connect to all the candidate mail servers.
Error disconnecting from mail server:—$sock closed by remote server (where $sock is the name of the socket opened to the mail server).
After all needed global variables in the e-mail template are defined:
if [catch {smtp_subst [file join $tcl_library email_template_sm]} result] {
puts stderr $result
exit 1
}
if [catch {smtp_send_email $result} result] {
puts stderr $result
exit 1
}
Given an e-mail template file e-mail_template, substitutes each global variable in the file by its user-defined value. Returns the text of the file after substitution.
smtp_subst e-mail_template
|
e-mail_template |
(Mandatory) Name of an e-mail template file in which global variables need to be substituted by a user-defined value. An example filename could be harddisk:/mirror/example.template which represents a file named example.template in mirror directory on the harddisk. |
The text of the e-mail template file with all the global variables substituted.
cannot open e-mail template file
cannot close e-mail template file
All command-line interface (CLI) library command extensions belong to the ::cisco::eem namespace.
This library provides users the ability to run CLI commands and get the output of the commands in Tcl. Users can use commands in this library to spawn an exec and open a virtual terminal channel to it, write the command to execute to the channel so that the command will be executed by exec, and read back the output of the command.
There are two types of CLI commands: interactive commands and non-interactive commands.
For interactive commands, after the command is entered, there will be a “Q&A” phase in which the router will ask for different user options, and the user is supposed to enter the answer for each question. Only after all the questions have been answered properly will the command run according to the user’s options until completion.
For noninteractive commands, once the command is entered, the command will run to completion. To run different types of commands using an EEM script, different CLI library command sequences should be used, which are documented in the Using the CLI Library to Run a Noninteractive Command and in the Using the CLI Library to Run an Interactive Command.
Closes the exec process and releases the VTY and the specified channel handler connected to the command-line interface (CLI).
cli_close fd tty_id
|
fd |
(Mandatory) The CLI channel handler. |
|
tty_id |
(Mandatory) The TTY ID returned from the cli_open command extension. |
None
Cannot close the channel.
Writes the command to the specified channel handler to execute the command. Then reads the output of the command from the channel and returns the output.
cli_exec fd cmd
|
fd |
(Mandatory) The command-line interface (CLI) channel handler. |
|
cmd |
(Mandatory) The CLI command to execute. |
The output of the CLI command executed.
Error reading the channel.
Returns the real and pseudo tty names for a given TTY ID.
cli_get_ttyname tty_id
|
tty_id |
(Mandatory) The TTY ID returned from the cli_open command extension. |
pty %s tty %s
None
Allocates a vty, creates an EXEC command-line interface (CLI) session, and connects the vty to a channel handler. Returns an array including the channel handler.
Note |
Each call to cli_open initiates a Cisco IOS XR7 software EXEC session that allocates a Cisco IOS XR7 software vty. The vty remains in use until the cli_close routine is called. Vtys are allocated from the pool of vtys that are configured using the line vty vty-pool CLI configuration command. Be aware that the cli_open routine fails when two or fewer vtys are available, preserving the remaining vtys for Telnet use. |
cli_open
None
"tty_id {%s} pty {%d} tty {%d} fd {%d}"
|
Event Type |
Description |
|---|---|
|
tty_id |
TTY ID. |
|
pty |
PTY device name. |
|
tty |
TTY device name. |
|
fd |
CLI channel handler. |
Cannot get pty for EXEC.
Cannot create an EXEC CLI session.
Error reading the first prompt.
Reads the command output from the specified command-line interface (CLI) channel handler until the pattern of the router prompt occurs in the contents read. Returns all the contents read up to the match.
cli_read fd
|
fd |
(Mandatory) CLI channel handler. |
All the contents read.
Cannot get router name.
Note |
This Tcl command extension blocks waiting for the router prompt to show up in the contents read. |
Reads and drains the command output of the specified command-line interface (CLI) channel handler. Returns all the contents read.
cli_read_drain fd
|
fd |
(Mandatory) The CLI channel handler. |
All the contents read.
None
Reads one line of the command output from the specified command-line interface (CLI) channel handler. Returns the line read.
cli_read_line fd
|
fd |
(Mandatory) CLI channel handler. |
The line read.
None
Note |
This Tcl command extension blocks waiting for the end of line to show up in the contents read. |
Reads the command output from the specified command-line interface (CLI) channel handler until the pattern that is to be matched occurs in the contents read. Returns all the contents read up to the match.
Note |
The pattern matching logic attempts a match by looking at the command output data as it is delivered from the Cisco IOS XR7 software command. The match is always done on the most recent 256 characters in the output buffer unless there are fewer characters available, in which case the match is done on fewer characters. If more than 256 characters in the output buffer are required for the match to succeed, the pattern will not match. |
cli_read_pattern fd ptn
|
fd |
(Mandatory) CLI channel handler. |
|
ptn |
(Mandatory) Pattern to be matched when reading the command output from the channel. |
All the contents read.
None
Note |
This Tcl command extension blocks waiting for the specified pattern to show up in the contents read. |
Writes the command that is to be executed to the specified CLI channel handler. The CLI channel handler executes the command.
cli_write fd cmd
|
fd |
(Mandatory) The CLI channel handler. |
|
cmd |
(Mandatory) The CLI command to execute. |
None
None
As an example, use configuration CLI commands to bring up Ethernet interface 1/0:
if [catch {cli_open} result] {
puts stderr $result
exit 1
} else {
array set cli1 $result
}
if [catch {cli_exec $cli1(fd) "config t"} result] {
puts stderr $result
exit 1
}
if [catch {cli_exec $cli1(fd) "interface Ethernet1/0"} result] {
puts stderr $result
exit 1
}
if [catch {cli_exec $cli1(fd) "no shut"} result] {
puts stderr $result
exit 1
}
if [catch {cli_exec $cli1(fd) "end"} result] {
puts stderr $result
exit 1
}
if [catch {cli_close $cli1(fd) $cli1(tty_id)} } result] {
puts stderr $result
exit 1
To run a noninteractive command, use the cli_exec command extension to issue the command, and then wait for the complete output and the router prompt. For example, the following shows the use of configuration CLI commands to bring up Ethernet interface 1/0:
if [catch {cli_open} result] {
error $result $errorInfo
} else {
set fd $result
}
if [catch {cli_exec $fd "config t"} result] {
error $result $errorInfo
}
if [catch {cli_exec $fd "interface Ethernet1/0"} result] {
error $result $errorInfo
}
if [catch {cli_exec $fd "no shut"} result] {
error $result $errorInfo
}
if [catch {cli_exec $fd "end"} result] {
error $result $errorInfo
}
if [catch {cli_close $fd} result] {
error $result $errorInfo
}
To run interactive commands, three phases are needed:
Phase 1: Issue the command using the cli_write command extension.
Phase 2: Q&A Phase. Use the cli_read_pattern command extension to read the question (the regular pattern that is specified to match the question text) and the cli_write command extension to write back the answers alternately.
Phase 3: Noninteractive phase. All questions have been answered, and the command will run to completion. Use the cli_read command extension to wait for the complete output of the command and the router prompt.
For example, use CLI commands to do squeeze bootflash: and save the output of this command in the Tcl variable cmd_output.
if [catch {cli_open} result] {
error $result $errorInfo
} else {
array set cli1 $result
}
# Phase 1: issue the command
if [catch {cli_write $cli1(fd) "squeeze bootflash:"} result] {
error $result $errorInfo
}
# Phase 2: Q&A phase
# wait for prompted question:
# All deleted files will be removed. Continue? [confirm]
if [catch {cli_read_pattern $cli1(fd) "All deleted"} result] {
error $result $errorInfo
}
# write a newline character
if [catch {cli_write $cli1(fd) "\n"} result] {
error $result $errorInfo
}
# wait for prompted question:
# Squeeze operation may take a while. Continue? [confirm]
if [catch {cli_read_pattern $cli1(fd) "Squeeze operation"} result] {
error $result $errorInfo
}
# write a newline character
if [catch {cli_write $cli1(fd) "\n"} result] {
error $result $errorInfo
}
# Phase 3: noninteractive phase
# wait for command to complete and the router prompt
if [catch {cli_read $cli1(fd) } result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_close $cli1(fd) $cli1(tty_id)} result] {
error $result $errorInfo
}
The following example causes a router to be reloaded using the CLI reload command. Note that the EEM action_reload command accomplishes the same result in a more efficient manner, but this example is presented to illustrate the flexibility of the CLI library for interactive command execution.
# 1. execute the reload command
if [catch {cli_open} result] {
error $result $errorInfo
} else {
array set cli1 $result
}
if [catch {cli_write $cli1(fd) "reload"} result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_read_pattern $cli1(fd) ".*(System configuration has been modified. Save\\\? \\\[yes/no\\\]: )"} result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_write $cli1(fd) "no"} result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_read_pattern $cli1(fd) ".*(Proceed with reload\\\? \\\[confirm\\\])"} result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_write $cli1(fd) "y"} result] {
error $result $errorInfo
} else {
set cmd_output $result
}
if [catch {cli_close $cli1(fd) $cli1(tty_id)} result] {
error $result $errorInfo
}
All the Tcl context library command extensions belong to the ::cisco::eem namespace.
Retrieves Tcl variable(s) identified by the given context name, and possibly the scalar variable name, the array variable name, and the array index. Retrieved information is automatically deleted.
Note |
Once saved information is retrieved, it is automatically deleted. If that information is needed by another policy, the policy that retrieves it (using the context_retrieve command extension) should also save it again (using the context_save command extension). |
context_retrieve ctxt [var] [index_if_array]
|
ctxt |
(Mandatory) Context name. |
|
var |
(Optional) Scalar variable name or array variable name. Defaults to a null string if this argument is not specified. |
|
index_if_array |
(Optional) Array index. |
Note |
The index_if_array argument is ignored when the var argument is a scalar variable. |
If var is unspecified, retrieves the whole variable table saved in the context.
If var is specified and index_if_array is not specified, or if index_if_array is specified but var is a scalar variable, retrieves the value of var .
If var is specified, and index_if_array is specified, and var is an array variable, retrieves the value of the specified array element.
Resets the Tcl global variables to the state that they were in when the save was performed.
A string displaying _cerrno, _cerr_sub_num, _cerr_sub_err, _cerr_posix_err, _cerr_str due to appl_reqinfo error.
Variable is not in the context.
The following examples show how to use the context_save and context_retrieve command extension functionality to save and retrieve data. The examples are shown in save and retrieve pairs.
If var is unspecified or if a pattern if specified, saves multiple variables to the context.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
set testvara 123
set testvarb 345
set testvarc 789
if {[catch {context_save TESTCTX “testvar*”} errmsg]} {
action_syslog msg "context_save failed: $errmsg"
} else {
action_syslog msg "context_save succeeded"
}
If var is unspecified, retrieves multiple variables from the context.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
if {[catch {foreach {var value} [context_retrieve TESTCTX] {set $var $value}} errmsg]} {
action_syslog msg "context_retrieve failed: $errmsg"
} else {
action_syslog msg "context_retrieve succeeded"
}
if {[info exists testvara]} {
action_syslog msg "testvara exists and is $testvara"
} else {
action_syslog msg "testvara does not exist"
}
if {[info exists testvarb]} {
action_syslog msg "testvarb exists and is $testvarb"
} else {
action_syslog msg "testvarb does not exist"
}
if {[info exists testvarc]} {
action_syslog msg "testvarc exists and is $testvarc"
} else {
action_syslog msg "testvarc does not exist"
}
If var is specified, saves the value of var.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
set testvar 123
if {[catch {context_save TESTCTX testvar} errmsg]} {
action_syslog msg "context_save failed: $errmsg"
} else {
action_syslog msg "context_save succeeded"
}
If var is specified and index_if_array is not specified, or if index_if_array is specified but var is a scalar variable, retrieves the value of var.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
if {[catch {set testvar [context_retrieve TESTCTX testvar]} errmsg]} {
action_syslog msg "context_retrieve failed: $errmsg"
} else {
action_syslog msg "context_retrieve succeeded"
}
if {[info exists testvar]} {
action_syslog msg "testvar exists and is $testvar"
} else {
action_syslog msg "testvar does not exist"
}
If var is specified, saves the value of var even if it is an array.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
array set testvar “testvar1 ok testvar2 not_ok”
if {[catch {context_save TESTCTX testvar} errmsg]} {
action_syslog msg "context_save failed: $errmsg"
} else {
action_syslog msg "context_save succeeded"
}
If var is specified, and index_if_array is not specified, and var is an array variable, retrieves the entire array.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
if {[catch {array set testvar [context_retrieve TESTCTX testvar]} errmsg]} {
action_syslog msg "context_retrieve failed: $errmsg"
} else {
action_syslog msg "context_retrieve succeeded"
}
if {[info exists testvar]} {
action_syslog msg "testvar exists and is [array get testvar]"
} else {
action_syslog msg "testvar does not exist"
}
If var is specified, saves the value of var even if it is an array.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
array set testvar “testvar1 ok testvar2 not_ok”
if {[catch {context_save TESTCTX testvar} errmsg]} {
action_syslog msg "context_save failed: $errmsg"
} else {
action_syslog msg "context_save succeeded"
}
If var is specified, and index_if_array is specified, and var is an array variable, retrieves the specified array element value.
::cisco::eem::event_register_none
namespace import ::cisco::eem::*
namespace import ::cisco::lib::*
if {[catch {set testvar [context_retrieve TESTCTX testvar testvar1]} errmsg]} {
action_syslog msg "context_retrieve failed: $errmsg"
} else {
action_syslog msg "context_retrieve succeeded"
}
if {[info exists testvar]} {
action_syslog msg "testvar exists and is $testvar"
} else {
action_syslog msg "testvar doesn't exist"
}
Saves Tcl variables that match a given pattern in current and global namespaces with the given context name as identification. Use this Tcl command extension to save information outside of a policy. Saved information can be retrieved by a different policy using the context_retrieve command extension.
Note |
Once saved information is retrieved, it is automatically deleted. If that information is needed by another policy, the policy that retrieves it (using the context_retrieve command extension) should also save it again (using the context_save command extension). |
context_save ctxt [pattern]
|
ctxt |
(Mandatory) Context name. |
|
pattern |
(Optional) Glob-style pattern as used by the string match Tcl command. If this argument is not specified, the pattern defaults to the wildcard *. There are three constructs used in glob patterns:
|
None
A string displaying _cerrno, _cerr_sub_num, _cerr_sub_err, _cerr_str due to appl_setinfo error.
For examples showing how to use the context_save and context_retrieve command extension functionality to save and retrieve data, see the Sample Usage.
Feedback