idnits 2.17.1 draft-ietf-bfd-tc-mib-08.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (May 14, 2014) is 3607 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) -- Obsolete informational reference (is this intentional?): RFC 5226 (Obsoleted by RFC 8126) Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group T. Nadeau 3 Internet-Draft Brocade 4 Intended status: Standards Track Z. Ali 5 Expires: November 15, 2014 N. Akiya 6 Cisco Systems 7 May 14, 2014 9 Definitions of Textual Conventions (TCs) for 10 Bidirectional Forwarding Detection (BFD) Management 11 draft-ietf-bfd-tc-mib-08 13 Abstract 15 This draft defines two Management Information Base (MIB) modules that 16 contain Textual Conventions to represent commonly used Bidirectional 17 Forwarding Detection (BFD) management information. The intent is 18 that these TEXTUAL CONVENTIONS (TCs) will be imported and used in BFD 19 related MIB modules that would otherwise define their own 20 representations. 22 Requirements Language 24 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 25 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 26 document are to be interpreted as described in BCP 14, RFC 2119 27 [RFC2119]. 29 Status of This Memo 31 This Internet-Draft is submitted in full conformance with the 32 provisions of BCP 78 and BCP 79. 34 Internet-Drafts are working documents of the Internet Engineering 35 Task Force (IETF). Note that other groups may also distribute 36 working documents as Internet-Drafts. The list of current Internet- 37 Drafts is at http://datatracker.ietf.org/drafts/current/. 39 Internet-Drafts are draft documents valid for a maximum of six months 40 and may be updated, replaced, or obsoleted by other documents at any 41 time. It is inappropriate to use Internet-Drafts as reference 42 material or to cite them other than as "work in progress." 44 This Internet-Draft will expire on November 15, 2014. 46 Copyright Notice 48 Copyright (c) 2014 IETF Trust and the persons identified as the 49 document authors. All rights reserved. 51 This document is subject to BCP 78 and the IETF Trust's Legal 52 Provisions Relating to IETF Documents 53 (http://trustee.ietf.org/license-info) in effect on the date of 54 publication of this document. Please review these documents 55 carefully, as they describe your rights and restrictions with respect 56 to this document. Code Components extracted from this document must 57 include Simplified BSD License text as described in Section 4.e of 58 the Trust Legal Provisions and are provided without warranty as 59 described in the Simplified BSD License. 61 Table of Contents 63 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 64 2. The Internet-Standard Management Framework . . . . . . . . . 2 65 3. BFD Textual Conventions MIB Definitions . . . . . . . . . . . 3 66 4. Security Considerations . . . . . . . . . . . . . . . . . . . 9 67 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10 68 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 10 69 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 70 7.1. Normative References . . . . . . . . . . . . . . . . . . 10 71 7.2. Informative References . . . . . . . . . . . . . . . . . 11 73 1. Introduction 75 This document defines two MIB modules that contain Textual 76 Conventions for Bidirectional Forwarding Detection (BFD) protocols. 77 These Textual Conventions should be imported by MIB modules which 78 manage BFD protocols. 80 Note that names of Textual Conventions defined in this document are 81 prefixed with either "Bfd" or "IANA" to make it obvious to readers 82 that some are specific to BFD modules, while others are IANA 83 maintained. 85 For an introduction to the concepts of BFD, see [RFC5880], [RFC5881], 86 [RFC5883], [RFC6428] and [RFC7130]. 88 2. The Internet-Standard Management Framework 90 For a detailed overview of the documents that describe the current 91 Internet-Standard Management Framework, please refer to section 7 of 92 RFC 3410 [RFC3410]. 94 Managed objects are accessed via a virtual information store, termed 95 the Management Information Base or MIB. MIB objects are generally 96 accessed through the Simple Network Management Protocol (SNMP). 97 Objects in the MIB are defined using the mechanisms defined in the 98 Structure of Management Information (SMI). This memo specifies a MIB 99 module that is compliant to the SMIv2, which is described in STD 58, 100 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 101 [RFC2580]. 103 3. BFD Textual Conventions MIB Definitions 105 This MIB module makes references to the following documents: 106 [RFC2578], [RFC2579], [RFC5880], [RFC5881], [RFC5883], [RFC6428] and 107 [RFC7130]. 109 BFD-TC-STD-MIB DEFINITIONS ::= BEGIN 111 IMPORTS 112 MODULE-IDENTITY, mib-2, Unsigned32 113 FROM SNMPv2-SMI -- [RFC2578] 115 TEXTUAL-CONVENTION 116 FROM SNMPv2-TC; -- [RFC2579] 118 bfdTCStdMib MODULE-IDENTITY 119 LAST-UPDATED 120 "201404131200Z" -- 13 April 2014 12:00:00 EST 122 ORGANIZATION "IETF Bidirectional Forwarding Detection 123 Working Group" 124 CONTACT-INFO 125 "Thomas D. Nadeau 126 Brocade 127 Email: tnadeau@lucidvision.com 129 Zafar Ali 130 Cisco Systems, Inc. 131 Email: zali@cisco.com 133 Nobo Akiya 134 Cisco Systems, Inc. 135 Email: nobo@cisco.com 137 Comments about this document should be emailed directly 138 to the BFD working group mailing list at 139 rtg-bfd@ietf.org" 141 DESCRIPTION 142 "Copyright (C) The IETF Trust (2014). The initial version 143 of this MIB module was published in RFC xxxx. For full legal 144 notices see the RFC itself. Supplementary information 145 may be available on: 146 http://www.ietf.org/copyrights/ianamib.html" 148 -- RFC Ed.: RFC-editor pls fill in xxxx 150 REVISION "201404131200Z" -- 13 April 2014 12:00:00 EST 151 DESCRIPTION 152 "Initial version. Published as RFC xxxx." 154 -- RFC Ed.: RFC-editor pls fill in xxxx 156 ::= { mib-2 XXX } 158 -- RFC Ed.: RFC-editor pls fill in XXX, see section 5 for details 160 BfdSessIndexTC ::= TEXTUAL-CONVENTION 161 DISPLAY-HINT "d" 162 STATUS current 163 DESCRIPTION 164 "An index used to uniquely identify BFD sessions." 165 SYNTAX Unsigned32 (1..4294967295) 167 BfdIntervalTC ::= TEXTUAL-CONVENTION 168 DISPLAY-HINT "d" 169 STATUS current 170 DESCRIPTION 171 "The BFD interval in microseconds." 172 SYNTAX Unsigned32 (0..4294967295) 174 BfdMultiplierTC ::= TEXTUAL-CONVENTION 175 DISPLAY-HINT "d" 176 STATUS current 177 DESCRIPTION 178 "The BFD failure detection multiplier." 179 SYNTAX Unsigned32 (1..255) 181 BfdCtrlDestPortNumberTC ::= TEXTUAL-CONVENTION 182 DISPLAY-HINT "d" 183 STATUS current 184 DESCRIPTION 185 "UDP destination port number of BFD control packets. 186 3784 represents single hop BFD session. 187 4784 represents multi hop BFD session. 188 6784 represents BFD on LAG session. 190 However, syntax is left open to wider range of values 191 purposely for two reasons: 192 1. Implementation uses non-compliant port number for 193 valid proprietary reason. 194 2. Potential future extension drafts. 196 The value of 0 is a special, reserved value used 197 to indicate special conditions and should not be considered 198 a valid port number." 199 REFERENCE 200 "Use of port 3784 from Katz, D. and D. Ward, 201 Bidirectional Forwarding Detection (BFD) for 202 IPv4 and IPv6 (Single Hop), RFC 5881, June 2010. 204 Use of port 4784 from Katz, D. and D. Ward, 205 Bidirectional Forwarding Detection (BFD) for 206 Multihop Paths, RFC 5883, June 2010. 208 Use of port 6784 from Bhatia, M., Chen, M., Boutros, S., 209 Binderberger, M., and J. Haas, Bidirectional Forwarding 210 Detection (BFD) on Link Aggregation Group (LAG) 211 Interfaces, RFC 7130, February 2014." 212 SYNTAX Unsigned32 (0..65535) 214 BfdCtrlSourcePortNumberTC ::= TEXTUAL-CONVENTION 215 DISPLAY-HINT "d" 216 STATUS current 217 DESCRIPTION 218 "UDP source port number of BFD control packets. 219 However, syntax is left open to wider range of values 220 purposely for two reasons: 221 1. Implementation uses non-compliant port number for 222 valid proprietary reason. 223 2. Potential future extension drafts. 225 The value of 0 is a special, reserved value used 226 to indicate special conditions and should not be considered 227 a valid port number." 228 REFERENCE 229 "Port 49152..65535 from RFC5881" 231 SYNTAX Unsigned32 (0..65535) 233 END 235 IANA-BFD-TC-STD-MIB DEFINITIONS ::= BEGIN 236 IMPORTS 237 MODULE-IDENTITY, mib-2 238 FROM SNMPv2-SMI -- [RFC2578] 240 TEXTUAL-CONVENTION 241 FROM SNMPv2-TC; -- [RFC2579] 243 ianaBfdTCStdMib MODULE-IDENTITY 244 LAST-UPDATED 245 "201404131200Z" -- 13 April 2014 12:00:00 EST 246 ORGANIZATION 247 "IANA" 248 CONTACT-INFO 249 "Internet Assigned Numbers Authority 250 Postal: 4676 Admiralty Way, Suite 330 251 Marina del Rey, CA 90292 252 Tel: +1 310 823 9358 253 E-Mail: iana@iana.org" 255 DESCRIPTION 256 "Copyright (C) The IETF Trust (2014). The initial version 257 of this MIB module was published in RFC xxxx. For full legal 258 notices see the RFC itself. Supplementary information 259 may be available on: 260 http://www.ietf.org/copyrights/ianamib.html" 262 -- RFC Ed.: RFC-editor pls fill in xxxx 264 REVISION 265 "201404131200Z" -- 13 April 2014 12:00:00 EST 266 DESCRIPTION 267 "Initial version. Published as RFC xxxx." 269 -- RFC Ed.: RFC-editor pls fill in xxxx 271 ::= { mib-2 YYY } 273 -- RFC Ed.: RFC-editor pls fill in YYY, see section 5 for details 275 IANAbfdDiagTC ::= TEXTUAL-CONVENTION 276 STATUS current 277 DESCRIPTION 278 "A common BFD diagnostic code." 279 REFERENCE 280 "Katz, D. and D. Ward, Bidirectional Forwarding 281 Detection (BFD), RFC 5880, June 2010. 283 Allan, D., Swallow, G., and Drake, J., Proactive Connectivity 284 Verification, Continuity Check, and Remote Defect 285 Indication for the MPLS Transport Profile, RFC 6428, 286 November 2011." 287 SYNTAX INTEGER { 288 noDiagnostic(0), 289 controlDetectionTimeExpired(1), 290 echoFunctionFailed(2), 291 neighborSignaledSessionDown(3), 292 forwardingPlaneReset(4), 293 pathDown(5), 294 concatenatedPathDown(6), 295 administrativelyDown(7), 296 reverseConcatenatedPathDown(8), 297 misConnectivityDefect(9) 298 } 300 IANAbfdSessTypeTC ::= TEXTUAL-CONVENTION 301 STATUS current 302 DESCRIPTION 303 "BFD session type" 304 REFERENCE 305 "Katz, D. and D. Ward, Bidirectional Forwarding 306 Detection (BFD), RFC 5880, June 2010. 308 Katz, D. and D. Ward, Bidirectional Forwarding 309 Detection (BFD) for IPv4 and IPv6 (Single Hop), 310 RFC 5881, June 2010. 312 Katz, D. and D. Ward, Bidirectional Forwarding 313 Detection (BFD) for Multihop Paths, RFC 5883, 314 June 2010." 315 SYNTAX INTEGER { 316 singleHop(1), 317 multiHopTotallyArbitraryPaths(2), 318 multiHopOutOfBandSignaling(3), 319 multiHopUnidirectionalLinks(4) 320 } 322 IANAbfdSessOperModeTC ::= TEXTUAL-CONVENTION 323 STATUS current 324 DESCRIPTION 325 "BFD session operating mode" 326 REFERENCE 327 "Katz, D. and D. Ward, Bidirectional Forwarding 328 Detection (BFD), RFC 5880, June 2010." 329 SYNTAX INTEGER { 330 asyncModeWEchoFunction(1), 331 asynchModeWOEchoFunction(2), 332 demandModeWEchoFunction(3), 333 demandModeWOEchoFunction(4) 334 } 336 IANAbfdSessStateTC ::= TEXTUAL-CONVENTION 337 STATUS current 338 DESCRIPTION 339 "BFD session state. State failing(5) is only applicable if 340 corresponding session is running in BFD version 0." 341 REFERENCE 342 "RFC 5880 - Bidirectional Forwarding Detection (BFD), Katz, 343 D., Ward, D., June 2010." 344 SYNTAX INTEGER { 345 adminDown(1), 346 down(2), 347 init(3), 348 up(4), 349 failing(5) 350 } 352 IANAbfdSessAuthenticationTypeTC ::= TEXTUAL-CONVENTION 353 STATUS current 354 DESCRIPTION 355 "BFD authentication type" 356 REFERENCE 357 "Sections 4.2 - 4.4 from Katz, D. and D. Ward, 358 Bidirectional Forwarding Detection (BFD), 359 RFC 5880, June 2010." 360 SYNTAX INTEGER { 361 noAuthentication(-1), 362 reserved(0), 363 simplePassword(1), 364 keyedMD5(2), 365 meticulousKeyedMD5(3), 366 keyedSHA1(4), 367 meticulousKeyedSHA1(5) 368 } 370 IANAbfdSessAuthenticationKeyTC ::= TEXTUAL-CONVENTION 371 DISPLAY-HINT "1x " 372 STATUS current 373 DESCRIPTION 374 "BFD authentication key type. 376 An IANAbfdSessAuthenticationKeyTC is always interpreted 377 within the context of an IANAbfdSessAuthenticationTypeTC 378 value. Every usage of the IANAbfdSessAuthenticationTypeTC 379 textual convention is required to specify the 380 IANAbfdSessAuthenticationKeyTC object that provides the 381 context. It is suggested that the 382 IANAbfdSessAuthenticationKeyTC object be logically registered 383 before the object(s) that use the 384 IANAbfdSessAuthenticationKeyTC textual convention, if they 385 appear in the same logical row. 387 The value of a IANAbfdSessAuthenticationKeyTC must 388 always be consistent with the value of the associated 389 IANAbfdSessAuthenticationTypeTC object. Attempts to set a 390 IANAbfdSessAuthenticationKeyTC object to a value inconsistent 391 with the associated IANAbfdSessAuthenticationTypeTC must fail 392 with an inconsistentValue error. 394 The following size constraints for a 395 IANAbfdSessAuthenticationKeyTC object are defined for the 396 associated IANAbfdSessAuthenticationTypeTC values show below: 398 noAuthentication(-1): SIZE(0) 399 reserved(0): SIZE(0) 400 simplePassword(1): SIZE(1..16) 401 keyedMD5(2): SIZE(16) 402 meticulousKeyedMD5(3): SIZE(16) 403 keyedSHA1(4): SIZE(20) 404 meticulousKeyedSHA1(5): SIZE(20) 406 When this textual convention is used as the syntax of an 407 index object, there may be issues with the limit of 128 408 sub-identifiers specified in SMIv2, STD 58. In this case, 409 the object definition MUST include a 'SIZE' clause to limit 410 the number of potential instance sub-identifiers; otherwise 411 the applicable constraints MUST be stated in the appropriate 412 conceptual row DESCRIPTION clauses, or in the surrounding 413 documentation if there is no single DESCRIPTION clause that 414 is appropriate." 415 REFERENCE 416 "RFC5880, Sections 4.2 - 4.4" 417 SYNTAX OCTET STRING(SIZE(0..252)) 419 END 421 4. Security Considerations 423 This module does not define any management objects. Instead, it 424 defines a set of textual conventions which may be used by other BFD 425 MIB modules to define management objects. 427 Meaningful security considerations can only be written in the MIB 428 modules that define management objects. Therefore, this document 429 does not introduce any additional security considerations. 431 5. IANA Considerations 433 This document provides the base definition of the IANA-BFD-TC-STD-MIB 434 module. This MIB module is under the direct control of IANA. See 435 Section 3 for the initial contents. Please see the most updated 436 version of this MIB at . [RFC-Editor's Note (to be removed prior to publication): the 438 IANA is requested to create page pointed to by URL.] Assignments of 439 IANA-BFD-TC-STD-MIB are via IETF Review [RFC5226]. 441 This MIB makes reference to the following documents: [RFC2578], 442 [RFC2579], [RFC5880], [RFC5881] and [RFC5883], [RFC6428] and 443 [RFC7130]. 445 IANA assigned an OID to the BFD-TC-STD-MIB module specified in this 446 document as { mib-2 XXX }. [RFC-Editor's Note (to be removed prior to 447 publication): the IANA is requested to assign a value for "XXX" under 448 the 'mib-2' subtree and to record the assignment in the SMI Numbers 449 registry. When the assignment has been made, the RFC Editor is asked 450 to replace "XXX" (here and in the MIB module) with the assigned value 451 and to remove this note.] 453 IANA assigned an OID to the IANA-BFD-TC-STD-MIB module specified in 454 this document as { mib-2 YYY }. [RFC-Editor's Note (to be removed 455 prior to publication): the IANA is requested to assign a value for 456 "YYY" under the 'mib-2' subtree and to record the assignment in the 457 SMI Numbers registry. When the assignment has been made, the RFC 458 Editor is asked to replace "YYY" (here and in the MIB module) with 459 the assigned value and to remove this note.] 461 6. Acknowledgments 463 Authors would like to thank Adrian Farrel and Jeffrey Haas for 464 performing thorough reviews and providing number of suggestions. 465 Authors would also like to thank David Ward and Christer Holmberg for 466 his comments and suggestions. 468 7. References 470 7.1. Normative References 472 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 473 Requirement Levels", BCP 14, RFC 2119, March 1997. 475 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 476 Schoenwaelder, Ed., "Structure of Management Information 477 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 479 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 480 Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 481 58, RFC 2579, April 1999. 483 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 484 "Conformance Statements for SMIv2", STD 58, RFC 2580, 485 April 1999. 487 [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 488 (BFD)", RFC 5880, June 2010. 490 [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 491 (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, June 492 2010. 494 [RFC5883] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 495 (BFD) for Multihop Paths", RFC 5883, June 2010. 497 [RFC6428] Allan, D., Swallow Ed. , G., and J. Drake Ed. , "Proactive 498 Connectivity Verification, Continuity Check, and Remote 499 Defect Indication for the MPLS Transport Profile", RFC 500 6428, November 2011. 502 [RFC7130] Bhatia, M., Chen, M., Boutros, S., Binderberger, M., and 503 J. Haas, "Bidirectional Forwarding Detection (BFD) on Link 504 Aggregation Group (LAG) Interfaces", RFC 7130, February 505 2014. 507 7.2. Informative References 509 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 510 "Introduction and Applicability Statements for Internet- 511 Standard Management Framework", RFC 3410, December 2002. 513 [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an 514 IANA Considerations Section in RFCs", BCP 26, RFC 5226, 515 May 2008. 517 Authors' Addresses 519 Thomas D. Nadeau 520 Brocade 522 EMail: tnadeau@lucidvision.com 523 Zafar Ali 524 Cisco Systems 526 EMail: zali@cisco.com 528 Nobo Akiya 529 Cisco Systems 531 EMail: nobo@cisco.com