idnits 2.17.1 draft-ietf-pim-bsr-mib-01.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 16. -- Found old boilerplate from RFC 3978, Section 5.5 on line 951. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 928. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 935. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 941. ** 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: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. 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 (October 29, 2006) is 6360 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: 'RFC2365' is defined on line 851, but no explicit reference was found in the text == Unused Reference: 'RFC2434' is defined on line 854, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-pim-sm-bsr' is defined on line 885, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-mboned-ip-mcast-mib' is defined on line 889, but no explicit reference was found in the text ** Obsolete normative reference: RFC 2434 (Obsoleted by RFC 5226) ** Obsolete normative reference: RFC 4601 (Obsoleted by RFC 7761) == Outdated reference: A later version (-10) exists of draft-ietf-pim-mib-v2-06 == Outdated reference: A later version (-12) exists of draft-ietf-pim-sm-bsr-08 == Outdated reference: A later version (-07) exists of draft-ietf-mboned-ip-mcast-mib-03 Summary: 5 errors (**), 0 flaws (~~), 10 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 PIM WG B. Joshi 3 Internet-Draft Infosys Technologies Ltd. 4 Expires: May 2, 2007 R. Bijlani 5 Cisco Systems 6 October 29, 2006 8 PIM Bootstrap Router MIB 9 draft-ietf-pim-bsr-mib-01.txt 11 Status of this Memo 13 By submitting this Internet-Draft, each author represents that any 14 applicable patent or other IPR claims of which he or she is aware 15 have been or will be disclosed, and any of which he or she becomes 16 aware will be disclosed, in accordance with Section 6 of BCP 79. 18 Internet-Drafts are working documents of the Internet Engineering 19 Task Force (IETF), its areas, and its working groups. Note that 20 other groups may also distribute working documents as Internet- 21 Drafts. 23 Internet-Drafts are draft documents valid for a maximum of six months 24 and may be updated, replaced, or obsoleted by other documents at any 25 time. It is inappropriate to use Internet-Drafts as reference 26 material or to cite them other than as "work in progress." 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt. 31 The list of Internet-Draft Shadow Directories can be accessed at 32 http://www.ietf.org/shadow.html. 34 This Internet-Draft will expire on May 2, 2007. 36 Copyright Notice 38 Copyright (C) The Internet Society (2006). 40 Abstract 42 This document defines a portion of the Management Information Base 43 (MIB) for use with network management protocols in the Internet 44 community. In particular, it describes managed objects used for 45 managing the Bootstrap Router (BSR) mechanism for PIM. 47 Table of Contents 49 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 50 2. The Internet-Standard Management Framework . . . . . . . . . . 3 51 3. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 3 52 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 5. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 4 54 6. Security Considerations . . . . . . . . . . . . . . . . . . . 17 55 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 19 56 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 19 57 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 19 58 9.1. Normative References . . . . . . . . . . . . . . . . . . . 19 59 9.2. Informative References . . . . . . . . . . . . . . . . . . 20 60 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 21 61 Intellectual Property and Copyright Statements . . . . . . . . . . 22 63 1. Introduction 65 This memo defines a portion of the Management Information Base (MIB) 66 for use with network management protocols in the Internet community. 67 In particular, it describes managed objects used for managing the 68 Bootstrap Router (BSR) mechanism for PIM. [RFC4601], [I-D.ietf-pim- 69 sm-bsr]. 71 This document was created by moving some of the PIM BSR specific MIB 72 tables from one of the earlier version of PIM MIB draft [I-D.ietf- 73 pim-mib-v2]. 75 2. The Internet-Standard Management Framework 77 For a detailed overview of the documents that describe the current 78 Internet-Standard Management Framework, please refer to section 7 of 79 RFC 3410[RFC3410]. 81 Managed objects are accessed via a virtual information store, termed 82 the Management Information Base or MIB. MIB objects are generally 83 accessed through the Simple Network Management Protocol (SNMP). 84 Objects in the MIB are defined using the mechanisms defined in the 85 Structure of Management Information (SMI). This memo specifies a MIB 86 module that is compliant to the SMIv2, which is described in STD 58, 87 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 88 [RFC2580]. 90 3. Conventions 92 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 93 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 94 document are to be interpreted as described in RFC 2119 [RFC2119]. 96 4. Overview 98 This MIB module contains four tables. The tables are: 100 1. The BSR Candidate-RP Table, which contains one row for each 101 multicast group address prefix for which the local router is to 102 advertise itself as a Candidate-RP. 104 2. The BSR Elected BSR RP-Set Table, which contains one row for each 105 Group-to-RP mapping that was received in C-RP advertisements. 107 3. The BSR Candidate-BSR Table, which contains one row for each 108 Candidate-BSR configuration for the local router. 110 4. The BSR Elected BSR Table, which contains one row for each 111 elected BSR. 113 This MIB module uses textual conventions defined in the IF-MIB 114 [RFC2863], the INET-ADDRESS-MIB [RFC4001] and the IANA-RTPROTO-MIB. 116 5. Definitions 118 PIM-BSR-MIB DEFINITIONS ::= BEGIN 120 IMPORTS 121 MODULE-IDENTITY, OBJECT-TYPE, 122 NOTIFICATION-TYPE, 123 mib-2, Unsigned32, TimeTicks FROM SNMPv2-SMI 124 RowStatus, TruthValue FROM SNMPv2-TC 125 MODULE-COMPLIANCE, OBJECT-GROUP, 126 NOTIFICATION-GROUP FROM SNMPv2-CONF 127 InetAddressType, 128 InetAddressPrefixLength, 129 InetAddress, 130 InetZoneIndex FROM INET-ADDRESS-MIB; 132 pimBsrMIB MODULE-IDENTITY 133 LAST-UPDATED "200610230000Z" -- 23 October 2006 134 ORGANIZATION "IETF PIM Working Group" 135 CONTACT-INFO 136 "Email: pim@ietf.org" 137 DESCRIPTION 138 "The MIB module for management of the Bootstrap Router 139 (BSR) mechanism for PIM routers. 141 Copyright (C) The Internet Society (2006). This version 142 of this MIB module is part of RFC yyyy; see the RFC 143 itself for full legal notices." 144 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 145 REVISION "200610230000Z" -- 23 October 2006 146 DESCRIPTION "Initial version, published as RFC yyyy." 147 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 148 ::= { mib-2 XXX } 149 -- RFC Ed.: replace XXX with IANA-assigned number & remove this note 151 -- 152 -- Top-level structure 153 -- 155 pimBsrNotifications OBJECT IDENTIFIER ::= { pimBsrMIB 0 } 156 pimBsrObjects OBJECT IDENTIFIER ::= { pimBsrMIB 1 } 158 -- 159 -- Conformance Information 160 -- 162 pimBsrConformance OBJECT IDENTIFIER ::= { pimBsrMIB 2 } 163 pimBsrCompliances OBJECT IDENTIFIER ::= { pimBsrConformance 1 } 164 pimBsrGroups OBJECT IDENTIFIER ::= { pimBsrConformance 2 } 166 -- 167 -- The BSR Candidate-RP Table 168 -- 170 pimBsrCandidateRPTable OBJECT-TYPE 171 SYNTAX SEQUENCE OF PimBsrCandidateRPEntry 172 MAX-ACCESS not-accessible 173 STATUS current 174 DESCRIPTION 175 "The (conceptual) table listing the IP multicast group 176 prefixes for which the local router is to advertise 177 itself as a Candidate-RP." 178 ::= { pimBsrObjects 1 } 180 pimBsrCandidateRPEntry OBJECT-TYPE 181 SYNTAX PimBsrCandidateRPEntry 182 MAX-ACCESS not-accessible 183 STATUS current 184 DESCRIPTION 185 "An entry (conceptual row) in the 186 pimBsrCandidateRPTable." 187 INDEX { pimBsrCandidateRPAddressType, 188 pimBsrCandidateRPAddress, 189 pimBsrCandidateRPGroupAddress, 190 pimBsrCandidateRPGroupPrefixLength } 191 ::= { pimBsrCandidateRPTable 1 } 193 PimBsrCandidateRPEntry ::= SEQUENCE { 194 pimBsrCandidateRPAddressType InetAddressType, 195 pimBsrCandidateRPAddress InetAddress, 196 pimBsrCandidateRPGroupAddress InetAddress, 197 pimBsrCandidateRPGroupPrefixLength InetAddressPrefixLength, 198 pimBsrCandidateRPBidir TruthValue, 199 pimBsrCandidateRPAdvTimer TimeTicks, 200 pimBsrCandidateRPPriority Unsigned32, 201 pimBsrCandidateRPAdvInterval Unsigned32, 202 pimBsrCandidateRPHoldtime Unsigned32, 203 pimBsrCandidateRPStatus RowStatus 204 } 206 pimBsrCandidateRPAddressType OBJECT-TYPE 207 SYNTAX InetAddressType 208 MAX-ACCESS not-accessible 209 STATUS current 210 DESCRIPTION 211 "The Inet address type of the Candidate-RP." 212 ::= { pimBsrCandidateRPEntry 1 } 214 pimBsrCandidateRPAddress OBJECT-TYPE 215 SYNTAX InetAddress (SIZE (4|8|16|20)) 216 MAX-ACCESS not-accessible 217 STATUS current 218 DESCRIPTION 219 "The (unicast) address that will be advertised as a 220 Candidate-RP. The InetAddressType is given by the 221 pimBsrCandidateRPAddressType object." 222 ::= { pimBsrCandidateRPEntry 2 } 224 pimBsrCandidateRPGroupAddress OBJECT-TYPE 225 SYNTAX InetAddress (SIZE (4|8|16|20)) 226 MAX-ACCESS not-accessible 227 STATUS current 228 DESCRIPTION 229 "The IP multicast group address that, when combined with 230 the corresponding value of 231 pimBsrCandidateRPGroupPrefixLength, identifies a group 232 prefix for which the local router will advertise itself 233 as a Candidate-RP. The InetAddressType is given by the 234 pimBsrCandidateRPAddressType object." 235 ::= { pimBsrCandidateRPEntry 3 } 237 pimBsrCandidateRPGroupPrefixLength OBJECT-TYPE 238 SYNTAX InetAddressPrefixLength (4..128) 239 MAX-ACCESS not-accessible 240 STATUS current 241 DESCRIPTION 242 "The multicast group address mask that, when combined 243 with the corresponding value of 244 pimBsrCandidateRPGroupAddress, identifies a group prefix 245 for which the local router will advertise itself as a 246 Candidate-RP. The InetAddressType is given by the 247 pimBsrCandidateRPAddressType object." 248 ::= { pimBsrCandidateRPEntry 4 } 250 pimBsrCandidateRPBidir OBJECT-TYPE 251 SYNTAX TruthValue 252 MAX-ACCESS read-create 253 STATUS current 254 DESCRIPTION 255 "If this object is set to TRUE, this group range is 256 advertised with this RP as a BIDIR-PIM group range. If 257 it is set to FALSE, it is advertised as a PIM-SM group 258 range." 259 DEFVAL { false } 260 ::= { pimBsrCandidateRPEntry 5 } 262 pimBsrCandidateRPAdvTimer OBJECT-TYPE 263 SYNTAX TimeTicks 264 MAX-ACCESS read-only 265 STATUS current 266 DESCRIPTION 267 "The time remaining before the local router next sends 268 a Candidate-RP-Advertisement to the elected BSR for 269 this zone." 270 ::= { pimBsrCandidateRPEntry 6 } 272 pimBsrCandidateRPPriority OBJECT-TYPE 273 SYNTAX Unsigned32 (0..255) 274 MAX-ACCESS read-create 275 STATUS current 276 DESCRIPTION 277 "The priority for this Candidate RP advertised in 278 Candidate-RP-Advertisements." 279 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2" 280 DEFVAL { 192 } 281 ::= { pimBsrCandidateRPEntry 7 } 283 pimBsrCandidateRPAdvInterval OBJECT-TYPE 284 SYNTAX Unsigned32 (0..26214) 285 MAX-ACCESS read-create 286 STATUS current 287 DESCRIPTION 288 "A Candidate RP generates Candidate-RP-Advertisements 289 periodically. This object represents the time interval 290 in seconds between two consecutive advertisements." 292 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2 and section 5" 293 DEFVAL { 60 } 295 ::= { pimBsrCandidateRPEntry 8 } 297 pimBsrCandidateRPHoldtime OBJECT-TYPE 298 SYNTAX Unsigned32 (0..65535) 299 MAX-ACCESS read-create 300 STATUS current 301 DESCRIPTION 302 "Holdtime for this Candidate RP. The amount of time (in 303 seconds) this Candidate-RP entry is valid." 305 REFERENCE "I-D.ietf-pim-sm-bsr section 4.2" 306 DEFVAL { 150 } 308 ::= { pimBsrCandidateRPEntry 9 } 310 pimBsrCandidateRPStatus OBJECT-TYPE 311 SYNTAX RowStatus 312 MAX-ACCESS read-create 313 STATUS current 314 DESCRIPTION 315 "The status of this row, by which new entries may be 316 created, or old entries deleted from this table." 318 ::= { pimBsrCandidateRPEntry 10 } 320 -- 321 -- The BSR Elected BSR RP-Set Table 322 -- 324 pimBsrElectedBSRRPSetTable OBJECT-TYPE 325 SYNTAX SEQUENCE OF PimBsrElectedBSRRPSetEntry 326 MAX-ACCESS not-accessible 327 STATUS current 328 DESCRIPTION 329 "The (conceptual) table listing BSR-specific information 330 about PIM group mappings learned via C-RP advertisements 331 or created locally using configurations. This table is 332 maintained only on the Elected BSR. 334 An Elected BSR uses this table to create Bootstrap 335 Messages after applying a local policy to include some 336 or all of the group mappings in this table." 338 ::= { pimBsrObjects 2 } 340 pimBsrElectedBSRRPSetEntry OBJECT-TYPE 341 SYNTAX PimBsrElectedBSRRPSetEntry 342 MAX-ACCESS not-accessible 343 STATUS current 344 DESCRIPTION 345 "An entry (conceptual row) in the 346 pimBsrElectedBSRRPSetTable." 347 INDEX { pimBsrElectedBSRGrpMappingAddrType, 348 pimBsrElectedBSRGrpMappingGrpAddr, 349 pimBsrElectedBSRGrpMappingGrpPrefixLen, 350 pimBsrElectedBSRGrpMappingRPAddr } 351 ::= { pimBsrElectedBSRRPSetTable 1 } 353 PimBsrElectedBSRRPSetEntry ::= SEQUENCE { 354 pimBsrElectedBSRGrpMappingAddrType InetAddressType, 355 pimBsrElectedBSRGrpMappingGrpAddr InetAddress, 356 pimBsrElectedBSRGrpMappingGrpPrefixLen InetAddressPrefixLength, 357 pimBsrElectedBSRGrpMappingRPAddr InetAddress, 358 pimBsrElectedBSRRPSetPriority Unsigned32, 359 pimBsrElectedBSRRPSetHoldtime Unsigned32, 360 pimBsrElectedBSRRPSetExpiryTime TimeTicks, 361 pimBsrElectedBSRRPSetGrpBidir TruthValue 362 } 364 pimBsrElectedBSRGrpMappingAddrType OBJECT-TYPE 365 SYNTAX InetAddressType 366 MAX-ACCESS not-accessible 367 STATUS current 368 DESCRIPTION 369 "The Inet address type of the IP multicast group 370 prefix." 371 ::= { pimBsrElectedBSRRPSetEntry 2 } 373 pimBsrElectedBSRGrpMappingGrpAddr OBJECT-TYPE 374 SYNTAX InetAddress (SIZE (4|8|16|20)) 375 MAX-ACCESS not-accessible 376 STATUS current 377 DESCRIPTION 378 "The IP multicast group address which, when combined 379 with pimBsrElectedBSRGrpMappingGrpPrefixLen, gives the 380 group prefix for this mapping. The InetAddressType is 381 given by the pimBsrElectedBSRGrpMappingAddrType object. 383 This address object is only significant up to 384 pimBsrElectedBSRGrpMappingGrpPrefixLen bits. The 385 remainder of the address bits are zero. This is 386 especially important for this field, which is part of 387 the index of this entry. Any non-zero bits would 388 signify an entirely different entry." 389 ::= { pimBsrElectedBSRRPSetEntry 3 } 391 pimBsrElectedBSRGrpMappingGrpPrefixLen OBJECT-TYPE 392 SYNTAX InetAddressPrefixLength (4..128) 393 MAX-ACCESS not-accessible 394 STATUS current 395 DESCRIPTION 396 "The multicast group prefix length that, when combined 397 with pimBsrElectedBSRGrpMappingGrpAddr, gives the group 398 prefix for this mapping. The InetAddressType is given by 399 the pimBsrElectedBSRGrpMappingAddrType object. If 400 pimBsrElectedBSRGrpMappingAddrType is 'ipv4' or 'ipv4z', 401 this object must be in the range 4..32. If 402 pimBsrElectedBSRGrpMappingAddrType is 'ipv6' or 'ipv6z', 403 this object must be in the range 8..128." 404 ::= { pimBsrElectedBSRRPSetEntry 4 } 406 pimBsrElectedBSRGrpMappingRPAddr OBJECT-TYPE 407 SYNTAX InetAddress (SIZE (4|8|16|20)) 408 MAX-ACCESS not-accessible 409 STATUS current 410 DESCRIPTION 411 "The IP address of the RP to be used for groups within 412 this group prefix. The InetAddressType is given by the 413 pimBsrElectedBSRGrpMappingAddrType object." 414 ::= { pimBsrElectedBSRRPSetEntry 5 } 416 pimBsrElectedBSRRPSetPriority OBJECT-TYPE 417 SYNTAX Unsigned32 (0..255) 418 MAX-ACCESS read-only 419 STATUS current 420 DESCRIPTION 421 "The priority for RP. Numerically higher values for 422 this object indicate lower priorities, with the value 423 zero denoting the highest priority." 424 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 425 ::= { pimBsrElectedBSRRPSetEntry 6 } 427 pimBsrElectedBSRRPSetHoldtime OBJECT-TYPE 428 SYNTAX Unsigned32 (0..65535) 429 UNITS "seconds" 430 MAX-ACCESS read-only 431 STATUS current 432 DESCRIPTION 433 "The holdtime for RP" 434 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 435 ::= { pimBsrElectedBSRRPSetEntry 7 } 437 pimBsrElectedBSRRPSetExpiryTime OBJECT-TYPE 438 SYNTAX TimeTicks 439 MAX-ACCESS read-only 440 STATUS current 441 DESCRIPTION 442 "The minimum time remaining before this entry will be 443 aged out. The value zero indicates that this entry will 444 never be aged out." 445 ::= { pimBsrElectedBSRRPSetEntry 8 } 447 pimBsrElectedBSRRPSetGrpBidir OBJECT-TYPE 448 SYNTAX TruthValue 449 MAX-ACCESS read-only 450 STATUS current 451 DESCRIPTION 452 "If this object is TRUE, this group range with this 453 RP is a BIDIR-PIM group range. If it is set to FALSE, 454 it is a PIM-SM group range." 455 ::= { pimBsrElectedBSRRPSetEntry 9 } 457 -- 458 -- The BSR Candidate-BSR Table 459 -- 461 pimBsrCandidateBSRTable OBJECT-TYPE 462 SYNTAX SEQUENCE OF PimBsrCandidateBSREntry 463 MAX-ACCESS not-accessible 464 STATUS current 465 DESCRIPTION 466 "The (conceptual) table containing Candidate-BSR 467 configuration for the local router. The table contains 468 one row for each zone for which the local router is 469 to advertise itself as a Candidate-BSR." 470 ::= { pimBsrObjects 3 } 472 pimBsrCandidateBSREntry OBJECT-TYPE 473 SYNTAX PimBsrCandidateBSREntry 474 MAX-ACCESS not-accessible 475 STATUS current 476 DESCRIPTION 477 "An entry (conceptual row) in the 478 pimBsrCandidateBSRTable." 479 INDEX { pimBsrCandidateBSRZoneIndex } 480 ::= { pimBsrCandidateBSRTable 1 } 482 PimBsrCandidateBSREntry ::= SEQUENCE { 483 pimBsrCandidateBSRZoneIndex InetZoneIndex, 484 pimBsrCandidateBSRAddressType InetAddressType, 485 pimBsrCandidateBSRAddress InetAddress, 486 pimBsrCandidateBSRPriority Unsigned32, 487 pimBsrCandidateBSRHashMaskLength Unsigned32, 488 pimBsrCandidateBSRElectedBSR TruthValue, 489 pimBsrCandidateBSRBootstrapTimer TimeTicks, 490 pimBsrCandidateBSRStatus RowStatus 491 } 493 pimBsrCandidateBSRZoneIndex OBJECT-TYPE 494 SYNTAX InetZoneIndex 495 MAX-ACCESS not-accessible 496 STATUS current 497 DESCRIPTION 498 "The zone index uniquely identifies the zone on 499 a device to which this Candidate BSR is attached. 500 There is one entry for each zone in ipMcastZoneTable. 501 Scope-level information for this zone can be extracted 502 from ipMcastZoneTable in IP MCAST MIB" 503 ::= { pimBsrCandidateBSREntry 1 } 505 pimBsrCandidateBSRAddressType OBJECT-TYPE 506 SYNTAX InetAddressType 507 MAX-ACCESS read-create 508 STATUS current 509 DESCRIPTION 510 "The address type of the Candidate-BSR." 511 ::= { pimBsrCandidateBSREntry 2 } 513 pimBsrCandidateBSRAddress OBJECT-TYPE 514 SYNTAX InetAddress 515 MAX-ACCESS read-create 516 STATUS current 517 DESCRIPTION 518 "The (unicast) address that the local router will 519 use to advertise itself as a Candidate-BSR. The 520 InetAddressType is given by the 521 pimBsrCandidateBSRAddressType object." 522 ::= { pimBsrCandidateBSREntry 3 } 524 pimBsrCandidateBSRPriority OBJECT-TYPE 525 SYNTAX Unsigned32 (0..255) 526 MAX-ACCESS read-create 527 STATUS current 528 DESCRIPTION 529 "The priority value for the local router as a 530 Candidate-BSR for this zone. Numerically higher 531 values for this object indicate higher priorities." 532 DEFVAL { 0 } 533 ::= { pimBsrCandidateBSREntry 4 } 535 pimBsrCandidateBSRHashMaskLength OBJECT-TYPE 536 SYNTAX Unsigned32 (0..128) 537 MAX-ACCESS read-create 538 STATUS current 539 DESCRIPTION 540 "The hash mask length (used in the RP hash function) 541 that the local router will advertise in its Bootstrap 542 messages for this zone. This object defaults 543 to 30 if pimBsrCandidateBSRAddressType is 'ipv4' or 544 'ipv4z' , and defaults to 126 if 545 pimBsrCandidateBSRAddressType is 'ipv6' or 'ipv6z'." 546 ::= { pimBsrCandidateBSREntry 5 } 548 pimBsrCandidateBSRElectedBSR OBJECT-TYPE 549 SYNTAX TruthValue 550 MAX-ACCESS read-only 551 STATUS current 552 DESCRIPTION 553 "Whether the local router is the elected BSR for this 554 zone." 555 ::= { pimBsrCandidateBSREntry 6 } 557 pimBsrCandidateBSRBootstrapTimer OBJECT-TYPE 558 SYNTAX TimeTicks 559 MAX-ACCESS read-only 560 STATUS current 561 DESCRIPTION 562 "The time remaining before the local router next 563 originates a Bootstrap message for this zone. 564 Value of this object is zero if 565 pimBsrCandidateBSRElectedBSR is 'FALSE'." 566 ::= { pimBsrCandidateBSREntry 7 } 568 pimBsrCandidateBSRStatus OBJECT-TYPE 569 SYNTAX RowStatus 570 MAX-ACCESS read-create 571 STATUS current 572 DESCRIPTION 573 "The status of this row, by which new entries may 574 be created, or old entries deleted from this table." 575 ::= { pimBsrCandidateBSREntry 8 } 577 -- 578 -- The BSR Elected-BSR Table 579 -- 581 pimBsrElectedBSRTable OBJECT-TYPE 582 SYNTAX SEQUENCE OF PimBsrElectedBSREntry 583 MAX-ACCESS not-accessible 584 STATUS current 585 DESCRIPTION 586 "The (conceptual) table containing information about 587 elected BSRs. The table contains one row for each 588 zone for which there is an elected BSR." 589 ::= { pimBsrObjects 4 } 591 pimBsrElectedBSREntry OBJECT-TYPE 592 SYNTAX PimBsrElectedBSREntry 593 MAX-ACCESS not-accessible 594 STATUS current 595 DESCRIPTION 596 "An entry (conceptual row) in the 597 pimBsrElectedBSRTable." 598 INDEX { pimBsrElectedBSRZoneIndex } 599 ::= { pimBsrElectedBSRTable 1 } 601 PimBsrElectedBSREntry ::= SEQUENCE { 602 pimBsrElectedBSRZoneIndex InetZoneIndex, 603 pimBsrElectedBSRAddressType InetAddressType, 604 pimBsrElectedBSRAddress InetAddress, 605 pimBsrElectedBSRPriority Unsigned32, 606 pimBsrElectedBSRHashMaskLength Unsigned32, 607 pimBsrElectedBSRExpiryTime TimeTicks 608 } 610 pimBsrElectedBSRZoneIndex OBJECT-TYPE 611 SYNTAX InetZoneIndex 612 MAX-ACCESS not-accessible 613 STATUS current 614 DESCRIPTION 615 "The zone index uniquely identifies the zone on a 616 device to which this Elected BSR is attached. There 617 is one entry for each zone in ipMcastZoneTable. 618 Scope-level information for this zone can be extracted 619 from ipMcastZoneTable in IP MCAST MIB." 620 ::= { pimBsrElectedBSREntry 1 } 622 pimBsrElectedBSRAddressType OBJECT-TYPE 623 SYNTAX InetAddressType 624 MAX-ACCESS not-accessible 625 STATUS current 626 DESCRIPTION 627 "The address type of the elected BSR." 628 ::= { pimBsrElectedBSREntry 2 } 630 pimBsrElectedBSRAddress OBJECT-TYPE 631 SYNTAX InetAddress (SIZE (4|8|16|20)) 632 MAX-ACCESS read-only 633 STATUS current 634 DESCRIPTION 635 "The (unicast) address of the elected BSR. The 636 InetAddressType is given by the 637 pimBsrElectedBSRAddressType object." 638 ::= { pimBsrElectedBSREntry 3 } 640 pimBsrElectedBSRPriority OBJECT-TYPE 641 SYNTAX Unsigned32 (0..255) 642 MAX-ACCESS read-only 643 STATUS current 644 DESCRIPTION 645 "The priority value for the elected BSR for this address 646 type. Numerically higher values for this object indicate 647 higher priorities." 648 ::= { pimBsrElectedBSREntry 4 } 650 pimBsrElectedBSRHashMaskLength OBJECT-TYPE 651 SYNTAX Unsigned32 (0..128) 652 MAX-ACCESS read-only 653 STATUS current 654 DESCRIPTION 655 "The hash mask length (used in the RP hash function) 656 advertised by the elected BSR for this zone." 657 ::= { pimBsrElectedBSREntry 5 } 659 pimBsrElectedBSRExpiryTime OBJECT-TYPE 660 SYNTAX TimeTicks 661 MAX-ACCESS read-only 662 STATUS current 663 DESCRIPTION 664 "The minimum time remaining before the elected BSR for 665 this zone will be declared down." 666 ::= { pimBsrElectedBSREntry 6 } 668 -- 669 -- PIM BSR Notifications 670 -- 672 pimBsrElectedBSRLostElection NOTIFICATION-TYPE 673 OBJECTS { pimBsrCandidateBSRElectedBSR } 674 STATUS current 675 DESCRIPTION 676 "A pimBsrElectedBSRLostElection notification should be 677 generated when current E-BSR lost election to a new 678 Candidate BSR. Only an E-BSR should generate this 679 notification. 681 This notification is generated when 682 pimBsrCandidateBSRElectedBSR becomes FALSE." 684 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 685 ::= { pimBsrNotifications 1 } 687 pimBsrCandidateBSRWinElection NOTIFICATION-TYPE 688 OBJECTS { pimBsrCandidateBSRElectedBSR } 689 STATUS current 690 DESCRIPTION 691 "A pimBsrCandidateBSRWinElection notification should be 692 generated when a C-BSR wins BSR Election. Only an 693 E-BSR should generate this notification. 695 This notification is generated when 696 pimBsrCandidateBSRElectedBSR becomes TRUE." 698 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 699 ::= { pimBsrNotifications 2 } 701 -- 702 -- Compliance Statements 703 -- 705 pimBsrCompliance MODULE-COMPLIANCE 706 STATUS current 707 DESCRIPTION 708 "The compliance statement for PIM routers that implement 709 the Bootstrap Router (BSR) mechanism." 710 MODULE -- this module 711 MANDATORY-GROUPS { pimBsrObjectGroup } 713 GROUP pimBsrDiagnosticsGroup 714 DESCRIPTION 715 "This group is optional." 717 ::= { pimBsrCompliances 1 } 719 -- 720 -- Units of Conformance 721 -- 723 pimBsrObjectGroup OBJECT-GROUP 724 OBJECTS { pimBsrCandidateRPBidir, 725 pimBsrCandidateRPAdvTimer, 726 pimBsrCandidateRPPriority, 727 pimBsrCandidateRPAdvInterval, 728 pimBsrCandidateRPHoldtime, 729 pimBsrCandidateRPStatus, 730 pimBsrElectedBSRRPSetPriority, 731 pimBsrElectedBSRRPSetHoldtime, 732 pimBsrElectedBSRRPSetExpiryTime, 733 pimBsrElectedBSRRPSetGrpBidir, 734 pimBsrCandidateBSRAddress, 735 pimBsrCandidateBSRPriority, 736 pimBsrCandidateBSRHashMaskLength, 737 pimBsrCandidateBSRElectedBSR, 738 pimBsrCandidateBSRBootstrapTimer, 739 pimBsrCandidateBSRStatus, 740 pimBsrElectedBSRAddress, 741 pimBsrElectedBSRPriority, 742 pimBsrElectedBSRHashMaskLength, 743 pimBsrElectedBSRExpiryTime } 744 STATUS current 745 DESCRIPTION 746 "A collection of objects for managing the Bootstrap 747 Router (BSR) mechanism for PIM routers." 748 ::= { pimBsrGroups 1 } 750 pimBsrDiagnosticsGroup NOTIFICATION-GROUP 751 NOTIFICATIONS { pimBsrElectedBSRLostElection, 752 pimBsrCandidateBSRWinElection } 753 STATUS current 754 DESCRIPTION 755 "Objects providing additional diagnostics related to 756 the Bootstrap Router (BSR) mechanism for PIM routers." 757 ::= { pimBsrGroups 2 } 759 END 761 6. Security Considerations 763 SNMP versions prior to SNMPv3 did not include adequate security. 764 Even if the network itself is secure (for example by using IPSec), 765 there is still no control over who on the secure network is allowed 766 to access (read/change/create/delete) the objects in this MIB module. 767 The support for SET operations in a non-secure environment without 768 proper protection can have a negative effect on network operations. 770 In this MIB module, possible effects that can be induced by SET 771 operations on writable objects include: 773 o A new Candidate BSR with high priority or modification of priority 774 of an existing candidate BSR can take over the functionality of 775 Elected BSR, which can prevent and disrupt the services. 777 o A new Candidate RP with lower priority or modification of priority 778 of an existing Candidate RP can force other routers to select 779 itself for a particular group prefix. This can prevent and 780 disrupt the services provided through this group prefix. 782 The following are the read-write and read-create objects defined in 783 this MIB module: 785 bsrCandidateRPBidir 786 bsrCandidateRPPriority 787 bsrCandidateRPAdvInterval 788 bsrCandidateRPHoldtime 789 bsrCandidateBSRAddressType 790 bsrCandidateBSRAddress 791 bsrCandidateBSRPriority 792 bsrCandidateBSRHashMaskLength 794 Some of the readable objects in this MIB module (i.e., objects with a 795 MAX-ACCESS other than not-accessible) may be considered sensitive or 796 vulnerable in some network environments. It is thus important to 797 control even GET and/or NOTIFY access to these objects and possibly 798 to even encrypt the values of these objects when sending them over 799 the network via SNMP. 801 In this MIB module, possible effects that can be induced by GET 802 and/or NOTIFY operations include: 804 o Determination of Elected BSR, Candidate BSRs and Candidate RPs in 805 the Multicast Network topology. This information may be sensitive 806 and may be used in preparation for DoS attacks including any of 807 the attacks described above. 809 SNMP versions prior to SNMPv3 did not include adequate security. 810 Even if the network itself is secure (for example by using IPSec), 811 there is still no control over whom on the secure network is allowed 812 to access (read/change/create/delete) the objects in this MIB module. 814 It is RECOMMENDED that implementers consider the security features as 815 provided by the SNMPv3 framework (see [RFC3410], section 8), 816 including full support for the SNMPv3 cryptographic mechanisms (for 817 authentication and privacy). 819 Further, deployment of SNMP versions prior to SNMPv3 is NOT 820 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 821 enable cryptographic security. It is then a customer/operator 822 responsibility to ensure that the SNMP entity giving access to an 823 instance of this MIB module is properly configured to give access to 824 the objects only to those principals (users) that have legitimate 825 rights to access (read/change/create/delete) them. 827 7. IANA Considerations 829 PIM-BSR-MIB should be rooted under the mib-2 subtree. IANA is 830 requested to assign { mib-2 XXX } to the PIM-BSR-MIB module specified 831 in this document. 833 8. Acknowledgments 835 This MIB module is based on the original work in 836 [I-D.ietf-pim-mib-v2] by R. Sivaramu, J. Lingard and B. Joshi. 838 Many thanks to Stig Venaas, Nidhi Bhaskar, David Mcwalter, David 839 Harrington and J. W. Atwood for their feedback on this MIB module. 841 Suggested IPv6 multicast MIBs by R. Sivaramu and R. Raghunarayan have 842 been used for comparison while editing this MIB module. 844 9. References 846 9.1. Normative References 848 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 849 Requirement Levels", BCP 14, RFC 2119, March 1997. 851 [RFC2365] Meyer, D., "Administratively Scoped IP Multicast", BCP 23, 852 RFC 2365, July 1998. 854 [RFC2434] Narten, T. and H. Alvestrand, "Guidelines for Writing an 855 IANA Considerations Section in RFCs", BCP 26, RFC 2434, 856 October 1998. 858 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 859 Schoenwaelder, Ed., "Structure of Management Information 860 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 862 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 863 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 864 STD 58, RFC 2579, April 1999. 866 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 867 "Conformance Statements for SMIv2", STD 58, RFC 2580, 868 April 1999. 870 [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group 871 MIB", RFC 2863, June 2000. 873 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 874 Schoenwaelder, "Textual Conventions for Internet Network 875 Addresses", RFC 4001, February 2005. 877 [RFC4601] Fenner, B., Handley, M., Holbrook, H., and I. Kouvelas, 878 "Protocol Independent Multicast - Sparse Mode (PIM-SM): 879 Protocol Specification (Revised)", RFC 4601, August 2006. 881 [I-D.ietf-pim-mib-v2] 882 Lingard, J., "Protocol Independent Multicast MIB", 883 draft-ietf-pim-mib-v2-06 (work in progress), April 2006. 885 [I-D.ietf-pim-sm-bsr] 886 Bhaskar, N., "Bootstrap Router (BSR) Mechanism for PIM", 887 draft-ietf-pim-sm-bsr-08 (work in progress), May 2006. 889 [I-D.ietf-mboned-ip-mcast-mib] 890 McWalter, D., "IP Multicast MIB", 891 draft-ietf-mboned-ip-mcast-mib-03 (work in progress), 892 August 2006. 894 9.2. Informative References 896 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 897 "Introduction and Applicability Statements for Internet- 898 Standard Management Framework", RFC 3410, December 2002. 900 Authors' Addresses 902 Bharat Joshi 903 Infosys Technologies Ltd. 904 44 Electronics City, Hosur Road 905 Bangalore 560 100 906 India 908 Email: bharat_joshi@infosys.com 909 URI: http://www.infosys.com/ 911 Raina Bijlani 912 Cisco Systems 913 170 W.Tasman Drive 914 San Jose CA 95134 915 USA 917 Email: rainab@cisco.com 919 Intellectual Property Statement 921 The IETF takes no position regarding the validity or scope of any 922 Intellectual Property Rights or other rights that might be claimed to 923 pertain to the implementation or use of the technology described in 924 this document or the extent to which any license under such rights 925 might or might not be available; nor does it represent that it has 926 made any independent effort to identify any such rights. Information 927 on the procedures with respect to rights in RFC documents can be 928 found in BCP 78 and BCP 79. 930 Copies of IPR disclosures made to the IETF Secretariat and any 931 assurances of licenses to be made available, or the result of an 932 attempt made to obtain a general license or permission for the use of 933 such proprietary rights by implementers or users of this 934 specification can be obtained from the IETF on-line IPR repository at 935 http://www.ietf.org/ipr. 937 The IETF invites any interested party to bring to its attention any 938 copyrights, patents or patent applications, or other proprietary 939 rights that may cover technology that may be required to implement 940 this standard. Please address the information to the IETF at 941 ietf-ipr@ietf.org. 943 Disclaimer of Validity 945 This document and the information contained herein are provided on an 946 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 947 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 948 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 949 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 950 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 951 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 953 Copyright Statement 955 Copyright (C) The Internet Society (2006). This document is subject 956 to the rights, licenses and restrictions contained in BCP 78, and 957 except as set forth therein, the authors retain all their rights. 959 Acknowledgment 961 Funding for the RFC Editor function is currently provided by the 962 Internet Society.