idnits 2.17.1 draft-ietf-bfd-mib-04.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 18. -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on line 1263. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1236. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1243. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1249. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 25) being 59 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([BFD]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust Copyright Line does not match the current year == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (February 25, 2008) is 5905 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-11) exists of draft-ietf-bfd-base-07 == Outdated reference: A later version (-09) exists of draft-ietf-bfd-multihop-06 == Outdated reference: A later version (-07) exists of draft-ietf-bfd-mpls-05 -- Obsolete informational reference (is this intentional?): RFC 2434 (Obsoleted by RFC 5226) Summary: 2 errors (**), 0 flaws (~~), 6 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 BFD Working Group Thomas D. Nadeau 2 INTERNET-DRAFT BT 3 Intended status: Standards Track Zafar Ali 4 Cisco Systems, Inc. 5 Nobo Akiya 6 Cisco Systems, G.K. 8 Expires: August 24, 2008 February 25, 2008 10 Bidirectional Forwarding Detection Management Information Base 11 draft-ietf-bfd-mib-04.txt 13 Status of this Memo 15 By submitting this Internet-Draft, each author represents that any 16 applicable patent or other IPR claims of which he or she is aware 17 have been or will be disclosed, and any of which he or she becomes 18 aware will be disclosed, in accordance with Section 6 of BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF), its areas, and its working groups. Note that other 22 groups may also distribute working documents as Internet-Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet-Drafts as reference 27 material or to cite them other than as "work in progress." 29 The list of current Internet-Drafts can be accessed at 30 http://www.ietf.org/ietf/1id-abstracts.txt. 32 The list of Internet-Draft Shadow Directories can be accessed at 33 http://www.ietf.org/shadow.html. 35 Abstract 37 This draft defines a portion of the Management Information Base 38 (MIB) for use with network management protocols in the Internet 39 community. In particular, it describes managed objects for modeling 40 Bidirectional Forwarding Detection (BFD) protocol [BFD]. 42 Contents 44 1. Introduction..................................................2 45 2. Terminology...................................................2 46 3. The Internet-Standard Management Framework....................2 47 4. Brief Description of MIB Objects..............................3 48 4.1 General Variables.............................................3 49 4.2 Session Table (bfdSessionTable)...............................3 51 BFD MIB February 25, 2008 53 4.3 Session Performance Table (bfdSessionPerfTable)...............3 54 4.4 BFD Session Discriminator Mapping Table (bfdSessDiscMapTable).3 55 4.5 BFD Session IP Mapping Table (bfdSessIpMapTable)..............3 56 5. BFD MIB Module Definitions....................................4 57 6. Security Considerations......................................23 58 7. IANA Considerations..........................................24 59 7.1 IANA Considerations for BFD-STD-MIB..........................24 60 8. References...................................................24 61 8.1 Normative References.........................................24 62 8.2 Informative References.......................................25 63 9. Acknowledgements.............................................25 64 10. Authors' Addresses...........................................25 65 11. Intellectual Property Statement..............................26 66 12. Full Copyright Statement.....................................26 68 1. Introduction 70 This memo defines an portion of the Management Information Base 71 (MIB) for use with network management protocols in the Internet 72 community. In particular, it describes managed objects to configure 73 and/or monitor Bi-Directional Forwarding Detection for [BFD] and 74 [BFD-MH],BFD versions 0 and/or 1, on devices supporting this 75 feature. 77 -- Ed Note: TBA, support for [BFD-LSP]. 79 This document adopts the definitions, acronyms and mechanisms 80 described in [BFD], [BFD-MH] and [BFD-LSP]. Unless otherwise 81 stated, the mechanisms described therein will not be re-described 82 here. 84 Comments should be made directly to the BFD mailing list at 85 rtg-bfd@ietf.org. 87 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 88 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and 89 "OPTIONAL" in this document are to be interpreted as described in 90 [RFC2119]. 92 2. Terminology 94 This document adopts the definitions, acronyms and mechanisms 95 described in [BFD], [BFD-MH] and [BFD-LSP]. Unless otherwise 96 stated, the mechanisms described therein will not be re-described 97 here. 99 BFD MIB February 25, 2008 101 3. The Internet-Standard Management Framework 103 For a detailed overview of the documents that describe the current 104 Internet-Standard Management Framework, please refer to section 7 of 105 RFC 3410 [RFC3410]. 107 Managed objects are accessed via a virtual information store, termed 108 the Management Information Base or MIB. MIB objects are generally 109 accessed through the Simple Network Management Protocol (SNMP). 110 Objects in the MIB are defined using the mechanisms defined in the 111 Structure of Management Information (SMI). This memo specifies a MIB 112 module that is compliant to the SMIv2, which is described in STD 58, 113 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 114 [RFC2580]. 116 4. Brief Description of MIB Objects 118 This section describes objects pertaining to BFD. The MIB objects 119 are derived from [BFD] and [BFD-MH]. 121 4.1 General Variables 123 The General Variables are used to identify parameters that are 124 global to the BFD process. 126 4.2 Session Table (bfdSessionTable) 128 The session table is used to identify a BFD session between a pair 129 of nodes. 131 4.3 Session Performance Table (bfdSessionPerfTable) 133 The session performance table is used for collecting BFD 134 performance counts on a per session basis. This table is an AUGMENT 135 to the bfdSessionTable. 137 4.4 BFD Session Discriminator Mapping Table (bfdSessDiscMapTable) 139 The BFD Session Discriminator Mapping Table maps a local 140 discriminator value to associated BFD sessions' BfdSessIndexTC used 141 in the bfdSessionTable. 143 4.5 BFD Session IP Mapping Table (bfdSessIpMapTable) 145 The BFD Session IP Mapping Table maps, given bfdSessInterface, 146 bfdSessAddrType, and bfdSessAddr, to an associated BFD sessions' 147 BfdSessIndexTC used in the bfdSessionTable. This table SHOULD 148 contains those BFD sessions are of IP type. 150 BFD MIB February 25, 2008 152 5. BFD MIB Module Definitions 154 This MIB module makes references to the following documents. 155 [RFC2578], [RFC2579], [RFC2580], [RFC2863], [RFC4001], and [RFC3413]. 157 BFD-STD-MIB DEFINITIONS ::= BEGIN 158 IMPORTS 159 MODULE-IDENTITY, OBJECT-TYPE, 160 Unsigned32, Counter32, Counter64, 161 NOTIFICATION-TYPE, mib-2 162 FROM SNMPv2-SMI -- [RFC2578] 164 TEXTUAL-CONVENTION, TruthValue, 165 RowStatus, StorageType, TimeStamp 166 FROM SNMPv2-TC -- [RFC2579] 168 MODULE-COMPLIANCE, OBJECT-GROUP, 169 NOTIFICATION-GROUP 170 FROM SNMPv2-CONF -- [RFC2580] 172 InterfaceIndex 173 FROM IF-MIB -- [RFC2863] 175 InetAddress, InetAddressType, InetPortNumber 176 FROM INET-ADDRESS-MIB -- [RFC4001] 177 ; 179 bfdMIB MODULE-IDENTITY 180 LAST-UPDATED "200802231200Z" -- 23 February 2008 12:00:00 EST 181 ORGANIZATION "IETF" 182 CONTACT-INFO 183 " Thomas D. Nadeau 184 BT 185 Email: tom.nadeau@bt.com 187 Zafar Ali 188 Cisco Systems, Inc. 189 Email: zali@cisco.com 191 Nobo Akiya 192 Cisco Systems, G.K. 193 Email: nobo@cisco.com 194 " 195 DESCRIPTION 196 "Bidirectional Forwarding Management Information Base." 198 BFD MIB February 25, 2008 200 -- Revision history. 201 REVISION 202 "200802231200Z" -- 23 February 2008 12:00:00 EST 203 DESCRIPTION 204 "Initial version. Published as RFC xxxx." -- RFC-editor pls fill 205 -- in xxxx 206 ::= { mib-2 XXX } -- assigned by IANA, see section 7.1 for details 208 -- Top level components of this MIB module. 210 bfdNotifications OBJECT IDENTIFIER ::= { bfdMIB 0 } 212 bfdObjects OBJECT IDENTIFIER ::= { bfdMIB 1 } 214 bfdConformance OBJECT IDENTIFIER ::= { bfdMIB 3 } 216 bfdScalarObjects OBJECT IDENTIFIER ::= { bfdObjects 1 } 218 -- Textual Conventions 220 BfdSessIndexTC ::= TEXTUAL-CONVENTION 221 DISPLAY-HINT "d" 222 STATUS current 223 DESCRIPTION 224 "An index used to uniquely identify BFD sessions." 225 SYNTAX Unsigned32 (1..4294967295) 227 BfdInterval ::= TEXTUAL-CONVENTION 228 STATUS current 229 DESCRIPTION 230 "The BFD interval delay in microseconds." 231 SYNTAX Unsigned32 (1..4294967295) 233 BfdDiag ::= TEXTUAL-CONVENTION 234 STATUS current 235 DESCRIPTION 236 "A common BFD diagnostic code." 237 SYNTAX INTEGER { noDiagnostic(1), 238 controlDetectionTimeExpired(2), 239 echoFunctionFailed(3), 240 neighborSignaledSessionDown(4), 241 forwardingPlaneReset(5), 242 pathDown(6), 243 concatenatedPathDown(7), 244 administrativelyDown(8), 245 reverseConcatenatedPathDown (9) 246 } 248 BFD MIB February 25, 2008 250 -- BFD General Variables 252 -- These parameters apply globally to the Router's 253 -- BFD Process. 255 bfdAdminStatus OBJECT-TYPE 256 SYNTAX INTEGER { enabled(1), disabled(2) } 258 MAX-ACCESS read-write 259 STATUS current 260 DESCRIPTION 261 "The global administrative status of BFD in this router. 262 The value 'enabled' denotes that the BFD Process is 263 active on at least one interface; 'disabled' disables 264 it on all interfaces." 265 DEFVAL { enabled } 266 ::= { bfdScalarObjects 1 } 268 -- BFD Session Table 269 -- The BFD Session Table specifies BFD session specific 270 -- information. 272 bfdSessTable OBJECT-TYPE 273 SYNTAX SEQUENCE OF BfdSessEntry 274 MAX-ACCESS not-accessible 275 STATUS current 276 DESCRIPTION 277 "The BFD Session Table describes the BFD sessions." 278 REFERENCE 279 "BFD Version 0 (draft-katz-ward-bfd-02.txt) and 280 BFD Version 1 (draft-ietf-bfd-base-07.txt)" 281 ::= { bfdObjects 2 } 283 bfdSessEntry OBJECT-TYPE 284 SYNTAX BfdSessEntry 285 MAX-ACCESS not-accessible 286 STATUS current 287 DESCRIPTION 288 "The BFD Session Entry describes BFD session." 289 INDEX { bfdSessIndex } 290 ::= { bfdSessTable 1 } 292 BfdSessEntry ::= SEQUENCE { 293 bfdSessIndex BfdSessIndexTC, 294 bfdSessVersionNumber Unsigned32, 295 bfdSessType INTEGER, 296 bfdSessDiscriminator Unsigned32, 297 bfdSessRemoteDiscr Unsigned32, 299 BFD MIB February 25, 2008 301 bfdSessUdpPort InetPortNumber, 302 bfdSessState INTEGER, 303 bfdSessRemoteHeardFlag TruthValue, 304 bfdSessDiag BfdDiag, 305 bfdSessOperMode INTEGER, 306 bfdSessDemandModeDesiredFlag TruthValue, 307 bfdSessEchoFuncModeDesiredFlag TruthValue, 308 bfdSessControlPlanIndepFlag TruthValue, 309 bfdSessInterface InterfaceIndex, 310 bfdSessAddrType InetAddressType, 311 bfdSessAddr InetAddress, 312 bfdSessDesiredMinTxInterval BfdInterval, 313 bfdSessReqMinRxInterval BfdInterval, 314 bfdSessReqMinEchoRxInterval BfdInterval, 315 bfdSessDetectMult Unsigned32, 316 bfdSessStorType StorageType, 317 bfdSessRowStatus RowStatus, 318 bfdSessAuthPresFlag TruthValue, 319 bfdSessAuthenticationType INTEGER 320 } 322 bfdSessIndex OBJECT-TYPE 323 SYNTAX BfdSessIndexTC 324 MAX-ACCESS not-accessible 325 STATUS current 326 DESCRIPTION 327 "This object contains an index used to represent a 328 unique BFD session on this device." 329 ::= { bfdSessEntry 1 } 331 bfdVersionNumber OBJECT-TYPE 332 SYNTAX Unsigned32 333 MAX-ACCESS read-only 334 STATUS current 335 DESCRIPTION 336 "The version number of the BFD protocol that this session 337 is running in." 338 REFERENCE 339 "BFD Version 0 (draft-katz-ward-bfd-02.txt) and 340 BFD Version 1 (draft-ietf-bfd-base-07.txt)" 341 DEFVAL { 0 } 342 ::= { bfdSessEntry 2 } 344 bfdSessType OBJECT-TYPE 345 SYNTAX INTEGER { 346 singleHop(1), 347 multiHop(2) 348 } 350 BFD MIB February 25, 2008 352 MAX-ACCESS read-only 353 STATUS current 354 DESCRIPTION 355 "The type of this BFD session." 356 ::= { bfdSessEntry 3 } 358 bfdSessDiscriminator OBJECT-TYPE 359 SYNTAX Unsigned32 (1..4294967295) 360 MAX-ACCESS read-only 361 STATUS current 362 DESCRIPTION 363 "This object specifies the local discriminator for this BFD 364 session, used to uniquely identify it." 365 ::= { bfdSessEntry 4 } 367 bfdSessRemoteDiscr OBJECT-TYPE 368 SYNTAX Unsigned32 (1..4294967295) 369 MAX-ACCESS read-only 370 STATUS current 371 DESCRIPTION 372 "This object specifies the session discriminator chosen 373 by the remote system for this BFD session." 374 ::= { bfdSessEntry 5 } 376 bfdSessUdpPort OBJECT-TYPE 377 SYNTAX InetPortNumber 378 MAX-ACCESS read-create 379 STATUS current 380 DESCRIPTION 381 "The destination UDP Port for BFD. The default value is 382 the well-known value for this port. BFD State failing(5) 383 is only applicable if this BFD session is running 384 version 0" 385 REFERENCE 386 "draft-katz-ward-bfd-02.txt and 387 draft-raggarwa-mpls-bfd-00.txt" 388 DEFVAL { 0 } 389 ::= { bfdSessEntry 6 } 391 bfdSessState OBJECT-TYPE 392 SYNTAX INTEGER { 393 adminDown(1), 394 down(2), 395 init(3), 396 up(4), 397 failing(5) 398 } 399 MAX-ACCESS read-only 401 BFD MIB February 25, 2008 403 STATUS current 404 DESCRIPTION 405 "The perceived state of the BFD session." 406 ::= { bfdSessEntry 7 } 408 bfdSessRemoteHeardFlag OBJECT-TYPE 409 SYNTAX TruthValue 410 MAX-ACCESS read-only 411 STATUS current 413 DESCRIPTION 414 "This object specifies status of BFD packet reception from 415 the remote system. Specifically, it is set to true(1) if 416 the local system is actively receiving BFD packets from the 417 remote system, and is set to false(0) if the local system 418 has not received BFD packets recently (within the detection 419 time) or if the local system is attempting to tear down 420 the BFD session. Value placed in this object is valid only 421 if this session is running in BFD version 0." 422 REFERENCE 423 "BFD Version 0 (draft-katz-ward-bfd-02.txt) and 424 BFD Version 1 (draft-ietf-bfd-base-07.txt)" 425 DEFVAL { 0 } 426 ::= { bfdSessEntry 8 } 428 bfdSessDiag OBJECT-TYPE 429 SYNTAX BfdDiag 430 MAX-ACCESS accessible-for-notify 431 STATUS current 432 DESCRIPTION 433 "A diagnostic code specifying the local system's reason 434 for the last transition of the session from up(4) 435 to some other state." 436 ::= { bfdSessEntry 9 } 438 bfdSessOperMode OBJECT-TYPE 439 SYNTAX INTEGER { asyncModeWEchoFun(1), 440 asynchModeWOEchoFun(2), 441 demandModeWEchoFunction(3), 442 demandModeWOEchoFunction(4) 443 } 444 MAX-ACCESS read-only 445 STATUS current 446 DESCRIPTION 447 "This object specifies current operating mode that BFD 448 session is operating in. 450 BFD MIB February 25, 2008 452 A value of AsyncModeWEchoFun(1) ... 453 A value of AsynchModeWOEchoFun(2) ... 454 A value of DemandModeWEchoFunction(3) ... 455 A value of DemandModeWOEchoFunction(4) ... 456 " 457 ::= { bfdSessEntry 10 } 459 bfdSessDemandModeDesiredFlag OBJECT-TYPE 460 SYNTAX TruthValue 461 MAX-ACCESS read-create 462 STATUS current 463 DESCRIPTION 464 "This object indicates that the local system's 465 desire to use Demand mode. Specifically, it is set 466 to true(1) if the local system wishes to use 467 Demand mode or false(0) if not" 468 DEFVAL { false } 469 ::= { bfdSessEntry 11 } 471 bfdSessEchoFuncModeDesiredFlag OBJECT-TYPE 472 SYNTAX TruthValue 473 MAX-ACCESS read-create 474 STATUS current 475 DESCRIPTION 476 "This object indicates that the local system's 477 desire to use Echo mode. Specifically, it is set 478 to true(1) if the local system wishes to use 479 Echo mode or false(0) if not" 480 DEFVAL { false } 481 ::= { bfdSessEntry 12 } 483 bfdSessControlPlanIndepFlag OBJECT-TYPE 484 SYNTAX TruthValue 485 MAX-ACCESS read-create 486 STATUS current 487 DESCRIPTION 488 "This object indicates that the local system's 489 ability to continue to function through a disruption of 490 the control plane. Specifically, it is set 491 to true(1) if the local system BFD implementation is 492 independent of the control plane. Otherwise, the 493 value is set to false(0)" 494 DEFVAL { false } 495 ::= { bfdSessEntry 13 } 497 BFD MIB February 25, 2008 499 bfdSessInterface OBJECT-TYPE 500 SYNTAX InterfaceIndex 501 MAX-ACCESS read-only 502 STATUS current 503 DESCRIPTION 504 "This object contains an interface index used to indicate 505 the interface which this BFD session is running on. This 506 value can be zero if there are no interface associated 507 with this BFD session" 508 ::= { bfdSessEntry 14 } 510 bfdSessAddrType OBJECT-TYPE 511 SYNTAX InetAddressType 512 MAX-ACCESS read-create 513 STATUS current 514 DESCRIPTION 515 "This object specifies IP address type of the neighboring IP 516 address which is being monitored with this BFD session. 518 Only values unknown(0), ipv4(1) or ipv6(2) 519 have to be supported. 521 A value of unknown(0) is allowed only when 522 the outgoing interface is of type point-to-point, or 523 when the BFD session is not associated with a specific 524 interface. 526 If any other unsupported values are attempted in a set 527 operation, the agent MUST return an inconsistentValue 528 error. 529 " 530 ::= { bfdSessEntry 15 } 532 bfdSessAddr OBJECT-TYPE 533 SYNTAX InetAddress 534 MAX-ACCESS read-create 535 STATUS current 536 DESCRIPTION 537 "This object specifies the neighboring IP address which is 538 being monitored with this BFD session. 539 It can also be used to enabled BFD on a specific 540 interface. The value is set to zero when BFD session is not 541 associated with a specific interface. " 542 ::= { bfdSessEntry 16 } 544 BFD MIB February 25, 2008 546 bfdSessDesiredMinTxInterval OBJECT-TYPE 547 SYNTAX BfdInterval 548 MAX-ACCESS read-create 549 STATUS current 550 DESCRIPTION 551 "This object specifies the minimum interval, in 552 microseconds, that the local system would like to use when 553 transmitting BFD Control packets." 554 ::= { bfdSessEntry 17 } 556 bfdSessReqMinRxInterval OBJECT-TYPE 557 SYNTAX BfdInterval 558 MAX-ACCESS read-create 559 STATUS current 560 DESCRIPTION 561 "This object specifies the minimum interval, in 562 microseconds, between received BFD Control packets the 563 local system is capable of supporting." 564 ::= { bfdSessEntry 18 } 566 bfdSessReqMinEchoRxInterval OBJECT-TYPE 567 SYNTAX BfdInterval 568 MAX-ACCESS read-create 569 STATUS current 570 DESCRIPTION 571 "This object specifies the minimum interval, in 572 microseconds, between received BFD Echo packets that this 573 system is capable of supporting." 574 ::= { bfdSessEntry 19 } 576 bfdSessDetectMult OBJECT-TYPE 577 SYNTAX Unsigned32 578 MAX-ACCESS read-create 579 STATUS current 580 DESCRIPTION 581 "This object specifies the Detect time multiplier." 582 ::= { bfdSessEntry 20 } 584 bfdSessStorType OBJECT-TYPE 585 SYNTAX StorageType 586 MAX-ACCESS read-create 587 STATUS current 588 DESCRIPTION 589 "This variable indicates the storage type for this 590 object. Conceptual rows having the value 591 'permanent' need not allow write-access to any 592 columnar objects in the row." 593 ::= { bfdSessEntry 21 } 595 BFD MIB February 25, 2008 597 bfdSessRowStatus OBJECT-TYPE 598 SYNTAX RowStatus 599 MAX-ACCESS read-create 600 STATUS current 601 DESCRIPTION 602 "This variable is used to create, modify, and/or 603 delete a row in this table. When a row in this 604 table has a row in the active(1) state, no 605 objects in this row can be modified except the 606 bfdSessRowStatus and bfdSessStorageType." 607 ::= { bfdSessEntry 22 } 609 bfdSessAuthPresFlag OBJECT-TYPE 610 SYNTAX TruthValue 611 MAX-ACCESS read-create 612 STATUS current 613 DESCRIPTION 614 "This object indicates that the local system's 615 desire to use Authentication. Specifically, it is set 616 to true(1) if the local system wishes the session 617 to be authenticated or false(0) if not" 618 DEFVAL { false } 619 ::= { bfdSessEntry 23 } 621 bfdSessAuthenticationType OBJECT-TYPE 622 SYNTAX INTEGER { simplePassword(1), 623 keyedMD5(2), 624 meticulousKeyedMD5(3), 625 keyedSHA1(4), 626 meticulousKeyedSHA1(5) 627 } 628 MAX-ACCESS read-create 629 STATUS current 630 DESCRIPTION 631 "The Authentication Type used for this BFD session. This 632 field is valid only when the Authentication Present bit is set" 633 ::= { bfdSessEntry 24 } 635 -- BFD Session Performance Table 637 bfdSessPerfTable OBJECT-TYPE 638 SYNTAX SEQUENCE OF BfdSessPerfEntry 639 MAX-ACCESS not-accessible 640 STATUS current 641 DESCRIPTION 642 "This table specifies BFD Session performance counters." 643 ::= { bfdObjects 3 } 645 BFD MIB February 25, 2008 647 bfdSessPerfEntry OBJECT-TYPE 648 SYNTAX BfdSessPerfEntry 649 MAX-ACCESS not-accessible 650 STATUS current 651 DESCRIPTION 652 "An entry in this table is created by a BFD-enabled node for 653 every BFD Session. bfdCounterDiscontinuityTime is used to 654 indicate potential discontinuity for all counter objects 655 in this table." 656 AUGMENTS { bfdSessEntry } 657 ::= { bfdSessPerfTable 1 } 659 BfdSessPerfEntry ::= SEQUENCE { 660 bfdSessPerfPktIn Counter32, 661 bfdSessPerfPktOut Counter32, 662 bfdSessUpTime TimeStamp, 663 bfdSessPerfLastSessDownTime TimeStamp, 664 bfdSessPerfLastCommLostDiag BfdDiag, 665 bfdSessPerfSessUpCount Counter32, 666 bfdSessPerfDiscTime TimeStamp, 668 -- High Capacity Counters 669 bfdSessPerfPktInHC Counter64, 670 bfdSessPerfPktOutHC Counter64 671 } 673 -- Ed Note: should we add per-diag code counts here, 675 bfdSessPerfPktIn OBJECT-TYPE 676 SYNTAX Counter32 677 MAX-ACCESS read-only 678 STATUS current 679 DESCRIPTION 680 "The total number of BFD messages received for this BFD 681 session." 682 ::= { bfdSessPerfEntry 1 } 684 bfdSessPerfPktOut OBJECT-TYPE 685 SYNTAX Counter32 686 MAX-ACCESS read-only 687 STATUS current 688 DESCRIPTION 689 "The total number of BFD messages sent for this BFD session." 690 ::= { bfdSessPerfEntry 2 } 692 BFD MIB February 25, 2008 694 bfdSessUpTime OBJECT-TYPE 695 SYNTAX TimeStamp 696 MAX-ACCESS read-only 697 STATUS current 698 DESCRIPTION 699 "The value of sysUpTime on the most recent occasion at which 700 the session came up. If no such up event exists this object 701 contains a zero value." 702 ::= { bfdSessPerfEntry 3 } 704 bfdSessPerfLastSessDownTime OBJECT-TYPE 705 SYNTAX TimeStamp 706 MAX-ACCESS read-only 707 STATUS current 708 DESCRIPTION 709 "The value of sysUpTime on the most recent occasion at which 710 the last time communication was lost with the neighbor. If 711 no such down event exist this object contains a zero value." 712 ::= { bfdSessPerfEntry 4 } 714 bfdSessPerfLastCommLostDiag OBJECT-TYPE 715 SYNTAX BfdDiag 716 MAX-ACCESS read-only 717 STATUS current 718 DESCRIPTION 719 "The BFD diag code for the last time communication was lost 720 with the neighbor. If no such down event exists this object 721 contains a zero value." 722 ::= { bfdSessPerfEntry 5 } 724 bfdSessPerfSessUpCount OBJECT-TYPE 725 SYNTAX Counter32 726 MAX-ACCESS read-only 727 STATUS current 728 DESCRIPTION 729 "The number of times this session has gone into the Up 730 state since the router last rebooted." 731 ::= { bfdSessPerfEntry 6 } 733 bfdSessPerfDiscTime OBJECT-TYPE 734 SYNTAX TimeStamp 735 MAX-ACCESS read-only 736 STATUS current 737 DESCRIPTION 738 "The value of sysUpTime on the most recent occasion at 739 which any one or more of the session counters suffered 740 a discontinuity. 742 BFD MIB February 25, 2008 744 The relevant counters are the specific instances associated 745 with this BFD session of any Counter32 object contained in 746 the BfdSessPerfTable. If no such discontinuities have occurred 747 since the last re-initialization of the local management 748 subsystem, then this object contains a zero value." 749 ::= { bfdSessPerfEntry 7 } 751 bfdSessPerfPktInHC OBJECT-TYPE 752 SYNTAX Counter64 753 MAX-ACCESS read-only 754 STATUS current 755 DESCRIPTION 756 "This value represents the total number of BFD messages 757 received for this BFD session. It MUST be equal to the 758 least significant 32 bits of bfdSessPerfPktIn 759 if bfdSessPerfPktInHC is supported according to 760 the rules spelled out in RFC2863." 761 ::= { bfdSessPerfEntry 8 } 763 bfdSessPerfPktOutHC OBJECT-TYPE 764 SYNTAX Counter64 765 MAX-ACCESS read-only 766 STATUS current 767 DESCRIPTION 768 "This value represents the total number of 769 total number of BFD messages transmitted for this 770 BFD session. It MUST be equal to the 771 least significant 32 bits of bfdSessPerfPktIn 772 if bfdSessPerfPktOutHC is supported according to 773 the rules spelled out in RFC2863." 774 ::= { bfdSessPerfEntry 9 } 776 -- BFD Session Discriminator Mapping Table 778 bfdSessDiscMapTable OBJECT-TYPE 779 SYNTAX SEQUENCE OF BfdSessDiscMapEntry 780 MAX-ACCESS not-accessible 781 STATUS current 782 DESCRIPTION 783 "The BFD Session Discriminator Mapping Table maps a 784 local discriminator value to associated BFD sessions' 785 BfdSessIndexTC used in the bfdSessionTable." 786 ::= { bfdObjects 4 } 788 BFD MIB February 25, 2008 790 bfdSessDiscMapEntry OBJECT-TYPE 791 SYNTAX BfdSessDiscMapEntry 792 MAX-ACCESS not-accessible 793 STATUS current 794 DESCRIPTION 795 "The BFD Session Discriminator Map Entry describes 796 BFD session that is mapped to this BfdSessIndexTC." 797 INDEX { bfdSessDiscriminator } 798 ::= { bfdSessDiscMapTable 1 } 800 BfdSessDiscrMapEntry ::= SEQUENCE { 801 bfdSessDiscMapIndex BfdSessIndexTC 802 } 804 bfdSessDiscMapIndex OBJECT-TYPE 805 SYNTAX BfdSessIndexTC 806 MAX-ACCESS read-only 807 STATUS current 808 DESCRIPTION 809 "This object specifies the BfdIndex referred to by 810 the indexes of this row. In essence, a mapping is 811 provided between these indexes and the BfdSessTable." 812 ::= { bfdSessDiscMapEntry 1 } 814 -- BFD Session IP Mapping Table 816 bfdSessIpMapTable OBJECT-TYPE 817 SYNTAX SEQUENCE OF BfdSessIpMapEntry 818 MAX-ACCESS not-accessible 819 STATUS current 820 DESCRIPTION 821 "The BFD Session IP Mapping Table maps given 822 bfdSessInterface, bfdSessAddrType, and bfdSessAddr 823 to an associated BFD sessions' BfdSessIndexTC used in 824 the bfdSessionTable. This table SHOULD contains those 825 BFD sessions are of IP type: SingleHop(1) and 826 MultiHop(2)." 827 ::= { bfdObjects 5 } 829 bfdSessIpMapEntry OBJECT-TYPE 830 SYNTAX BfdSessIpMapEntry 831 MAX-ACCESS not-accessible 832 STATUS current 833 DESCRIPTION 834 "The BFD Session IP Map Entry describes 835 BFD session that is mapped to this BfdSessIndexTC." 837 BFD MIB February 25, 2008 839 INDEX { bfdSessInterface, 840 bfdSessAddrType, 841 bfdSessAddr 842 } 843 ::= { bfdSessIpMapTable 1 } 845 BfdSessIpMapEntry ::= SEQUENCE { 846 bfdSessIpMapIndex BfdSessIndexTC 847 } 849 bfdSessIpMapIndex OBJECT-TYPE 850 SYNTAX BfdSessIndexTC 851 MAX-ACCESS read-only 852 STATUS current 853 DESCRIPTION 854 "This object specifies the BfdIndex referred to by 855 the indexes of this row. In essence, a mapping is 856 provided between these indexes and the BfdSessTable." 857 ::= { bfdSessIpMapEntry 1 } 859 -- Notification Configuration 861 bfdSessNotificationsEnable OBJECT-TYPE 862 SYNTAX TruthValue 863 MAX-ACCESS read-write 864 STATUS current 865 DESCRIPTION 866 "If this object is set to true(1), then it enables 867 the emission of bfdSessUp and bfdSessDown 868 notifications; otherwise these notifications are not 869 emitted." 870 REFERENCE 871 "See also RFC3413 for explanation that 872 notifications are under the ultimate control of the 873 MIB modules in this document." 874 DEFVAL { false } 875 ::= { bfdScalarObjects 4 } 877 bfdSessUp NOTIFICATION-TYPE 878 OBJECTS { bfdSessDiag, -- low range value 879 bfdSessDiag -- high range value 880 } 881 STATUS current 882 DESCRIPTION 883 "This notification is generated when the 884 bfdSessState object for one or more contiguous 885 entries in bfdSessTable are about to enter the up(4) 886 state from some other state. The included values of 888 BFD MIB February 25, 2008 890 bfdSessDiag MUST both be set equal to this 891 new state (i.e: up(4)). The two instances of 892 bfdSessDiag in this notification indicate the range 893 of indexes that are affected. Note that all the indexes 894 of the two ends of the range can be derived from the 895 instance identifiers of these two objects. For the 896 cases where a contiguous range of sessions 897 have transitioned into the up(4) state at roughly 898 the same time, the device SHOULD issue a single 899 notification for each range of contiguous indexes in 900 an effort to minimize the emission of a large number 901 of notifications. If a notification has to be 902 issued for just a single bfdSessEntry, then 903 the instance identifier (and values) of the two 904 bfdSessDiag objects MUST be the identical." 905 ::= { bfdNotifications 1 } 907 bfdSessDown NOTIFICATION-TYPE 908 OBJECTS { bfdSessDiag, -- low range value 909 bfdSessDiag -- high range value 910 } 911 STATUS current 912 DESCRIPTION 913 "This notification is generated when the 914 bfdSessState object for one or more contiguous 915 entries in bfdSessTable are about to enter the down(2) 916 or adminDown(1) states from some other state. The included 917 values of bfdSessDiag MUST both be set equal to this 918 new state (i.e: down(2) or adminDown(1)). The two instances 919 of bfdSessDiag in this notification indicate the range 920 of indexes that are affected. Note that all the indexes 921 of the two ends of the range can be derived from the 922 instance identifiers of these two objects. For 923 cases where a contiguous range of sessions 924 have transitioned into the down(2) or adminDown(1) states 925 at roughly the same time, the device SHOULD issue a single 926 notification for each range of contiguous indexes in 927 an effort to minimize the emission of a large number 928 of notifications. If a notification has to be 929 issued for just a single bfdSessEntry, then 930 the instance identifier (and values) of the two 931 bfdSessDiag objects MUST be the identical." 932 ::= { bfdNotifications 2 } 934 BFD MIB February 25, 2008 936 -- Ed Note: We need to add notification for changes 937 -- when the two ends automatically negotiate to a new detection time 938 -- value or when detection multiplier changes. 939 -- Similarly, changes in the operating mode (bfdSessOperMode) 940 -- also need to be notified. 942 -- Module compliance. 944 bfdGroups 945 OBJECT IDENTIFIER ::= { bfdConformance 1 } 947 bfdCompliances 948 OBJECT IDENTIFIER ::= { bfdConformance 2 } 950 -- Compliance requirement for fully compliant implementations. 952 bfdModuleFullCompliance MODULE-COMPLIANCE 953 STATUS current 954 DESCRIPTION "Compliance statement for agents that provide full 955 support for BFD-MIB. Such devices can 956 then be monitored and also be configured using 957 this MIB module." 959 MODULE -- This module. 960 MANDATORY-GROUPS { 961 bfdSessionGroup, 962 bfdSessionPerfGroup, 963 bfdSessionPerfHCGroup, 964 bfdNotificationGroup 965 } 967 GROUP bfdSessionPerfHCGroup 968 DESCRIPTION "This group is mandatory for those bfdPerfTable 969 entries for which any of the objects 970 bfdSessPerfPktInHC or bfdSessPerfPktOutHC 971 wraps around too quickly 972 based on the criteria specified in RFC 2863 for 973 high-capacity counters." 975 GROUP bfdNotificationGroup 976 DESCRIPTION "This group is only mandatory for those 977 implementations which can efficiently implement 978 the notifications contained in this group." 980 OBJECT bfdSessAddrType 981 SYNTAX InetAddressType { unknown(0), ipv4(1), ipv6(2) } 982 DESCRIPTION "Only unknown(0), ipv4(1) and ipv6(2) support 983 is required." 985 BFD MIB February 25, 2008 987 OBJECT bfdSessAddr 988 SYNTAX InetAddress (SIZE(0|4|16)) 989 DESCRIPTION "An implementation is only required to support 990 unknown(0), ipv4(1) and ipv6(2) sizes." 992 ::= { bfdCompliances 1 } 994 -- Read-Only Conformance TBD... 996 -- Units of conformance. 998 bfdSessionGroup OBJECT-GROUP 999 OBJECTS { 1000 bfdSessNotificationsEnable, 1001 bfdAdminStatus, 1002 bfdSessVersionNumber, 1003 bfdSessType, 1004 bfdSessDiscriminator, 1005 bfdSessRemoteDiscr, 1006 bfdSessUdpPort, 1007 bfdSessState, 1008 bfdSessRemoteHeardFlag, 1009 bfdSessDiag, 1010 bfdSessOperMode, 1011 bfdSessDemandModeDesiredFlag, 1012 bfdSessEchoFuncModeDesiredFlag, 1013 bfdSessControlPlanIndepFlag, 1014 bfdSessInterface, 1015 bfdSessAddrType, 1016 bfdSessAddr, 1017 bfdSessDesiredMinTxInterval, 1018 bfdSessReqMinRxInterval, 1019 bfdSessReqMinEchoRxInterval, 1020 bfdSessDetectMult, 1021 bfdSessStorType, 1022 bfdSessRowStatus, 1023 bfdSessAuthPresFlag, 1024 bfdSessAuthenticationType, 1025 bfdSessDiscMapIndex, 1026 bfdSessIpMapIndex 1027 } 1028 STATUS current 1029 DESCRIPTION 1030 "Collection of objects needed for BFD sessions." 1031 ::= { bfdGroups 1 } 1033 BFD MIB February 25, 2008 1035 bfdSessionPerfGroup OBJECT-GROUP 1036 OBJECTS { 1037 bfdSessPerfPktIn, 1038 bfdSessPerfPktOut, 1039 bfdSessUpTime, 1040 bfdSessPerfLastSessDownTime, 1041 bfdSessPerfLastCommLostDiag, 1042 bfdSessPerfSessUpCount, 1043 bfdSessPerfDiscTime 1044 } 1045 STATUS current 1046 DESCRIPTION 1047 "Collection of objects needed to monitor the 1048 performance of BFD sessions." 1049 ::= { bfdGroups 2 } 1051 bfdSessionPerfHCGroup OBJECT-GROUP 1052 OBJECTS { 1053 bfdSessPerfPktInHC, 1054 bfdSessPerfPktOutHC 1055 } 1056 STATUS current 1057 DESCRIPTION 1058 "Collection of objects needed to monitor the 1059 performance of BFD sessions for which the 1060 values of bfdSessPerfPktIn, bfdSessPerfPktOut 1061 wrap around too quickly." 1062 ::= { bfdGroups 3 } 1064 bfdNotificationGroup NOTIFICATION-GROUP 1065 NOTIFICATIONS { 1066 bfdSessUp, 1067 bfdSessDown 1068 } 1069 STATUS current 1070 DESCRIPTION 1071 "Set of notifications implemented in this 1072 module." 1073 ::= { bfdGroups 4 } 1075 END 1077 BFD MIB February 25, 2008 1079 6. Security Considerations 1081 There are a number of management objects defined in this MIB 1082 module with a MAX-ACCESS clause of read-write and/or read-create. 1083 Such objects may be considered sensitive or vulnerable in some 1084 network environments. It is thus important to control even GET and/or 1085 NOTIFY access to these objects and possibly to even encrypt the 1086 values of these objects when sending them over the network via SNMP. 1088 o The bfdSessTable may be used to directly configure BFD 1089 sessions. The bfdSessMapTable can be used indirectly 1090 in the same way. Unauthorized access to objects in 1091 this table could result in disruption of traffic on 1092 the network. This is especially true if an unauthorized 1093 user configures enough tables to invoke a denial of 1094 service attack on the device where they are configured, 1095 or on a remote device where the sessions terminate. 1097 Some of the readable objects in this MIB module (i.e., objects 1098 with a MAX-ACCESS other than not-accessible) may be considered 1099 sensitive or vulnerable in some network environments. It is thus 1100 important to control even GET and/or NOTIFY access to these objects 1101 and possibly to even encrypt the values of these objects when sending 1102 them over the network via SNMP. These are the tables and objects and 1103 their sensitivity/vulnerability: 1105 o The bfdSessPerfTable both allows access to the performance 1106 characteristics of BFD sessions. Network administrators not 1107 wishing to show this information should consider this 1108 table sensative. 1110 SNMP versions prior to SNMPv3 did not include adequate security. 1111 Even if the network itself is secure "for example by using IPSec", 1112 even then, there is no control as to who on the secure network is 1113 allowed to access and GET/SET "read/change/create/delete" the objects 1114 in these MIB modules. 1116 It is RECOMMENDED that implementers consider the security features 1117 as provided by the SNMPv3 framework "see [RFC3410], section 8", 1118 including full support for the SNMPv3 cryptographic mechanisms "for 1119 authentication and privacy". 1121 BFD MIB February 25, 2008 1123 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1124 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1125 enable cryptographic security. It is then a customer/operator 1126 responsibility to ensure that the SNMP entity giving access to an 1127 instance of this MIB module, is properly configured to give access to 1128 the objects only to those principals "users" that have legitimate 1129 rights to indeed GET or SET "change/create/delete" them. 1131 7. IANA Considerations 1133 There is one MIB module contained in this document. The following 1134 "IANA Considerations" subsection requests IANA for a new 1135 assignment under the mib-2 subtree. New assignments can only 1136 be made via a Standards Action as specified in [RFC2434]. 1138 7.1. IANA Considerations for BFD-STD-MIB 1140 The IANA is requested to assign { mib-2 XXX } to the BFD-STD-MIB 1141 module specified in this document. 1143 8. References 1145 8.1 Normative References 1147 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1148 Rose, M. and S. Waldbusser, "Structure of Management 1149 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1150 1999. 1152 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1153 Rose, M. and S. Waldbusser, "Textual Conventions for 1154 SMIv2", STD 58, RFC 2579, April 1999. 1156 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1157 Rose, M. and S. Waldbusser, "Conformance Statements for 1158 SMIv2", STD 58, RFC 2580, April 1999. 1160 [BFD] Katz, D., and Ward, D., "Bidirectional Forwarding 1161 Detection", draft-ietf-bfd-base-07.txt. 1163 BFD MIB February 25, 2008 1165 [BFD-MH] Katz, D., and Ward, D., "BFD for Multihop Paths", 1166 draft-ietf-bfd-multihop-06.txt. 1168 [BFD-LSP] Aggarwal, R., Kompella, K., T. D. Nadeau, and G. Swallow 1169 BFD For MPLS LSPs, draft-ietf-bfd-mpls-05.txt. 1171 8.2 Informative References 1173 [RFC2863] McCloghrie, K., Kastenholz, F., "The Interfaces Group MIB", 1174 STD 58, RFC 2863, June 2000. 1176 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 1177 Schoenwaelder, "Textual Conventions for Internet 1178 Network Addresses", RFC 4001, Feb. 2005. 1180 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate 1181 Requirement Levels", RFC 2119, BCP 14, April 1997. 1183 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1184 "Introduction and Applicability Statements for 1185 Internet-Standard Management Framework", RFC 3410, 1186 December 2002. 1188 [RFC3413] Levi, D., Meyer, P., Stewart, B., 1189 "SNMP Applications", RFC 3413, December 2002. 1191 [RFC2434] Narten, T. and H. Alvestrand., "Guidelines for Writing 1192 an IANA Considerations Section in RFCs", BCP 26, RFC 1193 2434, October 1998. 1195 9. Acknowledgements 1197 We would like to thank David Ward, Reshad Rahman, David Toscano, 1198 Sylvain Masse, Mark Tooker, and Kiran Koushik Agrahara Sreenivasa 1199 for their comments and suggestions. 1201 10. Authors' Addresses 1203 Thomas D. Nadeau 1204 BT 1205 BT Centre 1206 81 Newgate Street 1207 London, EC1A 7AJ 1208 United Kingdom 1209 Email: tom.nadeau@bt.com 1211 Zafar Ali 1212 2000 Innovation Drive 1213 Kanata, Ontario, K2K 3E8, Canada. 1214 Phone: 734-276-2459 1215 Email: zali@cisco.com 1217 BFD MIB February 25, 2008 1219 Nobo Akiya 1220 Cisco Systems G.K. 1221 Shinjuku Mitsui Building, 2-1-1, 1222 Nishi-Shinjuku, Shinjuku-Ku, 1223 Tokyo 163-0409, Japan 1224 Phone: +81 3 5324 4096 1225 Email: nobo@cisco.com 1227 11. Intellectual Property Statement 1229 The IETF takes no position regarding the validity or scope of any 1230 Intellectual Property Rights or other rights that might be claimed to 1231 pertain to the implementation or use of the technology described in 1232 this document or the extent to which any license under such rights 1233 might or might not be available; nor does it represent that it has 1234 made any independent effort to identify any such rights. Information 1235 on the procedures with respect to rights in RFC documents can be 1236 found in BCP 78 and BCP 79. 1238 Copies of IPR disclosures made to the IETF Secretariat and any 1239 assurances of licenses to be made available, or the result of an 1240 attempt made to obtain a general license or permission for the use of 1241 such proprietary rights by implementers or users of this 1242 specification can be obtained from the IETF on-line IPR repository at 1243 http://www.ietf.org/ipr. 1245 The IETF invites any interested party to bring to its attention any 1246 copyrights, patents or patent applications, or other proprietary 1247 rights that may cover technology that may be required to implement 1248 this standard. Please address the information to the IETF at ietf- 1249 ipr@ietf.org. 1251 12. Full Copyright Statement 1253 Copyright (C) The IETF Trust (2008). This document is subject 1254 to the rights, licenses and restrictions contained in BCP 78, and 1255 except as set forth therein, the authors retain all their rights. 1257 This document and the information contained herein are provided on an 1258 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 1259 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 1260 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 1261 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 1262 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1263 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1265 Acknowledgement 1267 Funding for the RFC Editor function is provided by the IETF 1268 Administrative Support Activity (IASA).