idnits 2.17.1 draft-ietf-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 -- however, there's a paragraph with a matching beginning. Boilerplate error? == No 'Intended status' indicated for this document; assuming Proposed Standard 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 33 instances of too long lines in the document, the longest one being 12 characters in excess of 72. ** There are 10 instances of lines with control characters in the document. ** The abstract seems to contain references ([BFD]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 126: '...and packet counters MUST be supported....' RFC 2119 keyword, line 129: '... MUST be supported and 64-bit octet ...' RFC 2119 keyword, line 131: '...ters AND 64-bit octet counters MUST be...' RFC 2119 keyword, line 488: '...ation, the agent MUST return an incons...' RFC 2119 keyword, line 680: '... BFD session. It MUST be equal to the...' (10 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == Line 403 has weird spacing: '...stem is attem...' == Line 1067 has weird spacing: '...for the purpo...' -- 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 (June 2004) is 7248 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: 'BFD-LSP' is mentioned on line 94, but not defined == Unused Reference: 'RFC3413' is defined on line 1042, but no explicit reference was found in the text -- Possible downref: Non-RFC (?) normative reference: ref. 'BFDSHARED' Summary: 7 errors (**), 0 flaws (~~), 5 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group Thomas D. Nadeau 2 Internet Draft Zafar Ali 3 Expires: December 2004 Cisco Systems, Inc. 5 June 2004 7 Bidirectional Forwarding Detection Management 8 Information Base 10 draft-ietf-bfd-mib-00.txt 12 Status of this Memo 14 This document is an Internet-Draft and is in full conformance with 15 all provisions of Section 10 of RFC 2026. 17 Internet-Drafts are working documents of the In ternet Engineering 18 Task Force (IETF), its areas, and its working groups. Note that 19 other groups may also distribute working documents as Internet- 20 Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six 23 months and may be updated, replaced, or obsoleted by other 24 documents at any time. It is inappropriate to use Internet- 25 Drafts as reference material or to cite them other than as "work 26 in progress." 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt. 31 The list of Internet-Draft Shadow Directories can be accessed at 32 http://www.ietf.org/shadow.html. 34 Abstract 36 This draft defines a portion of the Management Information Base 37 (MIB) for use with network management protocols in the Internet 38 community. In particular, it describes managed objects for modeling 39 Bidirectional Forwarding Detection (BFD) protocol [BFD]. 41 Table of Contents 43 1. Introduction .........................................................2 44 2. Terminology ..........................................................2 45 3. The SNMP Management Framework ........................................3 46 4. Use of 32-bit and 64-bit Counters ....................................3 47 5. Brief Description of MIB Objects .....................................3 48 5.1 General Variables ...................................................3 49 5.2 Session Table (bfdSessionTable) .....................................4 50 5.3 Session Performance Table (bfdSessionPerfTable) .....................4 51 5.4 Session Mapping Table (bfdSessMapTable) .............................4 52 6. BFD MIB Module Definitions ...........................................4 53 7. Security Considerations .............................................20 54 8. Acknowledgements ....................................................21 55 9. References ..........................................................21 56 9.1. Normative References .............................................21 57 9.2. Informative References ...........................................22 58 10. Author's Addresses..................................................22 59 11. Full Copyright Statement ...........................................22 60 12. Intellectual Property Notice .......................................22 61 13. IANA Considerations ................................................23 63 1. Introduction 65 For a detailed overview of the documents that describe the 66 current Internet-Standard Management Framework, please refer to 67 section of RFC 3410 [RFC3410]. 69 Managed objects are accessed via a virtual information store, 70 termed the Management Information Base or MIB. MIB objects are 71 generally accessed through the Simple Network Management Protocol 72 (SNMP). Objects in the MIB are defined using the mechanisms defined 73 in the Structure of Management Information (SMI). This memo 74 specifies a MIB module that is compliant to the SMIv2, which is 75 described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] 76 and STD 58, RFC 2580 [RFC2580]. 78 Current work is underway in the IETF to specify a suite of 79 protocols known as Bidirectional Forwarding Detection to detect 80 faults in the bidirectional path between two forwarding engines, 81 including interfaces, data link(s), and to the extent possible the 82 forwarding engines themselves, with potentially very low latency 83 [BFD]. 85 In this document we describe a MIB module that can be used to 86 manage BFD implementations. This MIB module covers both 87 configuration and performance monitoring aspects of BFD. 89 This document is based on draft-katz-ward-bfd-02.txt [BFD] and 90 only addresses MIB for MFD running over point-to-point interfaces. 91 Specifically, this version of the ID does not address BFD over 92 shared interfaces [BFDSHARED]. Furthermore, at present we do not 93 directly address manageability requirement when LSP-Ping is used for 94 boot-strapping the BFD session [BFD-LSP]. Nonetheless, some 95 considerations are in place for these applications of the BFD. These 96 aspects of BFD will be directly addressed in the future version of 97 the ID. 99 2. Terminology 100 This document uses terminology from the document describing the 101 BFD protocol [BFD]. 103 3. The SNMP Management Framework 105 For a detailed overview of the documents that describe the current 106 Internet-Standard Management Framework, please refer to section 7 of 107 RFC 3410 [RFC3410]. 109 Managed objects are accessed via a virtual information store, termed 110 the Management Information Base or MIB. MIB objects are generally 111 accessed through the Simple Network Management Protocol (SNMP). 112 Objects in the MIB are defined using the mechanisms defined in the 113 Structure of Management Information (SMI). This memo specifies a MIB 114 module that is compliant to the SMIv2, which is described in STD 58, 115 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 116 [RFC2580]. 118 4. Use of 32-bit and 64-bit Counters 120 64-bit counters are provided in this MIB module for high speed 121 interfaces where the use of 32-bit counters might be impractical. 122 The requirements on the use of 32-bit and 64-bit counters (copied 123 verbatim from [RFC2863]) are as follows. 125 For interfaces that operate at 20,000,000 (20 million) bits per 126 second or less, 32-bit byte and packet counters MUST be supported. 127 For interfaces that operate faster than 20,000,000 bits/second, 128 and slower than 650,000,000 bits/second, 32-bit packet counters 129 MUST be supported and 64-bit octet counters MUST be supported. 130 For interfaces that operate at 650,000,000 bits/second or faster, 131 64-bit packet counters AND 64-bit octet counters MUST be 132 supported. 134 5. Brief Description of MIB Objects 136 This section describes objects pertaining to BFD. The MIB objects 137 are derived from the BFD document [BFD]. 139 5.1 General Variables 141 The General Variables are used to identify parameters that are 142 global to the BFD process. 144 5.2 Session Table (bfdSessionTable) 146 The session table is used to identify a BFD session between a 147 pair of nodes. 149 5.3 Session Performance Table (bfdSessionPerfTable) 151 The session performance table is used for collecting BFD 152 performance counts on a per session basis. This table is an AUGMENT 153 to the bfdSessionTable. 155 5.4 Session Mapping Table (bfdSessMapTable) 157 The BFD Session Mapping Table maps the complex indexing of the BFD 158 sessions to the flat BFDIndex used in the BfdSessionTable. 160 6. BFD MIB Module Definitions 162 BFD-DRAFT-00-MIB DEFINITIONS ::= BEGIN 164 IMPORTS 165 MODULE-IDENTITY, OBJECT-TYPE, 166 Unsigned32, Counter32, Counter64, 167 NOTIFICATION-TYPE, mib-2 168 FROM SNMPv2-SMI 170 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 171 FROM SNMPv2-CONF 173 TEXTUAL-CONVENTION, TruthValue, RowStatus, StorageType, 174 TimeStamp 175 FROM SNMPv2-TC 177 InetAddress, InetAddressType 178 FROM INET-ADDRESS-MIB 179 ; 181 bfdMIB MODULE-IDENTITY 182 LAST-UPDATED "200401221200Z" -- 22 January 2004 12:00:00 EST 183 ORGANIZATION "IETF" 184 CONTACT-INFO 185 " Zafar Ali 186 Cisco Systems, Inc. 187 Email: zali@cisco.com 189 Thomas D. Nadeau 190 Cisco Systems, Inc. 191 Email: tnadeau@cisco.com 192 " 193 DESCRIPTION 194 "Bidirectional Forwarding Management Information Base." 196 -- Revision history. 198 REVISION 199 "200401221200Z" -- 22 January 2004 12:00:00 EST 200 DESCRIPTION 201 "Initial version." 202 ::= { mib-2 999 } -- To be assigned by IANA. 204 -- Top level components of this MIB module. 206 bfdNotifications OBJECT IDENTIFIER ::= { bfdMIB 0 } 208 bfdObjects OBJECT IDENTIFIER ::= { bfdMIB 1 } 210 bfdConformance OBJECT IDENTIFIER ::= { bfdMIB 3 } 212 bfdScalarObjects OBJECT IDENTIFIER ::= { bfdObjects 1 } 214 -- Textual Conventions 216 BfdSessIndexTC ::= TEXTUAL-CONVENTION 217 DISPLAY-HINT "d" 218 STATUS current 219 DESCRIPTION 220 "An index used to uniquely identify BFD sessions." 221 SYNTAX Unsigned32 (1..4294967295) 223 BfdInterval ::= TEXTUAL-CONVENTION 224 DISPLAY-HINT "d" 225 STATUS current 226 DESCRIPTION 227 "The BFD interval delay in microseconds." 228 SYNTAX Unsigned32 (1..4294967295) 230 BfdDiag ::= TEXTUAL-CONVENTION 231 STATUS current 232 DESCRIPTION 233 "A common BFD diagnostic code." 235 SYNTAX INTEGER { noDiagnostic(1), 236 controlDetectionTimeExpired(2), 237 echoFunctionFailed(3), 238 neighborSignaledSessionDown(4), 239 forwardingPlaneReset(5), 240 pathDown(6), 241 concatenatedPathDown(7), 242 administrativelyDown(8) 243 } 245 -- BFD General Variables 247 -- These parameters apply globally to the Router's 248 -- BFD Process. 250 bfdAdminStatus OBJECT-TYPE 251 SYNTAX INTEGER { enabled(1), disabled(2) } 252 MAX-ACCESS read-write 253 STATUS current 254 DESCRIPTION 255 "The global administrative status of BFD in this router. 256 The value 'enabled' denotes that the BFD Process is active 257 on at least one interface; 'disabled' disables it on 258 all interfaces." 259 DEFVAL { enabled } 260 ::= { bfdScalarObjects 1 } 262 bfdOperStatus OBJECT-TYPE 263 SYNTAX INTEGER { up(1), down(2) } 264 MAX-ACCESS read-only 265 STATUS current 266 DESCRIPTION 267 "The operational status of BFD on this router." 268 ::= { bfdScalarObjects 2 } 270 bfdVersionNumber OBJECT-TYPE 271 SYNTAX Unsigned32 272 MAX-ACCESS read-only 273 STATUS current 274 DESCRIPTION 275 "The current version number of the BFD protocol." 276 REFERENCE 277 " BFD Version 0 (draft-katz-ward-bfd-04.txt)" 278 DEFVAL { 0 } 279 ::= { bfdScalarObjects 3 } 281 -- BFD Session Table 282 -- The BFD Session Table specifies BFD session specific 283 -- information. 285 bfdSessTable OBJECT-TYPE 286 SYNTAX SEQUENCE OF BfdSessEntry 287 MAX-ACCESS not-accessible 288 STATUS current 289 DESCRIPTION 290 "The BFD Session Table describes the BFD sessions." 291 REFERENCE 292 "BFD Version 0 (draft-katz-ward-bfd-04.txt)" 294 ::= { bfdObjects 2 } 296 bfdSessEntry OBJECT-TYPE 297 SYNTAX BfdSessEntry 298 MAX-ACCESS not-accessible 299 STATUS current 300 DESCRIPTION 301 "The BFD Session Entry describes BFD session." 302 INDEX { bfdSessIndex } 303 ::= { bfdSessTable 1 } 305 BfdSessEntry ::= SEQUENCE { 306 bfdSessIndex BfdSessIndexTC, 307 bfdSessApplicationId Unsigned32, 308 bfdSessDiscriminator Unsigned32, 309 bfdSessLocalDiscr Unsigned32, 310 bfdSessRemoteDiscr Unsigned32, 311 bfdSessState INTEGER, 312 bfdSessRemoteHeardFlag TruthValue, 313 bfdSessDiag Unsigned32, 314 bfdSessOperMode INTEGER, 315 bfdSessDemandModeDesiredFlag TruthValue, 316 bfdSessEchoFuncModeDesiredFlag TruthValue, 317 bfdSessEchoFuncFlag INTEGER, 318 bfdSessAddrType InetAddressType, 319 bfdSessAddr InetAddress, 320 bfdSessDesiredMinTxInterval BfdInterval, 321 bfdSessDesiredMinRxInterval BfdInterval, 322 bfdSessDesiredMinEchoRxInterval BfdInterval, 323 bfdSessDetectMult BfdInterval, 324 bfdSessStorType StorageType, 325 bfdSessRowStatus RowStatus 326 } 328 bfdSessIndex OBJECT-TYPE 329 SYNTAX BfdSessIndexTC 330 MAX-ACCESS not-accessible 331 STATUS current 332 DESCRIPTION 333 "This object contains an index used to represent a 334 unique BFD session on this device." 335 ::= { bfdSessEntry 1 } 337 bfdSessApplicationId OBJECT-TYPE 338 SYNTAX Unsigned32 339 MAX-ACCESS read-only 340 STATUS current 341 DESCRIPTION 342 "This object contains an index used to indicate 343 an local application which owns or maintains this 344 BFD session. For instance, the VPN process may 345 maintain a subset of the total number of BFD 346 sessions. This application ID provides a convienent 347 way to segretate sessions by the applications which 348 maintain them." 349 ::= { bfdSessEntry 2 } 351 bfdSessDiscriminator OBJECT-TYPE 352 SYNTAX Unsigned32 (1..4294967295) 353 MAX-ACCESS read-only 354 STATUS current 355 DESCRIPTION 356 "This object specifies the local discriminator for this BFD 357 session, used to uniquely identify it." 358 ::= { bfdSessEntry 3 } 360 bfdSessLocalDiscr OBJECT-TYPE 361 SYNTAX Unsigned32 (1..4294967295) 362 MAX-ACCESS read-only 363 STATUS current 364 DESCRIPTION 365 "This object specifies the local discriminator for this BFD 366 session, used to uniquely identify it." 367 ::= { bfdSessEntry 4 } 369 bfdSessRemoteDiscr OBJECT-TYPE 370 SYNTAX Unsigned32 (1..4294967295) 371 MAX-ACCESS read-only 372 STATUS current 373 DESCRIPTION 374 "This object specifies the discriminator chosen by the 375 remote system local discriminator for this BFD 376 session." 377 ::= { bfdSessEntry 5 } 379 bfdSessState OBJECT-TYPE 380 SYNTAX INTEGER { 381 init(1), 382 up(2), 383 failing(3), 384 down(4), 385 adminDown(5) 386 } 387 MAX-ACCESS read-only 388 STATUS current 389 DESCRIPTION 390 "The perceived state of the BFD session." 391 ::= { bfdSessEntry 6 } 393 bfdSessRemoteHeardFlag OBJECT-TYPE 394 SYNTAX TruthValue 395 MAX-ACCESS read-only 396 STATUS current 397 DESCRIPTION 398 "This object specifies status of BFD packet reception from 399 the remote system. Specifically, it is set to true(1) if the 400 local system is actively receiving BFD packets from the 401 remote system, and is set to false(0) if the local system 402 has not received BFD packets recently (within the detection 403 time) or if the local system is attempting to tear down the 404 BFD session." 405 ::= { bfdSessEntry 7 } 407 bfdSessDiag OBJECT-TYPE 408 SYNTAX Unsigned32 409 MAX-ACCESS accessible-for-notify 410 STATUS current 411 DESCRIPTION 412 "A diagnostic code specifying the local system's reason 413 for the last transition of the session from up(1) to some 414 other state." 415 ::= { bfdSessEntry 8 } 417 bfdSessOperMode OBJECT-TYPE 418 SYNTAX INTEGER { asyncModeWEchoFun(1), 419 asynchModeWOEchoFun(2), 420 demandModeWEchoFunction(3), 421 demandModeWOEchoFunction(4) 422 } 423 MAX-ACCESS read-only 424 STATUS current 425 DESCRIPTION 426 "This object specifies current operating mode that BFD 427 session is operating in. 429 A value of AsyncModeWEchoFun(1) ... 430 A value of AsynchModeWOEchoFun(2) ... 431 A value of DemandModeWEchoFunction(3) ... 432 A value of DemandModeWOEchoFunction(4) ... 433 " 434 ::= { bfdSessEntry 9 } 436 bfdSessDemandModeDesiredFlag OBJECT-TYPE 437 SYNTAX TruthValue 438 MAX-ACCESS read-create 439 STATUS current 440 DESCRIPTION 441 "This object indicates that the local system's 442 desire to use Demand mode. Specifically, it is set 443 to true(1) if the local system wishes to use 444 Demand mode or false(0) if not" 445 DEFVAL { false } 446 ::= { bfdSessEntry 10 } 448 bfdSessEchoFuncModeDesiredFlag OBJECT-TYPE 449 SYNTAX TruthValue 450 MAX-ACCESS read-create 451 STATUS current 452 DESCRIPTION 453 "This object indicates that the local system's 454 desire to use Echo mode. Specifically, it is set 455 to true(1) if the local system wishes to use 456 Echo mode or false(0) if not" 457 DEFVAL { false } 458 ::= { bfdSessEntry 11 } 460 bfdSessEchoFuncFlag OBJECT-TYPE 461 SYNTAX INTEGER { enabled(1), disabled(2) } 462 MAX-ACCESS read-create 463 STATUS current 464 DESCRIPTION 465 "The administrative status of Echo function for this BFD 466 session. The value 'enabled' denotes that the Echo 467 function is enabled for this session; 'disabled' disables 468 Echo function for this session." 469 ::= { bfdSessEntry 12 } 471 bfdSessAddrType OBJECT-TYPE 472 SYNTAX InetAddressType 473 MAX-ACCESS read-create 474 STATUS current 475 DESCRIPTION 476 "This object specifies IP address of the interface associated with 477 this BFD session. 479 Only values unknown(0), ipv4(1) or ipv6(2) 480 have to be supported. 482 A value of unknown(0) is allowed only when 483 the outgoing interface is of type point-to-point, or 484 when the BFD session is not associated with a specific 485 interface. 487 If any other unsupported values are attempted in a set 488 operation, the agent MUST return an inconsistentValue 489 error. 490 " 491 ::= { bfdSessEntry 13 } 493 bfdSessAddr OBJECT-TYPE 494 SYNTAX InetAddress 495 MAX-ACCESS read-create 496 STATUS current 497 DESCRIPTION 498 "This object specifies IP address of the interface associated with 499 this BFD session. It can also be used to enabled BFD on a specific 500 interface. The value is set to zero when BFD session is not 501 associated with a specific interface. " 502 ::= { bfdSessEntry 14 } 504 bfdSessDesiredMinTxInterval OBJECT-TYPE 505 SYNTAX BfdInterval 506 MAX-ACCESS read-create 507 STATUS current 508 DESCRIPTION 509 "This object specifies the minimum interval, in 510 microseconds, that the local system would like to use when 511 transmitting BFD Control packets." 512 ::= { bfdSessEntry 15 } 514 bfdSessDesiredMinRxInterval OBJECT-TYPE 515 SYNTAX BfdInterval 516 MAX-ACCESS read-create 517 STATUS current 518 DESCRIPTION 519 "This object specifies the minimum interval, in 520 microseconds, between received BFD Control packets the 521 local system is capable of supporting." 522 ::= { bfdSessEntry 16 } 524 bfdSessDesiredMinEchoRxInterval OBJECT-TYPE 525 SYNTAX BfdInterval 526 MAX-ACCESS read-create 527 STATUS current 528 DESCRIPTION 529 "This object specifies the minimum interval, in 530 microseconds, between received BFD Echo packets that this 531 system is capable of supporting." 532 ::= { bfdSessEntry 17 } 534 bfdSessDetectMult OBJECT-TYPE 535 SYNTAX BfdInterval 536 MAX-ACCESS read-create 537 STATUS current 538 DESCRIPTION 539 "This object specifies the Detect time multiplier." 540 ::= { bfdSessEntry 18 } 542 bfdSessStorType OBJECT-TYPE 543 SYNTAX StorageType 544 MAX-ACCESS read-create 545 STATUS current 546 DESCRIPTION 547 "This variable indicates the storage type for this 548 object. Conceptual rows having the value 549 'permanent' need not allow write-access to any 550 columnar objects in the row." 551 ::= { bfdSessEntry 19 } 553 bfdSessRowStatus OBJECT-TYPE 554 SYNTAX RowStatus 555 MAX-ACCESS read-create 556 STATUS current 557 DESCRIPTION 558 "This variable is used to create, modify, and/or 559 delete a row in this table. When a row in this 560 table has a row in the active(1) state, no 561 objects in this row can be modified except the 562 bfdSessRowStatus and bfdSessStorageType." 563 ::= { bfdSessEntry 20 } 565 -- BFD Session Performance Table 567 bfdSessPerfTable OBJECT-TYPE 568 SYNTAX SEQUENCE OF BfdSessPerfEntry 569 MAX-ACCESS not-accessible 570 STATUS current 571 DESCRIPTION 572 "This table specifies BFD Session performance counters." 573 ::= { bfdObjects 3 } 575 bfdSessPerfEntry OBJECT-TYPE 576 SYNTAX BfdSessPerfEntry 577 MAX-ACCESS not-accessible 578 STATUS current 579 DESCRIPTION 580 "An entry in this table is created by a BFD-enabled node for 581 every BFD Session. bfdCounterDiscontinuityTime is used to 582 indicate potential discontinuity for all counter objects 583 in this table." 584 AUGMENTS { bfdSessEntry } 585 ::= { bfdSessPerfTable 1 } 587 BfdSessPerfEntry ::= SEQUENCE { 588 bfdSessPerfPktIn Counter32, 589 bfdSessPerfPktOut Counter32, 590 bfdSessPerfBadDiscrim Counter32, 591 bfdSessPerfLastSessDownTime TimeStamp, 592 bfdSessPerfLastCommLostDiag BfdDiag, 593 bfdSessPerfSessDownCount Counter32, 594 bfdSessPerfDiscTime TimeStamp, 596 -- High Capacity Counters 597 bfdSessPerfPktInHC Counter64, 598 bfdSessPerfPktOutHC Counter64, 599 bfdSessPerfBadDiscrimHC Counter64 601 } 603 -- Ed Note: should we add per-diag code counts here, 605 bfdSessPerfPktIn OBJECT-TYPE 606 SYNTAX Counter32 607 MAX-ACCESS read-only 608 STATUS current 609 DESCRIPTION 610 "The total number of BFD messages received for this BFD session." 611 ::= { bfdSessPerfEntry 1 } 613 bfdSessPerfPktOut OBJECT-TYPE 614 SYNTAX Counter32 615 MAX-ACCESS read-only 616 STATUS current 617 DESCRIPTION 618 "The total number of BFD messages sent for this BFD session." 619 ::= { bfdSessPerfEntry 2 } 621 bfdSessPerfBadDiscrim OBJECT-TYPE 622 SYNTAX Counter32 623 MAX-ACCESS read-only 624 STATUS current 625 DESCRIPTION 626 "The total number of BFD messages received with a 627 bad local Discriminator value for this BFD session." 628 ::= { bfdSessPerfEntry 3 } 630 bfdSessPerfLastSessDownTime OBJECT-TYPE 631 SYNTAX TimeStamp 632 MAX-ACCESS read-only 633 STATUS current 634 DESCRIPTION 635 "The value of sysUpTime on the most recent occasion at which 636 the last time communication was lost with the neighbor. If 637 no such down event exist this object contains a zero value." 638 ::= { bfdSessPerfEntry 4 } 640 bfdSessPerfLastCommLostDiag OBJECT-TYPE 641 SYNTAX BfdDiag 642 MAX-ACCESS read-only 643 STATUS current 644 DESCRIPTION 645 "The BFD diag code for the last time communication was lost 646 with the neighbor. If no such down event exist this object 647 contains a zero value." 648 ::= { bfdSessPerfEntry 5 } 650 bfdSessPerfSessDownCount OBJECT-TYPE 651 SYNTAX Counter32 652 MAX-ACCESS read-only 653 STATUS current 654 DESCRIPTION 655 "The number of times this session has gone into the down 656 state since the router last rebooted." 657 ::= { bfdSessPerfEntry 6 } 659 bfdSessPerfDiscTime OBJECT-TYPE 660 SYNTAX TimeStamp 661 MAX-ACCESS read-only 662 STATUS current 663 DESCRIPTION 664 "The value of sysUpTime on the most recent occasion at which any 665 one or more of the session counters suffered a discontinuity. 666 The relevant counters are the specific instances associated 667 with this BFD sesion of any Counter32 object contained in the 668 BfdSessPerfTable. If no such discontinuities have occurred 669 since the last re-initialization of the local management subsystem, 670 then this object contains a zero value." 671 ::= { bfdSessPerfEntry 7 } 673 bfdSessPerfPktInHC OBJECT-TYPE 674 SYNTAX Counter64 675 MAX-ACCESS read-only 676 STATUS current 677 DESCRIPTION 678 "This value represents the total number of 679 total number of BFD messages received for this 680 BFD session. It MUST be equal to the 681 least significant 32 bits of bfdSessPerfPktIn 682 if bfdSessPerfPktInHC is supported according to 683 the rules spelled out in RFC2863." 684 ::= { bfdSessPerfEntry 8 } 686 bfdSessPerfPktOutHC OBJECT-TYPE 687 SYNTAX Counter64 688 MAX-ACCESS read-only 689 STATUS current 690 DESCRIPTION 691 "This value represents the total number of 692 total number of BFD messages transmitted for this 693 BFD session. It MUST be equal to the 694 least significant 32 bits of bfdSessPerfPktIn 695 if bfdSessPerfPktOutHC is supported according to 696 the rules spelled out in RFC2863." 697 ::= { bfdSessPerfEntry 9 } 699 bfdSessPerfBadDiscrimHC OBJECT-TYPE 700 SYNTAX Counter64 701 MAX-ACCESS read-only 702 STATUS current 703 DESCRIPTION 704 "This value represents the total number of 705 total number of BFD messages received with a 706 bad local Discriminator value for this BFD session. 707 It MUST be equal to the least significant 32 bits of 708 bfdSessPerfBadDiscrimHC if bfdSessPerfBadDiscrimHC 709 is supported according to the rules spelled out 710 in RFC2863." 711 ::= { bfdSessPerfEntry 10 } 713 -- BFD Sess Mapping Table 715 bfdSessMapTable OBJECT-TYPE 716 SYNTAX SEQUENCE OF BfdSessMapEntry 717 MAX-ACCESS not-accessible 718 STATUS current 719 DESCRIPTION 720 "The BFD Session Map Table maps the complex 721 indexing of the BFD sessions to the flat 722 BFDIndex used in the BfdSessionTable. 724 Implementors need to be aware that if the value of 725 the bfdSessAddr (an OID) has more 726 that 111 sub-identifiers, then OIDs of column 727 instances in this table will have more than 128 728 sub-identifiers and cannot be accessed using SNMPv1, 729 SNMPv2c, or SNMPv3. 730 " 731 REFERENCE 732 "BFD Version 0 (draft-katz-ward-bfd-04.txt)" 733 ::= { bfdObjects 4 } 735 bfdSessMapEntry OBJECT-TYPE 736 SYNTAX BfdSessMapEntry 737 MAX-ACCESS not-accessible 738 STATUS current 739 DESCRIPTION 740 "The BFD Session Entry describes BFD session 741 that is mapped to this index. 743 Implementors need to be aware that if the value of 744 the bfdSessAddr has more that 111 octets, then OIDs of 745 column instances in this table will have more than 128 746 sub-identifiers and cannot be accessed using SNMPv1, 747 SNMPv2c, or SNMPv3" 749 INDEX { bfdSessApplicationId, 750 bfdSessDiscriminator, 751 bfdSessAddrType, 752 bfdSessAddr 753 } 754 ::= { bfdSessMapTable 1 } 756 BfdSessMapEntry ::= SEQUENCE { 757 bfdSessMapBfdIndex BfdSessIndexTC 758 } 760 bfdSessMapBfdIndex OBJECT-TYPE 761 SYNTAX BfdSessIndexTC 762 MAX-ACCESS read-only 763 STATUS current 764 DESCRIPTION 765 "This object specifies the BfdIndex refered to by 766 the indexes of this row. In essence, a mapping is 767 provided between these indexes and the BfdSessTable." 768 ::= { bfdSessMapEntry 1 } 770 -- Notification Configuration 772 bfdSessNotificationsEnable OBJECT-TYPE 773 SYNTAX TruthValue 774 MAX-ACCESS read-write 775 STATUS current 776 DESCRIPTION 777 "If this object is set to true(1), then it enables 778 the emission of bfdSessUp and bfdSessDown 779 notifications; otherwise these notifications are not 780 emitted." 781 REFERENCE 782 "See also RFC3413 for explanation that 783 notifications are under the ultimate control of the 784 MIB modules in this document." 785 DEFVAL { false } 786 ::= { bfdScalarObjects 4 } 788 bfdSessUp NOTIFICATION-TYPE 789 OBJECTS { bfdSessDiag, -- low range value 790 bfdSessDiag -- high range value 791 } 792 STATUS current 793 DESCRIPTION 794 "This notification is generated when the 795 bfdSessState object for one or more contiguous 796 entries in bfdSessTable are about to enter the up(2) 797 state from some other state. The included values of 798 bfdSessDiag MUST both be set equal to this 799 new state (i.e: up(1)). The two instances of 800 bfdSessDiag in this notification indicate the range 801 of indexes that are affected. Note that all the indexes 802 of the two ends of the range can be derived from the 803 instance identifiers of these two objects. For 804 cases where a contiguous range of sessions 805 have transitioned into the up(1) state at roughly 806 the same time, the device SHOULD issue a single 807 notification for each range of contiguous indexes in 808 an effort to minimize the emission of a large number 809 of notifications. If a notification has to be 810 issued for just a single bfdSessEntry, then 811 the instance identifier (and values) of the two 812 bfdSessDiag objects MUST be the identical." 813 ::= { bfdNotifications 1 } 815 bfdSessDown NOTIFICATION-TYPE 816 OBJECTS { bfdSessDiag, -- low range value 817 bfdSessDiag -- high range value 818 } 819 STATUS current 820 DESCRIPTION 821 "This notification is generated when the 822 bfdSessState object for one or more contiguous 823 entries in bfdSessTable are about to enter the down(4) 824 or adminDown(5) states from some other state. The included 825 values of bfdSessDiag MUST both be set equal to this 826 new state (i.e: down(4) or adminDown(5)). The two instances 827 of bfdSessDiag in this notification indicate the range 828 of indexes that are affected. Note that all the indexes 829 of the two ends of the range can be derived from the 830 instance identifiers of these two objects. For 831 cases where a contiguous range of sessions 832 have transitioned into the down(4) or adminDown(5) states 833 at roughly the same time, the device SHOULD issue a single 834 notification for each range of contiguous indexes in 835 an effort to minimize the emission of a large number 836 of notifications. If a notification has to be 837 issued for just a single bfdSessEntry, then 838 the instance identifier (and values) of the two 839 bfdSessDiag objects MUST be the identical." 840 ::= { bfdNotifications 2 } 842 -- Module compliance. 844 bfdGroups 845 OBJECT IDENTIFIER ::= { bfdConformance 1 } 847 bfdCompliances 848 OBJECT IDENTIFIER ::= { bfdConformance 2 } 850 -- Compliance requirement for fully compliant implementations. 852 bfdModuleFullCompliance MODULE-COMPLIANCE 853 STATUS current 854 DESCRIPTION "Compliance statement for agents that provide full 855 support for BFD-MIB. Such devices can 856 then be monitored and also be configured using 857 this MIB module." 859 MODULE -- This module. 860 MANDATORY-GROUPS { 861 bfdSessionGroup, 862 bfdSessionPerfGroup, 863 bfdSessionPerfHCGroup, 864 bfdNotificationGroup 865 } 867 GROUP bfdSessionPerfHCGroup 868 DESCRIPTION "This group is mandatory for those bfdPerfTable entries 869 for which any of the objects bfdSessPerfPktInHC, 870 bfdSessPerfPktOutHC, or bfdSessPerfBadDiscrimHC 871 wraps around too quickly based on the criteria specified in 872 RFC 2863 for high-capacity counters." 874 GROUP bfdNotificationGroup 875 DESCRIPTION "This group is only mandatory for those implementations 876 which can efficiently implement the notifications 877 contained in this group." 879 OBJECT bfdSessAddrType 880 SYNTAX InetAddressType { unknown(0), ipv4(1), ipv6(2) } 881 DESCRIPTION "Only unknown(0), ipv4(1) and ipv6(2) support 882 is required." 884 OBJECT bfdSessAddr 885 SYNTAX InetAddress (SIZE(0|4|16)) 886 DESCRIPTION "An implementation is only required to support 887 unknown(0), ipv4(1) and ipv6(2) sizes." 889 ::= { bfdCompliances 1 } 891 -- Read-Only compliance TBD... 893 -- Units of conformance. 895 bfdSessionGroup OBJECT-GROUP 896 OBJECTS { 897 bfdSessNotificationsEnable, 898 bfdAdminStatus, 899 bfdOperStatus, 900 bfdVersionNumber, 901 bfdSessApplicationId, 902 bfdSessDiscriminator, 903 bfdSessAddrType, 904 bfdSessAddr, 905 bfdSessLocalDiscr, 906 bfdSessRemoteDiscr, 907 bfdSessState, 908 bfdSessRemoteHeardFlag, 909 bfdSessDiag, 910 bfdSessOperMode, 911 bfdSessDemandModeDesiredFlag, 912 bfdSessEchoFuncFlag, 913 bfdSessEchoFuncModeDesiredFlag, 914 bfdSessDesiredMinTxInterval, 915 bfdSessDesiredMinRxInterval, 916 bfdSessDesiredMinEchoRxInterval, 917 bfdSessDetectMult, 918 bfdSessStorType, 919 bfdSessRowStatus, 920 bfdSessMapBfdIndex 921 } 922 STATUS current 923 DESCRIPTION 924 "Collection of objects needed for BFD sessions." 925 ::= { bfdGroups 1 } 927 bfdSessionPerfGroup OBJECT-GROUP 928 OBJECTS { 929 bfdSessPerfPktIn, 930 bfdSessPerfPktOut, 931 bfdSessPerfBadDiscrim, 932 bfdSessPerfLastSessDownTime, 933 bfdSessPerfLastCommLostDiag, 934 bfdSessPerfSessDownCount, 935 bfdSessPerfDiscTime 936 } 937 STATUS current 938 DESCRIPTION 939 "Collection of objects needed to monitor the 940 performance of BFD sessions." 941 ::= { bfdGroups 2 } 943 bfdSessionPerfHCGroup OBJECT-GROUP 944 OBJECTS { 945 bfdSessPerfPktInHC, 946 bfdSessPerfPktOutHC, 947 bfdSessPerfBadDiscrimHC 948 } 949 STATUS current 950 DESCRIPTION 951 "Collection of objects needed to monitor the 952 performance of BFD sessions for which the 953 values of bfdSessPerfPktIn, 954 bfdSessPerfPktOut, or bfdSessPerfBadDiscrim 955 wrap around too quickly." 956 ::= { bfdGroups 3 } 958 bfdNotificationGroup NOTIFICATION-GROUP 959 NOTIFICATIONS { 960 bfdSessUp, 961 bfdSessDown 962 } 963 STATUS current 964 DESCRIPTION 965 "Set of notifications implemented in this 966 module." 967 ::= { bfdGroups 4 } 969 END 971 7. Security Considerations 973 There are a number of management objects defined in this MIB 974 module with a MAX-ACCESS clause of read-write and/or read-create. 975 Such objects may be considered sensitive or vulnerable in some 976 network environments. It is thus important to control even GET 977 and/or NOTIFY access to these objects and possibly to even encrypt 978 the values of these objects when sending them over the network via 979 SNMP. 981 Some of the readable objects in this MIB module (i.e., objects 982 with a MAX-ACCESS other than not-accessible) may be considered 983 sensitive or vulnerable in some network environments. It is thus 984 important to control even GET and/or NOTIFY access to these objects 985 and possibly to even encrypt the values of these objects when 986 sending them over the network via SNMP. 988 SNMP versions prior to SNMPv3 did not include adequate security. 989 Even if the network itself is secure "for example by using IPSec", 990 even then, there is no control as to who on the secure network is 991 allowed to access and GET/SET "read/change/create/delete" the 992 objects in these MIB modules. 994 It is RECOMMENDED that implementers consider the security 995 features as provided by the SNMPv3 framework "see [RFC3410], section 996 8", including full support for the SNMPv3 cryptographic mechanisms 997 "for authentication and privacy". 999 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1000 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1001 enable cryptographic security. It is then a customer/operator 1002 responsibility to ensure that the SNMP entity giving access to an 1003 instance of this MIB module, is properly configured to give access 1004 to the objects only to those principals "users" that have legitimate 1005 rights to indeed GET or SET "change/create/delete" them. 1007 8. Acknowledgements 1009 We would like to thank David Ward for his comments and suggestions. 1011 9. References 1013 9.1 Normative References 1015 [BFD] Katz, D., and Ward, D., "Bidirectional Forwarding Detection", 1016 draft-katz-ward-bfd-02.txt (work in progress). 1018 [BFDSHARED] "Bidirectional Forwarding Detection over Shared 1019 Interfaces", work in progress. 1021 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1022 J., Rose, M., and S. Waldbusser, "Structure of Management 1023 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 1025 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1026 J., Rose, M., and S. Waldbusser, "Textual Conventions 1027 for SMIv2", STD 58, RFC 2579, April 1999. 1029 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, 1030 J., Rose, M., and S. Waldbusser, "Conformance Statements for SMIv2", 1031 STD 58, RFC 2580, April 1999. 1033 [RFC2863] McCloghrie, K., Kastenholz, F., "The Interfaces Group 1034 MIB", RFC 2863, June 2000. 1036 9.2 Informative References 1038 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1039 "Introduction and Applicability Statements for Internet-Standard 1040 Management Framework", RFC 3410,December 2002. 1042 [RFC3413] Levi, D., Meyer, P., Stewart, B., "Simple Network 1043 Management Protocol (SNMP) Applications", RFC 3413, December 2002. 1045 10. Author's Addresses 1047 Thomas D. Nadeau Zafar Ali 1048 Cisco Systems, Inc. Cisco Systems Inc. 1049 300 Beaver Brook Road 100 South Main St. #200 1050 Boxborough, MA 01719 Ann Arbor, MI 48104, USA. 1051 Phone: +1-978-936-1470 Phone: +1-734-276-2459 1052 Email: tnadeau@cisco.com Email: zali@cisco.com 1054 16. Full Copyright Statement 1056 Copyright (C) The Internet Society (2003). All Rights Reserved. 1058 This document and translations of it may be copied and furnished 1059 to others, and derivative works that comment on or otherwise 1060 explain it or assist in its implementation may be prepared, 1061 copied, published and distributed, in whole or in part, without 1062 restriction of any kind, provided that the above copyright notice 1063 and this paragraph are included on all such copies and derivative 1064 works. However, this document itself may not be modified in any 1065 way, such as by removing the copyright notice or references to the 1066 Internet Society or other Internet organizations, except as needed 1067 for the purpose of developing Internet standards in which case 1068 the procedures for copyrights defined in the Internet Standards 1069 process must be followed, or as required to translate it into 1070 languages other than English. 1072 The limited permissions granted above are perpetual and will not 1073 be revoked by the Internet Society or its successors or assigns. 1074 This document and the information contained herein is provided on 1075 an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET 1076 ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR 1077 IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 1078 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1079 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1081 17. Intellectual Property Notice 1083 The IETF takes no position regarding the validity or scope of any 1084 intellectual property or other rights that might be claimed to 1085 pertain to the implementation or use of the technology described in 1086 this document or the extent to which any license under such rights 1087 might or might not be available; neither does it represent that it 1088 has made any effort to identify any such rights. Information on the 1089 IETF's procedures with respect to rights in standards-track and 1090 standards-related documentation can be found in BCP-11 [RFC2028]. 1091 Copies of claims of rights made available for publication and any 1092 assurances of licenses to be made available, or the result of an 1093 attempt made to obtain a general license or permission for the use of 1094 such proprietary rights by implementors or users of this 1095 specification can be obtained from the IETF Secretariat. 1096 The IETF invites any interested party to bring to its attention any 1097 copyrights, patents or patent applications, or other proprietary 1098 rights that may cover technology that may be required to practice 1099 this standard. Please address the information to the IETF Executive 1100 Director.