Embedded Event Manager Configuration Guide, Cisco IOS XE Release 3S (Cisco ASR 1000)
EEM SMTP Library Tcl Command Extensions
EEM SMTP Library Command Extensions
Last Updated: December 14, 2012
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 IOScommand-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> Sourceaddr:<space><the IP addresses of the recipients> Subject:<subject line> <a blank line> <body>
In a Tcl policy, the port number can be specified by a "Port" line in the e-mail template. If port is not specified, the default port of 25 is used.
Below is a sample e-mail template file:
Mailservername: $_email_server From: $_email_from To: $_email_to Cc: $_email_cc Sourceaddr: $_email_ipaddr Port: <port number> 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.
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.
© 2012 Cisco Systems, Inc. All rights reserved.