1-- ***************************************************************** 2-- CISCO-HSRP-EXT-MIB 3-- 4-- Jan 2010, Sreenadh Gaddam 5-- Copyright (c) 1998-2005, 2009-2010 by cisco Systems Inc. 6-- All rights reserved. 7-- ***************************************************************** 8 9CISCO-HSRP-EXT-MIB DEFINITIONS ::= BEGIN 10 11IMPORTS 12 MODULE-IDENTITY, 13 OBJECT-TYPE, 14 IpAddress, 15 Unsigned32 16 FROM SNMPv2-SMI 17 MODULE-COMPLIANCE, 18 OBJECT-GROUP 19 FROM SNMPv2-CONF 20 TruthValue, 21 RowStatus 22 FROM SNMPv2-TC 23 InetAddressType, 24 InetAddress 25 FROM INET-ADDRESS-MIB 26 ifIndex, 27 InterfaceIndex 28 FROM IF-MIB 29 cHsrpGrpNumber 30 FROM CISCO-HSRP-MIB 31 ciscoMgmt 32 FROM CISCO-SMI; 33 34 35ciscoHsrpExtMIB MODULE-IDENTITY 36 LAST-UPDATED "201009020000Z" 37 ORGANIZATION "Cisco Systems, Inc." 38 CONTACT-INFO 39 "Cisco Systems 40 Customer Service 41 42 Postal: 170 W Tasman Drive 43 San Jose, CA 95134 44 USA 45 46 Tel: +1 800 553-NETS 47 48 E-mail: cs-hsrp@cisco.com" 49 DESCRIPTION 50 "The Extension MIB module for the CISCO-HSRP-MIB which is 51 based on RFC2281. 52 53 This MIB provides an extension to the CISCO-HSRP-MIB which 54 defines Cisco's proprietary Hot Standby Routing Protocol 55 (HSRP), defined in RFC2281. The extensions cover assigning 56 of secondary HSRP ip addresses, modifying an HSRP Group's 57 priority by tracking the operational status of interfaces, 58 etc. 59 60 Terminology: 61 HSRP is a protocol used amoung a group of routers for the 62 purpose of selecting an active router and a standby router. 63 64 An active router is the router of choice for routing 65 packets. 66 67 A standby router is a router that takes over the routing 68 duties when an active router fails, or when preset 69 conditions have been met. 70 71 A HSRP group or a standby group is a set of routers 72 which communicate using HSRP. An HSRP group has a group 73 MAC address and a group IP address. These are the 74 designated addresses. The active router assumes 75 (i.e. inherits) these group addresses. An HSRP group is 76 identified by a ( ifIndex, cHsrpGrpNumber ) pair. 77 78 BIA stands for Burned In Address." 79 REVISION "201009020000Z" 80 DESCRIPTION 81 "The following changes have been made. 82 83 [1] Objects cHsrpExtIfTrackedIpNone has been deprecated. 84 85 [2] Deprecates object group cHsrpExtIfTrackedGroupSup1, which 86 supplementary to cHsrpExtIfTrackedGroup. 87 88 89 [3] Added new compliance cHsrpExtComplianceRev2, which 90 deprecates cHsrpExtComplianceRev1." 91 REVISION "201002050000Z" 92 DESCRIPTION 93 "Added cHsrpExtIfTrackedIpNone to 94 cHsrpExtIfTrackedTable 95 96 Added new table cHsrpExtIfStandbyTable. 97 98 Added OBJECT-GROUP cHsrpExtIfStandbyGroup91. 99 100 Added OBJECT-GROUP cHsrpExtIfTrackedGroupSup1, which 101 supplementary to cHsrpExtIfTrackedGroup. 102 103 Added MODULE-COMPLIANCE cHsrpExtComplianceRev1, which 104 deprecates cHsrpExtCompliance." 105 REVISION "200602150000Z" 106 DESCRIPTION 107 "Updated the imports such that Unsigned32 is imported from 108 SNMPv2-SMI instead of CISCO-TC. Updated the module 109 description. Also updated the descriptions of 110 cHsrpExtIfTrackedEntry and cHsrpExtIfTracked. Formatted the 111 complete MIB." 112 REVISION "9808030000Z" 113 DESCRIPTION 114 "Initial version of this mib." 115 ::= { ciscoMgmt 107 } 116 117 118ciscoHsrpExtMIBObjects OBJECT IDENTIFIER 119 ::= { ciscoHsrpExtMIB 1 } 120 121-- HSRP Extension Tables 122-- Extention group info 123 124cHsrpExtGroup OBJECT IDENTIFIER 125 ::= { ciscoHsrpExtMIBObjects 1 } 126 127-- Interface Use Burned-In Address state 128 129cHsrpExtIfBIA OBJECT IDENTIFIER 130 ::= { ciscoHsrpExtMIBObjects 2 } 131 132 133cHsrpExtIfTrackedTable OBJECT-TYPE 134 SYNTAX SEQUENCE OF CHsrpExtIfTrackedEntry 135 MAX-ACCESS not-accessible 136 STATUS current 137 DESCRIPTION 138 "A table containing information about tracked interfaces per 139 HSRP group." 140 ::= { cHsrpExtGroup 1 } 141 142cHsrpExtIfTrackedEntry OBJECT-TYPE 143 SYNTAX CHsrpExtIfTrackedEntry 144 MAX-ACCESS not-accessible 145 STATUS current 146 DESCRIPTION 147 "Each row of this table allows the tracking of one 148 interface of the HSRP group which is identified by the 149 (ifIndex, cHsrpGrpNumber) values in this table's INDEX clause. 150 Weight(priority) is given to each and every interface tracked. 151 When a tracked interface is unavailable, the HSRP priority of 152 the router is decreased. i.e cHsrpGrpPriority value assigned 153 to an HSRP group will reduce by the value assigned to 154 cHsrpExtIfTrackedPriority. This reduces the likelihood 155 of a router with a failed key interface becoming the 156 active router. 157 158 Setting cHsrpExtIfTrackedRowStatus to active starts 159 the tracking of cHsrpExtIfTracked by the HSRP group. 160 The value of cHsrpExtIfTrackedRowStatus may be set 161 to destroy at any time. 162 163 Entries may not be created via SNMP without explicitly setting 164 cHsrpExtIfTrackedRowStatus to either 'createAndGo' 165 or 'createAndWait'. 166 167 Entries can be created and modified via the management 168 protocol or by the device's local management interface. 169 170 If the row is not active, and a local management interface 171 command modifies that row, the row may transition to active 172 state. 173 174 A row entry in the cHsrpExtIfTrackedTable can not be created 175 unless the corresponding row in the cHsrpGrpTable has been 176 created. If that corresponding row in cHsrpGrpTable is 177 deleted, the interfaces it tracks also get deleted. 178 179 A row which is not in active state will timeout after a 180 configurable period (five minutes by default). This timeout 181 period can be changed by setting cHsrpConfigTimeout." 182 INDEX { 183 ifIndex, 184 cHsrpGrpNumber, 185 cHsrpExtIfTracked 186 } 187 ::= { cHsrpExtIfTrackedTable 1 } 188 189CHsrpExtIfTrackedEntry ::= SEQUENCE { 190 cHsrpExtIfTracked InterfaceIndex, 191 cHsrpExtIfTrackedPriority Unsigned32, 192 cHsrpExtIfTrackedRowStatus RowStatus, 193 cHsrpExtIfTrackedIpNone TruthValue 194} 195 196cHsrpExtIfTracked OBJECT-TYPE 197 SYNTAX InterfaceIndex 198 MAX-ACCESS not-accessible 199 STATUS current 200 DESCRIPTION 201 "The ifIndex value of the tracked interface." 202 ::= { cHsrpExtIfTrackedEntry 1 } 203 204cHsrpExtIfTrackedPriority OBJECT-TYPE 205 SYNTAX Unsigned32 (0..255) 206 MAX-ACCESS read-create 207 STATUS current 208 DESCRIPTION 209 "Priority of the tracked interface for the corresponding 210 { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0 211 is the lowest priority and 255 is the highest. When a tracked 212 interface is unavailable, the cHsrpGrpPriority of the router 213 is decreased by the value of this object instance (If the 214 cHsrpGrpPriority is less than the 215 cHsrpExtIfTrackedPriority, then the HSRP priority 216 becomes 0). This allows a standby router to be configured 217 with a priority such that if the currently active router's 218 priority is lowered because the tracked interface goes down, 219 the standby router can takeover." 220 DEFVAL { 0 } 221 ::= { cHsrpExtIfTrackedEntry 2 } 222 223cHsrpExtIfTrackedRowStatus OBJECT-TYPE 224 SYNTAX RowStatus 225 MAX-ACCESS read-create 226 STATUS current 227 DESCRIPTION 228 "The control that allows modification, creation, and deletion 229 of entries. For detailed rules see the DESCRIPTION for 230 cHsrpExtIfTrackedEntry." 231 ::= { cHsrpExtIfTrackedEntry 3 } 232 233cHsrpExtIfTrackedIpNone OBJECT-TYPE 234 SYNTAX TruthValue 235 MAX-ACCESS read-create 236 STATUS deprecated 237 DESCRIPTION 238 "This object specifies the disable HSRP IPv4 virtual 239 IP address." 240 DEFVAL { false } 241 ::= { cHsrpExtIfTrackedEntry 4 } 242 243 244 245cHsrpExtSecAddrTable OBJECT-TYPE 246 SYNTAX SEQUENCE OF CHsrpExtSecAddrEntry 247 MAX-ACCESS not-accessible 248 STATUS current 249 DESCRIPTION 250 "A table containing information about secondary HSRP IP 251 Addresses per interface and group." 252 ::= { cHsrpExtGroup 2 } 253 254cHsrpExtSecAddrEntry OBJECT-TYPE 255 SYNTAX CHsrpExtSecAddrEntry 256 MAX-ACCESS not-accessible 257 STATUS current 258 DESCRIPTION 259 "The CHsrpExtSecAddrEntry allows creation of secondary 260 IP Addresses for each cHsrpGrpEntry row. 261 262 Secondary addresses can be added by setting 263 cHsrpExtSecAddrRowStatus to be active. The value of 264 cHsrpExtSecAddrRowStatus may be set to destroy at any 265 time. 266 267 Entries may not be created via SNMP without explicitly setting 268 cHsrpExtSecAddrRowStatus to either 'createAndGo' 269 or 'createAndWait'. 270 271 Entries can be created and modified via the management 272 protocol or by the device's local management interface. 273 274 If the row is not active, and a local management interface 275 command modifies that row, the row may transition to active 276 state. 277 278 A row which is not in active state will timeout after a 279 configurable period (five minutes by default). This timeout 280 period can be changed by setting cHsrpConfigTimeout. 281 282 Before creation of a cHsrpExtSecAddrEntry row, 283 either cHsrpGrpConfiguredVirtualIpAddr or 284 cHsrpGrpLearnedVirtualIpAddr must have a valid IP Address. 285 This is because a secondary ip address cannot be created 286 unless the primary ip address has already been set. 287 288 To create a new cHsrpExtSecAddrEntry row, a management 289 station should choose the ifIndex of the interface which is to 290 be added as part of an HSRP group. Also, an HSRP group number 291 and a cHsrpExtSecAddrAddress should be chosen. 292 293 Deleting a {ifIndex, cHsrpGrpNumber} row in the 294 cHsrpGrpTable will delete all corresponding 295 rows in the cHsrpExtSecAddrTable. 296 Deleting a primary address value in the cHsrpGrpEntry row 297 will delete all secondary addresses for the same 298 {ifIndex, cHsrpGrpNumber} pair." 299 INDEX { 300 ifIndex, 301 cHsrpGrpNumber, 302 cHsrpExtSecAddrAddress 303 } 304 ::= { cHsrpExtSecAddrTable 1 } 305 306CHsrpExtSecAddrEntry ::= SEQUENCE { 307 cHsrpExtSecAddrAddress IpAddress, 308 cHsrpExtSecAddrRowStatus RowStatus 309} 310 311cHsrpExtSecAddrAddress OBJECT-TYPE 312 SYNTAX IpAddress 313 MAX-ACCESS not-accessible 314 STATUS current 315 DESCRIPTION 316 "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair. 317 As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a 318 primary address must exist before a secondary address for 319 the same {ifIndex, cHsrpGrpNumber} pair can be created." 320 ::= { cHsrpExtSecAddrEntry 1 } 321 322cHsrpExtSecAddrRowStatus OBJECT-TYPE 323 SYNTAX RowStatus 324 MAX-ACCESS read-create 325 STATUS current 326 DESCRIPTION 327 "The control that allows modification, creation, and deletion 328 of entries. For detailed rules see the DESCRIPTION for 329 cHsrpExtSecAddrEntry." 330 ::= { cHsrpExtSecAddrEntry 2 } 331 332 333 334cHsrpExtIfStandbyTable OBJECT-TYPE 335 SYNTAX SEQUENCE OF CHsrpExtIfStandbyEntry 336 MAX-ACCESS not-accessible 337 STATUS current 338 DESCRIPTION 339 "A table containing information about standby 340 interfaces per HSRP group." 341 ::= { cHsrpExtGroup 3 } 342 343cHsrpExtIfStandbyEntry OBJECT-TYPE 344 SYNTAX CHsrpExtIfStandbyEntry 345 MAX-ACCESS not-accessible 346 STATUS current 347 DESCRIPTION 348 "The cHsrpExtIfStandbyEntry allows an HSRP group 349 interface to track one or more standby interfaces. 350 351 To create a new cHsrpExtIfStandbyEntry row, a 352 management station should choose the ifIndex of 353 the interface which is to be added as part of an 354 HSRP group. Also, an HSRP group number and a 355 cHsrpExtIfStandbyIndex should be chosen." 356 INDEX { 357 ifIndex, 358 cHsrpGrpNumber, 359 cHsrpExtIfStandbyIndex 360 } 361 ::= { cHsrpExtIfStandbyTable 1 } 362 363CHsrpExtIfStandbyEntry ::= SEQUENCE { 364 cHsrpExtIfStandbyIndex Unsigned32, 365 cHsrpExtIfStandbyDestAddrType InetAddressType, 366 cHsrpExtIfStandbyDestAddr InetAddress, 367 cHsrpExtIfStandbySourceAddrType InetAddressType, 368 cHsrpExtIfStandbySourceAddr InetAddress, 369 cHsrpExtIfStandbyRowStatus RowStatus 370} 371 372cHsrpExtIfStandbyIndex OBJECT-TYPE 373 SYNTAX Unsigned32 (1..4) 374 MAX-ACCESS not-accessible 375 STATUS current 376 DESCRIPTION 377 "This object defines the index of the standby table." 378 ::= { cHsrpExtIfStandbyEntry 1 } 379 380cHsrpExtIfStandbyDestAddrType OBJECT-TYPE 381 SYNTAX InetAddressType 382 MAX-ACCESS read-create 383 STATUS current 384 DESCRIPTION 385 "This object specifies the type of Internet address 386 denoted by cHsrpExtIfStandbyDestAddr." 387 ::= { cHsrpExtIfStandbyEntry 2 } 388 389cHsrpExtIfStandbyDestAddr OBJECT-TYPE 390 SYNTAX InetAddress 391 MAX-ACCESS read-create 392 STATUS current 393 DESCRIPTION 394 "This object specifies the destination IP address of 395 the standby router." 396 ::= { cHsrpExtIfStandbyEntry 3 } 397 398cHsrpExtIfStandbySourceAddrType OBJECT-TYPE 399 SYNTAX InetAddressType 400 MAX-ACCESS read-create 401 STATUS current 402 DESCRIPTION 403 "This object specifies the type of Internet address 404 denoted by cHsrpExtIfStandbySourceAddr." 405 ::= { cHsrpExtIfStandbyEntry 4 } 406 407cHsrpExtIfStandbySourceAddr OBJECT-TYPE 408 SYNTAX InetAddress 409 MAX-ACCESS read-create 410 STATUS current 411 DESCRIPTION 412 "This object specifies the source IP address of 413 the standby router." 414 ::= { cHsrpExtIfStandbyEntry 5 } 415 416cHsrpExtIfStandbyRowStatus OBJECT-TYPE 417 SYNTAX RowStatus 418 MAX-ACCESS read-create 419 STATUS current 420 DESCRIPTION 421 "The control that allows modification, creation, 422 and deletion of entries. Entries may not be created 423 via SNMP without explicitly setting 424 cHsrpExtIfStandbyRowStatus to either 425 'createAndGo' or 'createAndWait'." 426 ::= { cHsrpExtIfStandbyEntry 6 } 427 428 429 430cHsrpExtIfTable OBJECT-TYPE 431 SYNTAX SEQUENCE OF CHsrpExtIfEntry 432 MAX-ACCESS not-accessible 433 STATUS current 434 DESCRIPTION 435 "HSRP-specific configurations for each physical interface." 436 ::= { cHsrpExtIfBIA 1 } 437 438cHsrpExtIfEntry OBJECT-TYPE 439 SYNTAX CHsrpExtIfEntry 440 MAX-ACCESS not-accessible 441 STATUS current 442 DESCRIPTION 443 "If HSRP entries on this interface must use the BIA (Burned 444 In Address), there must be an entry for the interface in this 445 table. Entries of this table are only accessible if HSRP has 446 been enabled i.e entries can not be created if HSRP is not 447 enabled. Also, the interfaces should be of IEEE 802 ones 448 (Ethernet, Token Ring, FDDI,VLAN, LANE, TR-LANE). 449 450 Setting cHsrpExtIfRowStatus to active initiates the 451 entry with default value for cHsrpExtIfUseBIA as FALSE. 452 The value of cHsrpExtIfRowStatus may be set to destroy 453 at any time. If the row is not initiated, it is similar to 454 having cHsrpExtIfUseBIA as FALSE. 455 456 Entries may not be created via SNMP without explicitly setting 457 cHsrpExtIfRowStatus to either 'createAndGo' or 'createAndWait'. 458 459 Entries can be created and modified via the management 460 protocol or by the device's local management interface. 461 462 If the row is not active, and a local management interface 463 command modifies that row, the row may transition to active 464 state. 465 466 A row which is not in active state will timeout after a 467 configurable period (five minutes by default). This timeout 468 period can be changed by setting cHsrpConfigTimeout." 469 INDEX { ifIndex } 470 ::= { cHsrpExtIfTable 1 } 471 472CHsrpExtIfEntry ::= SEQUENCE { 473 cHsrpExtIfUseBIA TruthValue, 474 cHsrpExtIfRowStatus RowStatus 475} 476 477cHsrpExtIfUseBIA OBJECT-TYPE 478 SYNTAX TruthValue 479 MAX-ACCESS read-create 480 STATUS current 481 DESCRIPTION 482 "If set to TRUE, the HSRP Group MAC Address for all groups 483 on this interface will be the burned-in-address. Otherwise, 484 this will be determined by ciscoHsrpGroupNumber. In case of 485 sub-interfaces, UseBIA applies to all sub-interfaces on an 486 interface and to all groups on those sub-interfaces." 487 DEFVAL { false } 488 ::= { cHsrpExtIfEntry 1 } 489 490cHsrpExtIfRowStatus OBJECT-TYPE 491 SYNTAX RowStatus 492 MAX-ACCESS read-create 493 STATUS current 494 DESCRIPTION 495 "The control that allows modification, creation, and deletion 496 of entries. For detailed rules see the DESCRIPTION for 497 cHsrpExtIfEntry." 498 ::= { cHsrpExtIfEntry 2 } 499 500 501-- Notifications 502-- None 503-- 504-- Conformance groups 505 506cHsrpExtConformance OBJECT IDENTIFIER 507 ::= { ciscoHsrpExtMIB 3 } 508 509cHsrpExtCompliances OBJECT IDENTIFIER 510 ::= { cHsrpExtConformance 1 } 511 512cHsrpExtComplianceGroups OBJECT IDENTIFIER 513 ::= { cHsrpExtConformance 2 } 514 515 516-- compliance statements 517 518cHsrpExtCompliance MODULE-COMPLIANCE 519 STATUS deprecated 520 DESCRIPTION 521 "The compliance statement for entities which implement 522 the CISCO-HSRP-EXT-MIB. This is deprecated by 523 cHsrpExtComplianceRev1." 524 MODULE -- this module 525 MANDATORY-GROUPS { 526 cHsrpExtIfTrackedGroup, 527 cHsrpExtSecAddrGroup, 528 cHsrpExtIfGroup 529 } 530 ::= { cHsrpExtCompliances 1 } 531 532cHsrpExtComplianceRev1 MODULE-COMPLIANCE 533 STATUS deprecated 534 DESCRIPTION 535 "the compliance statement for entities which implement 536 the CISCO-HSRP-EXT-MIB.This is deprecated by 537 cHsrpExtComplianceRev2." 538 MODULE -- this module 539 MANDATORY-GROUPS { 540 cHsrpExtIfTrackedGroup, 541 cHsrpExtSecAddrGroup, 542 cHsrpExtIfGroup, 543 cHsrpExtIfStandbyGroup91, 544 cHsrpExtIfTrackedGroupSup1 545 } 546 ::= { cHsrpExtCompliances 2 } 547 548cHsrpExtComplianceRev2 MODULE-COMPLIANCE 549 STATUS current 550 DESCRIPTION 551 "the compliance statement for entities which implement 552 the CISCO-HSRP-EXT-MIB." 553 MODULE -- this module 554 MANDATORY-GROUPS { 555 cHsrpExtIfTrackedGroup, 556 cHsrpExtSecAddrGroup, 557 cHsrpExtIfGroup, 558 cHsrpExtIfStandbyGroup91 559 } 560 ::= { cHsrpExtCompliances 3 } 561 562cHsrpExtIfTrackedGroup OBJECT-GROUP 563 OBJECTS { 564 cHsrpExtIfTrackedPriority, 565 cHsrpExtIfTrackedRowStatus 566 } 567 STATUS current 568 DESCRIPTION 569 "The collection of objects used to add, delete and retrieve 570 the interfaces getting tracked for HSRP groups." 571 ::= { cHsrpExtComplianceGroups 1 } 572 573cHsrpExtSecAddrGroup OBJECT-GROUP 574 OBJECTS { cHsrpExtSecAddrRowStatus } 575 STATUS current 576 DESCRIPTION 577 "The collection of objects used to add, delete and retrieve 578 primary and secondary Ip Addresses for HSRP groups." 579 ::= { cHsrpExtComplianceGroups 2 } 580 581cHsrpExtIfGroup OBJECT-GROUP 582 OBJECTS { 583 cHsrpExtIfUseBIA, 584 cHsrpExtIfRowStatus 585 } 586 STATUS current 587 DESCRIPTION 588 "Object which tells if HSRP entries on this interface must 589 use BIA or not." 590 ::= { cHsrpExtComplianceGroups 3 } 591 592cHsrpExtIfStandbyGroup91 OBJECT-GROUP 593 OBJECTS { 594 cHsrpExtIfStandbyDestAddrType, 595 cHsrpExtIfStandbyDestAddr, 596 cHsrpExtIfStandbySourceAddrType, 597 cHsrpExtIfStandbySourceAddr, 598 cHsrpExtIfStandbyRowStatus 599 } 600 STATUS current 601 DESCRIPTION 602 "The collection of objects used to add, delete and 603 retrieve the interfaces getting standby for 604 HSRP groups." 605 ::= { cHsrpExtComplianceGroups 4 } 606 607cHsrpExtIfTrackedGroupSup1 OBJECT-GROUP 608 OBJECTS { cHsrpExtIfTrackedIpNone } 609 STATUS deprecated 610 DESCRIPTION 611 "The collection of HSRP interface tracked objects 612 which suppliments cHsrpExtIfTrackedGroup." 613 ::= { cHsrpExtComplianceGroups 5 } 614 615END 616 617 618 619