Monitoring Internet Failover Events Using Cisco EEM and Tcl Script

In situations where you have redundant Internet links in a primary and backup setup, you would want to know whenever a failover event occurs. As soon as such an event occurs you may want to be alerted via email to investigate and contact your Internet service provider if needed. When the primary link comes up, you may want a notification the path is up. This can be achieved using EEM variables in combination with a Tcl script or alternatively by using an Event Manager applet.

This specific instance I describe below is when you have failover controlled and tracked at the router level. This is to say a router with an IP SLA configuration for ICMP echo-replies, a tracking object and a tracked route that gets automatically removed from routing table when the tracking condition is triggered.

To summarize the steps

  • Configure IP SLA, tracking and your tracked routes
  • Define your Cisco EEM environment variables
  • Setup your Tcl script and save it as a file with a .tcl extension
  • TFTP the .tcl file you saved to your router’s flash
  • Specify your Event Manager file’s directory location
  • Register the Event Manager policy

The first order of business is to make sure you have your IP SLA, track object and routes configured and running.

ip sla 1
 icmp-echo source-ip
 frequency 30
ip sla schedule 1 life forever start-time now
ip sla responder

track 1 ip sla 1 reachability
 delay down 70

ip route track 1
ip route

After you have that configured how ever way you see fit, you’d define the Cisco EEM event variables you’ll later be using in the Tcl script.

event manager environment _mail_server
event manager environment _mail_src_ip
event manager environment _mail_from
event manager environment _mail_to
event manager environment _mail_cc_to

These variables above are just like what you would have in an ordinary programming/coding language. Values to be used down the line. Sometimes, if you have lots of IPs on a router, couple of the errors you may see when configuring the router to send an email are SMTP reply code 530 or error in reply. That may mean email the router is sending is being denied by your mail server. In such instances the email might need to be sourced from an IP address that’s trusted; in this case _mail_src_ip.

Another consideration is to make sure you understand if there is a need to change the default SMTP port number 25 to 587 or 465 etc. That would be specific to your environment and needs to be adjusted accordingly when setting up the config.

Verify what is supported and what is not on your specific code version by checking the EEM version available to you. Some features such as changing the default SMTP port or support for “@” character use in email may not be available in very old versions. Consult the release notes.

#show event manager version 
Embedded Event Manager Version 4.00
Component Versions:
eem: (rel8)1.0.0
eem-gold: (rel1)1.0.2
eem-call-home: (rel2)1.0.4

At this point the EEM variables have been defined and can dive in to the Tcl scripting segment.

::cisco::eem::event_register_track 1 state any

namespace import ::cisco::eem::*
namespace import ::cisco::lib::*

# This extracts the hostname of your router and assigns it to variable routername
set routername [info hostname]

# This requests the status of tracked object (down or up) and assigns it to track_state
array set track_info [event_reqinfo]
set track_state $track_info(track_state)

if {$track_state == "down"} {
   action_syslog msg "Primary Internet Path Down"

   set mail_pre "Mailservername: $_mail_server\n"
   append mail_pre "From: $_mail_from\n"
   append mail_pre "To: $_mail_to\n"
   append mail_pre "Cc: $_mail_cc_to\n"
   append mail_pre "Sourceaddr: $_mail_src_ip\n"
   append mail_pre "Subject: $routername PRIMARY INTERNET PATH DOWN\n\n"
   append mail_pre "$routername Primary Internet Path Down. \nPlease investigate and contact ISP if necessary\n\n"
   set mail_msg [uplevel #0 [list subst -nobackslashes -nocommands $mail_pre]]
   if [catch {smtp_send_email $mail_msg} result] {
   error $result $errorInfo

} else {
   action_syslog msg "Primary Internet Circuit UP"

   set mail_pre "Mailservername: $_mail_server\n"
   append mail_pre "From: $_mail_from\n"
   append mail_pre "To: $_mail_to\n"
   append mail_pre "Cc: $_mail_cc_to\n"
   append mail_pre "Sourceaddr: $_mail_src_ip\n"
   append mail_pre "Subject: $routername PRIMARY INTERNET PATH UP\n\n"
   append mail_pre "$routername Primary Internet Path UP. \n\n"
   set mail_msg [uplevel #0 [list subst -nobackslashes -nocommands $mail_pre]]
   if [catch {smtp_send_email $mail_msg} result] {
   error $result $errorInfo

action_syslog msg "E-mail sent to $_mail_to and $_mail_cc_to!"

Once you’ve saved your Tcl Script to a file with a .tcl extension, you’d just need to TFTP it to your router. Here I’ll just upload it to flash: directory.

#copy tftp flash:
Address or name of remote host []?
Source filename []? sendmail.tcl
Destination filename []? sendmail.tcl

At this point you’re ready to specify the working directory of the Event Manager by pointing it to the router directory you’ve uploaded the file.

(config)# event manager directory user policy "flash:/"

Final step is to register the policy as follows

(config)# event manager policy sendmail.tcl

An important bit to remember when troubleshooting any errors in your script is, after you make any changes to the Tcl script and upload the newly modified .tcl file to your router, you need to reissue a registration for the changes to take effect.

(config)# no event manager policy sendmail.tcl
(config)# event manager policy sendmail.tcl

That’s the gist of monitoring redundant Internet link failover status controlled by a router using Cisco EEM and a Tcl script. As I mentioned at the top of this post an alternative approach is to use an Event Manager applet. Yet another method of achieving the same goal would be to solely focus on SNMP traps generated during failover events, collecting the SNMP traps by your favored network management software and setting up alerts based on the trap.

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s