Guest

High Availability

Cisco IOS Embedded Event Manager Q&A

Q&A

Last Updated: January 2005

EMBEDDED MANAGEMENT AND CISCO IOS SOFTWARE EMBEDDED EVENT MANAGER

Q. What is embedded management?
A. The term embedded management is used describe the software subsystems within Cisco® IOS® Software that help manage, monitor, and automate actions within a router or switch running Cisco IOS Software.
Q. What is unique about embedded management and Cisco IOS Software Embedded Event Manager (EEM) in particular?
A. Traditionally, network management happens from outside the network looking in. Embedded management and EEM add a new dimension. It is management from within the network and within the device itself.
Q. What benefit do I get from EEM?
A. The answer depends on what you do with it. For the most part, you can elect to use it or not. If you want, you can use EEM to automate tasks, to program actions to take based on certain events, to write custom syslog messages, or to send alerts or e-mail from a router or switch to inform operations personnel. The benefit comes from being able to automatically take action and collect data to better manage your devices and network.
Q. I already have a network management system. Do I need EEM?
A. External network management systems play a significant role in fault management, configuration management, capacity planning, provisioning, and data collection. But there are advantages to having an onboard or embedded management capability. For example, there could be instances where some problem cuts off communication to an external management system, leaving it unable to manage the device. Or it might be difficult to achieve the desired polling rate for many managed devices from a central system. In this case, distributing part of the management burden to the device itself might be a better solution.
Q. I have a small business network with very little network management. Should I care about EEM?
A. Because EEM runs on the routers and switches themselves, you do not need to have an external network management system to gain some data collection and device management capabilities. You can use EEM to help the devices to help you manage the network.
Q. This is starting to sound interesting. Basically, how does EEM work?
A. EEM consists of three main components: event detectors, the event manager server, and the policy director. These are software components in the Cisco IOS Software. The event detectors do just that: detect when certain events occur within Cisco IOS Software and notify the event manager server. The policy director registers with the event manager server to receive events and implements policy actions. The policies are either system policies that come with Cisco IOS Software or user policies defined by you. After being registered, the policy's actions are carried out whenever the event of interest occurs.
Q. What are some examples of events?
A. For example, you might have a policy run when a particular syslog message occurs. Or a policy could run when an interface fails. Or a policy could run when CPU utilization reaches some specified threshold. There are many examples using the available event detectors.
Q. How many different event detectors are there?
A. There are currently 15 event detectors and more to come in future Cisco IOS Software releases.
Q. How are EEM policies defined?
A. User policies are defined by you, the customer. There are two types of user policies: applet policies and TCL policies. They are registered using configuration command-line interface (CLI) commands. See more about each of them in later questions.
Q. Can an EEM policy send an Simple Network Management Protocol (SNMP) trap?
A. Yes. The MIB that defines the trap or inform is CISCO-EMBEDDED-EVENT-MGR-MIB.my and can be retrieved from Cisco.com.

EEM AVAILABILITY

Q. Is EEM available now?
A. Yes. It is available for many Cisco Systems® products. It is in recent versions of Cisco IOS Software mainline, "T," "S," and "SX" software trains. Please see Cisco IOS Software Feature Navigator for more information.
Q. Are there different versions of EEM?
A. Yes. EEMv1.0 was introduced in Cisco IOS Software Releases 12.0(26)S and 12.3(4)T. EEMv2.0 added some additional functions. EEMv2.1 followed and added the ability for users to program their own policies using TCL. The latest version at the time this was prepared was EEMv2.2.
Q. Where can I get more details about the different EEM versions?
A. Please see the Cisco IOS Software documentation.

EEM APPLET POLICIES

Q. What is an applet policy?
A. An applet policy is a fairly simple policy defined using the Cisco configuration CLI.
Q. Can I send an e-mail message using an applet policy?
A. Yes, EEMv2.1 and above allow this.
Q. Can I issue a Cisco IOS Software CLI?
A. Yes.
Q. Can I parse the output from CLI commands and different actions based on the output using applet policies?
A. No. You will probably want to use a TCL policy for that.

EEM TCL POLICIES

