idnits 2.17.1 draft-ietf-bfd-mib-02.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 15. -- Found old boilerplate from RFC 3978, Section 5.5 on line 1090. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1112. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1119. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1125. ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing document type: Expected "INTERNET-DRAFT" in the upper left hand corner of the first page == No 'Intended status' indicated for this document; assuming Proposed Standard 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 RFC 3978 Section 5.4 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 (July 2005) is 6857 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) == Unused Reference: 'RFC3413' is defined on line 1054, but no explicit reference was found in the text == Outdated reference: A later version (-11) exists of draft-ietf-bfd-base-02 == Outdated reference: A later version (-09) exists of draft-ietf-bfd-multihop-03 == Outdated reference: A later version (-07) exists of draft-ietf-bfd-mpls-02 ** Obsolete normative reference: RFC 3291 (Obsoleted by RFC 4001) -- Obsolete informational reference (is this intentional?): RFC 2434 (Obsoleted by RFC 5226) Summary: 6 errors (**), 0 flaws (~~), 7 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 Standard Track Zafar Ali 3 Cisco Systems, Inc. 5 Expires: January 2006 July 2005 7 Bidirectional Forwarding Detection Management Information Base 8 draft-ietf-bfd-mib-02.txt 10 Status of this Memo 12 By submitting this Internet-Draft, each author represents that any 13 applicable patent or other IPR claims of which he or she is aware 14 have been or will be disclosed, and any of which he or she becomes 15 aware will be disclosed, in accordance with Section 6 of BCP 79. 17 Internet-Drafts are working documents of the Internet Engineering 18 Task Force (IETF), its areas, and its working groups. Note that other 19 groups may also distribute working documents as Internet-Drafts. 21 Internet-Drafts are draft documents valid for a maximum of six months 22 and may be updated, replaced, or obsoleted by other documents at any 23 time. It is inappropriate to use Internet-Drafts as reference 24 material or to cite them other than as "work in progress." 26 The list of current Internet-Drafts can be accessed at 27 http://www.ietf.org/ietf/1id-abstracts.txt. 29 The list of Internet-Draft Shadow Directories can be accessed at 30 http://www.ietf.org/shadow.html. 32 Abstract 34 This draft defines a portion of the Management Information Base 35 (MIB) for use with network management protocols in the Internet 36 community. In particular, it describes managed objects for modeling 37 Bidirectional Forwarding Detection (BFD) protocol [BFD]. 39 Contents 41 1. Introduction...................................................2 42 2. Terminology....................................................3 43 3. The Internet-Standard Management Framework.....................3 44 3. Brief Description of MIB Objects...............................3 45 3.1 General Variables..........................................3 46 3.2 Session Table (bfdSessionTable)............................3 47 3.3 Session Performance Table (bfdSessionPerfTable)............3 48 3.4 Session Mapping Table (bfdSessMapTable)....................3 50 4. BFD MIB Module Definitions.....................................4 51 5. Security Considerations.......................................21 52 6. Acknowledgements..............................................22 53 7. References....................................................23 54 7.1 Normative References.........................................23 55 7.2 Informative References.......................................23 56 8. Author's Addresses............................................23 57 9. Full Copyright Statement......................................24 58 10. IANA Considerations.........................................41 59 10.1. IANA Considerations for BFD-STD-MIB.......................41 60 11. Intellectual Property Statement.............................41 62 1. Introduction 64 This memo defines an portion of the Management 65 Information Base (MIB) for use with network management protocols 66 in the Internet community. In particular, it describes managed 67 objects to configure and/or monitor Bi-Directional Forwarding 68 Detection on devices supporting this feature. 70 This document adopts the definitions, acronyms and mechanisms 71 described in [BFD], [BFD-MH] and [BFD-LSP]. Unless otherwise 72 stated, the mechanisms described therein will not be re-described 73 here. 75 Comments should be made directly to the BFD mailing list at 76 rtg-bfd@ietf.org. 78 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 79 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and 80 "OPTIONAL" in this document are to be interpreted as described in 81 [RFC2119]. 83 2. Terminology 85 This document adopts the definitions, acronyms and mechanisms 86 described in [BFD], [BFD-MH] and [BFD-LSP]. Unless otherwise 87 stated, the mechanisms described therein will not be re-described 88 here. 90 3. The Internet-Standard Management Framework 92 For a detailed overview of the documents that describe the current 93 Internet-Standard Management Framework, please refer to section 7 of 94 RFC 3410 [RFC3410]. 96 Managed objects are accessed via a virtual information store, termed 97 the Management Information Base or MIB. MIB objects are generally 98 accessed through the Simple Network Management Protocol (SNMP). 99 Objects in the MIB are defined using the mechanisms defined in the 100 Structure of Management Information (SMI). This memo specifies a MIB 101 module that is compliant to the SMIv2, which is described in STD 58, 102 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 103 [RFC2580]. 105 4. Brief Description of MIB Objects 107 This section describes objects pertaining to BFD. The MIB objects 108 are derived from the BFD document [BFD]. 110 4.1 General Variables 112 The General Variables are used to identify parameters that are 113 global to the BFD process. 115 4.2 Session Table (bfdSessionTable) 117 The session table is used to identify a BFD session between a pair 118 of nodes. 120 4.3 Session Performance Table (bfdSessionPerfTable) 122 The session performance table is used for collecting BFD 123 performance counts on a per session basis. This table is an AUGMENT 124 to the bfdSessionTable. 126 3.4 Session Mapping Table (bfdSessMapTable) 128 The BFD Session Mapping Table maps the complex indexing of the BFD 129 sessions to the flat BFDIndex used in the BfdSessionTable. 131 5. BFD MIB Module Definitions 133 BFD-STD-MIB DEFINITIONS ::= BEGIN 134 IMPORTS 135 MODULE-IDENTITY, OBJECT-TYPE, 136 Unsigned32, Counter32, Counter64, 137 NOTIFICATION-TYPE, mib-2 138 FROM SNMPv2-SMI -- [RFC2578] 140 MODULE-COMPLIANCE, OBJECT-GROUP, 141 NOTIFICATION-GROUP 142 FROM SNMPv2-CONF -- [RFC2580] 144 TEXTUAL-CONVENTION, TruthValue, 145 RowStatus, StorageType, TimeStamp 146 FROM SNMPv2-TC -- [RFC2579] 148 InetAddress, InetAddressType, InetPortNumber 149 FROM INET-ADDRESS-MIB -- [RFC3291] 150 ; 152 bfdMIB MODULE-IDENTITY 153 LAST-UPDATED "200507221200Z" -- 04 July 2005 12:00:00 EST 154 ORGANIZATION "IETF" 155 CONTACT-INFO 156 " Thomas D. Nadeau 157 Cisco Systems, Inc. 158 Email: tnadeau@cisco.com 160 Zafar Ali 161 Cisco Systems, Inc. 162 Email: zali@cisco.com 163 " 164 DESCRIPTION 165 "Bidirectional Forwarding Management Information Base." 167 -- Revision history. 168 REVISION 169 "200508221200Z" -- 04 August 2005 12:00:00 EST 170 DESCRIPTION 171 "Initial version. Published as RFC xxxx." -- RFC-editor pls fill 172 -- in xxxx 173 ::= { mib-2 XXX } -- assigned by IANA, see section 18.1 for details 175 -- Top level components of this MIB module. 177 bfdNotifications OBJECT IDENTIFIER ::= { bfdMIB 0 } 179 bfdObjects OBJECT IDENTIFIER ::= { bfdMIB 1 } 181 bfdConformance OBJECT IDENTIFIER ::= { bfdMIB 3 } 183 bfdScalarObjects OBJECT IDENTIFIER ::= { bfdObjects 1 } 185 -- Textual Conventions 187 BfdSessIndexTC ::= TEXTUAL-CONVENTION 188 DISPLAY-HINT "d" 189 STATUS current 190 DESCRIPTION 191 "An index used to uniquely identify BFD sessions." 192 SYNTAX Unsigned32 (1..4294967295) 193 BfdInterval ::= TEXTUAL-CONVENTION 194 STATUS current 195 DESCRIPTION 196 "The BFD interval delay in microseconds." 197 SYNTAX Unsigned32 (1..4294967295) 199 BfdDiag ::= TEXTUAL-CONVENTION 200 STATUS current 201 DESCRIPTION 202 "A common BFD diagnostic code." 204 SYNTAX INTEGER { noDiagnostic(1), 205 controlDetectionTimeExpired(2), 206 echoFunctionFailed(3), 207 neighborSignaledSessionDown(4), 208 forwardingPlaneReset(5), 209 pathDown(6), 210 concatenatedPathDown(7), 211 administrativelyDown(8), 212 reverseConcatenatedPathDown (9) 213 } 215 -- BFD General Variables 217 -- These parameters apply globally to the Router's 218 -- BFD Process. 220 bfdAdminStatus OBJECT-TYPE 221 SYNTAX INTEGER { enabled(1), disabled(2) } 222 MAX-ACCESS read-write 223 STATUS current 224 DESCRIPTION 225 "The global administrative status of BFD in this router. 226 The value 'enabled' denotes that the BFD Process is 227 active on at least one interface; 'disabled' disables 228 it on all interfaces." 229 DEFVAL { enabled } 230 ::= { bfdScalarObjects 1 } 232 bfdVersionNumber OBJECT-TYPE 233 SYNTAX Unsigned32 234 MAX-ACCESS read-only 235 STATUS current 236 DESCRIPTION 237 "The current version number of the BFD protocol." 238 REFERENCE 239 " BFD Version 0 (draft-katz-ward-bfd-02.txt)" 240 DEFVAL { 0 } 241 ::= { bfdScalarObjects 3 } 243 -- BFD Session Table 244 -- The BFD Session Table specifies BFD session specific 245 -- information. 247 bfdSessTable OBJECT-TYPE 248 SYNTAX SEQUENCE OF BfdSessEntry 249 MAX-ACCESS not-accessible 250 STATUS current 251 DESCRIPTION 252 "The BFD Session Table describes the BFD sessions." 253 REFERENCE 254 "BFD Version 0 (draft-katz-ward-bfd-02.txt)" 255 ::= { bfdObjects 2 } 257 bfdSessEntry OBJECT-TYPE 258 SYNTAX BfdSessEntry 259 MAX-ACCESS not-accessible 260 STATUS current 261 DESCRIPTION 262 "The BFD Session Entry describes BFD session." 263 INDEX { bfdSessIndex } 264 ::= { bfdSessTable 1 } 266 BfdSessEntry ::= SEQUENCE { 267 bfdSessIndex BfdSessIndexTC, 268 bfdSessApplicationId Unsigned32, 269 bfdSessDiscriminator Unsigned32, 270 bfdSessRemoteDiscr Unsigned32, 271 bfdSessUdpPort InetPortNumber, 272 bfdSessState INTEGER, 273 bfdSessRemoteHeardFlag TruthValue, 274 bfdSessDiag Unsigned32, 275 bfdSessOperMode INTEGER, 276 bfdSessDemandModeDesiredFlag TruthValue, 277 bfdSessEchoFuncModeDesiredFlag TruthValue, 278 bfdSessControlPlanIndepFlag TruthValue, 279 bfdSessAddrType InetAddressType, 280 bfdSessAddr InetAddress, 281 bfdSessDesiredMinTxInterval BfdInterval, 282 bfdSessDesiredMinRxInterval BfdInterval, 283 bfdSessDesiredMinEchoRxInterval BfdInterval, 284 bfdSessDetectMult Unsigned32, 285 bfdSessStorType StorageType, 286 bfdSessRowStatus RowStatus, 287 bfdSessAuthPresFlag TruthValue, 288 bfdSessAuthenticationType INTEGER 289 } 291 bfdSessIndex OBJECT-TYPE 292 SYNTAX BfdSessIndexTC 293 MAX-ACCESS not-accessible 294 STATUS current 295 DESCRIPTION 296 "This object contains an index used to represent a 297 unique BFD session on this device." 298 ::= { bfdSessEntry 1 } 300 bfdSessApplicationId OBJECT-TYPE 301 SYNTAX Unsigned32 302 MAX-ACCESS read-only 303 STATUS current 304 DESCRIPTION 305 "This object contains an index used to indicate 306 a local application which owns or maintains this 307 BFD session. For instance, the MPLS VPN process may 308 maintain a subset of the total number of BFD 309 sessions. This application ID provides a convenient 310 way to segregate sessions by the applications which 311 maintain them." 312 ::= { bfdSessEntry 2 } 314 bfdSessDiscriminator OBJECT-TYPE 315 SYNTAX Unsigned32 (1..4294967295) 316 MAX-ACCESS read-only 317 STATUS current 318 DESCRIPTION 319 "This object specifies the local discriminator for this BFD 320 session, used to uniquely identify it." 321 ::= { bfdSessEntry 3 } 323 bfdSessRemoteDiscr OBJECT-TYPE 324 SYNTAX Unsigned32 (1..4294967295) 325 MAX-ACCESS read-only 326 STATUS current 327 DESCRIPTION 328 "This object specifies the session discriminator chosen 329 by the remote system for this BFD session." 330 ::= { bfdSessEntry 4 } 332 bfdSessUdpPort OBJECT-TYPE 333 SYNTAX InetPortNumber 334 MAX-ACCESS read-create 335 STATUS current 336 DESCRIPTION 337 "The UDP Port for BFD. The default value is the 338 well-known value for this port." 339 REFERENCE 340 "draft-katz-ward-bfd-02.txt and 341 draft-raggarwa-mpls-bfd-00.txt" 342 DEFVAL { 0 } 343 ::= { bfdSessEntry 5 } 345 bfdSessState OBJECT-TYPE 346 SYNTAX INTEGER { 347 adminDown(1), 348 down(2), 349 init(3), 350 up(4) 351 } 352 MAX-ACCESS read-only 353 STATUS current 354 DESCRIPTION 355 "The perceived state of the BFD session." 356 ::= { bfdSessEntry 6 } 358 bfdSessRemoteHeardFlag OBJECT-TYPE 359 SYNTAX TruthValue 360 MAX-ACCESS read-only 361 STATUS current 362 DESCRIPTION 363 "This object specifies status of BFD packet reception from 364 the remote system. Specifically, it is set to true(1) if 365 the local system is actively receiving BFD packets from the 366 remote system, and is set to false(0) if the local system 367 has not received BFD packets recently (within the detection 368 time) or if the local system is attempting to tear down 369 the BFD session." 370 ::= { bfdSessEntry 7 } 372 bfdSessDiag OBJECT-TYPE 373 SYNTAX Unsigned32 374 MAX-ACCESS accessible-for-notify 375 STATUS current 376 DESCRIPTION 377 "A diagnostic code specifying the local system's reason 378 for the last transition of the session from up(1) 379 to some other state." 380 ::= { bfdSessEntry 8 } 382 bfdSessOperMode OBJECT-TYPE 383 SYNTAX INTEGER { asyncModeWEchoFun(1), 384 asynchModeWOEchoFun(2), 385 demandModeWEchoFunction(3), 386 demandModeWOEchoFunction(4) 387 } 388 MAX-ACCESS read-only 389 STATUS current 390 DESCRIPTION 391 "This object specifies current operating mode that BFD 392 session is operating in. 394 A value of AsyncModeWEchoFun(1) ... 395 A value of AsynchModeWOEchoFun(2) ... 396 A value of DemandModeWEchoFunction(3) ... 397 A value of DemandModeWOEchoFunction(4) ... 398 " 399 ::= { bfdSessEntry 9 } 401 bfdSessDemandModeDesiredFlag OBJECT-TYPE 402 SYNTAX TruthValue 403 MAX-ACCESS read-create 404 STATUS current 405 DESCRIPTION 406 "This object indicates that the local system's 407 desire to use Demand mode. Specifically, it is set 408 to true(1) if the local system wishes to use 409 Demand mode or false(0) if not" 410 DEFVAL { false } 411 ::= { bfdSessEntry 10 } 413 bfdSessEchoFuncModeDesiredFlag OBJECT-TYPE 414 SYNTAX TruthValue 415 MAX-ACCESS read-create 416 STATUS current 417 DESCRIPTION 418 "This object indicates that the local system's 419 desire to use Echo mode. Specifically, it is set 420 to true(1) if the local system wishes to use 421 Echo mode or false(0) if not" 422 DEFVAL { false } 423 ::= { bfdSessEntry 11 } 425 bfdSessControlPlanIndepFlag OBJECT-TYPE 426 SYNTAX TruthValue 427 MAX-ACCESS read-create 428 STATUS current 429 DESCRIPTION 430 "This object indicates that the local system's 431 ability to continue to function through a disruption of 432 the control plane. Specifically, it is set 433 to true(1) if the local system BFD implementation is 434 independent of the control plane. Otherwise, the 435 value is set to false(0)" 436 DEFVAL { false } 437 ::= { bfdSessEntry 12 } 439 bfdSessAddrType OBJECT-TYPE 440 SYNTAX InetAddressType 441 MAX-ACCESS read-create 442 STATUS current 443 DESCRIPTION 444 "This object specifies IP address of the interface 445 associated with this BFD session. 447 Only values unknown(0), ipv4(1) or ipv6(2) 448 have to be supported. 450 A value of unknown(0) is allowed only when 451 the outgoing interface is of type point-to-point, or 452 when the BFD session is not associated with a specific 453 interface. 455 If any other unsupported values are attempted in a set 456 operation, the agent MUST return an inconsistentValue 457 error. 458 " 459 ::= { bfdSessEntry 13 } 461 bfdSessAddr OBJECT-TYPE 462 SYNTAX InetAddress 463 MAX-ACCESS read-create 464 STATUS current 465 DESCRIPTION 466 "This object specifies IP address of the interface 467 associated with this BFD session. 468 It can also be used to enabled BFD on a specific 469 interface. The value is set to zero when BFD session is not 470 associated with a specific interface. " 471 ::= { bfdSessEntry 14 } 473 bfdSessDesiredMinTxInterval OBJECT-TYPE 474 SYNTAX BfdInterval 475 MAX-ACCESS read-create 476 STATUS current 477 DESCRIPTION 478 "This object specifies the minimum interval, in 479 microseconds, that the local system would like to use when 480 transmitting BFD Control packets." 481 ::= { bfdSessEntry 15 } 483 bfdSessDesiredMinRxInterval OBJECT-TYPE 484 SYNTAX BfdInterval 485 MAX-ACCESS read-create 486 STATUS current 487 DESCRIPTION 488 "This object specifies the minimum interval, in 489 microseconds, between received BFD Control packets the 490 local system is capable of supporting." 491 ::= { bfdSessEntry 16 } 493 bfdSessDesiredMinEchoRxInterval OBJECT-TYPE 494 SYNTAX BfdInterval 495 MAX-ACCESS read-create 496 STATUS current 497 DESCRIPTION 498 "This object specifies the minimum interval, in 499 microseconds, between received BFD Echo packets that this 500 system is capable of supporting." 501 ::= { bfdSessEntry 17 } 503 bfdSessDetectMult OBJECT-TYPE 504 SYNTAX Unsigned32 505 MAX-ACCESS read-create 506 STATUS current 507 DESCRIPTION 508 "This object specifies the Detect time multiplier." 509 ::= { bfdSessEntry 18 } 511 bfdSessStorType OBJECT-TYPE 512 SYNTAX StorageType 513 MAX-ACCESS read-create 514 STATUS current 515 DESCRIPTION 516 "This variable indicates the storage type for this 517 object. Conceptual rows having the value 518 'permanent' need not allow write-access to any 519 columnar objects in the row." 520 ::= { bfdSessEntry 19 } 522 bfdSessRowStatus OBJECT-TYPE 523 SYNTAX RowStatus 524 MAX-ACCESS read-create 525 STATUS current 526 DESCRIPTION 527 "This variable is used to create, modify, and/or 528 delete a row in this table. When a row in this 529 table has a row in the active(1) state, no 530 objects in this row can be modified except the 531 bfdSessRowStatus and bfdSessStorageType." 532 ::= { bfdSessEntry 20 } 534 bfdSessAuthPresFlag OBJECT-TYPE 535 SYNTAX TruthValue 536 MAX-ACCESS read-create 537 STATUS current 538 DESCRIPTION 539 "This object indicates that the local system's 540 desire to use Authentication. Specifically, it is set 541 to true(1) if the local system wishes the session 542 to be authenticated or false(0) if not" 543 DEFVAL { false } 544 ::= { bfdSessEntry 21 } 546 bfdSessAuthenticationType OBJECT-TYPE 547 SYNTAX INTEGER { simplePassword(1), 548 keyedMD5(2), 549 meticulousKeyedMD5(3), 550 keyedSHA1(4), 551 meticulousKeyedSHA1(5) 552 } 553 MAX-ACCESS read-create 554 STATUS current 555 DESCRIPTION 556 "The Authentication Type used for this BFD session. This 557 field is valid only when the Authentication Present bit is set" 558 ::= { bfdSessEntry 22 } 560 -- BFD Session Performance Table 562 bfdSessPerfTable OBJECT-TYPE 563 SYNTAX SEQUENCE OF BfdSessPerfEntry 564 MAX-ACCESS not-accessible 565 STATUS current 566 DESCRIPTION 567 "This table specifies BFD Session performance counters." 568 ::= { bfdObjects 3 } 570 bfdSessPerfEntry OBJECT-TYPE 571 SYNTAX BfdSessPerfEntry 572 MAX-ACCESS not-accessible 573 STATUS current 574 DESCRIPTION 575 "An entry in this table is created by a BFD-enabled node for 576 every BFD Session. bfdCounterDiscontinuityTime is used to 577 indicate potential discontinuity for all counter objects 578 in this table." 579 AUGMENTS { bfdSessEntry } 580 ::= { bfdSessPerfTable 1 } 582 BfdSessPerfEntry ::= SEQUENCE { 583 bfdSessPerfPktIn Counter32, 584 bfdSessPerfPktOut Counter32, 585 bfdSessUpTime TimeStamp, 586 bfdSessPerfLastSessDownTime TimeStamp, 587 bfdSessPerfLastCommLostDiag BfdDiag, 588 bfdSessPerfSessUpCount Counter32, 589 bfdSessPerfDiscTime TimeStamp, 591 -- High Capacity Counters 592 bfdSessPerfPktInHC Counter64, 593 bfdSessPerfPktOutHC Counter64 594 } 596 -- Ed Note: should we add per-diag code counts here, 598 bfdSessPerfPktIn OBJECT-TYPE 599 SYNTAX Counter32 600 MAX-ACCESS read-only 601 STATUS current 602 DESCRIPTION 603 "The total number of BFD messages received for this BFD 604 session." 605 ::= { bfdSessPerfEntry 1 } 607 bfdSessPerfPktOut OBJECT-TYPE 608 SYNTAX Counter32 609 MAX-ACCESS read-only 610 STATUS current 611 DESCRIPTION 612 "The total number of BFD messages sent for this BFD session." 613 ::= { bfdSessPerfEntry 2 } 615 bfdSessUpTime OBJECT-TYPE 616 SYNTAX TimeStamp 617 MAX-ACCESS read-only 618 STATUS current 619 DESCRIPTION 620 "The value of sysUpTime on the most recent occasion at which 621 the session came up. If no such up event exists this object 622 contains a zero value." 623 ::= { bfdSessPerfEntry 3 } 625 bfdSessPerfLastSessDownTime OBJECT-TYPE 626 SYNTAX TimeStamp 627 MAX-ACCESS read-only 628 STATUS current 629 DESCRIPTION 630 "The value of sysUpTime on the most recent occasion at which 631 the last time communication was lost with the neighbor. If 632 no such down event exist this object contains a zero value." 633 ::= { bfdSessPerfEntry 4 } 635 bfdSessPerfLastCommLostDiag OBJECT-TYPE 636 SYNTAX BfdDiag 637 MAX-ACCESS read-only 638 STATUS current 639 DESCRIPTION 640 "The BFD diag code for the last time communication was lost 641 with the neighbor. If no such down event exists this object 642 contains a zero value." 643 ::= { bfdSessPerfEntry 5 } 645 bfdSessPerfSessUpCount OBJECT-TYPE 646 SYNTAX Counter32 647 MAX-ACCESS read-only 648 STATUS current 649 DESCRIPTION 650 "The number of times this session has gone into the Up 651 state since the router last rebooted." 652 ::= { bfdSessPerfEntry 6 } 654 bfdSessPerfDiscTime OBJECT-TYPE 655 SYNTAX TimeStamp 656 MAX-ACCESS read-only 657 STATUS current 658 DESCRIPTION 659 "The value of sysUpTime on the most recent occasion at 660 which any one or more of the session counters suffered 661 a discontinuity. 663 The relevant counters are the specific instances associated 664 with this BFD session of any Counter32 object contained in 665 the BfdSessPerfTable. If no such discontinuities have occurred 666 since the last re-initialization of the local management 667 subsystem, then this object contains a zero value." 668 ::= { bfdSessPerfEntry 7 } 670 bfdSessPerfPktInHC OBJECT-TYPE 671 SYNTAX Counter64 672 MAX-ACCESS read-only 673 STATUS current 674 DESCRIPTION 675 "This value represents the total number of BFD messages 676 received for this BFD session. It MUST be equal to the 677 least significant 32 bits of bfdSessPerfPktIn 678 if bfdSessPerfPktInHC is supported according to 679 the rules spelled out in RFC2863." 680 ::= { bfdSessPerfEntry 8 } 682 bfdSessPerfPktOutHC OBJECT-TYPE 683 SYNTAX Counter64 684 MAX-ACCESS read-only 685 STATUS current 686 DESCRIPTION 687 "This value represents the total number of 688 total number of BFD messages transmitted for this 689 BFD session. It MUST be equal to the 690 least significant 32 bits of bfdSessPerfPktIn 691 if bfdSessPerfPktOutHC is supported according to 692 the rules spelled out in RFC2863." 693 ::= { bfdSessPerfEntry 9 } 695 -- BFD Session Mapping Table 697 bfdSessMapTable OBJECT-TYPE 698 SYNTAX SEQUENCE OF BfdSessMapEntry 699 MAX-ACCESS not-accessible 700 STATUS current 701 DESCRIPTION 702 "The BFD Session Mapping Table maps the complex 703 indexing of the BFD sessions to the flat 704 BFDIndex used in the BfdSessionTable. 706 Implementors need to be aware that if the value of 707 the bfdSessAddr (an OID) has more 708 that 111 sub-identifiers, then OIDs of column 709 instances in this table will have more than 128 710 sub-identifiers and cannot be accessed using SNMPv1, 711 SNMPv2c, or SNMPv3. 712 " 713 REFERENCE 714 "BFD Version 0 (draft-katz-ward-bfd-02.txt)" 715 ::= { bfdObjects 4 } 717 bfdSessMapEntry OBJECT-TYPE 718 SYNTAX BfdSessMapEntry 719 MAX-ACCESS not-accessible 720 STATUS current 721 DESCRIPTION 722 "The BFD Session Entry describes BFD session 723 that is mapped to this index. 725 Implementors need to be aware that if the value of 726 the mplsInSegmentMapLabelPtrIndex (an OID) has more 727 that 111 sub-identifiers, then OIDs of column 728 instances in this table will have more than 128 729 sub-identifiers and cannot be accessed using SNMPv1, 730 SNMPv2c, or SNMPv3." 731 INDEX { bfdSessApplicationId, 732 bfdSessDiscriminator, 733 bfdSessAddrType, 734 bfdSessAddr 735 } 736 ::= { bfdSessMapTable 1 } 738 BfdSessMapEntry ::= SEQUENCE { 739 bfdSessMapBfdIndex BfdSessIndexTC 740 } 742 bfdSessMapBfdIndex OBJECT-TYPE 743 SYNTAX BfdSessIndexTC 744 MAX-ACCESS read-only 745 STATUS current 746 DESCRIPTION 747 "This object specifies the BfdIndex referred to by 748 the indexes of this row. In essence, a mapping is 749 provided between these indexes and the BfdSessTable." 750 ::= { bfdSessMapEntry 1 } 752 -- Notification Configuration 754 bfdSessNotificationsEnable OBJECT-TYPE 755 SYNTAX TruthValue 756 MAX-ACCESS read-write 757 STATUS current 758 DESCRIPTION 759 "If this object is set to true(1), then it enables 760 the emission of bfdSessUp and bfdSessDown 761 notifications; otherwise these notifications are not 762 emitted." 763 REFERENCE 764 "See also RFC3413 for explanation that 765 notifications are under the ultimate control of the 766 MIB modules in this document." 767 DEFVAL { false } 768 ::= { bfdScalarObjects 4 } 770 bfdSessUp NOTIFICATION-TYPE 771 OBJECTS { bfdSessDiag, -- low range value 772 bfdSessDiag -- high range value 773 } 774 STATUS current 775 DESCRIPTION 776 "This notification is generated when the 777 bfdSessState object for one or more contiguous 778 entries in bfdSessTable are about to enter the up(2) 779 state from some other state. The included values of 780 bfdSessDiag MUST both be set equal to this 781 new state (i.e: up(1)). The two instances of 782 bfdSessDiag in this notification indicate the range 783 of indexes that are affected. Note that all the indexes 784 of the two ends of the range can be derived from the 785 instance identifiers of these two objects. For the 786 cases where a contiguous range of sessions 787 have transitioned into the up(1) state at roughly 788 the same time, the device SHOULD issue a single 789 notification for each range of contiguous indexes in 790 an effort to minimize the emission of a large number 791 of notifications. If a notification has to be 792 issued for just a single bfdSessEntry, then 793 the instance identifier (and values) of the two 794 bfdSessDiag objects MUST be the identical." 795 ::= { bfdNotifications 1 } 797 bfdSessDown NOTIFICATION-TYPE 798 OBJECTS { bfdSessDiag, -- low range value 799 bfdSessDiag -- high range value 800 } 801 STATUS current 802 DESCRIPTION 803 "This notification is generated when the 804 bfdSessState object for one or more contiguous 805 entries in bfdSessTable are about to enter the down(4) 806 or adminDown(5) states from some other state. The included 807 values of bfdSessDiag MUST both be set equal to this 808 new state (i.e: down(4) or adminDown(5)). The two instances 809 of bfdSessDiag in this notification indicate the range 810 of indexes that are affected. Note that all the indexes 811 of the two ends of the range can be derived from the 812 instance identifiers of these two objects. For 813 cases where a contiguous range of sessions 814 have transitioned into the down(4) or adminDown(5) states 815 at roughly the same time, the device SHOULD issue a single 816 notification for each range of contiguous indexes in 817 an effort to minimize the emission of a large number 818 of notifications. If a notification has to be 819 issued for just a single bfdSessEntry, then 820 the instance identifier (and values) of the two 821 bfdSessDiag objects MUST be the identical." 822 ::= { bfdNotifications 2 } 824 -- Ed Note: We need to add notification for changes 825 -- when the two ends automatically negotiate to a new detection time 826 -- value or when detection multiplier changes. 827 -- Similarly, changes in the operating mode (bfdSessOperMode) 828 -- also need to be notified. 830 -- Module compliance. 832 bfdGroups 833 OBJECT IDENTIFIER ::= { bfdConformance 1 } 835 bfdCompliances 836 OBJECT IDENTIFIER ::= { bfdConformance 2 } 838 -- Compliance requirement for fully compliant implementations. 840 bfdModuleFullCompliance MODULE-COMPLIANCE 841 STATUS current 842 DESCRIPTION "Compliance statement for agents that provide full 843 support for BFD-MIB. Such devices can 844 then be monitored and also be configured using 845 this MIB module." 847 MODULE -- This module. 848 MANDATORY-GROUPS { 849 bfdSessionGroup, 850 bfdSessionPerfGroup, 851 bfdSessionPerfHCGroup, 852 bfdNotificationGroup 853 } 855 GROUP bfdSessionPerfHCGroup 856 DESCRIPTION "This group is mandatory for those bfdPerfTable 857 entries for which any of the objects 858 bfdSessPerfPktInHC or bfdSessPerfPktOutHC 859 wraps around too quickly 860 based on the criteria specified in RFC 2863 for 861 high-capacity counters." 863 GROUP bfdNotificationGroup 864 DESCRIPTION "This group is only mandatory for those 865 implementations which can efficiently implement 866 the notifications contained in this group." 868 OBJECT bfdSessAddrType 869 SYNTAX InetAddressType { unknown(0), ipv4(1), ipv6(2) } 870 DESCRIPTION "Only unknown(0), ipv4(1) and ipv6(2) support 871 is required." 873 OBJECT bfdSessAddr 874 SYNTAX InetAddress (SIZE(0|4|16)) 875 DESCRIPTION "An implementation is only required to support 876 unknown(0), ipv4(1) and ipv6(2) sizes." 878 ::= { bfdCompliances 1 } 880 -- Read-Only Conformance TBD... 882 -- Units of conformance. 884 bfdSessionGroup OBJECT-GROUP 885 OBJECTS { 886 bfdSessNotificationsEnable, 887 bfdAdminStatus, 888 bfdVersionNumber, 889 bfdSessApplicationId, 890 bfdSessDiscriminator, 891 bfdSessAddrType, 892 bfdSessAddr, 893 bfdSessRemoteDiscr, 894 bfdSessUdpPort, 895 bfdSessState, 896 bfdSessRemoteHeardFlag, 897 bfdSessDiag, 898 bfdSessOperMode, 899 bfdSessDemandModeDesiredFlag, 900 bfdSessEchoFuncModeDesiredFlag, 901 bfdSessControlPlanIndepFlag, 902 bfdSessDesiredMinTxInterval, 903 bfdSessDesiredMinRxInterval, 904 bfdSessDesiredMinEchoRxInterval, 905 bfdSessDetectMult, 906 bfdSessStorType, 907 bfdSessRowStatus, 908 bfdSessMapBfdIndex, 909 bfdSessAuthPresFlag, 910 bfdSessAuthenticationType 911 } 912 STATUS current 913 DESCRIPTION 914 "Collection of objects needed for BFD sessions." 915 ::= { bfdGroups 1 } 917 bfdSessionPerfGroup OBJECT-GROUP 918 OBJECTS { 919 bfdSessPerfPktIn, 920 bfdSessPerfPktOut, 921 bfdSessUpTime, 922 bfdSessPerfLastSessDownTime, 923 bfdSessPerfLastCommLostDiag, 924 bfdSessPerfSessUpCount, 925 bfdSessPerfDiscTime 926 } 927 STATUS current 928 DESCRIPTION 929 "Collection of objects needed to monitor the 930 performance of BFD sessions." 931 ::= { bfdGroups 2 } 933 bfdSessionPerfHCGroup OBJECT-GROUP 934 OBJECTS { 935 bfdSessPerfPktInHC, 936 bfdSessPerfPktOutHC 937 } 938 STATUS current 939 DESCRIPTION 940 "Collection of objects needed to monitor the 941 performance of BFD sessions for which the 942 values of bfdSessPerfPktIn, bfdSessPerfPktOut 943 wrap around too quickly." 944 ::= { bfdGroups 3 } 946 bfdNotificationGroup NOTIFICATION-GROUP 947 NOTIFICATIONS { 948 bfdSessUp, 949 bfdSessDown 950 } 951 STATUS current 952 DESCRIPTION 953 "Set of notifications implemented in this 954 module." 956 ::= { bfdGroups 4 } 958 END 960 6. Security Considerations 962 There are a number of management objects defined in this MIB 963 module with a MAX-ACCESS clause of read-write and/or read-create. 964 Such objects may be considered sensitive or vulnerable in some 965 network environments. It is thus important to control even GET and/or 966 NOTIFY access to these objects and possibly to even encrypt the 967 values of these objects when sending them over the network via SNMP. 969 o The bfdSessTable may be used to directly configure BFD 970 sessions. The bfdSessMapTable can be used indirectly 971 in the same way. Unauthorized access to objects in 972 this table could result in disruption of traffic on 973 the network. This is especially true if an unauthorized 974 user configures enough tables to invoke a denial of 975 service attack on the device where they are configured, 976 or on a remote device where the sessions terminate. 978 Some of the readable objects in this MIB module (i.e., objects 979 with a MAX-ACCESS other than not-accessible) may be considered 980 sensitive or vulnerable in some network environments. It is thus 981 important to control even GET and/or NOTIFY access to these objects 982 and possibly to even encrypt the values of these objects when sending 983 them over the network via SNMP. These are the tables and objects and 984 their sensitivity/vulnerability: 986 o The bfdSessPerfTable both allows access to the performance 987 characteristics of BFD sessions. Network administrators not 988 wishing to show this information should consider this 989 table sensative. 991 SNMP versions prior to SNMPv3 did not include adequate security. 992 Even if the network itself is secure "for example by using IPSec", 993 even then, there is no control as to who on the secure network is 994 allowed to access and GET/SET "read/change/create/delete" the objects 995 in these MIB modules. 997 It is RECOMMENDED that implementers consider the security features 998 as provided by the SNMPv3 framework "see [RFC3410], section 8", 999 including full support for the SNMPv3 cryptographic mechanisms "for 1000 authentication and privacy". 1002 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1003 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1004 enable cryptographic security. It is then a customer/operator 1005 responsibility to ensure that the SNMP entity giving access to an 1006 instance of this MIB module, is properly configured to give access to 1007 the objects only to those principals "users" that have legitimate 1008 rights to indeed GET or SET "change/create/delete" them. 1010 7. Acknowledgements 1012 We would like to thank David Ward for his comments and suggestions. 1014 8. References 1016 8.1 Normative References 1018 [BFD] Katz, D., and Ward, D., "Bidirectional Forwarding 1019 Detection", draft-ietf-bfd-base-02.txt. 1021 [BFD-MH] Katz, D., and Ward, D., "BFD for Multihop Paths", 1022 draft-ietf-bfd-multihop-03.txt. 1024 [BFD-LSP] Aggarwal, R., Kompella, K., T. D. Nadeau, and G. Swallow 1025 BFD For MPLS LSPs, draft-ietf-bfd-mpls-02.txt. 1027 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1028 Rose, M. and S. Waldbusser, "Structure of Management 1029 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1030 1999. 1032 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1033 Rose, M. and S. Waldbusser, "Textual Conventions for 1034 SMIv2", STD 58, RFC 2579, April 1999. 1036 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1037 Rose, M. and S. Waldbusser, "Conformance Statements for 1038 SMIv2", STD 58, RFC 2580, April 1999. 1040 [RFC3291] Daniele, M., Haberman, B., Routhier, S., and J. 1041 Schoenwaelder, "Textual Conventions for Internet 1042 Network Addresses", RFC 3291, May 2002. 1044 8.2 Informative References 1046 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate 1047 Requirement Levels", RFC 2119, BCP 14, March 1997. 1049 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1050 "Introduction and Applicability Statements for 1051 Internet-Standard Management Framework", RFC 3410, 1052 December 2002. 1054 [RFC3413] Levi, D., Meyer, P., Stewart, B., 1055 "SNMP Applications", RFC 3413, December 2002. 1057 [RFC2434] Narten, T. and H. Alvestrand., "Guidelines for Writing 1058 an IANA Considerations Section in RFCs", BCP 26, RFC 1059 2434, October 1998. 1061 9. Authors' Addresses 1063 Thomas D. Nadeau 1064 Cisco Systems, Inc. 1065 300 Beaver Brook Road 1066 Boxboro, MA 01719 1067 Phone: +1-978-936-1470 1069 Email: tnadeau@cisco.com 1071 Zafar Ali 1072 Cisco Systems Inc. 1073 100 South Main St. #200 1074 Ann Arbor, MI 48104, USA. 1075 Phone: +1-734-276-2459 1076 Email: zali@cisco.com 1078 10. Full Copyright Statement 1080 Copyright (C) The Internet Society (2005). This document is subject 1081 to the rights, licenses and restrictions contained in BCP 78, and 1082 except as set forth therein, the authors retain all their rights. 1084 This document and the information contained herein are provided on an 1085 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 1086 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 1087 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 1088 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 1089 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1090 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1092 11. IANA Considerations 1094 There is one MIB module contained in this document. The following 1095 "IANA Considerations" subsection requests IANA for a new 1096 assignment under the mib-2 subtree. New assignments can only 1097 be made via a Standards Action as specified in [RFC2434]. 1099 11.1. IANA Considerations for BFD-STD-MIB 1100 The IANA is requested to assign { mib-2 XXX } to the 1101 MPLS-L3VPN-STD-MIB module specified in this document. 1103 12. Intellectual Property Statement 1105 The IETF takes no position regarding the validity or scope of any 1106 Intellectual Property Rights or other rights that might be claimed to 1107 pertain to the implementation or use of the technology described in 1108 this document or the extent to which any license under such rights 1109 might or might not be available; nor does it represent that it has 1110 made any independent effort to identify any such rights. Information 1111 on the procedures with respect to rights in RFC documents can be 1112 found in BCP 78 and BCP 79. 1114 Copies of IPR disclosures made to the IETF Secretariat and any 1115 assurances of licenses to be made available, or the result of an 1116 attempt made to obtain a general license or permission for the use of 1117 such proprietary rights by implementers or users of this 1118 specification can be obtained from the IETF on-line IPR repository at 1119 http://www.ietf.org/ipr. 1121 The IETF invites any interested party to bring to its attention any 1122 copyrights, patents or patent applications, or other proprietary 1123 rights that may cover technology that may be required to implement 1124 this standard. Please address the information to the IETF at ietf- 1125 ipr@ietf.org.