idnits 2.17.1 draft-ietf-bfd-tc-mib-04.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 (November 21, 2013) is 3807 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) No issues found here. Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group T. Nadeau 3 Internet-Draft Juniper Networks 4 Intended status: Standards Track Z. Ali 5 Expires: May 25, 2014 N. Akiya 6 Cisco Systems 7 November 21, 2013 9 Definitions of Textual Conventions (TCs) for 10 Bidirectional Forwarding Detection (BFD) Management 11 draft-ietf-bfd-tc-mib-04 13 Abstract 15 This draft defines a Management Information Base (MIB) module which 16 contains 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 May 25, 2014. 46 Copyright Notice 47 Copyright (c) 2013 IETF Trust and the persons identified as the 48 document authors. All rights reserved. 50 This document is subject to BCP 78 and the IETF Trust's Legal 51 Provisions Relating to IETF Documents 52 (http://trustee.ietf.org/license-info) in effect on the date of 53 publication of this document. Please review these documents 54 carefully, as they describe your rights and restrictions with respect 55 to this document. Code Components extracted from this document must 56 include Simplified BSD License text as described in Section 4.e of 57 the Trust Legal Provisions and are provided without warranty as 58 described in the Simplified BSD License. 60 Table of Contents 62 1. The Internet-Standard Management Framework . . . . . . . . . 2 63 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 64 3. BFD Textual Conventions MIB Definitions . . . . . . . . . . . 3 65 4. Security Considerations . . . . . . . . . . . . . . . . . . . 8 66 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 67 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 8 68 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 69 7.1. Normative References . . . . . . . . . . . . . . . . . . 8 70 7.2. Informative References . . . . . . . . . . . . . . . . . 9 72 1. The Internet-Standard Management Framework 74 For a detailed overview of the documents that describe the current 75 Internet-Standard Management Framework, please refer to section 7 of 76 RFC 3410 [RFC3410]. 78 Managed objects are accessed via a virtual information store, termed 79 the Management Information Base or MIB. MIB objects are generally 80 accessed through the Simple Network Management Protocol (SNMP). 81 Objects in the MIB are defined using the mechanisms defined in the 82 Structure of Management Information (SMI). This memo specifies a MIB 83 module that is compliant to the SMIv2, which is described in STD 58, 84 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 85 [RFC2580]. 87 2. Introduction 89 This document defines a MIB module which contains Textual Conventions 90 for Bidirectional Forwarding Detection (BFD) protocols. These 91 Textual Conventions should be imported by MIB modules which manage 92 BFD protocols. 94 Note that names of Textual Conventions defined in this document are 95 prefixed with "IANA" to make it obvious to readers that they are IANA 96 maintained. 98 For an introduction to the concepts of BFD, see [RFC5880], [RFC5881] 99 and [RFC5883]. 101 3. BFD Textual Conventions MIB Definitions 103 This MIB module makes references to the following documents: 104 [RFC2578], [RFC2579], [RFC5880], [RFC5881] and [RFC5883]. 106 IANA-BFD-TC-STD-MIB DEFINITIONS ::= BEGIN 108 IMPORTS 109 MODULE-IDENTITY, mib-2, Unsigned32 110 FROM SNMPv2-SMI -- [RFC2578] 112 TEXTUAL-CONVENTION 113 FROM SNMPv2-TC; -- [RFC2579] 115 ianaBfdTCStdMib MODULE-IDENTITY 116 LAST-UPDATED 117 "201311211200Z" -- 21 Nov. 2013 12:00:00 EST 118 ORGANIZATION 119 "IANA" 120 CONTACT-INFO 121 "Internet Assigned Numbers Authority 122 Postal: 4676 Admiralty Way, Suite 330 123 Marina del Rey, CA 90292 124 Tel: +1 310 823 9358 125 E-Mail: iana@iana.org" 127 DESCRIPTION 128 "Copyright (C) The IETF Trust (2013). The initial version 129 of this MIB module was published in RFC xxxx. For full legal 130 notices see the RFC itself. Supplementary information 131 may be available on: 132 http://www.ietf.org/copyrights/ianamib.html" 133 -- RFC Ed.: RFC-editor pls fill in xxxx 135 REVISION 136 "201311211200Z" -- 21 Nov. 2013 12:00:00 EST 137 DESCRIPTION 138 "Initial version. Published as RFC xxxx." 139 -- RFC Ed.: RFC-editor pls fill in xxxx 140 ::= { mib-2 XXX } 141 -- RFC Ed.: assigned by IANA, see section 5 for details 142 IANAbfdSessIndexTC ::= TEXTUAL-CONVENTION 143 DISPLAY-HINT "d" 144 STATUS current 145 DESCRIPTION 146 "An index used to uniquely identify BFD sessions." 147 SYNTAX Unsigned32 (1..4294967295) 149 IANAbfdIntervalTC ::= TEXTUAL-CONVENTION 150 DISPLAY-HINT "d" 151 STATUS current 152 DESCRIPTION 153 "The BFD interval in microseconds." 154 SYNTAX Unsigned32 (0..4294967295) 156 IANAbfdMultiplierTC ::= TEXTUAL-CONVENTION 157 DISPLAY-HINT "d" 158 STATUS current 159 DESCRIPTION 160 "The BFD failure detection multiplier." 161 SYNTAX Unsigned32 (1..255) 163 IANAbfdDiagTC ::= TEXTUAL-CONVENTION 164 STATUS current 165 DESCRIPTION 166 "A common BFD diagnostic code." 167 SYNTAX INTEGER { 168 noDiagnostic(0), 169 controlDetectionTimeExpired(1), 170 echoFunctionFailed(2), 171 neighborSignaledSessionDown(3), 172 forwardingPlaneReset(4), 173 pathDown(5), 174 concatenatedPathDown(6), 175 administrativelyDown(7), 176 reverseConcatenatedPathDown(8) 177 } 179 IANAbfdSessTypeTC ::= TEXTUAL-CONVENTION 180 STATUS current 181 DESCRIPTION 182 "BFD session type" 183 REFERENCE 184 "Katz, D. and D. Ward, Bidirectional Forwarding 185 Detection (BFD), RFC 5880, June 2010. 187 Katz, D. and D. Ward, Bidirectional Forwarding 188 Detection (BFD) for IPv4 and IPv6 (Single Hop), 189 RFC 5881, June 2010. 191 Katz, D. and D. Ward, Bidirectional Forwarding 192 Detection (BFD) for Multihop Paths, RFC 5883, 193 June 2010." 194 SYNTAX INTEGER { 195 singleHop(1), 196 multiHopTotallyArbitraryPaths(2), 197 multiHopOutOfBandSignaling(3), 198 multiHopUnidirectionalLinks(4), 199 multiPointHead(5), 200 multiPointTail(6) 201 } 203 IANAbfdSessOperModeTC ::= TEXTUAL-CONVENTION 204 STATUS current 205 DESCRIPTION 206 "BFD session operating mode" 207 REFERENCE 208 "Katz, D. and D. Ward, Bidirectional Forwarding 209 Detection (BFD), RFC 5880, June 2010." 210 SYNTAX INTEGER { 211 asyncModeWEchoFunction(1), 212 asynchModeWOEchoFunction(2), 213 demandModeWEchoFunction(3), 214 demandModeWOEchoFunction(4) 215 } 217 IANAbfdCtrlDestPortNumberTC ::= TEXTUAL-CONVENTION 218 DISPLAY-HINT "d" 219 STATUS current 220 DESCRIPTION 221 "UDP destination port number of BFD control packets. 222 3784 represents single hop BFD session. 223 4784 represents multi hop BFD session. 224 However, syntax is left open to wider range of values 225 purposely for two reasons: 226 1. implementation uses non-compliant port number for 227 valid proprietary reason. 228 2. potential future extension drafts." 229 REFERENCE 230 "Use of port 3784 from Katz, D. and D. Ward, 231 Bidirectional Forwarding Detection (BFD) for 232 IPv4 and IPv6 (Single Hop), RFC 5881, June 2010. 234 Use of port 4784 from Katz, D. and D. Ward, 235 Bidirectional Forwarding Detection (BFD) for 236 Multihop Paths, RFC 5883, June 2010." 237 SYNTAX Unsigned32 (0..65535) 238 IANAbfdCtrlSourcePortNumberTC ::= TEXTUAL-CONVENTION 239 DISPLAY-HINT "d" 240 STATUS current 241 DESCRIPTION 242 "UDP source port number of BFD control packets. 243 However, syntax is left open to wider range of values 244 purposely for two reasons: 245 1. implementation uses non-compliant port number for 246 valid proprietary reason. 247 2. potential future extension drafts." 248 REFERENCE 249 "Port 49152..65535 (RFC5881)" 250 SYNTAX Unsigned32 (0..65535) 252 IANAbfdSessStateTC ::= TEXTUAL-CONVENTION 253 STATUS current 254 DESCRIPTION 255 "BFD session state. State failing(5) is only applicable if 256 corresponding session is running in BFD version 0." 257 REFERENCE 258 "RFC 5880 - Bidirectional Forwarding Detection (BFD), Katz, 259 D., Ward, D., June 2010." 260 SYNTAX INTEGER { 261 adminDown(1), 262 down(2), 263 init(3), 264 up(4), 265 failing(5) 266 } 268 IANAbfdSessAuthenticationTypeTC ::= TEXTUAL-CONVENTION 269 STATUS current 270 DESCRIPTION 271 "BFD authentication type" 272 REFERENCE 273 "Sections 4.2 - 4.4 from Katz, D. and D. Ward, 274 Bidirectional Forwarding Detection (BFD), 275 RFC 5880, June 2010." 276 SYNTAX INTEGER { 277 noAuthentication(-1), 278 reserved(0), 279 simplePassword(1), 280 keyedMD5(2), 281 meticulousKeyedMD5(3), 282 keyedSHA1(4), 283 meticulousKeyedSHA1(5) 284 } 285 IANAbfdSessAuthenticationKeyTC ::= TEXTUAL-CONVENTION 286 DISPLAY-HINT "1x " 287 STATUS current 288 DESCRIPTION 289 "BFD authentication key type. 291 An IANAbfdSessAuthenticationKeyTC is always interpreted 292 within the context of an IANAbfdSessAuthenticationTypeTC 293 value. Every usage of the IANAbfdSessAuthenticationTypeTC 294 textual convention is required to specify the 295 IANAbfdSessAuthenticationKeyTC object that provides the 296 context. It is suggested that the 297 IANAbfdSessAuthenticationKeyTC object be logically registered 298 before the object(s) that use the 299 IANAbfdSessAuthenticationKeyTC textual convention, if they 300 appear in the same logical row. 302 The value of a IANAbfdSessAuthenticationKeyTC must 303 always be consistent with the value of the associated 304 IANAbfdSessAuthenticationTypeTC object. Attempts to set a 305 IANAbfdSessAuthenticationKeyTC object to a value inconsistent 306 with the associated IANAbfdSessAuthenticationTypeTC must fail 307 with an inconsistentValue error. 309 The following size constraints for a 310 IANAbfdSessAuthenticationKeyTC object are defined for the 311 associated IANAbfdSessAuthenticationTypeTC values show below: 313 noAuthentication(-1): SIZE(0) 314 reserved(0): SIZE(0) 315 simplePassword(1): SIZE(1..16) 316 keyedMD5(2): SIZE(16) 317 meticulousKeyedMD5(3): SIZE(16) 318 keyedSHA1(4): SIZE(20) 319 meticulousKeyedSHA1(5): SIZE(20) 321 When this textual convention is used as the syntax of an 322 index object, there may be issues with the limit of 128 323 sub-identifiers specified in SMIv2, STD 58. In this case, 324 the object definition MUST include a 'SIZE' clause to limit 325 the number of potential instance sub-identifiers; otherwise 326 the applicable constraints MUST be stated in the appropriate 327 conceptual row DESCRIPTION clauses, or in the surrounding 328 documentation if there is no single DESCRIPTION clause that 329 is appropriate." 330 REFERENCE 331 "RFC5880, Sections 4.2 - 4.4" 332 SYNTAX OCTET STRING(SIZE(0..252)) 333 END 335 4. Security Considerations 337 This module does not define any management objects. Instead, it 338 defines a set of textual conventions which may be used by other BFD 339 MIB modules to define management objects. 341 Meaningful security considerations can only be written in the MIB 342 modules that define management objects. Therefore, this document has 343 no impact on the security of the Internet. 345 5. IANA Considerations 347 This document provides the base definition of the IANA-BFD-TC-STD-MIB 348 module. This MIB module is under the direct control of IANA. Please 349 see the most updated version of this MIB at . [RFC-Editor's Note (to be removed prior to 351 publication): the IANA is requested to create page pointed to by 352 URL.] 354 This MIB makes reference to the following documents: [RFC2578], 355 [RFC2579], [RFC5880], [RFC5881] and [RFC5883]. 357 IANA assigned an OID to the IANA-BFD-TC-STD-MIB module specified in 358 this document as { mib-2 XXX }. [RFC-Editor's Note (to be removed 359 prior to publication): the IANA is requested to assign a value for 360 "XXX" under the 'mib-2' subtree and to record the assignment in the 361 SMI Numbers registry. When the assignment has been made, the RFC 362 Editor is asked to replace "XXX" (here and in the MIB module) with 363 the assigned value and to remove this note.] 365 6. Acknowledgments 367 Authors would like to thank David Ward and Jeffrey Haas for their 368 comments and suggestions. 370 7. References 372 7.1. Normative References 374 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 375 Requirement Levels", BCP 14, RFC 2119, March 1997. 377 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 378 Schoenwaelder, Ed., "Structure of Management Information 379 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 381 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 382 Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 383 58, RFC 2579, April 1999. 385 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 386 "Conformance Statements for SMIv2", STD 58, RFC 2580, 387 April 1999. 389 [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 390 (BFD)", RFC 5880, June 2010. 392 [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 393 (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, June 394 2010. 396 [RFC5883] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 397 (BFD) for Multihop Paths", RFC 5883, June 2010. 399 7.2. Informative References 401 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 402 "Introduction and Applicability Statements for Internet- 403 Standard Management Framework", RFC 3410, December 2002. 405 Authors' Addresses 407 Thomas D. Nadeau 408 Juniper Networks 410 EMail: tnadeau@juniper.net 412 Zafar Ali 413 Cisco Systems 415 EMail: zali@cisco.com 417 Nobo Akiya 418 Cisco Systems 420 EMail: nobo@cisco.com