idnits 2.17.1 draft-nadeau-bfd-mib-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity. ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == There are 7 instances of lines with non-ascii characters in the document. == No 'Intended status' indicated for this document; assuming Proposed Standard == It seems as if not all pages are separated by form feeds - found 0 form feeds but 23 pages Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** There are 9 instances of too long lines in the document, the longest one being 11 characters in excess of 72. ** 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: ---------------------------------------------------------------------------- == Line 414 has weird spacing: '...stem is attem...' == Line 881 has weird spacing: '...-- when detec...' == Line 1031 has weird spacing: '... Such obje...' == 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 2004) is 7370 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) -- Missing reference section? 'BFD' on line 1072 looks like a reference -- Missing reference section? 'RFC2119' on line 46 looks like a reference -- Missing reference section? 'RFC3410' on line 1081 looks like a reference -- Missing reference section? 'RFC2578' on line 1085 looks like a reference -- Missing reference section? 'RFC2579' on line 1089 looks like a reference -- Missing reference section? 'RFC2580' on line 1093 looks like a reference -- Missing reference section? 'BFD-SHARED' on line 1075 looks like a reference -- Missing reference section? 'BFD-LSP' on line 1078 looks like a reference -- Missing reference section? 'RFC2863' on line 1097 looks like a reference -- Missing reference section? 'RFC3413' on line 1100 looks like a reference Summary: 8 errors (**), 0 flaws (~~), 7 warnings (==), 12 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group 3 Individual Submission Thomas D. Nadeau 4 Internet Draft Zafar Ali 5 Cisco Systems, Inc. 7 Document: draft-nadeau-bfd-mib-00.txt 8 Expires: August 2004 February 2004 10 Bidirectional Forwarding Detection Management Information Base 11 draft-nadeau-bfd-mib-00.txt 13 Status of this Memo 15 This document is an Internet-Draft and is in full conformance with 16 all provisions of Section 10 of RFC2026. Internet-Drafts are working 17 documents of the Internet Engineering Task Force (IETF), its areas, 18 and its working groups. Note that other groups may also distribute 19 working documents as Internet-Drafts. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF), its areas, and its working groups. Note that 22 other groups may also distribute working documents as Internet- 23 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." 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 Abstract 35 This draft defines a portion of the Management Information Base 36 (MIB) for use with network management protocols in the Internet 37 community. In particular, it describes managed objects for modeling 38 Bidirectional Forwarding Detection (BFD) protocol [BFD]. 40 Conventions used in this document 42 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 43 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in 44 this document are to be interpreted as described in RFC 2119 45 [RFC2119]. 47 T. Nadeau and Z. Ali Page 1 2/9/2004 49 draft-nadeau-bfd-mib-00.txt February 2004 51 SUMMARY 53 This draft defines Management Information Base (MIB) for 54 Bidirectional Forwarding Detection (BFD) protocol [BFD]. 56 RELATED REFERENCES 58 Please refer to the reference section. 60 Table of Contents 62 1. Introduction...................................................2 63 2. Terminology....................................................3 64 3. Brief Description of MIB Objects...............................3 65 3.1 General Variables..........................................3 66 3.2 Session Table (bfdSessionTable)............................3 67 3.3 Session Performance Table (bfdSessionPerfTable)............3 68 3.4 Session Mapping Table (bfdSessMapTable)....................3 69 4. BFD MIB Module Definitions.....................................3 70 5. Security Considerations.......................................21 71 6. Acknowledgements..............................................22 72 Reference........................................................22 73 Author's Addresses...............................................22 75 1. Introduction 77 For a detailed overview of the documents that describe the current 78 Internet-Standard Management Framework, please refer to section of 79 RFC 3410 [RFC3410]. 81 Managed objects are accessed via a virtual information store, 82 termed the Management Information Base or MIB. MIB objects are 83 generally accessed through the Simple Network Management Protocol 84 (SNMP). Objects in the MIB are defined using the mechanisms defined 85 in the Structure of Management Information (SMI). This memo specifies 86 a MIB module that is compliant to the SMIv2, which is described in 87 STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, 88 RFC 2580 [RFC2580]. 90 Current work is underway in the IETF to specify a suite of 91 protocols known as Bidirectional Forwarding Detection to detect 92 faults in the bidirectional path between two forwarding engines, 93 including interfaces, data link(s), and to the extent possible the 94 forwarding engines themselves, with potentially very low latency 95 [BFD]. 97 T. Nadeau and Z. Ali Page 2 2/9/2004 99 draft-nadeau-bfd-mib-00.txt February 2004 101 In this document we describe a MIB module that can be used to 102 manage BFD implementations. This MIB module covers both configuration 103 and performance monitoring aspects of BFD. 105 This document is based on draft-katz-ward-bfd-01.txt [BFD] and 106 only addresses MIB for MFD running over point-to-point interfaces. 107 Specifically, this version of the ID does not address BFD over shared 108 medium, e.g., Ethernet [BFD-SHARED]. Furthermore, at present we did not directly 109 address manageability requirement when LSP-Ping is used for boot- 110 strapping the BFD session [BFD-LSP]. Nonetheless, some considerations 111 are in place for these applications of the BFD. These aspects of BFD 112 will be directly addressed in the future version of the ID. 114 2. Terminology 116 This document uses terminology from the document describing the 117 BFD protocol [BFD]. 119 3. Brief Description of MIB Objects 121 This section describes objects pertaining to BFD. The MIB objects 122 are derived from the BFD document [BFD]. 124 3.1 General Variables 126 The General Variables are used to identify parameters that are 127 global to the BFD process. 129 3.2 Session Table (bfdSessionTable) 131 The session table is used to identify a BFD session between a pair 132 of nodes. 134 3.3 Session Performance Table (bfdSessionPerfTable) 136 The session performance table is used for collecting BFD 137 performance counts on a per session basis. This table is an AUGMENT 138 to the bfdSessionTable. 140 3.4 Session Mapping Table (bfdSessMapTable) 142 The BFD Session Mapping Table maps the complex indexing of the BFD 143 sessions to the flat BFDIndex used in the BfdSessionTable. 145 4. BFD MIB Module Definitions 147 BFD-MIB-DRAFT-00 DEFINITIONS ::= BEGIN 149 T. Nadeau and Z. Ali Page 3 2/9/2004 151 draft-nadeau-bfd-mib-00.txt February 2004 153 IMPORTS 154 MODULE-IDENTITY, OBJECT-TYPE, 155 Unsigned32, Counter32, Counter64, 156 NOTIFICATION-TYPE, mib-2 157 FROM SNMPv2-SMI 159 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 160 FROM SNMPv2-CONF 162 TEXTUAL-CONVENTION, TruthValue, RowStatus, StorageType, 163 TimeStamp 164 FROM SNMPv2-TC 166 InetAddress, InetAddressType, InetPortNumber 167 FROM INET-ADDRESS-MIB 168 ; 170 bfdMIB MODULE-IDENTITY 171 LAST-UPDATED "200401221200Z" -- 22 January 2004 12:00:00 EST 172 ORGANIZATION "IETF" 173 CONTACT-INFO 174 " Thomas D. Nadeau 175 Cisco Systems, Inc. 176 Email: tnadeau@cisco.com 178 Zafar Ali 179 Cisco Systems, Inc. 180 Email: zali@cisco.com 181 " 182 DESCRIPTION 183 "Bidirectional Forwarding Management Information Base." 185 -- Revision history. 186 REVISION 187 "200401221200Z" -- 22 January 2004 12:00:00 EST 188 DESCRIPTION 189 "Initial version." 190 ::= { mib-2 999 } -- To be assigned by IANA. 192 -- Top level components of this MIB module. 194 bfdNotifications OBJECT IDENTIFIER ::= { bfdMIB 0 } 196 bfdObjects OBJECT IDENTIFIER ::= { bfdMIB 1 } 198 T. Nadeau and Z. Ali Page 4 2/9/2004 200 draft-nadeau-bfd-mib-00.txt February 2004 202 bfdConformance OBJECT IDENTIFIER ::= { bfdMIB 3 } 204 bfdScalarObjects OBJECT IDENTIFIER ::= { bfdObjects 1 } 206 -- Textual Conventions 208 BfdSessIndexTC ::= TEXTUAL-CONVENTION 209 DISPLAY-HINT "d" 210 STATUS current 211 DESCRIPTION 212 "An index used to uniquely identify BFD sessions." 213 SYNTAX Unsigned32 (1..4294967295) 215 BfdInterval ::= TEXTUAL-CONVENTION 216 STATUS current 217 DESCRIPTION 218 "The BFD interval delay in microseconds." 219 SYNTAX Unsigned32 (1..4294967295) 221 BfdDiag ::= TEXTUAL-CONVENTION 222 STATUS current 223 DESCRIPTION 224 "A common BFD diagnostic code." 226 SYNTAX INTEGER { noDiagnostic(1), 227 controlDetectionTimeExpired(2), 228 echoFunctionFailed(3), 229 neighborSignaledSessionDown(4), 230 forwardingPlaneReset(5), 231 pathDown(6), 232 concatenatedPathDown(7), 233 administrativelyDown(8) 234 } 236 -- BFD General Variables 238 -- These parameters apply globally to the Router's 239 -- BFD Process. 241 bfdAdminStatus OBJECT-TYPE 242 SYNTAX INTEGER { enabled(1), disabled(2) } 243 MAX-ACCESS read-write 244 STATUS current 245 DESCRIPTION 246 "The global administrative status of BFD in this router. 248 T. Nadeau and Z. Ali Page 5 2/9/2004 250 draft-nadeau-bfd-mib-00.txt February 2004 252 The value 'enabled' denotes that the BFD Process is active 253 on at least one interface; 'disabled' disables it on 254 all interfaces." 255 DEFVAL { enabled } 256 ::= { bfdScalarObjects 1 } 258 bfdOperStatus OBJECT-TYPE 259 SYNTAX INTEGER { up(1), down(2) } 260 MAX-ACCESS read-only 261 STATUS current 262 DESCRIPTION 263 "The operational status of BFD on this router." 264 ::= { bfdScalarObjects 2 } 266 bfdVersionNumber OBJECT-TYPE 267 SYNTAX Unsigned32 268 MAX-ACCESS read-only 269 STATUS current 270 DESCRIPTION 271 "The current version number of the BFD protocol." 272 REFERENCE 273 " BFD Version 0 (draft-katz-ward-bfd-01.txt)" 274 DEFVAL { 0 } 275 ::= { bfdScalarObjects 3 } 277 -- BFD Session Table 278 -- The BFD Session Table specifies BFD session specific 279 -- information. 281 bfdSessTable OBJECT-TYPE 282 SYNTAX SEQUENCE OF BfdSessEntry 283 MAX-ACCESS not-accessible 284 STATUS current 285 DESCRIPTION 286 "The BFD Session Table describes the BFD sessions." 287 REFERENCE 288 "BFD Version 0 (draft-katz-ward-bfd-01.txt)" 289 ::= { bfdObjects 2 } 291 bfdSessEntry OBJECT-TYPE 292 SYNTAX BfdSessEntry 293 MAX-ACCESS not-accessible 294 STATUS current 295 DESCRIPTION 296 "The BFD Session Entry describes BFD session." 298 T. Nadeau and Z. Ali Page 6 2/9/2004 300 draft-nadeau-bfd-mib-00.txt February 2004 302 INDEX { bfdSessIndex } 303 ::= { bfdSessTable 1 } 305 BfdSessEntry ::= SEQUENCE { 306 bfdSessIndex BfdSessIndexTC, 307 bfdSessApplicationId Unsigned32, 308 bfdSessDiscriminator Unsigned32, 309 bfdSessRemoteDiscr Unsigned32, 310 bfdSessUdpPort InetPortNumber, 311 bfdSessState INTEGER, 312 bfdSessRemoteHeardFlag TruthValue, 313 bfdSessDiag Unsigned32, 314 bfdSessOperMode INTEGER, 315 bfdSessDemandModeDesiredFlag TruthValue, 316 bfdSessEchoFuncModeDesiredFlag TruthValue, 317 bfdSessAddrType InetAddressType, 318 bfdSessAddr InetAddress, 319 bfdSessDesiredMinTxInterval BfdInterval, 320 bfdSessDesiredMinRxInterval BfdInterval, 321 bfdSessDesiredMinEchoRxInterval BfdInterval, 322 bfdSessDetectMult BfdInterval, 323 bfdSessStorType StorageType, 324 bfdSessRowStatus RowStatus 325 } 327 bfdSessIndex OBJECT-TYPE 328 SYNTAX BfdSessIndexTC 329 MAX-ACCESS read-only 330 STATUS current 331 DESCRIPTION 332 "This object contains an index used to represent a 333 unique BFD session on this device." 334 ::= { bfdSessEntry 1 } 336 bfdSessApplicationId OBJECT-TYPE 337 SYNTAX Unsigned32 338 MAX-ACCESS read-only 339 STATUS current 340 DESCRIPTION 341 "This object contains an index used to indicate 342 a local application which owns or maintains this 343 BFD session. For instance, the MPLS VPN process may 344 maintain a subset of the total number of BFD 345 sessions. This application ID provides a convenient 346 way to segregate sessions by the applications which 347 maintain them." 348 ::= { bfdSessEntry 2 } 350 T. Nadeau and Z. Ali Page 7 2/9/2004 352 draft-nadeau-bfd-mib-00.txt February 2004 354 bfdSessDiscriminator OBJECT-TYPE 355 SYNTAX Unsigned32 (1..4294967295) 356 MAX-ACCESS read-only 357 STATUS current 358 DESCRIPTION 359 "This object specifies the local discriminator for this BFD 360 session, used to uniquely identify it." 361 ::= { bfdSessEntry 3 } 363 bfdSessRemoteDiscr OBJECT-TYPE 364 SYNTAX Unsigned32 (1..4294967295) 365 MAX-ACCESS read-only 366 STATUS current 367 DESCRIPTION 368 "This object specifies the session discriminator chosen 369 by the remote system for this BFD session." 370 ::= { bfdSessEntry 4 } 372 bfdSessUdpPort OBJECT-TYPE 373 SYNTAX InetPortNumber 374 MAX-ACCESS read-create 375 STATUS current 376 DESCRIPTION 377 "The UDP Port for BFD. The default value is the 378 well-known value for this port." 379 REFERENCE 380 "draft-katz-ward-bfd-01.txt and 381 draft-raggarwa-mpls-bfd-00.txt" 382 DEFVAL { TBD } 383 ::= { bfdSessEntry 5 } 385 bfdSessState OBJECT-TYPE 386 SYNTAX INTEGER { 387 init(1), 388 up(2), 389 failing(3), 390 down(4), 391 adminDown(5) 392 } 393 MAX-ACCESS read-only 394 STATUS current 395 DESCRIPTION 396 "The perceived state of the BFD session." 397 ::= { bfdSessEntry 6 } 399 bfdSessRemoteHeardFlag OBJECT-TYPE 401 T. Nadeau and Z. Ali Page 8 2/9/2004 403 draft-nadeau-bfd-mib-00.txt February 2004 405 SYNTAX TruthValue 406 MAX-ACCESS read-only 407 STATUS current 408 DESCRIPTION 409 "This object specifies status of BFD packet reception from 410 the remote system. Specifically, it is set to true(1) if the 411 local system is actively receiving BFD packets from the 412 remote system, and is set to false(0) if the local system 413 has not received BFD packets recently (within the detection 414 time) or if the local system is attempting to tear down the 415 BFD session." 416 ::= { bfdSessEntry 7 } 418 bfdSessDiag OBJECT-TYPE 419 SYNTAX Unsigned32 420 MAX-ACCESS accessible-for-notify 421 STATUS current 422 DESCRIPTION 423 "A diagnostic code specifying the local system's reason 424 for the last transition of the session from up(1) 425 to some other state." 426 ::= { bfdSessEntry 8 } 428 bfdSessOperMode OBJECT-TYPE 429 SYNTAX INTEGER { asyncModeWEchoFun(1), 430 asynchModeWOEchoFun(2), 431 demandModeWEchoFunction(3), 432 demandModeWOEchoFunction(4) 433 } 434 MAX-ACCESS read-only 435 STATUS current 436 DESCRIPTION 437 "This object specifies current operating mode that BFD 438 session is operating in. 440 A value of AsyncModeWEchoFun(1) ... 441 A value of AsynchModeWOEchoFun(2) ... 442 A value of DemandModeWEchoFunction(3) ... 443 A value of DemandModeWOEchoFunction(4) ... 444 " 445 ::= { bfdSessEntry 9 } 447 bfdSessDemandModeDesiredFlag OBJECT-TYPE 448 SYNTAX TruthValue 449 MAX-ACCESS read-create 451 T. Nadeau and Z. Ali Page 9 2/9/2004 453 draft-nadeau-bfd-mib-00.txt February 2004 455 STATUS current 456 DESCRIPTION 457 "This object indicates that the local system's 458 desire to use Demand mode. Specifically, it is set 459 to true(1) if the local system wishes to use 460 Demand mode or false(0) if not" 461 DEFVAL { false } 462 ::= { bfdSessEntry 10 } 464 bfdSessEchoFuncModeDesiredFlag OBJECT-TYPE 465 SYNTAX TruthValue 466 MAX-ACCESS read-create 467 STATUS current 468 DESCRIPTION 469 "This object indicates that the local system's 470 desire to use Echo mode. Specifically, it is set 471 to true(1) if the local system wishes to use 472 Echo mode or false(0) if not" 473 DEFVAL { false } 474 ::= { bfdSessEntry 11 } 476 bfdSessAddrType OBJECT-TYPE 477 SYNTAX InetAddressType 478 MAX-ACCESS read-create 479 STATUS current 480 DESCRIPTION 481 "This object specifies IP address of the interface 482 associated with this BFD session. 484 Only values unknown(0), ipv4(1) or ipv6(2) 485 have to be supported. 487 A value of unknown(0) is allowed only when 488 the outgoing interface is of type point-to-point, or 489 when the BFD session is not associated with a specific 490 interface. 492 If any other unsupported values are attempted in a set 493 operation, the agent MUST return an inconsistentValue 494 error. 495 " 496 ::= { bfdSessEntry 12 } 498 bfdSessAddr OBJECT-TYPE 499 SYNTAX InetAddress 500 MAX-ACCESS read-create 502 T. Nadeau and Z. Ali Page 10 2/9/2004 504 draft-nadeau-bfd-mib-00.txt February 2004 506 STATUS current 507 DESCRIPTION 508 "This object specifies IP address of the interface 509 associated with this BFD session. 510 It can also be used to enabled BFD on a specific 511 interface. The value is set to zero when BFD session is not 512 associated with a specific interface. " 513 ::= { bfdSessEntry 13 } 515 bfdSessDesiredMinTxInterval OBJECT-TYPE 516 SYNTAX BfdInterval 517 MAX-ACCESS read-create 518 STATUS current 519 DESCRIPTION 520 "This object specifies the minimum interval, in 521 microseconds, that the local system would like to use when 522 transmitting BFD Control packets." 523 ::= { bfdSessEntry 14 } 525 bfdSessDesiredMinRxInterval OBJECT-TYPE 526 SYNTAX BfdInterval 527 MAX-ACCESS read-create 528 STATUS current 529 DESCRIPTION 530 "This object specifies the minimum interval, in 531 microseconds, between received BFD Control packets the 532 local system is capable of supporting." 533 ::= { bfdSessEntry 15 } 535 bfdSessDesiredMinEchoRxInterval OBJECT-TYPE 536 SYNTAX BfdInterval 537 MAX-ACCESS read-create 538 STATUS current 539 DESCRIPTION 540 "This object specifies the minimum interval, in 541 microseconds, between received BFD Echo packets that this 542 system is capable of supporting." 543 ::= { bfdSessEntry 16 } 545 bfdSessDetectMult OBJECT-TYPE 546 SYNTAX BfdInterval 547 MAX-ACCESS read-create 548 STATUS current 549 DESCRIPTION 550 "This object specifies the Detect time multiplier." 551 ::= { bfdSessEntry 17 } 553 T. Nadeau and Z. Ali Page 11 2/9/2004 555 draft-nadeau-bfd-mib-00.txt February 2004 557 bfdSessStorType OBJECT-TYPE 558 SYNTAX StorageType 559 MAX-ACCESS read-create 560 STATUS current 561 DESCRIPTION 562 "This variable indicates the storage type for this 563 object. Conceptual rows having the value 564 'permanent' need not allow write-access to any 565 columnar objects in the row." 566 ::= { bfdSessEntry 18 } 568 bfdSessRowStatus OBJECT-TYPE 569 SYNTAX RowStatus 570 MAX-ACCESS read-create 571 STATUS current 572 DESCRIPTION 573 "This variable is used to create, modify, and/or 574 delete a row in this table. When a row in this 575 table has a row in the active(1) state, no 576 objects in this row can be modified except the 577 bfdSessRowStatus and bfdSessStorageType." 578 ::= { bfdSessEntry 19 } 580 -- BFD Session Performance Table 582 bfdSessPerfTable OBJECT-TYPE 583 SYNTAX SEQUENCE OF BfdSessPerfEntry 584 MAX-ACCESS not-accessible 585 STATUS current 586 DESCRIPTION 587 "This table specifies BFD Session performance counters." 588 ::= { bfdObjects 3 } 590 bfdSessPerfEntry OBJECT-TYPE 591 SYNTAX BfdSessPerfEntry 592 MAX-ACCESS not-accessible 593 STATUS current 594 DESCRIPTION 595 "An entry in this table is created by a BFD-enabled node for 596 every BFD Session. bfdCounterDiscontinuityTime is used to 597 indicate potential discontinuity for all counter objects 598 in this table." 599 AUGMENTS { bfdSessEntry } 600 ::= { bfdSessPerfTable 1 } 602 BfdSessPerfEntry ::= SEQUENCE { 604 T. Nadeau and Z. Ali Page 12 2/9/2004 606 draft-nadeau-bfd-mib-00.txt February 2004 608 bfdSessPerfPktIn Counter32, 609 bfdSessPerfPktOut Counter32, 610 bfdSessPerfBadDiscrim Counter32, 611 bfdSessPerfLastSessDownTime TimeStamp, 612 bfdSessPerfLastCommLostDiag BfdDiag, 613 bfdSessPerfSessDownCount Counter32, 614 bfdSessPerfDiscTime TimeStamp, 616 -- High Capacity Counters 617 bfdSessPerfPktInHC Counter64, 618 bfdSessPerfPktOutHC Counter64, 619 bfdSessPerfBadDiscrimHC Counter64 621 } 623 -- Ed Note: should we add per-diag code counts here, 625 bfdSessPerfPktIn OBJECT-TYPE 626 SYNTAX Counter32 627 MAX-ACCESS read-only 628 STATUS current 629 DESCRIPTION 630 "The total number of BFD messages received for this BFD 631 session." 632 ::= { bfdSessPerfEntry 1 } 634 bfdSessPerfPktOut OBJECT-TYPE 635 SYNTAX Counter32 636 MAX-ACCESS read-only 637 STATUS current 638 DESCRIPTION 639 "The total number of BFD messages sent for this BFD session." 640 ::= { bfdSessPerfEntry 2 } 642 bfdSessPerfBadDiscrim OBJECT-TYPE 643 SYNTAX Counter32 644 MAX-ACCESS read-only 645 STATUS current 646 DESCRIPTION 647 "The total number of BFD messages received with a 648 bad local Discriminator value for this BFD session." 649 ::= { bfdSessPerfEntry 3 } 651 bfdSessPerfLastSessDownTime OBJECT-TYPE 652 SYNTAX TimeStamp 653 MAX-ACCESS read-only 654 STATUS current 656 T. Nadeau and Z. Ali Page 13 2/9/2004 658 draft-nadeau-bfd-mib-00.txt February 2004 660 DESCRIPTION 661 "The value of sysUpTime on the most recent occasion at which 662 the last time communication was lost with the neighbor. If 663 no such down event exist this object contains a zero value." 664 ::= { bfdSessPerfEntry 4 } 666 bfdSessPerfLastCommLostDiag OBJECT-TYPE 667 SYNTAX BfdDiag 668 MAX-ACCESS read-only 669 STATUS current 670 DESCRIPTION 671 "The BFD diag code for the last time communication was lost 672 with the neighbor. If no such down event exists this object 673 contains a zero value." 674 ::= { bfdSessPerfEntry 5 } 676 bfdSessPerfSessDownCount OBJECT-TYPE 677 SYNTAX Counter32 678 MAX-ACCESS read-only 679 STATUS current 680 DESCRIPTION 681 "The number of times this session has gone into the down 682 state since the router last rebooted." 683 ::= { bfdSessPerfEntry 6 } 685 bfdSessPerfDiscTime OBJECT-TYPE 686 SYNTAX TimeStamp 687 MAX-ACCESS read-only 688 STATUS current 689 DESCRIPTION 690 "The value of sysUpTime on the most recent occasion at which any 691 one or more of the session counters suffered a discontinuity. 692 The relevant counters are the specific instances associated 693 with this BFD session of any Counter32 object contained in the 694 BfdSessPerfTable. If no such discontinuities have occurred 695 since the last re-initialization of the local management subsystem, 696 then this object contains a zero value." 697 ::= { bfdSessPerfEntry 7 } 699 bfdSessPerfPktInHC OBJECT-TYPE 700 SYNTAX Counter64 701 MAX-ACCESS read-only 702 STATUS current 704 T. Nadeau and Z. Ali Page 14 2/9/2004 706 draft-nadeau-bfd-mib-00.txt February 2004 708 DESCRIPTION 709 "This value represents the total number of BFD messages 710 received for this BFD session. It MUST be equal to the 711 least significant 32 bits of bfdSessPerfPktIn 712 if bfdSessPerfPktInHC is supported according to 713 the rules spelled out in RFC2863." 714 ::= { bfdSessPerfEntry 8 } 716 bfdSessPerfPktOutHC OBJECT-TYPE 717 SYNTAX Counter64 718 MAX-ACCESS read-only 719 STATUS current 720 DESCRIPTION 721 "This value represents the total number of 722 total number of BFD messages transmitted for this 723 BFD session. It MUST be equal to the 724 least significant 32 bits of bfdSessPerfPktIn 725 if bfdSessPerfPktOutHC is supported according to 726 the rules spelled out in RFC2863." 727 ::= { bfdSessPerfEntry 9 } 729 bfdSessPerfBadDiscrimHC OBJECT-TYPE 730 SYNTAX Counter64 731 MAX-ACCESS read-only 732 STATUS current 733 DESCRIPTION 734 "This value represents the total number of 735 total number of BFD messages received with a 736 bad local Discriminator value for this BFD session. 737 It MUST be equal to the least significant 32 bits of 738 bfdSessPerfBadDiscrimHC if bfdSessPerfBadDiscrimHC 739 is supported according to the rules spelled out 740 in RFC2863." 741 ::= { bfdSessPerfEntry 10 } 743 -- BFD Session Mapping Table 745 bfdSessMapTable OBJECT-TYPE 746 SYNTAX SEQUENCE OF BfdSessMapEntry 747 MAX-ACCESS not-accessible 748 STATUS current 749 DESCRIPTION 750 "The BFD Session Mapping Table maps the complex 751 indexing of the BFD sessions to the flat 752 BFDIndex used in the BfdSessionTable. 754 T. Nadeau and Z. Ali Page 15 2/9/2004 756 draft-nadeau-bfd-mib-00.txt February 2004 758 Implementors need to be aware that if the value of 759 the bfdSessAddr (an OID) has more 760 that 111 sub-identifiers, then OIDs of column 761 instances in this table will have more than 128 762 sub-identifiers and cannot be accessed using SNMPv1, 763 SNMPv2c, or SNMPv3. 764 " 765 REFERENCE 766 "BFD Version 0 (draft-katz-ward-bfd-01.txt)" 767 ::= { bfdObjects 4 } 769 bfdSessMapEntry OBJECT-TYPE 770 SYNTAX BfdSessMapEntry 771 MAX-ACCESS not-accessible 772 STATUS current 773 DESCRIPTION 774 "The BFD Session Entry describes BFD session 775 that is mapped to this index." 776 INDEX { bfdSessApplicationId, 777 bfdSessDiscriminator, 778 bfdSessAddrType, 779 bfdSessAddr 780 } 781 ::= { bfdSessMapTable 1 } 783 BfdSessMapEntry ::= SEQUENCE { 784 bfdSessMapBfdIndex BfdSessIndexTC 785 } 787 bfdSessMapBfdIndex OBJECT-TYPE 788 SYNTAX BfdSessIndexTC 789 MAX-ACCESS read-only 790 STATUS current 791 DESCRIPTION 792 "This object specifies the BfdIndex referred to by 793 the indexes of this row. In essence, a mapping is 794 provided between these indexes and the BfdSessTable." 795 ::= { bfdSessMapEntry 1 } 797 -- Notification Configuration 799 bfdSessNotificationsEnable OBJECT-TYPE 800 SYNTAX TruthValue 801 MAX-ACCESS read-write 802 STATUS current 803 DESCRIPTION 804 "If this object is set to true(1), then it enables 806 T. Nadeau and Z. Ali Page 16 2/9/2004 808 draft-nadeau-bfd-mib-00.txt February 2004 810 the emission of bfdSessUp and bfdSessDown 811 notifications; otherwise these notifications are not 812 emitted." 813 REFERENCE 814 "See also RFC3413 for explanation that 815 notifications are under the ultimate control of the 816 MIB modules in this document." 817 DEFVAL { false } 818 ::= { bfdScalarObjects 4 } 820 bfdSessUp NOTIFICATION-TYPE 821 OBJECTS { bfdSessDiag, -- low range value 822 bfdSessDiag -- high range value 823 } 824 STATUS current 825 DESCRIPTION 826 "This notification is generated when the 827 bfdSessState object for one or more contiguous 828 entries in bfdSessTable are about to enter the up(2) 829 state from some other state. The included values of 830 bfdSessDiag MUST both be set equal to this 831 new state (i.e: up(1)). The two instances of 832 bfdSessDiag in this notification indicate the range 833 of indexes that are affected. Note that all the indexes 834 of the two ends of the range can be derived from the 835 instance identifiers of these two objects. For the 836 cases where a contiguous range of sessions 837 have transitioned into the up(1) state at roughly 838 the same time, the device SHOULD issue a single 839 notification for each range of contiguous indexes in 840 an effort to minimize the emission of a large number 841 of notifications. If a notification has to be 842 issued for just a single bfdSessEntry, then 843 the instance identifier (and values) of the two 844 bfdSessDiag objects MUST be the identical." 845 ::= { bfdNotifications 1 } 847 bfdSessDown NOTIFICATION-TYPE 848 OBJECTS { bfdSessDiag, -- low range value 849 bfdSessDiag -- high range value 850 } 851 STATUS current 852 DESCRIPTION 853 "This notification is generated when the 854 bfdSessState object for one or more contiguous 855 entries in bfdSessTable are about to enter the down(4) 856 or adminDown(5) states from some other state. The included 858 T. Nadeau and Z. Ali Page 17 2/9/2004 860 draft-nadeau-bfd-mib-00.txt February 2004 862 values of bfdSessDiag MUST both be set equal to this 863 new state (i.e: down(4) or adminDown(5)). The two instances 864 of bfdSessDiag in this notification indicate the range 865 of indexes that are affected. Note that all the indexes 866 of the two ends of the range can be derived from the 867 instance identifiers of these two objects. For 868 cases where a contiguous range of sessions 869 have transitioned into the down(4) or adminDown(5) states 870 at roughly the same time, the device SHOULD issue a single 871 notification for each range of contiguous indexes in 872 an effort to minimize the emission of a large number 873 of notifications. If a notification has to be 874 issued for just a single bfdSessEntry, then 875 the instance identifier (and values) of the two 876 bfdSessDiag objects MUST be the identical." 877 ::= { bfdNotifications 2 } 879 -- Ed Note: We need to add notification for changes 880 -- when the two ends automatically negotiate to a new detection time value or 881 -- when detection multiplier changes. 882 -- Similarly, changes in the operating mode (bfdSessOperMode) 883 -- also need to be notified. 885 -- Module compliance. 887 bfdGroups 888 OBJECT IDENTIFIER ::= { bfdConformance 1 } 890 bfdCompliances 891 OBJECT IDENTIFIER ::= { bfdConformance 2 } 893 -- Compliance requirement for fully compliant implementations. 895 bfdModuleFullCompliance MODULE-COMPLIANCE 896 STATUS current 897 DESCRIPTION "Compliance statement for agents that provide full 898 support for BFD-MIB. Such devices can 899 then be monitored and also be configured using 900 this MIB module." 902 MODULE -- This module. 903 MANDATORY-GROUPS { 904 bfdSessionGroup, 905 bfdSessionPerfGroup, 906 bfdSessionPerfHCGroup, 907 bfdNotificationGroup 908 } 910 T. Nadeau and Z. Ali Page 18 2/9/2004 912 draft-nadeau-bfd-mib-00.txt February 2004 914 GROUP bfdSessionPerfHCGroup 915 DESCRIPTION "This group is mandatory for those bfdPerfTable 916 entries for which any of the objects 917 bfdSessPerfPktInHC, bfdSessPerfPktOutHC, or 918 bfdSessPerfBadDiscrimHC wraps around too quickly 919 based on the criteria specified in RFC 2863 for 920 high-capacity counters." 922 GROUP bfdNotificationGroup 923 DESCRIPTION "This group is only mandatory for those 924 implementations which can efficiently implement 925 the notifications contained in this group." 927 OBJECT bfdSessAddrType 928 SYNTAX InetAddressType { unknown(0), ipv4(1), ipv6(2) } 929 DESCRIPTION "Only unknown(0), ipv4(1) and ipv6(2) support 930 is required." 932 OBJECT bfdSessAddr 933 SYNTAX InetAddress (SIZE(0|4|16)) 934 DESCRIPTION "An implementation is only required to support 935 unknown(0), ipv4(1) and ipv6(2) sizes." 937 ::= { bfdCompliances 1 } 939 -- Read-Only Conformance TBD... 941 -- Units of conformance. 943 bfdSessionGroup OBJECT-GROUP 944 OBJECTS { 945 bfdSessNotificationsEnable, 946 bfdAdminStatus, 947 bfdOperStatus, 948 bfdVersionNumber, 950 bfdSessIndex, 951 bfdSessApplicationId, 952 bfdSessDiscriminator, 953 bfdSessAddrType, 954 bfdSessAddr, 955 bfdSessRemoteDiscr, 956 bfdSessState, 957 bfdSessRemoteHeardFlag, 958 bfdSessDiag, 960 T. Nadeau and Z. Ali Page 19 2/9/2004 962 draft-nadeau-bfd-mib-00.txt February 2004 964 bfdSessOperMode, 965 bfdSessDemandModeDesiredFlag, 966 bfdSessEchoFuncModeDesiredFlag, 967 bfdSessDesiredMinTxInterval, 968 bfdSessDesiredMinRxInterval, 969 bfdSessDesiredMinEchoRxInterval, 970 bfdSessDetectMult, 971 bfdSessStorType, 972 bfdSessRowStatus, 973 bfdSessMapBfdIndex 974 } 975 STATUS current 976 DESCRIPTION 977 "Collection of objects needed for BFD sessions." 978 ::= { bfdGroups 1 } 980 bfdSessionPerfGroup OBJECT-GROUP 981 OBJECTS { 982 bfdSessPerfPktIn, 983 bfdSessPerfPktOut, 984 bfdSessPerfBadDiscrim, 985 bfdSessPerfLastSessDownTime, 986 bfdSessPerfLastCommLostDiag, 987 bfdSessPerfSessDownCount, 988 bfdSessPerfDiscTime 989 } 990 STATUS current 991 DESCRIPTION 992 "Collection of objects needed to monitor the 993 performance of BFD sessions." 994 ::= { bfdGroups 2 } 996 bfdSessionPerfHCGroup OBJECT-GROUP 997 OBJECTS { 998 bfdSessPerfPktInHC, 999 bfdSessPerfPktOutHC, 1000 bfdSessPerfBadDiscrimHC 1001 } 1002 STATUS current 1003 DESCRIPTION 1004 "Collection of objects needed to monitor the 1005 performance of BFD sessions for which the 1006 values of bfdSessPerfPktIn, bfdSessPerfPktOut, 1007 or bfdSessPerfBadDiscrim wrap around too quickly." 1008 ::= { bfdGroups 3 } 1010 T. Nadeau and Z. Ali Page 20 2/9/2004 1012 draft-nadeau-bfd-mib-00.txt February 2004 1014 bfdNotificationGroup NOTIFICATION-GROUP 1015 NOTIFICATIONS { 1016 bfdSessUp, 1017 bfdSessDown 1018 } 1019 STATUS current 1020 DESCRIPTION 1021 "Set of notifications implemented in this 1022 module." 1023 ::= { bfdGroups 4 } 1025 END 1027 5. Security Considerations 1029 There are a number of management objects defined in this MIB 1030 module with a MAX-ACCESS clause of read-write and/or read-create. 1031 Such objects may be considered sensitive or vulnerable in some 1032 network environments. It is thus important to control even GET and/or 1033 NOTIFY access to these objects and possibly to even encrypt the 1034 values of these objects when sending them over the network via SNMP. 1036 Some of the readable objects in this MIB module (i.e., objects 1037 with a MAX-ACCESS other than not-accessible) may be considered 1038 sensitive or vulnerable in some network environments. It is thus 1039 important to control even GET and/or NOTIFY access to these objects 1040 and possibly to even encrypt the values of these objects when sending 1041 them over the network via SNMP. 1043 SNMP versions prior to SNMPv3 did not include adequate security. 1044 Even if the network itself is secure "for example by using IPSec", 1045 even then, there is no control as to who on the secure network is 1046 allowed to access and GET/SET "read/change/create/delete" the objects 1047 in these MIB modules. 1049 It is RECOMMENDED that implementers consider the security features 1050 as provided by the SNMPv3 framework "see [RFC3410], section 8", 1051 including full support for the SNMPv3 cryptographic mechanisms "for 1052 authentication and privacy". 1054 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1055 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1056 enable cryptographic security. It is then a customer/operator 1057 responsibility to ensure that the SNMP entity giving access to an 1058 instance of this MIB module, is properly configured to give access to 1059 the objects only to those principals "users" that have legitimate 1060 rights to indeed GET or SET "change/create/delete" them. 1062 T. Nadeau and Z. Ali Page 21 2/9/2004 1064 draft-nadeau-bfd-mib-00.txt February 2004 1066 6. Acknowledgements 1068 We would like to thank David Ward for his comments and suggestions. 1070 Reference 1072 [BFD] Katz, D., and Ward, D., "Bidirectional Forwarding Detection", 1073 draft-katz-ward-bfd-01.txt (work in progress). 1075 [BFD-SHARED] �Bidirectional Forwarding Detection over Shared 1076 Medium�, work in progress. 1078 [BFD-LSP] Aggarwal, R., Kompella, K., �BFD For MPLS LSPs�, draft- 1079 raggarwa-mpls-bfd-00.txt, April, 2004. 1081 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1082 "Introduction and Applicability Statements for Internet-Standard 1083 Management Framework", RFC 3410,December 2002. 1085 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1086 J., Rose, M., and S. Waldbusser, "Structure of Management Information 1087 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 1089 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1090 J., Rose, M., and S. Waldbusser, "Textual Conventions 1091 for SMIv2", STD 58, RFC 2579, April 1999. 1093 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1094 J., Rose, M., and S. Waldbusser, "Conformance Statements for SMIv2", 1095 STD 58, RFC 2580, April 1999. 1097 [RFC2863] McCloghrie, K., Kastenholz, F., �The Interfaces Group 1098 MIB�, RFC 2863, June 2000. 1100 [RFC3413] Levi, D., Meyer, P., Stewart, B., �Simple Network 1101 Management Protocol (SNMP) Applications�, RFC 3413, December 2002. 1103 Author's Addresses 1105 Thomas D. Nadeau 1106 Cisco Systems, Inc. 1107 300 Beaver Brook Road 1108 Boxboro, MA 01719 1109 Phone: +1-978-936-1470 1110 Email: tnadeau@cisco.com 1112 T. Nadeau and Z. Ali Page 22 2/9/2004 1114 draft-nadeau-bfd-mib-00.txt February 2004 1116 Zafar Ali 1117 Cisco Systems Inc. 1118 100 South Main St. #200 1119 Ann Arbor, MI 48104, USA. 1120 Phone: +1-734-276-2459 1121 Email: zali@cisco.com 1123 T. Nadeau and Z. Ali Page 23 2/9/2004