Knowledge

Embedded event manager

Source 📝

101:(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. 25: 136:
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, or 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
145:
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.
124:
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
137:
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; event detectors, policies and programming languages.
663:
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"
54: 767: 237:
Policies determine what is run when an event is detected. Policies save users from having to enumerate an action for every possible event.
801: 752: 736: 76: 815: 810: 697: 564:
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
110: 782: 678: 37: 47: 41: 33: 109:
EEM is a member of a family of embedded management technologies in Cisco IOS including SNMP, NetFlow, IP SLA,
842: 161: 58: 255:- when more complex programs need to be built, EEM supports Tcl (Tool Command Language) development 689: 685: 117:, ESM (Embedded Syslog Manager), ERM (Embedded Resource Manager), EMM (Embedded Menu Manager), 732: 637:<-- actions such as writing to flash, making config changes, etc. require enable privilege 176: 258:
IOS.sh - newer versions of IOS support IOS.sh (IOS shell) macros similar to Linux bash shell
805: 786: 701: 311:
12.4(2)T, 12.2(33)SRB1, 12.4(11)T (EEM 2.3), 12.2(33)SRC (EEM 2.3), 12.2(33)SXH (EEM 2.3)
627:<-- obtain the current device hostname and place it in the $ _info_routername variable 798: 667:<-- send an email with the result of the last CLI command in the body of the message 836: 694: 727:
Blair, Ray; Durai, Arvind; Lautmann, John (2010). "Embedded Event Manager (EEM)".
98: 249:
Applets - these allow CLI to be run when a certain set of conditions occurs
821: 181: 171: 779: 762: 568:
state changes. This example defines an applet action rather than Tcl.
374:
Watchdog, Counter, Interface Counter, Timer, Application-Specific EDs
166: 114: 695:
Progrizon: EEM Deployment Application Suite and EEM Policy Builder
565: 152: 706: 757: 252: 118: 18: 245:
EEM supports three methods of programmability and scripting.
597:<-- define the address from which the email will be sent 198:
SNMP notification (i.e. when the device receives a trap)
780:
Progrizon, Inc. EEM Solution Development and Consulting
573:
event manager environment _email_server 172.27.121.177
308:
12.2(18)SXF4 (IOS with modularity) 12.2(18)SXF5 (IOS)
587:<-- define the address to which email will be sent 593:
event manager environment _email_from EMAIL_ADDRESS
538:Programmatic applets, Netflow, IP SLA, Routing EDs 583:event manager environment _email_to EMAIL_ADDRESS 399:Counter Modification, System Info, Email Actions 517:Multiple event support, SNMP Proxy, XML RPC EDs 46:but its sources remain unclear because it lacks 314:12.4(20)T, 12.2(40)SE, 12.2(40)SG, 12.2(33)SXI 811:Cisco IOS Automation and Customization (CIOSC) 613:event syslog pattern ".*%HSRP-5-STATECHANGE.*" 731:. Networking Technology Series. Cisco Press. 674:Network management software and tools support 125: 8: 816:Advanced IOS Customization using EEM (ACEEM) 603:event manager applet email_hsrp_state_change 647:<-- write some debugging output to flash 768:Embedded Event Manager Configuration Guide 77:Learn how and when to remove this message 266: 577:<-- define the environment variable 7: 822:"Cisco Embedded Event Manager (EEM)" 305:12.3(14)T1, 12.2(28)SBC, 12.2(33)SR 653:flash:append hsrp_state_change.txt" 643:append flash:hsrp_state_change.txt" 472:GOLD, System Manager, WDSysMon EDs 157:OIR (Online Insertion and Removal) 14: 216:GOLD (Generic OnLine Diagnostics) 228:None (launch the event manually) 148:Typical of EEM Event Detectors: 105:Cisco embedded management family 23: 633:action 1.1 cli command "enable" 623:action 1.0 info type routername 774:EEM-Based Solution Development 225:Enhanced Object Tracking (EOT) 1: 707:Davra Networks: EEM Solutions 448:User and System Tcl Policies 111:Web Services Management Agent 657:<-- more debugging output 99:Cisco's IOS operating system 97:) is a feature included in 16:Cisco IOS automation feature 729:TcL Scripting for Cisco IOS 679:Network management Software 859: 186:Application specific event 617:<-- define the trigger 121:and Service Diagnostics. 799:Progrizon, Inc. Training 607:<-- set up the policy 241:Programming capabilities 126:Programming Capabilities 32:This article includes a 763:EEM Scripting Community 681:utilizing EEM include: 296:IOS Version Introduced 61:more precise citations. 495:Resource, RF, EOT EDs 162:command-line interface 91:Embedded Event Manager 348:Syslog, SNMP Actions 299:12.3(4)T, 12.0(26)S 195:Redundancy framework 804:2011-07-15 at the 785:2011-07-15 at the 700:2011-07-15 at the 263:Version comparison 192:Interface counters 34:list of references 826:aboutnetworks.net 557: 556: 322:Syslog, SNMP EDs 87: 86: 79: 850: 829: 742: 668: 664: 658: 654: 648: 644: 638: 634: 628: 624: 618: 614: 608: 604: 598: 594: 588: 584: 578: 574: 267: 207:Timer subscriber 82: 75: 71: 68: 62: 57:this article by 48:inline citations 27: 26: 19: 858: 857: 853: 852: 851: 849: 848: 847: 833: 832: 820: 806:Wayback Machine 795: 787:Wayback Machine 776: 749: 739: 726: 723: 721:Further reading 717: 715: 702:Wayback Machine 676: 666: 662: 656: 652: 646: 642: 636: 632: 626: 622: 616: 612: 606: 602: 596: 592: 586: 582: 576: 572: 562: 265: 243: 235: 143: 141:Event detectors 134: 107: 83: 72: 66: 63: 52: 38:related reading 28: 24: 17: 12: 11: 5: 856: 854: 846: 845: 835: 834: 831: 830: 818: 813: 808: 794: 791: 790: 789: 775: 772: 771: 770: 765: 760: 755: 753:EEM Data Sheet 748: 747:External links 745: 744: 743: 737: 722: 719: 714: 711: 710: 709: 704: 692: 690:CiscoWorks LMS 675: 672: 671: 670: 660: 650: 640: 630: 620: 610: 600: 590: 580: 561: 558: 555: 554: 551: 549: 547: 545: 543: 541: 539: 535: 534: 531: 528: 526: 524: 522: 520: 518: 514: 513: 510: 507: 504: 502: 500: 498: 496: 492: 491: 488: 485: 482: 479: 477: 475: 473: 469: 468: 465: 462: 459: 456: 453: 451: 449: 445: 444: 441: 438: 435: 432: 429: 427: 425: 421: 420: 417: 414: 411: 408: 405: 402: 400: 396: 395: 392: 389: 386: 383: 380: 377: 375: 371: 370: 367: 364: 361: 358: 355: 352: 349: 345: 344: 341: 338: 335: 332: 329: 326: 323: 319: 318: 315: 312: 309: 306: 303: 300: 297: 293: 292: 289: 286: 283: 280: 277: 274: 271: 264: 261: 260: 259: 256: 250: 242: 239: 234: 231: 230: 229: 226: 223: 220: 217: 214: 211: 208: 205: 202: 199: 196: 193: 190: 187: 184: 179: 174: 169: 164: 158: 155: 142: 139: 133: 130: 106: 103: 85: 84: 42:external links 31: 29: 22: 15: 13: 10: 9: 6: 4: 3: 2: 855: 844: 843:Cisco Systems 841: 840: 838: 827: 823: 819: 817: 814: 812: 809: 807: 803: 800: 797: 796: 792: 788: 784: 781: 778: 777: 773: 769: 766: 764: 761: 759: 756: 754: 751: 750: 746: 740: 738:9781587059452 734: 730: 725: 724: 720: 718: 712: 708: 705: 703: 699: 696: 693: 691: 687: 684: 683: 682: 680: 673: 669: 661: 659: 651: 649: 641: 639: 631: 629: 621: 619: 611: 609: 601: 599: 591: 589: 581: 579: 571: 570: 569: 567: 559: 552: 550: 548: 546: 544: 542: 540: 537: 536: 532: 529: 527: 525: 523: 521: 519: 516: 515: 511: 508: 505: 503: 501: 499: 497: 494: 493: 489: 486: 483: 480: 478: 476: 474: 471: 470: 466: 463: 460: 457: 454: 452: 450: 447: 446: 442: 439: 436: 433: 430: 428: 426: 424:OIR, CLI EDs 423: 422: 418: 415: 412: 409: 406: 403: 401: 398: 397: 393: 390: 387: 384: 381: 378: 376: 373: 372: 368: 365: 362: 359: 356: 353: 350: 347: 346: 342: 339: 336: 333: 330: 327: 324: 321: 320: 316: 313: 310: 307: 304: 301: 298: 295: 294: 290: 287: 284: 281: 278: 275: 272: 269: 268: 262: 257: 254: 251: 248: 247: 246: 240: 238: 232: 227: 224: 221: 219:Environmental 218: 215: 212: 209: 206: 203: 200: 197: 194: 191: 189:Config change 188: 185: 183: 180: 178: 175: 173: 170: 168: 165: 163: 159: 156: 154: 151: 150: 149: 146: 140: 138: 131: 129: 127: 122: 120: 116: 112: 104: 102: 100: 96: 92: 81: 78: 70: 67:November 2015 60: 56: 50: 49: 43: 39: 35: 30: 21: 20: 825: 728: 716: 677: 665: 655: 645: 635: 625: 615: 605: 595: 585: 575: 563: 302:12.2(27)SBC 270:EEM Version 244: 236: 147: 144: 135: 123: 108: 94: 90: 88: 73: 64: 53:Please help 45: 210:IOS Process 59:introducing 713:References 686:CiscoWorks 317:12.4(22)T 837:Category 802:Archived 793:Training 783:Archived 698:Archived 285:2.2/2.3 233:Policies 201:Resource 128:below). 560:Example 222:Routing 213:Counter 182:NetFlow 177:IP SLAs 172:XML-RPC 55:improve 758:Go EEM 735:  282:2.1.5 167:Syslog 115:Syslog 89:Cisco 204:Timer 132:About 40:, or 733:ISBN 688:and 566:HSRP 291:3.0 288:2.4 279:2.1 276:2.0 273:1.0 160:CLI 153:SNMP 253:Tcl 119:Tcl 95:EEM 839:: 824:. 553:X 533:X 530:X 512:X 509:X 506:X 490:X 487:X 484:X 481:X 467:X 464:X 461:X 458:X 455:X 443:X 440:X 437:X 434:X 431:X 419:X 416:X 413:X 410:X 407:X 404:X 394:X 391:X 388:X 385:X 382:X 379:X 369:X 366:X 363:X 360:X 357:X 354:X 351:X 343:X 340:X 337:X 334:X 331:X 328:X 325:X 113:, 44:, 36:, 828:. 741:. 93:( 80:) 74:( 69:) 65:( 51:.

Index

list of references
related reading
external links
inline citations
improve
introducing
Learn how and when to remove this message
Cisco's IOS operating system
Web Services Management Agent
Syslog
Tcl
Programming Capabilities
SNMP
command-line interface
Syslog
XML-RPC
IP SLAs
NetFlow
Tcl
HSRP
Network management Software
CiscoWorks
CiscoWorks LMS
Progrizon: EEM Deployment Application Suite and EEM Policy Builder
Archived
Wayback Machine
Davra Networks: EEM Solutions
ISBN
9781587059452
EEM Data Sheet

Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.