Embedded event manager: Difference between revisions

Revision as of 17:21, 12 November 2010

Latest revision as of 10:07, 6 March 2024

(22 intermediate revisions by 14 users not shown)

Line 1:

{{Short description|Cisco IOS automation feature}}

''(Cisco EEM stands for Embedded Event Manager)''

{{no footnotes|date=November 2015}}

Cisco '''Embedded Event Manager''' ('''EEM''') is a feature included in [[Cisco IOS|Cisco's IOS operating system]] (and some other Cisco OSes such as IOS-XR, IOS-XE, and NX-OS) that allow programmability and automation capabilities inside the device. EEM allows the behavior of a Cisco device to adapt to specific user requirements by allowing scripting, thresholding, proactive actions, data collection and event management inside the Cisco device itself. Using EEM, problems can be identified and resolved automatically in advance by setting event triggers (called Event Detectors) to watch for specific types of situations or thresholds, or run a set of actions periodically.

==Cisco EEM (Embedded Event Manager)==

Cisco EEM is a feature included in Cisco's IOS operating system (and some other Cisco OSes such as IOS-XR, IOS-XE, and NX-OS) that allow programmability and automation capabilities inside the device. EEM allows the behavior of a Cisco device to adapt to specific user requirements by allowing scripting, thresholding, proactive actions, data collection and event management inside the Cisco device itself. Using EEM, problems can be identified and resolved automatically in advance by setting event triggers (called Event Detectors) to watch for specific types of situations or thresholds, or run a set of actions periodically.

==Cisco embedded management family==

When a situation is detected by EEM, it uses policies to invoke actions based on the type of event and the configured policy. EEM currently supports three different types of programming actions (see [[Embedded_event_manager#Programming_Capabilities|Programming Capabilities]] below).

EEM is a member of a family of embedded management technologies in Cisco IOS including SNMP, NetFlow, IP SLA, [[Web Services Management Agent]], [[Syslog]], ESM (Embedded Syslog Manager), ERM (Embedded Resource Manager), EMM (Embedded Menu Manager), [[Tcl]] and Service Diagnostics.

When a situation is detected by EEM, it uses policies to invoke actions based on the type of event and the configured policy. EEM currently supports three different types of programming actions (see [[Embedded_event_managerEmbedded event manager#Programming_CapabilitiesProgramming Capabilities|Programming Capabilities]] below).

[[File:embedded event manager overview.png]]

==About==

==Cisco Embedded Management Family==

With EEM, users can capture complex network events and run sophisticated programs on Cisco devices. The version of EEM on most Cisco devices is version 2.1, and the latestor version is 3.0 which was introduced in IOS 12.4(22)T. The latest version is version 4.0, which was released November 2011, targeting IOS releases 12.2SR, 12.2SB, 12.4, and 12.4T, 15.0M, 12.2SG, 12.2SE, Cisco IOS XE, and future versions. EEM consists of three areas; Eventevent Detectorsdetectors, Policiespolicies and Programmingprogramming languages.

EEM is a member of a family of embedded management technologies in Cisco IOS including SNMP, NetFlow, IP SLA, [[Web Services Management Agent]], [[Syslog]], ESM (Embedded Syslog Manager), ERM (Embedded Resource Manager), EMM (Embedded Menu Manager), Tcl and Service Diagnostics.

==About=Event EEMdetectors===

With EEM, users can capture complex network events and run sophisticated programs on Cisco devices. The version of EEM on most Cisco devices is version 2.1, and the latest version is 3.0 which was introduced in IOS 12.4(22)T. EEM consists of three areas; Event Detectors, Policies and Programming languages.

===Event Detectors===

The brains of EEM are event detectors. These event detectors are built-in capabilities to watch for specific situations or conditions. Newer versions of EEM have more event detectors than older ones.

'''Typical of EEM Event Detectors:'''

* [[SNMP]]

* OIR (Online Insertion and Removal)

* CLI [[Commandcommand-line Line Interfaceinterface]]

* [[Syslog]]

* [[XML-RPC]]

* [[IP SLASLAs]]

* [[NetFlow]]

* Application specific event

Line 41 ⟶ 39:

* None (launch the event manually)

===EEM Policies===

Policies determine what is run when an event is detected. Policies save users from having to enumerate an action for every possible event.

===Programming Capabilitiescapabilities===

EEM supports three methods of programmability and scripting.

# Applets - these allow CLI to be run when a certain set of conditions occurs

# [[Tcl]] - when more complex programs need to be built, EEM supports Tcl (Tool Command Language) development

# IOS.sh - newer versions of IOS support IOS.sh (IOS shell) macros similar to Linux bash shell

===EEM Version Comparison=comparison==

{| class="wikitable"

|-

Line 163 ⟶ 160:

|}

==Example EEM Commands==

There are four steps to setting up an EEM system. In this example, we will get an email of the status of the system when the [[HSRP]] state changes. This examplesexample defines an applet action rather than Tcl.

1.# <tt>{{mono|event manager environment _email_server 172.27.121.177<tt>}} ''<span style="color:blue;">&lt;-- define the environment variable</span>''

2.# <tt>{{mono|event manager environment _email_to EMAIL_ADDRESS</tt>}} ''<span style="color:blue;">&lt;-- define the address to which email will be sent</span>''

3.# <tt>{{mono|event manager environment _email_from EMAIL_ADDRESS</tt>}} ''<span style="color:blue;">&lt;-- define the address from which the email will be sent</span>''

4.# <tt>{{mono|event manager applet email_hsrp_state_change</tt>}} ''<span style="color:blue;">&lt;-- set up the policy</span>''

5.# <tt>{{mono|event syslog pattern ".*%HSRP-5-STATECHANGE.*"</tt>}} ''<span style="color:blue;">&lt;-- define the trigger</span>''

6.# <tt>{{mono|action 1.0 info type routername</tt>}} ''<span style="color:blue;">&lt;-- obtain the current device hostname and place it in the $_info_routername variable</span>''

7.# <tt>{{mono|action 1.1 cli command "enable"</tt>}} ''<span style="color:blue;">&lt;-- actions such as writing to flash, making config changes, etc. require enable privilege</span>''

8.# <tt>{{mono|action 1.3 cli command "show standby | append flash:hsrp_state_change.txt"</tt>}} ''<span style="color:blue;">&lt;-- write some debugging output to flash</span>''

9.# <tt>{{mono|action 1.4 cli command "show standby brief | flash:append hsrp_state_change.txt"</tt>}} ''<span style="color:blue;">&lt;-- more debugging output</span>''

10.# <tt>{{mono|action 1.5 mail server "$_email_server" to "$_email_to" from "$_email_from" subject "HSRP_STATE_CHANGE Alert from $_info_routername: $_syslog_msg" body "$_cli_result"</tt>}} ''<span style="color:blue;">&lt;-- send an email with the result of the last CLI command in the body of the message</span>''

==Network management software and tools support==

2. <tt>event manager environment _email_to EMAIL_ADDRESS</tt> ''<span style="color:blue;">&lt;-- define the address to which email will be sent</span>''

[[Network management Software]] utilizing EEM include:

* [[CiscoWorks]] and [[CiscoWorks#LMS_ApplicationsLMS Applications|CiscoWorks LMS]]

* [http://progrizon.com/products/tools-overview.html Progrizon: EEM Deployment Application Suite and EEM Policy Builder] {{Webarchive|url=https://web.archive.org/web/20110715120502/http://www.progrizon.com/products/tools-overview.html |date=2011-07-15 }}

* [http://www.davranetworks.com Davra Networks: EEM Solutions]

==References==

3. <tt>event manager environment _email_from EMAIL_ADDRESS</tt> ''<span style="color:blue;">&lt;-- define the address from which the email will be sent</span>''

<references/>

== Further reading ==

4. <tt>event manager applet email_hsrp_state_change</tt> ''<span style="color:blue;">&lt;-- set up the policy</span>''

* {{cite book|chapter=Embedded Event Manager (EEM)|title=TcL Scripting for Cisco IOS|series=Networking Technology Series|first1=Ray|last1=Blair|first2=Arvind|last2=Durai|first3=John|last3=Lautmann|publisher=Cisco Press|year=2010|isbn=9781587059452}}

==RelatedExternal links==

5. <tt>event syslog pattern ".*%HSRP-5-STATECHANGE.*"</tt> ''<span style="color:blue;">&lt;-- define the trigger</span>''

6. <tt>action 1.0 info type routername</tt> ''<span style="color:blue;">&lt;-- obtain the current device hostname and place it in the $_info_routername variable</span>''

7. <tt>action 1.1 cli command "enable"</tt> ''<span style="color:blue;">&lt;-- actions such as writing to flash, making config changes, etc. require enable privilege</span>''

8. <tt>action 1.3 cli command "show standby | append flash:hsrp_state_change.txt"</tt> ''<span style="color:blue;">&lt;-- write some debugging output to flash</span>''

9. <tt>action 1.4 cli command "show standby brief | flash:append hsrp_state_change.txt"</tt> ''<span style="color:blue;">&lt;-- more debugging output</span>''

10. <tt>action 1.5 mail server "$_email_server" to "$_email_to" from "$_email_from" subject "HSRP_STATE_CHANGE Alert from $_info_routername: $_syslog_msg" body "$_cli_result"</tt> ''<span style="color:blue;">&lt;-- send an email with the result of the last CLI command in the body of the message</span>''

==Related links==

* [http://www.cisco.com/en/US/prod/collateral/iosswrel/ps6537/ps6555/ps6815/datasheet_c78-492444.html EEM Data Sheet]

* [[Cisco]]

* [http://www.cisco.com/go/eem Go EEM]

* [http://www.cisco.com/go/ciscobeyond EEM Scripting Community]

* [https://www.cisco.com/c/en/us/td/docs/ios-xml/ios/eem/configuration/xe-16/eem-xe-16-book/eem-overview.html Embedded Event Manager Configuration Guide]

* [[Tcl]]

* [http://www.cisco.com/go/smartcallhome Go Smart Call Home]

* [[Web Services Management Agent]]

===EEM-Based Solution Development===

==Network Management Software and Tools Support==

* [http://www.progrizon.com/index.html Progrizon, Inc. EEM Solution Development and Consulting] {{Webarchive|url=https://web.archive.org/web/20110715120534/http://www.progrizon.com/index.html |date=2011-07-15 }}

Software solutions utilizing EEM include, but not limited to:

===Training===

* [[CiscoWorks]]

* [http://progrizon.com/products/training-overview.html Progrizon, Inc. Training] {{Webarchive|url=https://web.archive.org/web/20110715120410/http://www.progrizon.com/products/training-overview.html |date=2011-07-15 }}

* [[CiscoWorks#LMS_Applications|CiscoWorks LMS]]

* [https://web.archive.org/web/20110715120414/http://www.progrizon.com/indexproducts/training-CIOSC.html Progrizon:Cisco IOS Automation EEMand SolutionCustomization Development(CIOSC)]

* [https://web.archive.org/web/20110715120457/http://www.progrizon.com/products/training-ACEEM.html Advanced IOS Customization using EEM (ACEEM)]

* [http://www.davranetworks.com Davra Networks: EEM Solutions]

* {{cite web |url=https://aboutnetworks.net/cisco-eem/ |title=Cisco Embedded Event Manager (EEM) |website=aboutnetworks.net}}

==References==

<references/>

{{DEFAULTSORT:Embedded Event Manager}}