idnits 2.17.1 draft-ietf-pim-bsr-mib-06.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, updated by RFC 4748 on line 1028. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1005. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1012. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1018. 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 IETF Trust 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 (May 5, 2008) is 5827 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 normative reference: RFC 4601 (Obsoleted by RFC 7761) Summary: 2 errors (**), 0 flaws (~~), 3 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: November 6, 2008 R. Bijlani 5 May 5, 2008 7 PIM Bootstrap Router MIB 8 draft-ietf-pim-bsr-mib-06.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 19 other groups may also distribute working documents as Internet- 20 Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six months 23 and may be updated, replaced, or obsoleted by other documents at any 24 time. It is inappropriate to use Internet-Drafts as reference 25 material or to cite them other than as "work in progress." 27 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt. 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 This Internet-Draft will expire on November 6, 2008. 35 Copyright Notice 37 Copyright (C) The IETF Trust (2008). 39 Abstract 41 This document defines a portion of the Management Information Base 42 (MIB) for use with network management protocols in the Internet 43 community. In particular, it describes managed objects used for 44 managing the Bootstrap Router (BSR) mechanism for PIM (Protocol 45 Independent Multicast). 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 . . . . . . . . . . . . . . . . . . . 19 55 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20 56 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 21 57 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 21 58 9.1. Normative References . . . . . . . . . . . . . . . . . . . 21 59 9.2. Informative References . . . . . . . . . . . . . . . . . . 22 60 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 23 61 Intellectual Property and Copyright Statements . . . . . . . . . . 24 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], [RFC5059]. 70 This document was created by moving some of the PIM BSR specific MIB 71 tables from one of the earlier version of PIM MIB [RFC5060]. 73 2. The Internet-Standard Management Framework 75 For a detailed overview of the documents that describe the current 76 Internet-Standard Management Framework, please refer to section 7 of 77 RFC 3410[RFC3410]. 79 Managed objects are accessed via a virtual information store, termed 80 the Management Information Base or MIB. MIB objects are generally 81 accessed through the Simple Network Management Protocol (SNMP). 82 Objects in the MIB are defined using the mechanisms defined in the 83 Structure of Management Information (SMI). This memo specifies a MIB 84 module that is compliant to the SMIv2, which is described in STD 58, 85 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 86 [RFC2580]. 88 3. Conventions 90 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 91 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 92 document are to be interpreted as described in RFC 2119 [RFC2119]. 94 4. Overview 96 This MIB module contains four tables. The tables are: 98 1. The Candidate-RP Table, which contains one row for each multicast 99 group address prefix for which the local router is configured to 100 advertise itself as a Candidate-RP. This table exists on routers 101 that are configured as Candidate-RP. 103 2. The Elected BSR RP-Set Table, which contains one row for each 104 Group-to-RP mapping that was received in C-RP advertisements. 105 This table exists on a router that is an elected BSR. 107 3. The Candidate-BSR Table, which contains one row for each 108 Candidate-BSR configuration for the local router. This table 109 exists on routers that are configured as Candidate-BSR. 111 4. The Elected BSR Table, which contains one row for each elected 112 BSR. This table exists on a router that is an elected BSR. 114 This MIB module uses textual conventions defined in the INET-ADDRESS- 115 MIB [RFC4001]. 117 5. Definitions 119 PIM-BSR-MIB DEFINITIONS ::= BEGIN 121 IMPORTS 122 MODULE-IDENTITY, OBJECT-TYPE, 123 NOTIFICATION-TYPE, 124 mib-2, Unsigned32, TimeTicks FROM SNMPv2-SMI 125 RowStatus, TruthValue, 126 StorageType FROM SNMPv2-TC 127 MODULE-COMPLIANCE, OBJECT-GROUP, 128 NOTIFICATION-GROUP FROM SNMPv2-CONF 129 InetAddressType, 130 InetAddressPrefixLength, 131 InetAddress, 132 InetZoneIndex FROM INET-ADDRESS-MIB; 134 pimBsrMIB MODULE-IDENTITY 135 LAST-UPDATED "200804300000Z" -- 30 April 2008 136 ORGANIZATION 137 "IETF Protocol Independent Multicast (PIM) Working Group" 138 CONTACT-INFO 139 "Email: pim@ietf.org 140 WG charter: 141 http://www.ietf.org/html.charters/pim-charter.html" 142 DESCRIPTION 143 "The MIB module for management of the Bootstrap Router 144 (BSR) mechanism for PIM routers. 146 Copyright (C) The IETF Trust (2008). This version 147 of this MIB module is part of RFC yyyy; see the RFC 148 itself for full legal notices." 149 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 150 REVISION "200804300000Z" -- 30 April 2008 151 DESCRIPTION "Initial version, published as RFC yyyy." 152 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 153 ::= { mib-2 XXX } 154 -- RFC Ed.: replace XXX with IANA-assigned number & remove this note 156 -- 157 -- Top-level structure 158 -- 160 pimBsrNotifications OBJECT IDENTIFIER ::= { pimBsrMIB 0 } 161 pimBsrObjects OBJECT IDENTIFIER ::= { pimBsrMIB 1 } 163 -- 164 -- Conformance Information 165 -- 167 pimBsrConformance OBJECT IDENTIFIER ::= { pimBsrMIB 2 } 168 pimBsrCompliances OBJECT IDENTIFIER ::= { pimBsrConformance 1 } 169 pimBsrGroups OBJECT IDENTIFIER ::= { pimBsrConformance 2 } 171 -- 172 -- The BSR Candidate-RP Table 173 -- 175 pimBsrCandidateRPTable OBJECT-TYPE 176 SYNTAX SEQUENCE OF PimBsrCandidateRPEntry 177 MAX-ACCESS not-accessible 178 STATUS current 179 DESCRIPTION 180 "The (conceptual) table listing the IP multicast group 181 prefixes for which the local router is to advertise 182 itself as a Candidate-RP." 183 ::= { pimBsrObjects 1 } 185 pimBsrCandidateRPEntry OBJECT-TYPE 186 SYNTAX PimBsrCandidateRPEntry 187 MAX-ACCESS not-accessible 188 STATUS current 189 DESCRIPTION 190 "An entry (conceptual row) in the 191 pimBsrCandidateRPTable." 192 INDEX { pimBsrCandidateRPAddressType, 193 pimBsrCandidateRPAddress, 194 pimBsrCandidateRPGroupAddress, 195 pimBsrCandidateRPGroupPrefixLength } 196 ::= { pimBsrCandidateRPTable 1 } 198 PimBsrCandidateRPEntry ::= SEQUENCE { 199 pimBsrCandidateRPAddressType InetAddressType, 200 pimBsrCandidateRPAddress InetAddress, 201 pimBsrCandidateRPGroupAddress InetAddress, 202 pimBsrCandidateRPGroupPrefixLength InetAddressPrefixLength, 203 pimBsrCandidateRPBidir TruthValue, 204 pimBsrCandidateRPAdvTimer TimeTicks, 205 pimBsrCandidateRPPriority Unsigned32, 206 pimBsrCandidateRPAdvInterval Unsigned32, 207 pimBsrCandidateRPHoldtime Unsigned32, 208 pimBsrCandidateRPStatus RowStatus, 209 pimBsrCandidateRPStorageType StorageType 210 } 212 pimBsrCandidateRPAddressType OBJECT-TYPE 213 SYNTAX InetAddressType 214 MAX-ACCESS not-accessible 215 STATUS current 216 DESCRIPTION 217 "The Inet address type of the Candidate-RP." 218 ::= { pimBsrCandidateRPEntry 1 } 220 pimBsrCandidateRPAddress OBJECT-TYPE 221 SYNTAX InetAddress (SIZE (4|8|16|20)) 222 MAX-ACCESS not-accessible 223 STATUS current 224 DESCRIPTION 225 "The (unicast) address that will be advertised as a 226 Candidate-RP. The InetAddressType is given by the 227 pimBsrCandidateRPAddressType object." 228 ::= { pimBsrCandidateRPEntry 2 } 230 pimBsrCandidateRPGroupAddress OBJECT-TYPE 231 SYNTAX InetAddress (SIZE (4|8|16|20)) 232 MAX-ACCESS not-accessible 233 STATUS current 234 DESCRIPTION 235 "The IP multicast group address that, when combined with 236 the corresponding value of 237 pimBsrCandidateRPGroupPrefixLength, identifies a group 238 prefix for which the local router will advertise itself 239 as a Candidate-RP. The InetAddressType is given by the 240 pimBsrCandidateRPAddressType object. 242 This address object is only significant up to 243 pimBsrCandidateRPGroupPrefixLength bits. The 244 remainder of the address bits are zero. This is 245 especially important for this field, which is part of 246 the index of this entry. Any non-zero bits would 247 signify an entirely different entry." 248 ::= { pimBsrCandidateRPEntry 3 } 250 pimBsrCandidateRPGroupPrefixLength OBJECT-TYPE 251 SYNTAX InetAddressPrefixLength (4..128) 252 MAX-ACCESS not-accessible 253 STATUS current 254 DESCRIPTION 255 "The multicast group address mask that, when combined 256 with the corresponding value of 257 pimBsrCandidateRPGroupAddress, identifies a group prefix 258 for which the local router will advertise itself as a 259 Candidate-RP. The InetAddressType is given by the 260 pimBsrCandidateRPAddressType object." 261 ::= { pimBsrCandidateRPEntry 4 } 263 pimBsrCandidateRPBidir OBJECT-TYPE 264 SYNTAX TruthValue 265 MAX-ACCESS read-create 266 STATUS current 267 DESCRIPTION 268 "If this object is set to TRUE, this group range is 269 advertised with this RP as a BIDIR-PIM group range. If 270 it is set to FALSE, it is advertised as a PIM-SM group 271 range." 272 DEFVAL { false } 273 ::= { pimBsrCandidateRPEntry 5 } 275 pimBsrCandidateRPAdvTimer OBJECT-TYPE 276 SYNTAX TimeTicks 277 MAX-ACCESS read-only 278 STATUS current 279 DESCRIPTION 280 "The time remaining before the local router next sends 281 a Candidate-RP-Advertisement to the elected BSR for 282 this zone." 283 ::= { pimBsrCandidateRPEntry 6 } 285 pimBsrCandidateRPPriority OBJECT-TYPE 286 SYNTAX Unsigned32 (0..255) 287 MAX-ACCESS read-create 288 STATUS current 289 DESCRIPTION 290 "The priority for this Candidate RP advertised in 291 Candidate-RP-Advertisements." 292 REFERENCE "RFC5059 section 3.2" 293 DEFVAL { 192 } 294 ::= { pimBsrCandidateRPEntry 7 } 296 pimBsrCandidateRPAdvInterval OBJECT-TYPE 297 SYNTAX Unsigned32 (1..26214) 298 UNITS "seconds" 299 MAX-ACCESS read-create 300 STATUS current 301 DESCRIPTION 302 "A Candidate RP generates Candidate-RP-Advertisements 303 periodically. This object represents the time interval 304 in seconds between two consecutive advertisements." 306 REFERENCE "RFC5059 section 3.2 and section 5" 307 DEFVAL { 60 } 309 ::= { pimBsrCandidateRPEntry 8 } 311 pimBsrCandidateRPHoldtime OBJECT-TYPE 312 SYNTAX Unsigned32 (0..65535) 313 UNITS "seconds" 314 MAX-ACCESS read-create 315 STATUS current 316 DESCRIPTION 317 "Holdtime for this Candidate RP. The amount of time (in 318 seconds) this Candidate-RP entry is valid. 320 This object's value can be zero only when this C-RP is 321 shutting down" 323 REFERENCE "RFC5059 section 4.2" 324 DEFVAL { 150 } 326 ::= { pimBsrCandidateRPEntry 9 } 328 pimBsrCandidateRPStatus OBJECT-TYPE 329 SYNTAX RowStatus 330 MAX-ACCESS read-create 331 STATUS current 332 DESCRIPTION 333 "The status of this row, by which new entries may be 334 created, or old entries deleted from this table. 336 This status object can be set to active(1) without 337 setting any other columnar objects in this entry 339 All writable objects in this entry can be modified 340 when the status of this entry is active(1)." 342 ::= { pimBsrCandidateRPEntry 10 } 344 pimBsrCandidateRPStorageType OBJECT-TYPE 345 SYNTAX StorageType 346 MAX-ACCESS read-create 347 STATUS current 348 DESCRIPTION 349 "The storage type for this row. Rows having the value 350 'permanent' need not allow write-access to any columnar 351 objects in the row." 352 DEFVAL { nonVolatile } 353 ::= { pimBsrCandidateRPEntry 11 } 355 -- 356 -- The BSR Elected BSR RP-Set Table 357 -- 359 pimBsrElectedBSRRPSetTable OBJECT-TYPE 360 SYNTAX SEQUENCE OF PimBsrElectedBSRRPSetEntry 361 MAX-ACCESS not-accessible 362 STATUS current 363 DESCRIPTION 364 "The (conceptual) table listing BSR-specific information 365 about PIM group mappings learned via C-RP advertisements 366 or created locally using configurations. This table is 367 maintained only on the Elected BSR. 369 An Elected BSR uses this table to create Bootstrap 370 Messages after applying a local policy to include some 371 or all of the group mappings in this table." 373 ::= { pimBsrObjects 2 } 375 pimBsrElectedBSRRPSetEntry OBJECT-TYPE 376 SYNTAX PimBsrElectedBSRRPSetEntry 377 MAX-ACCESS not-accessible 378 STATUS current 379 DESCRIPTION 380 "An entry (conceptual row) in the 381 pimBsrElectedBSRRPSetTable." 382 INDEX { pimBsrElectedBSRGrpMappingAddrType, 383 pimBsrElectedBSRGrpMappingGrpAddr, 384 pimBsrElectedBSRGrpMappingGrpPrefixLen, 385 pimBsrElectedBSRGrpMappingRPAddr } 386 ::= { pimBsrElectedBSRRPSetTable 1 } 388 PimBsrElectedBSRRPSetEntry ::= SEQUENCE { 389 pimBsrElectedBSRGrpMappingAddrType InetAddressType, 390 pimBsrElectedBSRGrpMappingGrpAddr InetAddress, 391 pimBsrElectedBSRGrpMappingGrpPrefixLen InetAddressPrefixLength, 392 pimBsrElectedBSRGrpMappingRPAddr InetAddress, 393 pimBsrElectedBSRRPSetPriority Unsigned32, 394 pimBsrElectedBSRRPSetHoldtime Unsigned32, 395 pimBsrElectedBSRRPSetExpiryTime TimeTicks, 396 pimBsrElectedBSRRPSetGrpBidir TruthValue 397 } 399 pimBsrElectedBSRGrpMappingAddrType OBJECT-TYPE 400 SYNTAX InetAddressType 401 MAX-ACCESS not-accessible 402 STATUS current 403 DESCRIPTION 404 "The Inet address type of the IP multicast group 405 prefix." 406 ::= { pimBsrElectedBSRRPSetEntry 2 } 408 pimBsrElectedBSRGrpMappingGrpAddr OBJECT-TYPE 409 SYNTAX InetAddress (SIZE (4|8|16|20)) 410 MAX-ACCESS not-accessible 411 STATUS current 412 DESCRIPTION 413 "The IP multicast group address which, when combined 414 with pimBsrElectedBSRGrpMappingGrpPrefixLen, gives the 415 group prefix for this mapping. The InetAddressType is 416 given by the pimBsrElectedBSRGrpMappingAddrType object. 418 This address object is only significant up to 419 pimBsrElectedBSRGrpMappingGrpPrefixLen bits. The 420 remainder of the address bits are zero. This is 421 especially important for this field, which is part of 422 the index of this entry. Any non-zero bits would 423 signify an entirely different entry." 424 ::= { pimBsrElectedBSRRPSetEntry 3 } 426 pimBsrElectedBSRGrpMappingGrpPrefixLen OBJECT-TYPE 427 SYNTAX InetAddressPrefixLength (4..128) 428 MAX-ACCESS not-accessible 429 STATUS current 430 DESCRIPTION 431 "The multicast group prefix length that, when combined 432 with pimBsrElectedBSRGrpMappingGrpAddr, gives the group 433 prefix for this mapping. The InetAddressType is given by 434 the pimBsrElectedBSRGrpMappingAddrType object. If 435 pimBsrElectedBSRGrpMappingAddrType is 'ipv4' or 'ipv4z', 436 this object must be in the range 4..32. If 437 pimBsrElectedBSRGrpMappingAddrType is 'ipv6' or 'ipv6z', 438 this object must be in the range 8..128." 439 ::= { pimBsrElectedBSRRPSetEntry 4 } 441 pimBsrElectedBSRGrpMappingRPAddr OBJECT-TYPE 442 SYNTAX InetAddress (SIZE (4|8|16|20)) 443 MAX-ACCESS not-accessible 444 STATUS current 445 DESCRIPTION 446 "The IP address of the RP to be used for groups within 447 this group prefix. The InetAddressType is given by the 448 pimBsrElectedBSRGrpMappingAddrType object." 449 ::= { pimBsrElectedBSRRPSetEntry 5 } 451 pimBsrElectedBSRRPSetPriority OBJECT-TYPE 452 SYNTAX Unsigned32 (0..255) 453 MAX-ACCESS read-only 454 STATUS current 455 DESCRIPTION 456 "The priority for RP. Numerically higher values for 457 this object indicate lower priorities, with the value 458 zero denoting the highest priority." 459 REFERENCE "RFC5059 section 4.1" 460 ::= { pimBsrElectedBSRRPSetEntry 6 } 462 pimBsrElectedBSRRPSetHoldtime OBJECT-TYPE 463 SYNTAX Unsigned32 (0..65535) 464 UNITS "seconds" 465 MAX-ACCESS read-only 466 STATUS current 467 DESCRIPTION 468 "The holdtime for RP" 469 REFERENCE "RFC5059 section 4.1" 470 ::= { pimBsrElectedBSRRPSetEntry 7 } 472 pimBsrElectedBSRRPSetExpiryTime OBJECT-TYPE 473 SYNTAX TimeTicks 474 MAX-ACCESS read-only 475 STATUS current 476 DESCRIPTION 477 "The minimum time remaining before this entry will be 478 aged out. The value zero indicates that this entry will 479 never be aged out." 480 ::= { pimBsrElectedBSRRPSetEntry 8 } 482 pimBsrElectedBSRRPSetGrpBidir OBJECT-TYPE 483 SYNTAX TruthValue 484 MAX-ACCESS read-only 485 STATUS current 486 DESCRIPTION 487 "If this object is TRUE, this group range with this 488 RP is a BIDIR-PIM group range. If it is set to FALSE, 489 it is a PIM-SM group range." 490 ::= { pimBsrElectedBSRRPSetEntry 9 } 492 -- 493 -- The BSR Candidate-BSR Table 494 -- 496 pimBsrCandidateBSRTable OBJECT-TYPE 497 SYNTAX SEQUENCE OF PimBsrCandidateBSREntry 498 MAX-ACCESS not-accessible 499 STATUS current 500 DESCRIPTION 501 "The (conceptual) table containing Candidate-BSR 502 configuration for the local router. The table contains 503 one row for each zone for which the local router is 504 to advertise itself as a Candidate-BSR." 505 ::= { pimBsrObjects 3 } 507 pimBsrCandidateBSREntry OBJECT-TYPE 508 SYNTAX PimBsrCandidateBSREntry 509 MAX-ACCESS not-accessible 510 STATUS current 511 DESCRIPTION 512 "An entry (conceptual row) in the 513 pimBsrCandidateBSRTable." 514 INDEX { pimBsrCandidateBSRZoneIndex } 515 ::= { pimBsrCandidateBSRTable 1 } 517 PimBsrCandidateBSREntry ::= SEQUENCE { 518 pimBsrCandidateBSRZoneIndex InetZoneIndex, 519 pimBsrCandidateBSRAddressType InetAddressType, 520 pimBsrCandidateBSRAddress InetAddress, 521 pimBsrCandidateBSRPriority Unsigned32, 522 pimBsrCandidateBSRHashMaskLength Unsigned32, 523 pimBsrCandidateBSRElectedBSR TruthValue, 524 pimBsrCandidateBSRBootstrapTimer TimeTicks, 525 pimBsrCandidateBSRStatus RowStatus, 526 pimBsrCandidateBSRStorageType StorageType 527 } 529 pimBsrCandidateBSRZoneIndex OBJECT-TYPE 530 SYNTAX InetZoneIndex (1..4294967295) 531 MAX-ACCESS not-accessible 532 STATUS current 533 DESCRIPTION 534 "The zone index uniquely identifies the zone on a 535 device to which this Candidate BSR is attached. There is 536 one entry for each zone in ipMcastZoneTable. Scope-level 537 information for this zone can be extracted from 538 ipMcastZoneTable in IP Multicast MIB [RFC5132]. 540 Zero is a special value used to request the default zone 541 for a given scope. Zero is not a valid value for this 542 object." 544 ::= { pimBsrCandidateBSREntry 1 } 546 pimBsrCandidateBSRAddressType OBJECT-TYPE 547 SYNTAX InetAddressType 548 MAX-ACCESS read-create 549 STATUS current 550 DESCRIPTION 551 "The address type of the Candidate-BSR." 552 ::= { pimBsrCandidateBSREntry 2 } 554 pimBsrCandidateBSRAddress OBJECT-TYPE 555 SYNTAX InetAddress 556 MAX-ACCESS read-create 557 STATUS current 558 DESCRIPTION 559 "The (unicast) address that the local router will 560 use to advertise itself as a Candidate-BSR. The 561 InetAddressType is given by the 562 pimBsrCandidateBSRAddressType object." 563 ::= { pimBsrCandidateBSREntry 3 } 565 pimBsrCandidateBSRPriority OBJECT-TYPE 566 SYNTAX Unsigned32 (0..255) 567 MAX-ACCESS read-create 568 STATUS current 569 DESCRIPTION 570 "The priority value for the local router as a 571 Candidate-BSR for this zone. Numerically higher 572 values for this object indicate higher priorities." 573 DEFVAL { 0 } 574 ::= { pimBsrCandidateBSREntry 4 } 576 pimBsrCandidateBSRHashMaskLength OBJECT-TYPE 577 SYNTAX Unsigned32 (0..128) 578 MAX-ACCESS read-create 579 STATUS current 580 DESCRIPTION 581 "The hash mask length (used in the RP hash function) 582 that the local router will advertise in its Bootstrap 583 messages for this zone. This object defaults 584 to 30 if pimBsrCandidateBSRAddressType is 'ipv4' or 585 'ipv4z' , and defaults to 126 if 586 pimBsrCandidateBSRAddressType is 'ipv6' or 'ipv6z'." 587 ::= { pimBsrCandidateBSREntry 5 } 589 pimBsrCandidateBSRElectedBSR OBJECT-TYPE 590 SYNTAX TruthValue 591 MAX-ACCESS read-only 592 STATUS current 593 DESCRIPTION 594 "Whether the local router is the elected BSR for this 595 zone." 596 ::= { pimBsrCandidateBSREntry 6 } 598 pimBsrCandidateBSRBootstrapTimer OBJECT-TYPE 599 SYNTAX TimeTicks 600 MAX-ACCESS read-only 601 STATUS current 602 DESCRIPTION 603 "The time remaining before the local router next 604 originates a Bootstrap message for this zone. 605 Value of this object is zero if 606 pimBsrCandidateBSRElectedBSR is 'FALSE'." 607 ::= { pimBsrCandidateBSREntry 7 } 609 pimBsrCandidateBSRStatus OBJECT-TYPE 610 SYNTAX RowStatus 611 MAX-ACCESS read-create 612 STATUS current 613 DESCRIPTION 614 "The status of this row, by which new entries may 615 be created, or old entries deleted from this table. 617 This status object can be set to active(1) without 618 setting any other columnar objects in this entry 620 All writable objects in this entry can be modified 621 when the status of this entry is active(1)." 622 ::= { pimBsrCandidateBSREntry 8 } 624 pimBsrCandidateBSRStorageType OBJECT-TYPE 625 SYNTAX StorageType 626 MAX-ACCESS read-create 627 STATUS current 628 DESCRIPTION 629 "The storage type for this row. Rows having the value 630 'permanent' need not allow write-access to any columnar 631 objects in the row." 632 DEFVAL { nonVolatile } 634 ::= { pimBsrCandidateBSREntry 9 } 636 -- 637 -- The BSR Elected-BSR Table 638 -- 640 pimBsrElectedBSRTable OBJECT-TYPE 641 SYNTAX SEQUENCE OF PimBsrElectedBSREntry 642 MAX-ACCESS not-accessible 643 STATUS current 644 DESCRIPTION 645 "The (conceptual) table containing information about 646 elected BSRs. The table contains one row for each 647 zone for which there is an elected BSR." 648 ::= { pimBsrObjects 4 } 650 pimBsrElectedBSREntry OBJECT-TYPE 651 SYNTAX PimBsrElectedBSREntry 652 MAX-ACCESS not-accessible 653 STATUS current 654 DESCRIPTION 655 "An entry (conceptual row) in the 656 pimBsrElectedBSRTable." 657 INDEX { pimBsrElectedBSRZoneIndex } 658 ::= { pimBsrElectedBSRTable 1 } 660 PimBsrElectedBSREntry ::= SEQUENCE { 661 pimBsrElectedBSRZoneIndex InetZoneIndex, 662 pimBsrElectedBSRAddressType InetAddressType, 663 pimBsrElectedBSRAddress InetAddress, 664 pimBsrElectedBSRPriority Unsigned32, 665 pimBsrElectedBSRHashMaskLength Unsigned32, 666 pimBsrElectedBSRExpiryTime TimeTicks 667 } 669 pimBsrElectedBSRZoneIndex OBJECT-TYPE 670 SYNTAX InetZoneIndex (1..4294967295) 671 MAX-ACCESS not-accessible 672 STATUS current 673 DESCRIPTION 674 "The zone index uniquely identifies the zone on a 675 device to which this Elected BSR is attached. There 676 is one entry for each zone in ipMcastZoneTable. 677 Scope-level information for this zone can be extracted 678 from ipMcastZoneTable in IP MCAST MIB. 680 Zero is a special value used to request the default zone 681 for a given scope. Zero is not a valid value for this 682 object." 684 ::= { pimBsrElectedBSREntry 1 } 686 pimBsrElectedBSRAddressType OBJECT-TYPE 687 SYNTAX InetAddressType 688 MAX-ACCESS read-only 689 STATUS current 690 DESCRIPTION 691 "The address type of the elected BSR." 692 ::= { pimBsrElectedBSREntry 2 } 694 pimBsrElectedBSRAddress OBJECT-TYPE 695 SYNTAX InetAddress (SIZE (4|8|16|20)) 696 MAX-ACCESS read-only 697 STATUS current 698 DESCRIPTION 699 "The (unicast) address of the elected BSR. The 700 InetAddressType is given by the 701 pimBsrElectedBSRAddressType object." 702 ::= { pimBsrElectedBSREntry 3 } 704 pimBsrElectedBSRPriority OBJECT-TYPE 705 SYNTAX Unsigned32 (0..255) 706 MAX-ACCESS read-only 707 STATUS current 708 DESCRIPTION 709 "The priority value for the elected BSR for this address 710 type. Numerically higher values for this object indicate 711 higher priorities." 712 ::= { pimBsrElectedBSREntry 4 } 714 pimBsrElectedBSRHashMaskLength OBJECT-TYPE 715 SYNTAX Unsigned32 (0..128) 716 MAX-ACCESS read-only 717 STATUS current 718 DESCRIPTION 719 "The hash mask length (used in the RP hash function) 720 advertised by the elected BSR for this zone." 721 ::= { pimBsrElectedBSREntry 5 } 723 pimBsrElectedBSRExpiryTime OBJECT-TYPE 724 SYNTAX TimeTicks 725 MAX-ACCESS read-only 726 STATUS current 727 DESCRIPTION 728 "The minimum time remaining before the elected BSR for 729 this zone will be declared down." 731 ::= { pimBsrElectedBSREntry 6 } 733 -- 734 -- PIM BSR Notifications 735 -- 737 pimBsrElectedBSRLostElection NOTIFICATION-TYPE 738 OBJECTS { pimBsrElectedBSRAddressType, 739 pimBsrElectedBSRAddress, 740 pimBsrElectedBSRPriority } 741 STATUS current 742 DESCRIPTION 743 "A pimBsrElectedBSRLostElection notification should be 744 generated when current E-BSR lost election to a new 745 Candidate BSR. Only an E-BSR should generate this 746 notification. 748 This notification is generated when 749 pimBsrCandidateBSRElectedBSR becomes FALSE." 751 REFERENCE "RFC5059 section 3.1" 752 ::= { pimBsrNotifications 1 } 754 pimBsrCandidateBSRWinElection NOTIFICATION-TYPE 755 OBJECTS { pimBsrCandidateBSRElectedBSR } 756 STATUS current 757 DESCRIPTION 758 "A pimBsrCandidateBSRWinElection notification should be 759 generated when a C-BSR wins BSR Election. Only an 760 E-BSR should generate this notification. 762 This notification is generated when 763 pimBsrCandidateBSRElectedBSR becomes TRUE." 765 REFERENCE "RFC5059 section 3.1" 766 ::= { pimBsrNotifications 2 } 768 -- 769 -- Compliance Statements 770 -- 772 pimBsrCompliance MODULE-COMPLIANCE 773 STATUS current 774 DESCRIPTION 775 "The compliance statement for PIM routers that implement 776 the Bootstrap Router (BSR) mechanism." 777 MODULE -- this module 778 MANDATORY-GROUPS { pimBsrObjectGroup } 779 GROUP pimBsrDiagnosticsGroup 780 DESCRIPTION 781 "This group is optional." 783 ::= { pimBsrCompliances 1 } 785 -- 786 -- Units of Conformance 787 -- 789 pimBsrObjectGroup OBJECT-GROUP 790 OBJECTS { pimBsrCandidateRPBidir, 791 pimBsrCandidateRPAdvTimer, 792 pimBsrCandidateRPPriority, 793 pimBsrCandidateRPAdvInterval, 794 pimBsrCandidateRPHoldtime, 795 pimBsrCandidateRPStatus, 796 pimBsrCandidateRPStorageType, 797 pimBsrElectedBSRRPSetPriority, 798 pimBsrElectedBSRRPSetHoldtime, 799 pimBsrElectedBSRRPSetExpiryTime, 800 pimBsrElectedBSRRPSetGrpBidir, 801 pimBsrCandidateBSRAddress, 802 pimBsrCandidateBSRAddressType, 803 pimBsrCandidateBSRPriority, 804 pimBsrCandidateBSRHashMaskLength, 805 pimBsrCandidateBSRElectedBSR, 806 pimBsrCandidateBSRBootstrapTimer, 807 pimBsrCandidateBSRStatus, 808 pimBsrCandidateBSRStorageType, 809 pimBsrElectedBSRAddress, 810 pimBsrElectedBSRAddressType, 811 pimBsrElectedBSRPriority, 812 pimBsrElectedBSRHashMaskLength, 813 pimBsrElectedBSRExpiryTime } 814 STATUS current 815 DESCRIPTION 816 "A collection of objects for managing the Bootstrap 817 Router (BSR) mechanism for PIM routers." 818 ::= { pimBsrGroups 1 } 820 pimBsrDiagnosticsGroup NOTIFICATION-GROUP 821 NOTIFICATIONS { pimBsrElectedBSRLostElection, 822 pimBsrCandidateBSRWinElection } 823 STATUS current 824 DESCRIPTION 825 "Objects providing additional diagnostics related to 826 the Bootstrap Router (BSR) mechanism for PIM routers." 828 ::= { pimBsrGroups 2 } 830 END 832 6. Security Considerations 834 There are a number of management objects defined in this MIB module 835 with a MAX-ACCESS clause of read-write and/or read-create. Such 836 objects may be considered sensitive or vulnerable in some network 837 environments. The support for SET operations in a non-secure 838 environment without proper protection can have a negative effect on 839 network operations. These are the tables and objects and their 840 sensitivity/vulnerability: 842 o A new Candidate BSR with high priority or modification of priority 843 of an existing candidate BSR can take over the functionality of 844 Elected BSR, which can prevent and disrupt the services. 846 o A new Candidate RP with lower priority or modification of priority 847 of an existing Candidate RP can force other routers to select 848 itself for a particular group prefix. This can prevent and 849 disrupt the services provided through this group prefix. 851 The following are the read-write and read-create objects defined in 852 this MIB module: 854 bsrCandidateRPBidir 855 bsrCandidateRPPriority 856 bsrCandidateRPAdvInterval 857 bsrCandidateRPHoldtime 858 bsrCandidateBSRAddressType 859 bsrCandidateBSRAddress 860 bsrCandidateBSRPriority 861 bsrCandidateBSRHashMaskLength 863 Some of the readable objects in this MIB module (i.e., objects with a 864 MAX-ACCESS other than not-accessible) may be considered sensitive or 865 vulnerable in some network environments. It is thus important to 866 control even GET and/or NOTIFY access to these objects and possibly 867 to even encrypt the values of these objects when sending them over 868 the network via SNMP. These are the tables and objects and their 869 sensitivity/vulnerability: 871 pimBsrCandidateRPAdvTimer 872 pimBsrElectedBSRRPSetPriority 873 pimBsrElectedBSRRPSetHoldtime 874 pimBsrElectedBSRRPSetExpiryTime 875 pimBsrElectedBSRRPSetGrpBidir 876 pimBsrCandidateBSRElectedBSR 877 pimBsrCandidateBSRBootstrapTimer 878 pimBsrElectedBSRAddressType 879 pimBsrElectedBSRAddress 880 pimBsrElectedBSRPriority 881 pimBsrElectedBSRHashMaskLength 882 pimBsrElectedBSRExpiryTime 884 In this MIB module, possible effects that can be induced by GET 885 operations include: 887 o Determination of Elected BSR, Candidate BSRs and Candidate RPs in 888 the Multicast Network topology. This information may be sensitive 889 and may be used in preparation for DoS attacks including any of 890 the attacks described above. 892 SNMP versions prior to SNMPv3 did not include adequate security. 893 Even if the network itself is secure (for example by using IPsec), 894 there is still no control over whom on the secure network is allowed 895 to access (read/change/create/delete) the objects in this MIB module. 897 It is RECOMMENDED that implementers consider the security features as 898 provided by the SNMPv3 framework (see [RFC3410], section 8), 899 including full support for the SNMPv3 cryptographic mechanisms (for 900 authentication and privacy). 902 Further, deployment of SNMP versions prior to SNMPv3 is NOT 903 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 904 enable cryptographic security. It is then a customer/operator 905 responsibility to ensure that the SNMP entity giving access to an 906 instance of this MIB module is properly configured to give access to 907 the objects only to those principals (users) that have legitimate 908 rights to access (read/change/create/delete) them. 910 7. IANA Considerations 912 The MIB module in this document uses the following IANA-assigned 913 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 915 Descriptor OBJECT IDENTIFIER value 916 ---------- ----------------------- 917 pimBsrMIB { mib-2 XXX } 918 Editor's Note (to be removed prior to publication): the IANA is 919 requested to assign a value for "XXX" under the 'mib-2' subtree and 920 to record the assignment in the SMI Numbers registry. When the 921 assignment has been made, the RFC Editor is asked to replace "XXX" 922 (here and in the MIB module) with the assigned value and to remove 923 this note. 925 8. Acknowledgments 927 This MIB module is based on the original work in [RFC5060] by R. 928 Sivaramu, J. Lingard and B. Joshi. 930 Many thanks to Bill Fenner, Stig Venaas, Nidhi Bhaskar, David 931 Mcwalter, David Harrington and J. W. Atwood for their feedback on 932 this MIB module. 934 Suggested IPv6 multicast MIBs by R. Sivaramu and R. Raghunarayan have 935 been used for comparison while editing this MIB module. 937 9. References 939 9.1. Normative References 941 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 942 Requirement Levels", BCP 14, RFC 2119, March 1997. 944 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 945 Schoenwaelder, Ed., "Structure of Management Information 946 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 948 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 949 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 950 STD 58, RFC 2579, April 1999. 952 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 953 "Conformance Statements for SMIv2", STD 58, RFC 2580, 954 April 1999. 956 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 957 Schoenwaelder, "Textual Conventions for Internet Network 958 Addresses", RFC 4001, February 2005. 960 [RFC4601] Fenner, B., Handley, M., Holbrook, H., and I. Kouvelas, 961 "Protocol Independent Multicast - Sparse Mode (PIM-SM): 962 Protocol Specification (Revised)", RFC 4601, August 2006. 964 [RFC5060] Sivaramu, R., Lingard, J., McWalter, D., Joshi, B., and A. 965 Kessler, "Protocol Independent Multicast MIB", RFC 5060, 966 January 2008. 968 [RFC5059] Bhaskar, N., Gall, A., Lingard, J., and S. Venaas, 969 "Bootstrap Router (BSR) Mechanism for Protocol Independent 970 Multicast (PIM)", RFC 5059, January 2008. 972 [RFC5132] McWalter, D., Thaler, D., and A. Kessler, "IP Multicast 973 MIB", RFC 5132, December 2007. 975 9.2. Informative References 977 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 978 "Introduction and Applicability Statements for Internet- 979 Standard Management Framework", RFC 3410, December 2002. 981 Authors' Addresses 983 Bharat Joshi 984 Infosys Technologies Ltd. 985 44 Electronics City, Hosur Road 986 Bangalore 560 100 987 India 989 Email: bharat_joshi@infosys.com 990 URI: http://www.infosys.com/ 992 Raina Bijlani 994 Email: rainab@gmail.com 996 Intellectual Property Statement 998 The IETF takes no position regarding the validity or scope of any 999 Intellectual Property Rights or other rights that might be claimed to 1000 pertain to the implementation or use of the technology described in 1001 this document or the extent to which any license under such rights 1002 might or might not be available; nor does it represent that it has 1003 made any independent effort to identify any such rights. Information 1004 on the procedures with respect to rights in RFC documents can be 1005 found in BCP 78 and BCP 79. 1007 Copies of IPR disclosures made to the IETF Secretariat and any 1008 assurances of licenses to be made available, or the result of an 1009 attempt made to obtain a general license or permission for the use of 1010 such proprietary rights by implementers or users of this 1011 specification can be obtained from the IETF on-line IPR repository at 1012 http://www.ietf.org/ipr. 1014 The IETF invites any interested party to bring to its attention any 1015 copyrights, patents or patent applications, or other proprietary 1016 rights that may cover technology that may be required to implement 1017 this standard. Please address the information to the IETF at 1018 ietf-ipr@ietf.org. 1020 Disclaimer of Validity 1022 This document and the information contained herein are provided on an 1023 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 1024 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 1025 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 1026 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 1027 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1028 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1030 Copyright Statement 1032 Copyright (C) The IETF Trust (2008). This document is subject to the 1033 rights, licenses and restrictions contained in BCP 78, and except as 1034 set forth therein, the authors retain all their rights. 1036 Acknowledgment 1038 Funding for the RFC Editor function is currently provided by the 1039 Internet Society.