Q. What is a TCL policy?
A. It is an EEM policy programmed using the TCL programming language.
Q. Do you mean to say there is a TCL interpreter in Cisco IOS Software?
A. Yes, and there has been since Cisco IOS Software Release 12.0. The current version (as of this writing, November 2005) is 8.3.4. It is used by the voice-over-IP (VoIP) subsystems in Cisco IOS Software for interactive voice response, embedded syslog manager, and the Cisco IOS Software TCL shell as well as with EEM.
Q. How do I create TCL policies?
A. Typically, offline on a PC, using a text editor or programming environment. You would code your policy, then download it (copy it) to the router or switch using Trivial File Transfer Protocol (TFTP) or some other protocol that works, then register it using the EEM configuration CLI commands, then test it.
Q. What if it does not work?
A. There are some debug commands to help you find any errors in your policy. You would typically want to try your policy in a test environment before using it in a production network. It might take a few iterations to get it right. Each time you modify your code, transfer it to the router, unregister it, reregister it, and try it. Continue iterating through those steps until you are satisfied and then deploy your EEM TCL policy to your production routers.
Q. Is there any management tool to help with managing the TCL policies? What about Cisco Resource Manager Essentials?
A. Not yet. EEM is still relatively new, and the external management tools have not been updated to manage EEM policies.
Q. Suppose my TCL script gets in a loop. Will it crash the router?
A. No. The EEM subsystem, TCL interpreter, and Cisco IOS Software infrastructure have been designed to guard against your policy causing problems. Of course, if the logic of your program is wrong, you could affect the operation of the network. That is why it is prudent to test your policy in a test environment before widespread deployment.
Q. Can someone load a virus into the router using this TCL interpreter or with EEM?
A. No. Not without the enable password for the router. The configuration and registration of any EEM policy is done through the configuration, and you must first have authority for that. At registration the policy is read into the router's memory and implemented from there.
Q. Where can I learn TCL and how to use it for EEM?
A. There are many excellent books about TCL programming. One widely acclaimed title is Practical Programming in Tcl and Tk by Brent B. Welch. The programming and use of EEM TCL extensions are covered in the "Writing Embedded Event Manager Policies" guide (see Cisco IOS Software documentation).
Q. What effect does EEM have on router or switch performance?
A. First, you do not have to use EEM, and all user TCL policies are completely disabled by no event manager directory user policy. The effects on performance depend on the number of policies registered and the number of event manager scheduler threads configured. The number of policies that can be registered is limited by the amount of available memory. More performance-related information will be available soon in another document.
Q. Can I send an e-mail message from an EEM TCL policy?
A. Yes.
Q. Can I register TCL policies that have been compiled using TclPro compiler?
A. Not presently. This is coming in a future release.

FOR MORE INFORMATION

For more information about Cisco IOS Software EEM, visit http://www.cisco.com/go/eem or contact your local account representative or askabouteem@external.cisco.com.
Text Box:  Corporate HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAwww.cisco.comTel:   408 526-4000    800 553-NETS (6387)Fax: 408 526-4100    European HeadquartersCisco Systems International BVHaarlerbergparkHaarlerbergweg 13-191101 CH AmsterdamThe Netherlandswww-europe.cisco.comTel:  31 0 20 357 1000Fax:    31 0 20 357 1100    Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAwww.cisco.comTel:    408 526-7660Fax:    408 527-0883    Asia Pacific HeadquartersCisco Systems, Inc.168 Robinson Road#28-01 Capital TowerSingapore 068912www.cisco.comTel: +65 6317 7777Fax: +65 6317 7799Cisco Systems has more than 200 offices in the following countries and regions. Addresses, phone numbers, and fax numbers are listed onthe Cisco Website at www.cisco.com/go/offices.Argentina · Australia · Austria · Belgium · Brazil · Bulgaria · Canada · Chile · China PRC · Colombia · Costa Rica · Croatia · Cyprus Czech Republic · Denmark · Dubai, UAE · Finland · France · Germany · Greece · Hong Kong SAR · Hungary · India · Indonesia · Ireland · Israel Italy · Japan · Korea · Luxembourg · Malaysia · Mexico · The Netherlands · New Zealand · Norway · Peru · Philippines · Poland · Portugal Puerto Rico · Romania · Russia · Saudi Arabia · Scotland · Singapore · Slovakia · Slovenia · South Africa · Spain · Sweden · Switzerland · Taiwan Thailand · Turkey · Ukraine · United Kingdom · United States · Venezuela · Vietnam · ZimbabweCopyright  2005 Cisco Systems, Inc. All rights reserved. CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, StrataView Plus, TeleRouter, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0502R)   205393.BH_ETMG_PI_12.05Printed in the USA Text Box:  Corporate HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAwww.cisco.comTel:    408 526-4000    800 553-NETS (6387)Fax: 408 526-4100    European HeadquartersCisco Systems International BVHaarlerbergparkHaarlerbergweg 13-191101 CH AmsterdamThe Netherlandswww-europe.cisco.comTel:  31 0 20 357 1000Fax:    31 0 20 357 1100    Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAwww.cisco.comTel:    408 526-7660Fax:    408 527-0883    Asia Pacific HeadquartersCisco Systems, Inc.168 Robinson Road#28-01 Capital TowerSingapore 068912www.cisco.comTel: +65 6317 7777Fax: +65 6317 7799Cisco Systems has more than 200 offices in the following countries and regions. Addresses, phone numbers, and fax numbers are listed onthe Cisco Website at www.cisco.com/go/offices.Argentina · Australia · Austria · Belgium · Brazil · Bulgaria · Canada · Chile · China PRC · Colombia · Costa Rica · Croatia · Cyprus Czech Republic · Denmark · Dubai, UAE · Finland · France · Germany · Greece · Hong Kong SAR · Hungary · India · Indonesia · Ireland · Israel Italy · Japan · Korea · Luxembourg · Malaysia · Mexico · The Netherlands · New Zealand · Norway · Peru · Philippines · Poland · Portugal Puerto Rico · Romania · Russia · Saudi Arabia · Scotland · Singapore · Slovakia · Slovenia · South Africa · Spain · Sweden · Switzerland · Taiwan Thailand · Turkey · Ukraine · United Kingdom · United States · Venezuela · Vietnam · ZimbabweCopyright  2005 Cisco Systems, Inc. All rights reserved. CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, StrataView Plus, TeleRouter, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0502R)   205393.BH_ETMG_PI_12.05Printed in the USA