idnits 2.17.1 draft-ietf-bfd-tc-mib-02.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 (June 18, 2013) is 3965 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: 'RFC4001' is defined on line 393, but no explicit reference was found in the text == Unused Reference: 'RFC2863' is defined on line 397, but no explicit reference was found in the text == Unused Reference: 'RFC3413' is defined on line 400, but no explicit reference was found in the text Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 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: December 20, 2013 N. Akiya 6 Cisco Systems 7 June 18, 2013 9 Definitions of Textual Conventions (TCs) for 10 Bidirectional Forwarding Detection (BFD) Management 11 draft-ietf-bfd-tc-mib-02 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 December 20, 2013. 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 . . . . . . . . . . . . . . . . . . . 7 66 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 67 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 68 6.1. Normative References . . . . . . . . . . . . . . . . . . 8 69 6.2. Informative References . . . . . . . . . . . . . . . . . 9 70 Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 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 For an introduction to the concepts of BFD, see [RFC5880], [RFC5881] 95 and [RFC5883]. 97 3. BFD Textual Conventions MIB Definitions 99 BFD-TC-STD-MIB DEFINITIONS ::= BEGIN 101 IMPORTS 102 MODULE-IDENTITY, mib-2, Unsigned32 103 FROM SNMPv2-SMI -- [RFC2578] 105 TEXTUAL-CONVENTION 106 FROM SNMPv2-TC; -- [RFC2579] 108 bfdTCStdMib MODULE-IDENTITY 109 LAST-UPDATED "201306191200Z" -- 19 June 2013 12:00:00 EST 110 ORGANIZATION "IETF Bidirectional Forwarding Detection 111 Working Group" 112 CONTACT-INFO 113 "Thomas D. Nadeau 114 Juniper Networks 115 Email: tnadeau@lucidvision.com 117 Zafar Ali 118 Cisco Systems, Inc. 119 Email: zali@cisco.com 121 Nobo Akiya 122 Cisco Systems, Inc. 123 Email: nobo@cisco.com" 124 DESCRIPTION 125 "This MIB module defines TEXTUAL-CONVENTIONs for concepts 126 used in Bidirectional Forwarding Detection (BFD) 127 protocols." 128 REVISION "201306191200Z" -- 19 June 2013 12:00:00 EST 129 DESCRIPTION 130 "Initial version. Published as RFC xxxx." 131 -- RFC Ed.: RFC-editor pls fill in xxxx 132 ::= { mib-2 XXX } 133 -- RFC Ed.: assigned by IANA, see section 5 for details 135 BfdSessIndexTC ::= TEXTUAL-CONVENTION 136 DISPLAY-HINT "d" 137 STATUS current 138 DESCRIPTION 139 "An index used to uniquely identify BFD sessions." 140 SYNTAX Unsigned32 (1..4294967295) 141 BfdIntervalTC ::= TEXTUAL-CONVENTION 142 DISPLAY-HINT "d" 143 STATUS current 144 DESCRIPTION 145 "The BFD interval in microseconds." 146 SYNTAX Unsigned32 (0..4294967295) 148 BfdMultiplierTC ::= TEXTUAL-CONVENTION 149 DISPLAY-HINT "d" 150 STATUS current 151 DESCRIPTION 152 "The BFD failure detection multiplier." 153 SYNTAX Unsigned32 (1..255) 155 BfdDiagTC ::= TEXTUAL-CONVENTION 156 STATUS current 157 DESCRIPTION 158 "A common BFD diagnostic code." 159 SYNTAX INTEGER { 160 noDiagnostic(0), 161 controlDetectionTimeExpired(1), 162 echoFunctionFailed(2), 163 neighborSignaledSessionDown(3), 164 forwardingPlaneReset(4), 165 pathDown(5), 166 concatenatedPathDown(6), 167 administrativelyDown(7), 168 reverseConcatenatedPathDown(8) 169 } 171 BfdSessTypeTC ::= TEXTUAL-CONVENTION 172 STATUS current 173 DESCRIPTION 174 "BFD session type" 175 REFERENCE 176 "Katz, D. and D. Ward, Bidirectional Forwarding 177 Detection (BFD), RFC 5880, June 2010. 179 Katz, D. and D. Ward, Bidirectional Forwarding 180 Detection (BFD) for IPv4 and IPv6 (Single Hop), 181 RFC 5881, June 2010. 183 Katz, D. and D. Ward, Bidirectional Forwarding 184 Detection (BFD) for Multihop Paths, RFC 5883, 185 June 2010." 186 SYNTAX INTEGER { 187 singleHop(1), 188 multiHopTotallyArbitraryPaths(2), 189 multiHopOutOfBandSignaling(3), 190 multiHopUnidirectionalLinks(4), 191 multiPointHead(5), 192 multiPointTail(6) 193 } 195 BfdSessOperModeTC ::= TEXTUAL-CONVENTION 196 STATUS current 197 DESCRIPTION 198 "BFD session operating mode" 199 REFERENCE 200 "Katz, D. and D. Ward, "Bidirectional Forwarding 201 Detection (BFD)", RFC 5880, June 2010." 202 SYNTAX INTEGER { 203 asyncModeWEchoFunction(1), 204 asynchModeWOEchoFunction(2), 205 demandModeWEchoFunction(3), 206 demandModeWOEchoFunction(4) 207 } 209 BfdCtrlDestPortNumberTC ::= TEXTUAL-CONVENTION 210 DISPLAY-HINT "d" 211 STATUS current 212 DESCRIPTION 213 "UDP destination port number of BFD control packets. 214 3784 represents single hop BFD session. 215 4784 represents multi hop BFD session. 216 However, syntax is left open to wider range of values 217 purposely for two reasons: 218 1. implementation uses non-compliant port number for 219 valid proprietary reason. 220 2. potential future extension drafts." 221 REFERENCE 222 "Use of port 3784 from Katz, D. and D. Ward, 223 Bidirectional Forwarding 224 Detection (BFD) for IPv4 and IPv6 (Single Hop)", 225 RFC 5881, June 2010. 227 Use of port 4784 from Katz, D. and D. Ward, Bidirectional 228 Forwarding Detection (BFD) for IPv4 and IPv6 229 (Single Hop), RFC 5881, June 2010." 230 SYNTAX Unsigned32 (0..65535) 232 BfdCtrlSourcePortNumberTC ::= TEXTUAL-CONVENTION 233 DISPLAY-HINT "d" 234 STATUS current 235 DESCRIPTION 236 "UDP source port number of BFD control packets. 238 However, syntax is left open to wider range of values 239 purposely for two reasons: 240 1. implementation uses non-compliant port number for 241 valid proprietary reason. 242 2. potential future extension drafts." 243 REFERENCE 244 "Port 49152..65535 (RFC5881)" 245 SYNTAX Unsigned32 (0..65535) 247 BfdSessStateTC ::= TEXTUAL-CONVENTION 248 STATUS current 249 DESCRIPTION 250 "BFD session state. State failing(5) is only applicable if 251 corresponding session is running in BFD version 0." 252 REFERENCE 253 "RFC 5880 - Bidirectional Forwarding Detection (BFD), Katz, 254 D., Ward, D., June 2010." 255 SYNTAX INTEGER { 256 adminDown(1), 257 down(2), 258 init(3), 259 up(4), 260 failing(5) 261 } 263 BfdSessAuthenticationTypeTC ::= TEXTUAL-CONVENTION 264 STATUS current 265 DESCRIPTION 266 "BFD authentication type" 267 REFERENCE 268 "Sections 4.2 - 4.4 from Katz, D. and D. Ward, 269 Bidirectional Forwarding Detection (BFD), 270 RFC 5880, June 2010." 271 SYNTAX INTEGER { 272 noAuthentication(-1), 273 reserved(0), 274 simplePassword(1), 275 keyedMD5(2), 276 meticulousKeyedMD5(3), 277 keyedSHA1(4), 278 meticulousKeyedSHA1(5) 279 } 281 BfdSessionAuthenticationKeyTC ::= TEXTUAL-CONVENTION 282 DISPLAY-HINT "1x " 283 STATUS current 284 DESCRIPTION 285 "BFD authentication key type. 287 A BfdSessionAuthenticationKeyTC is always interpreted within 288 the context of an BfdSessAuthenticationTypeTC value. Every 289 usage of the BfdSessionAuthenticationTypeTC textual 290 convention is required to specify the 291 BfdSessionAuthenticationKeyTC object that provides the 292 context. It is suggested that the 293 BfdSessionAuthentcationTypeTC object be logically registered 294 before the object(s) that use the 295 BfdSessionAuthenticationKeyTC textual convention, if they 296 appear in the same logical row. 298 The value of a BfdSessionAuthenticationKeyTC must always be 299 consistent with the value of the associated 300 BfdSessionAuthencationTypeTC object. Attempts to set a 301 BfdSessionAuthenticationKeyTC object to a value inconsistent 302 with the associated BfdSessionAuthenticationTypeTC must fail 303 with an inconsistentValue error. 305 The following size constraints for a 306 BfdSessionAuthenticationKeyTC object are defined for the 307 associated BfdSessionAuthenticationTypeTC values show below: 309 noAuthentication(-1): SIZE(0) 310 reserved(0): SIZE(0) 311 simplePassword(1): SIZE(1..16) 312 keyedMD5(2): SIZE(16) 313 meticulousKeyedMD5(3): SIZE(16) 314 keyedSHA1(4): SIZE(20) 315 meticulousKeyedSHA1(5): SIZE(20) 317 When this textual convention is used as the syntax of an 318 index object, there may be issues with the limit of 128 319 sub-identifiers specified in SMIv2, STD 58. In this case, 320 the object definition MUST include a 'SIZE' clause to limit 321 the number of potential instance sub-identifiers; otherwise 322 the applicable constraints MUST be stated in the appropriate 323 conceptual row DESCRIPTION clauses, or in the surrounding 324 documentation if there is no single DESCRIPTION clause that 325 is appropriate." 326 REFERENCE 327 "RFC5880, Sections 4.2 - 4.4" 328 SYNTAX OCTET STRING(SIZE(0..252)) 330 END 332 4. Security Considerations 333 This module does not define any management objects. Instead, it 334 defines a set of textual conventions which may be used by other BFD 335 MIB modules to define management objects. 337 Meaningful security considerations can only be written in the MIB 338 modules that define management objects. Therefore, this document has 339 no impact on the security of the Internet. 341 5. IANA Considerations 343 The MIB module in this document uses the following IANA-assigned 344 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 346 Descriptor OBJECT IDENTIFIER value 347 ---------- ----------------------- 349 bfdTCStdMib { mib-2 XXX } 351 [Editor's Note (to be removed prior to publication): the IANA is 352 requested to assign a value for "XXX" under the 'mib-2' subtree and 353 to record the assignment in the SMI Numbers registry. When the 354 assignment has been made, the RFC Editor is asked to replace "XXX" 355 (here and in the MIB module) with the assigned value and to remove 356 this note.] 358 6. References 360 6.1. Normative References 362 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 363 Requirement Levels", BCP 14, RFC 2119, March 1997. 365 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 366 Schoenwaelder, Ed., "Structure of Management Information 367 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 369 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 370 Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 371 58, RFC 2579, April 1999. 373 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 374 "Conformance Statements for SMIv2", STD 58, RFC 2580, 375 April 1999. 377 [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 378 (BFD)", RFC 5880, June 2010. 380 [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 381 (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, June 382 2010. 384 [RFC5883] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 385 (BFD) for Multihop Paths", RFC 5883, June 2010. 387 6.2. Informative References 389 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 390 "Introduction and Applicability Statements for Internet- 391 Standard Management Framework", RFC 3410, December 2002. 393 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 394 Schoenwaelder, "Textual Conventions for Internet Network 395 Addresses", RFC 4001, February 2005. 397 [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group 398 MIB", RFC 2863, June 2000. 400 [RFC3413] Levi, D., Meyer, P., and B. Stewart, "Simple Network 401 Management Protocol (SNMP) Applications", STD 62, RFC 402 3413, December 2002. 404 Appendix A. Acknowledgments 406 Authors would like to thank David Ward and Jeffrey Haas for their 407 comments and suggestions. 409 Authors' Addresses 411 Thomas D. Nadeau 412 Juniper Networks 414 EMail: tnadeau@juniper.net 416 Zafar Ali 417 Cisco Systems 419 EMail: zali@cisco.com 421 Nobo Akiya 422 Cisco Systems 424 EMail: nobo@cisco.com