idnits 2.17.1 draft-ietf-pim-bsr-mib-04.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, updated by RFC 4748 on line 1026. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1003. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1010. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1016. 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 (October 25, 2007) is 6026 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: 'I-D.ietf-pim-sm-bsr' is defined on line 959, but no explicit reference was found in the text ** Obsolete normative reference: RFC 4601 (Obsoleted by RFC 7761) == Outdated reference: A later version (-12) exists of draft-ietf-pim-sm-bsr-10 == Outdated reference: A later version (-07) exists of draft-ietf-mboned-ip-mcast-mib-05 Summary: 2 errors (**), 0 flaws (~~), 6 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: April 27, 2008 R. Bijlani 5 Cisco Systems 6 October 25, 2007 8 PIM Bootstrap Router MIB 9 draft-ietf-pim-bsr-mib-04.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 April 27, 2008. 36 Copyright Notice 38 Copyright (C) The IETF Trust (2007). 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 . . . . . . . . . . . . . . . . . . . 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], [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 Candidate-RP Table, which contains one row for each multicast 101 group address prefix for which the local router is to advertise 102 itself as a Candidate-RP. This table exists on routers that are 103 configured as Candidate-RP. 105 2. The Elected BSR RP-Set Table, which contains one row for each 106 Group-to-RP mapping that was received in C-RP advertisements. 107 This table exists on a router that is an elected BSR. 109 3. The Candidate-BSR Table, which contains one row for each 110 Candidate-BSR configuration for the local router. This table 111 exists on routers that are configured as Candidate-BSR. 113 4. The Elected BSR Table, which contains one row for each elected 114 BSR. This table exists on a router that is an elected BSR. 116 This MIB module uses textual conventions defined in the INET-ADDRESS- 117 MIB [RFC4001]. 119 5. Definitions 121 PIM-BSR-MIB DEFINITIONS ::= BEGIN 123 IMPORTS 124 MODULE-IDENTITY, OBJECT-TYPE, 125 NOTIFICATION-TYPE, 126 mib-2, Unsigned32, TimeTicks FROM SNMPv2-SMI 127 RowStatus, TruthValue, 128 StorageType FROM SNMPv2-TC 129 MODULE-COMPLIANCE, OBJECT-GROUP, 130 NOTIFICATION-GROUP FROM SNMPv2-CONF 131 InetAddressType, 132 InetAddressPrefixLength, 133 InetAddress, 134 InetZoneIndex FROM INET-ADDRESS-MIB; 136 pimBsrMIB MODULE-IDENTITY 137 LAST-UPDATED "200710250000Z" -- 25 October 2007 138 ORGANIZATION 139 "IETF Protocol Independent Multicast (PIM) Working Group" 140 CONTACT-INFO 141 "Email: pim@ietf.org 142 WG charter: 143 http://www.ietf.org/html.charters/pim-charter.html" 144 DESCRIPTION 145 "The MIB module for management of the Bootstrap Router 146 (BSR) mechanism for PIM routers. 148 Copyright (C) The IETF Trust (2007). This version 149 of this MIB module is part of RFC yyyy; see the RFC 150 itself for full legal notices." 151 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 152 REVISION "200710250000Z" -- 25 October 2007 153 DESCRIPTION "Initial version, published as RFC yyyy." 154 -- RFC Ed.: replace yyyy with actual RFC number & remove this note 155 ::= { mib-2 XXX } 156 -- RFC Ed.: replace XXX with IANA-assigned number & remove this note 158 -- 159 -- Top-level structure 160 -- 162 pimBsrNotifications OBJECT IDENTIFIER ::= { pimBsrMIB 0 } 163 pimBsrObjects OBJECT IDENTIFIER ::= { pimBsrMIB 1 } 165 -- 166 -- Conformance Information 167 -- 169 pimBsrConformance OBJECT IDENTIFIER ::= { pimBsrMIB 2 } 170 pimBsrCompliances OBJECT IDENTIFIER ::= { pimBsrConformance 1 } 171 pimBsrGroups OBJECT IDENTIFIER ::= { pimBsrConformance 2 } 173 -- 174 -- The BSR Candidate-RP Table 175 -- 177 pimBsrCandidateRPTable OBJECT-TYPE 178 SYNTAX SEQUENCE OF PimBsrCandidateRPEntry 179 MAX-ACCESS not-accessible 180 STATUS current 181 DESCRIPTION 182 "The (conceptual) table listing the IP multicast group 183 prefixes for which the local router is to advertise 184 itself as a Candidate-RP." 185 ::= { pimBsrObjects 1 } 187 pimBsrCandidateRPEntry OBJECT-TYPE 188 SYNTAX PimBsrCandidateRPEntry 189 MAX-ACCESS not-accessible 190 STATUS current 191 DESCRIPTION 192 "An entry (conceptual row) in the 193 pimBsrCandidateRPTable." 194 INDEX { pimBsrCandidateRPAddressType, 195 pimBsrCandidateRPAddress, 196 pimBsrCandidateRPGroupAddress, 197 pimBsrCandidateRPGroupPrefixLength } 198 ::= { pimBsrCandidateRPTable 1 } 200 PimBsrCandidateRPEntry ::= SEQUENCE { 201 pimBsrCandidateRPAddressType InetAddressType, 202 pimBsrCandidateRPAddress InetAddress, 203 pimBsrCandidateRPGroupAddress InetAddress, 204 pimBsrCandidateRPGroupPrefixLength InetAddressPrefixLength, 205 pimBsrCandidateRPBidir TruthValue, 206 pimBsrCandidateRPAdvTimer TimeTicks, 207 pimBsrCandidateRPPriority Unsigned32, 208 pimBsrCandidateRPAdvInterval Unsigned32, 209 pimBsrCandidateRPHoldtime Unsigned32, 210 pimBsrCandidateRPStatus RowStatus, 211 pimBsrCandidateRPStorageType StorageType 212 } 214 pimBsrCandidateRPAddressType OBJECT-TYPE 215 SYNTAX InetAddressType 216 MAX-ACCESS not-accessible 217 STATUS current 218 DESCRIPTION 219 "The Inet address type of the Candidate-RP." 220 ::= { pimBsrCandidateRPEntry 1 } 222 pimBsrCandidateRPAddress OBJECT-TYPE 223 SYNTAX InetAddress (SIZE (4|8|16|20)) 224 MAX-ACCESS not-accessible 225 STATUS current 226 DESCRIPTION 227 "The (unicast) address that will be advertised as a 228 Candidate-RP. The InetAddressType is given by the 229 pimBsrCandidateRPAddressType object." 230 ::= { pimBsrCandidateRPEntry 2 } 232 pimBsrCandidateRPGroupAddress OBJECT-TYPE 233 SYNTAX InetAddress (SIZE (4|8|16|20)) 234 MAX-ACCESS not-accessible 235 STATUS current 236 DESCRIPTION 237 "The IP multicast group address that, when combined with 238 the corresponding value of 239 pimBsrCandidateRPGroupPrefixLength, identifies a group 240 prefix for which the local router will advertise itself 241 as a Candidate-RP. The InetAddressType is given by the 242 pimBsrCandidateRPAddressType object. 244 This address object is only significant up to 245 pimBsrCandidateRPGroupPrefixLength bits. The 246 remainder of the address bits are zero. This is 247 especially important for this field, which is part of 248 the index of this entry. Any non-zero bits would 249 signify an entirely different entry." 250 ::= { pimBsrCandidateRPEntry 3 } 252 pimBsrCandidateRPGroupPrefixLength OBJECT-TYPE 253 SYNTAX InetAddressPrefixLength (4..128) 254 MAX-ACCESS not-accessible 255 STATUS current 256 DESCRIPTION 257 "The multicast group address mask that, when combined 258 with the corresponding value of 259 pimBsrCandidateRPGroupAddress, identifies a group prefix 260 for which the local router will advertise itself as a 261 Candidate-RP. The InetAddressType is given by the 262 pimBsrCandidateRPAddressType object." 263 ::= { pimBsrCandidateRPEntry 4 } 265 pimBsrCandidateRPBidir OBJECT-TYPE 266 SYNTAX TruthValue 267 MAX-ACCESS read-create 268 STATUS current 269 DESCRIPTION 270 "If this object is set to TRUE, this group range is 271 advertised with this RP as a BIDIR-PIM group range. If 272 it is set to FALSE, it is advertised as a PIM-SM group 273 range." 274 DEFVAL { false } 275 ::= { pimBsrCandidateRPEntry 5 } 277 pimBsrCandidateRPAdvTimer OBJECT-TYPE 278 SYNTAX TimeTicks 279 MAX-ACCESS read-only 280 STATUS current 281 DESCRIPTION 282 "The time remaining before the local router next sends 283 a Candidate-RP-Advertisement to the elected BSR for 284 this zone." 285 ::= { pimBsrCandidateRPEntry 6 } 287 pimBsrCandidateRPPriority OBJECT-TYPE 288 SYNTAX Unsigned32 (0..255) 289 MAX-ACCESS read-create 290 STATUS current 291 DESCRIPTION 292 "The priority for this Candidate RP advertised in 293 Candidate-RP-Advertisements." 294 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2" 295 DEFVAL { 192 } 296 ::= { pimBsrCandidateRPEntry 7 } 298 pimBsrCandidateRPAdvInterval OBJECT-TYPE 299 SYNTAX Unsigned32 (1..26214) 300 UNITS "seconds" 301 MAX-ACCESS read-create 302 STATUS current 303 DESCRIPTION 304 "A Candidate RP generates Candidate-RP-Advertisements 305 periodically. This object represents the time interval 306 in seconds between two consecutive advertisements." 308 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2 and section 5" 309 DEFVAL { 60 } 311 ::= { pimBsrCandidateRPEntry 8 } 313 pimBsrCandidateRPHoldtime OBJECT-TYPE 314 SYNTAX Unsigned32 (0..65535) 315 UNITS "seconds" 316 MAX-ACCESS read-create 317 STATUS current 318 DESCRIPTION 319 "Holdtime for this Candidate RP. The amount of time (in 320 seconds) this Candidate-RP entry is valid. 322 This object's value can be zero only when this C-RP is 323 shutting down" 325 REFERENCE "I-D.ietf-pim-sm-bsr section 4.2" 326 DEFVAL { 150 } 328 ::= { pimBsrCandidateRPEntry 9 } 330 pimBsrCandidateRPStatus OBJECT-TYPE 331 SYNTAX RowStatus 332 MAX-ACCESS read-create 333 STATUS current 334 DESCRIPTION 335 "The status of this row, by which new entries may be 336 created, or old entries deleted from this table. 338 This status object can be set to active(1) without 339 setting any other columnar objects in this entry 341 All writable objects in this entry can be modified 342 when the status of this entry is active(1)." 344 ::= { pimBsrCandidateRPEntry 10 } 346 pimBsrCandidateRPStorageType OBJECT-TYPE 347 SYNTAX StorageType 348 MAX-ACCESS read-create 349 STATUS current 350 DESCRIPTION 351 "The storage type for this row. Rows having the value 352 'permanent' need not allow write-access to any columnar 353 objects in the row." 354 DEFVAL { nonVolatile } 355 ::= { pimBsrCandidateRPEntry 11 } 357 -- 358 -- The BSR Elected BSR RP-Set Table 359 -- 361 pimBsrElectedBSRRPSetTable OBJECT-TYPE 362 SYNTAX SEQUENCE OF PimBsrElectedBSRRPSetEntry 363 MAX-ACCESS not-accessible 364 STATUS current 365 DESCRIPTION 366 "The (conceptual) table listing BSR-specific information 367 about PIM group mappings learned via C-RP advertisements 368 or created locally using configurations. This table is 369 maintained only on the Elected BSR. 371 An Elected BSR uses this table to create Bootstrap 372 Messages after applying a local policy to include some 373 or all of the group mappings in this table." 375 ::= { pimBsrObjects 2 } 377 pimBsrElectedBSRRPSetEntry OBJECT-TYPE 378 SYNTAX PimBsrElectedBSRRPSetEntry 379 MAX-ACCESS not-accessible 380 STATUS current 381 DESCRIPTION 382 "An entry (conceptual row) in the 383 pimBsrElectedBSRRPSetTable." 384 INDEX { pimBsrElectedBSRGrpMappingAddrType, 385 pimBsrElectedBSRGrpMappingGrpAddr, 386 pimBsrElectedBSRGrpMappingGrpPrefixLen, 387 pimBsrElectedBSRGrpMappingRPAddr } 388 ::= { pimBsrElectedBSRRPSetTable 1 } 390 PimBsrElectedBSRRPSetEntry ::= SEQUENCE { 391 pimBsrElectedBSRGrpMappingAddrType InetAddressType, 392 pimBsrElectedBSRGrpMappingGrpAddr InetAddress, 393 pimBsrElectedBSRGrpMappingGrpPrefixLen InetAddressPrefixLength, 394 pimBsrElectedBSRGrpMappingRPAddr InetAddress, 395 pimBsrElectedBSRRPSetPriority Unsigned32, 396 pimBsrElectedBSRRPSetHoldtime Unsigned32, 397 pimBsrElectedBSRRPSetExpiryTime TimeTicks, 398 pimBsrElectedBSRRPSetGrpBidir TruthValue 399 } 401 pimBsrElectedBSRGrpMappingAddrType OBJECT-TYPE 402 SYNTAX InetAddressType 403 MAX-ACCESS not-accessible 404 STATUS current 405 DESCRIPTION 406 "The Inet address type of the IP multicast group 407 prefix." 408 ::= { pimBsrElectedBSRRPSetEntry 2 } 410 pimBsrElectedBSRGrpMappingGrpAddr OBJECT-TYPE 411 SYNTAX InetAddress (SIZE (4|8|16|20)) 412 MAX-ACCESS not-accessible 413 STATUS current 414 DESCRIPTION 415 "The IP multicast group address which, when combined 416 with pimBsrElectedBSRGrpMappingGrpPrefixLen, gives the 417 group prefix for this mapping. The InetAddressType is 418 given by the pimBsrElectedBSRGrpMappingAddrType object. 420 This address object is only significant up to 421 pimBsrElectedBSRGrpMappingGrpPrefixLen bits. The 422 remainder of the address bits are zero. This is 423 especially important for this field, which is part of 424 the index of this entry. Any non-zero bits would 425 signify an entirely different entry." 426 ::= { pimBsrElectedBSRRPSetEntry 3 } 428 pimBsrElectedBSRGrpMappingGrpPrefixLen OBJECT-TYPE 429 SYNTAX InetAddressPrefixLength (4..128) 430 MAX-ACCESS not-accessible 431 STATUS current 432 DESCRIPTION 433 "The multicast group prefix length that, when combined 434 with pimBsrElectedBSRGrpMappingGrpAddr, gives the group 435 prefix for this mapping. The InetAddressType is given by 436 the pimBsrElectedBSRGrpMappingAddrType object. If 437 pimBsrElectedBSRGrpMappingAddrType is 'ipv4' or 'ipv4z', 438 this object must be in the range 4..32. If 439 pimBsrElectedBSRGrpMappingAddrType is 'ipv6' or 'ipv6z', 440 this object must be in the range 8..128." 441 ::= { pimBsrElectedBSRRPSetEntry 4 } 443 pimBsrElectedBSRGrpMappingRPAddr OBJECT-TYPE 444 SYNTAX InetAddress (SIZE (4|8|16|20)) 445 MAX-ACCESS not-accessible 446 STATUS current 447 DESCRIPTION 448 "The IP address of the RP to be used for groups within 449 this group prefix. The InetAddressType is given by the 450 pimBsrElectedBSRGrpMappingAddrType object." 451 ::= { pimBsrElectedBSRRPSetEntry 5 } 453 pimBsrElectedBSRRPSetPriority OBJECT-TYPE 454 SYNTAX Unsigned32 (0..255) 455 MAX-ACCESS read-only 456 STATUS current 457 DESCRIPTION 458 "The priority for RP. Numerically higher values for 459 this object indicate lower priorities, with the value 460 zero denoting the highest priority." 461 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 462 ::= { pimBsrElectedBSRRPSetEntry 6 } 464 pimBsrElectedBSRRPSetHoldtime OBJECT-TYPE 465 SYNTAX Unsigned32 (0..65535) 466 UNITS "seconds" 467 MAX-ACCESS read-only 468 STATUS current 469 DESCRIPTION 470 "The holdtime for RP" 471 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 472 ::= { pimBsrElectedBSRRPSetEntry 7 } 474 pimBsrElectedBSRRPSetExpiryTime OBJECT-TYPE 475 SYNTAX TimeTicks 476 MAX-ACCESS read-only 477 STATUS current 478 DESCRIPTION 479 "The minimum time remaining before this entry will be 480 aged out. The value zero indicates that this entry will 481 never be aged out." 482 ::= { pimBsrElectedBSRRPSetEntry 8 } 484 pimBsrElectedBSRRPSetGrpBidir OBJECT-TYPE 485 SYNTAX TruthValue 486 MAX-ACCESS read-only 487 STATUS current 488 DESCRIPTION 489 "If this object is TRUE, this group range with this 490 RP is a BIDIR-PIM group range. If it is set to FALSE, 491 it is a PIM-SM group range." 492 ::= { pimBsrElectedBSRRPSetEntry 9 } 494 -- 495 -- The BSR Candidate-BSR Table 496 -- 498 pimBsrCandidateBSRTable OBJECT-TYPE 499 SYNTAX SEQUENCE OF PimBsrCandidateBSREntry 500 MAX-ACCESS not-accessible 501 STATUS current 502 DESCRIPTION 503 "The (conceptual) table containing Candidate-BSR 504 configuration for the local router. The table contains 505 one row for each zone for which the local router is 506 to advertise itself as a Candidate-BSR." 507 ::= { pimBsrObjects 3 } 509 pimBsrCandidateBSREntry OBJECT-TYPE 510 SYNTAX PimBsrCandidateBSREntry 511 MAX-ACCESS not-accessible 512 STATUS current 513 DESCRIPTION 514 "An entry (conceptual row) in the 515 pimBsrCandidateBSRTable." 516 INDEX { pimBsrCandidateBSRZoneIndex } 517 ::= { pimBsrCandidateBSRTable 1 } 519 PimBsrCandidateBSREntry ::= SEQUENCE { 520 pimBsrCandidateBSRZoneIndex InetZoneIndex, 521 pimBsrCandidateBSRAddressType InetAddressType, 522 pimBsrCandidateBSRAddress InetAddress, 523 pimBsrCandidateBSRPriority Unsigned32, 524 pimBsrCandidateBSRHashMaskLength Unsigned32, 525 pimBsrCandidateBSRElectedBSR TruthValue, 526 pimBsrCandidateBSRBootstrapTimer TimeTicks, 527 pimBsrCandidateBSRStatus RowStatus, 528 pimBsrCandidateBSRStorageType StorageType 529 } 531 pimBsrCandidateBSRZoneIndex OBJECT-TYPE 532 SYNTAX InetZoneIndex 533 MAX-ACCESS not-accessible 534 STATUS current 535 DESCRIPTION 536 "The zone index uniquely identifies the zone on a 537 device to which this Candidate BSR is attached. There is 538 one entry for each zone in ipMcastZoneTable. Scope-level 539 information for this zone can be extracted from 540 ipMcastZoneTable in IP Multicast MIB. 541 [I-D.ietf-mboned-ip-mcast-mib]." 542 ::= { pimBsrCandidateBSREntry 1 } 544 pimBsrCandidateBSRAddressType OBJECT-TYPE 545 SYNTAX InetAddressType 546 MAX-ACCESS read-create 547 STATUS current 548 DESCRIPTION 549 "The address type of the Candidate-BSR." 550 ::= { pimBsrCandidateBSREntry 2 } 552 pimBsrCandidateBSRAddress OBJECT-TYPE 553 SYNTAX InetAddress 554 MAX-ACCESS read-create 555 STATUS current 556 DESCRIPTION 557 "The (unicast) address that the local router will 558 use to advertise itself as a Candidate-BSR. The 559 InetAddressType is given by the 560 pimBsrCandidateBSRAddressType object." 561 ::= { pimBsrCandidateBSREntry 3 } 563 pimBsrCandidateBSRPriority OBJECT-TYPE 564 SYNTAX Unsigned32 (0..255) 565 MAX-ACCESS read-create 566 STATUS current 567 DESCRIPTION 568 "The priority value for the local router as a 569 Candidate-BSR for this zone. Numerically higher 570 values for this object indicate higher priorities." 571 DEFVAL { 0 } 572 ::= { pimBsrCandidateBSREntry 4 } 574 pimBsrCandidateBSRHashMaskLength OBJECT-TYPE 575 SYNTAX Unsigned32 (0..128) 576 MAX-ACCESS read-create 577 STATUS current 578 DESCRIPTION 579 "The hash mask length (used in the RP hash function) 580 that the local router will advertise in its Bootstrap 581 messages for this zone. This object defaults 582 to 30 if pimBsrCandidateBSRAddressType is 'ipv4' or 583 'ipv4z' , and defaults to 126 if 584 pimBsrCandidateBSRAddressType is 'ipv6' or 'ipv6z'." 585 ::= { pimBsrCandidateBSREntry 5 } 587 pimBsrCandidateBSRElectedBSR OBJECT-TYPE 588 SYNTAX TruthValue 589 MAX-ACCESS read-only 590 STATUS current 591 DESCRIPTION 592 "Whether the local router is the elected BSR for this 593 zone." 594 ::= { pimBsrCandidateBSREntry 6 } 596 pimBsrCandidateBSRBootstrapTimer OBJECT-TYPE 597 SYNTAX TimeTicks 598 MAX-ACCESS read-only 599 STATUS current 600 DESCRIPTION 601 "The time remaining before the local router next 602 originates a Bootstrap message for this zone. 603 Value of this object is zero if 604 pimBsrCandidateBSRElectedBSR is 'FALSE'." 605 ::= { pimBsrCandidateBSREntry 7 } 607 pimBsrCandidateBSRStatus OBJECT-TYPE 608 SYNTAX RowStatus 609 MAX-ACCESS read-create 610 STATUS current 611 DESCRIPTION 612 "The status of this row, by which new entries may 613 be created, or old entries deleted from this table. 615 This status object can be set to active(1) without 616 setting any other columnar objects in this entry 618 All writable objects in this entry can be modified 619 when the status of this entry is active(1)." 620 ::= { pimBsrCandidateBSREntry 8 } 622 pimBsrCandidateBSRStorageType OBJECT-TYPE 623 SYNTAX StorageType 624 MAX-ACCESS read-create 625 STATUS current 626 DESCRIPTION 627 "The storage type for this row. Rows having the value 628 'permanent' need not allow write-access to any columnar 629 objects in the row." 630 DEFVAL { nonVolatile } 631 ::= { pimBsrCandidateBSREntry 9 } 633 -- 634 -- The BSR Elected-BSR Table 635 -- 637 pimBsrElectedBSRTable OBJECT-TYPE 638 SYNTAX SEQUENCE OF PimBsrElectedBSREntry 639 MAX-ACCESS not-accessible 640 STATUS current 641 DESCRIPTION 642 "The (conceptual) table containing information about 643 elected BSRs. The table contains one row for each 644 zone for which there is an elected BSR." 645 ::= { pimBsrObjects 4 } 647 pimBsrElectedBSREntry OBJECT-TYPE 648 SYNTAX PimBsrElectedBSREntry 649 MAX-ACCESS not-accessible 650 STATUS current 651 DESCRIPTION 652 "An entry (conceptual row) in the 653 pimBsrElectedBSRTable." 654 INDEX { pimBsrElectedBSRZoneIndex } 655 ::= { pimBsrElectedBSRTable 1 } 657 PimBsrElectedBSREntry ::= SEQUENCE { 658 pimBsrElectedBSRZoneIndex InetZoneIndex, 659 pimBsrElectedBSRAddressType InetAddressType, 660 pimBsrElectedBSRAddress InetAddress, 661 pimBsrElectedBSRPriority Unsigned32, 662 pimBsrElectedBSRHashMaskLength Unsigned32, 663 pimBsrElectedBSRExpiryTime TimeTicks 664 } 666 pimBsrElectedBSRZoneIndex OBJECT-TYPE 667 SYNTAX InetZoneIndex 668 MAX-ACCESS not-accessible 669 STATUS current 670 DESCRIPTION 671 "The zone index uniquely identifies the zone on a 672 device to which this Elected BSR is attached. There 673 is one entry for each zone in ipMcastZoneTable. 674 Scope-level information for this zone can be extracted 675 from ipMcastZoneTable in IP MCAST MIB." 676 ::= { pimBsrElectedBSREntry 1 } 678 pimBsrElectedBSRAddressType OBJECT-TYPE 679 SYNTAX InetAddressType 680 MAX-ACCESS read-only 681 STATUS current 682 DESCRIPTION 683 "The address type of the elected BSR." 684 ::= { pimBsrElectedBSREntry 2 } 686 pimBsrElectedBSRAddress OBJECT-TYPE 687 SYNTAX InetAddress (SIZE (4|8|16|20)) 688 MAX-ACCESS read-only 689 STATUS current 690 DESCRIPTION 691 "The (unicast) address of the elected BSR. The 692 InetAddressType is given by the 693 pimBsrElectedBSRAddressType object." 694 ::= { pimBsrElectedBSREntry 3 } 696 pimBsrElectedBSRPriority OBJECT-TYPE 697 SYNTAX Unsigned32 (0..255) 698 MAX-ACCESS read-only 699 STATUS current 700 DESCRIPTION 701 "The priority value for the elected BSR for this address 702 type. Numerically higher values for this object indicate 703 higher priorities." 704 ::= { pimBsrElectedBSREntry 4 } 706 pimBsrElectedBSRHashMaskLength OBJECT-TYPE 707 SYNTAX Unsigned32 (0..128) 708 MAX-ACCESS read-only 709 STATUS current 710 DESCRIPTION 711 "The hash mask length (used in the RP hash function) 712 advertised by the elected BSR for this zone." 713 ::= { pimBsrElectedBSREntry 5 } 715 pimBsrElectedBSRExpiryTime OBJECT-TYPE 716 SYNTAX TimeTicks 717 MAX-ACCESS read-only 718 STATUS current 719 DESCRIPTION 720 "The minimum time remaining before the elected BSR for 721 this zone will be declared down." 722 ::= { pimBsrElectedBSREntry 6 } 724 -- 725 -- PIM BSR Notifications 726 -- 728 pimBsrElectedBSRLostElection NOTIFICATION-TYPE 729 OBJECTS { pimBsrElectedBSRAddressType, 730 pimBsrElectedBSRAddress, 731 pimBsrElectedBSRPriority } 732 STATUS current 733 DESCRIPTION 734 "A pimBsrElectedBSRLostElection notification should be 735 generated when current E-BSR lost election to a new 736 Candidate BSR. Only an E-BSR should generate this 737 notification. 739 This notification is generated when 740 pimBsrCandidateBSRElectedBSR becomes FALSE." 742 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 743 ::= { pimBsrNotifications 1 } 745 pimBsrCandidateBSRWinElection NOTIFICATION-TYPE 746 OBJECTS { pimBsrCandidateBSRElectedBSR } 747 STATUS current 748 DESCRIPTION 749 "A pimBsrCandidateBSRWinElection notification should be 750 generated when a C-BSR wins BSR Election. Only an 751 E-BSR should generate this notification. 753 This notification is generated when 754 pimBsrCandidateBSRElectedBSR becomes TRUE." 756 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 757 ::= { pimBsrNotifications 2 } 759 -- 760 -- Compliance Statements 761 -- 763 pimBsrCompliance MODULE-COMPLIANCE 764 STATUS current 765 DESCRIPTION 766 "The compliance statement for PIM routers that implement 767 the Bootstrap Router (BSR) mechanism." 768 MODULE -- this module 769 MANDATORY-GROUPS { pimBsrObjectGroup } 771 GROUP pimBsrDiagnosticsGroup 772 DESCRIPTION 773 "This group is optional." 775 ::= { pimBsrCompliances 1 } 777 -- 778 -- Units of Conformance 779 -- 781 pimBsrObjectGroup OBJECT-GROUP 782 OBJECTS { pimBsrCandidateRPBidir, 783 pimBsrCandidateRPAdvTimer, 784 pimBsrCandidateRPPriority, 785 pimBsrCandidateRPAdvInterval, 786 pimBsrCandidateRPHoldtime, 787 pimBsrCandidateRPStatus, 788 pimBsrCandidateRPStorageType, 789 pimBsrElectedBSRRPSetPriority, 790 pimBsrElectedBSRRPSetHoldtime, 791 pimBsrElectedBSRRPSetExpiryTime, 792 pimBsrElectedBSRRPSetGrpBidir, 793 pimBsrCandidateBSRAddress, 794 pimBsrCandidateBSRAddressType, 795 pimBsrCandidateBSRPriority, 796 pimBsrCandidateBSRHashMaskLength, 797 pimBsrCandidateBSRElectedBSR, 798 pimBsrCandidateBSRBootstrapTimer, 799 pimBsrCandidateBSRStatus, 800 pimBsrCandidateBSRStorageType, 801 pimBsrElectedBSRAddress, 802 pimBsrElectedBSRAddressType, 803 pimBsrElectedBSRPriority, 804 pimBsrElectedBSRHashMaskLength, 805 pimBsrElectedBSRExpiryTime } 806 STATUS current 807 DESCRIPTION 808 "A collection of objects for managing the Bootstrap 809 Router (BSR) mechanism for PIM routers." 810 ::= { pimBsrGroups 1 } 812 pimBsrDiagnosticsGroup NOTIFICATION-GROUP 813 NOTIFICATIONS { pimBsrElectedBSRLostElection, 814 pimBsrCandidateBSRWinElection } 815 STATUS current 816 DESCRIPTION 817 "Objects providing additional diagnostics related to 818 the Bootstrap Router (BSR) mechanism for PIM routers." 819 ::= { pimBsrGroups 2 } 821 END 823 6. Security Considerations 825 There are a number of management objects defined in this MIB module 826 with a MAX-ACCESS clause of read-write and/or read-create. Such 827 objects may be considered sensitive or vulnerable in some network 828 environments. The support for SET operations in a non-secure 829 environment without proper protection can have a negative effect on 830 network operations. These are the tables and objects and their 831 sensitivity/vulnerability: 833 o A new Candidate BSR with high priority or modification of priority 834 of an existing candidate BSR can take over the functionality of 835 Elected BSR, which can prevent and disrupt the services. 837 o A new Candidate RP with lower priority or modification of priority 838 of an existing Candidate RP can force other routers to select 839 itself for a particular group prefix. This can prevent and 840 disrupt the services provided through this group prefix. 842 The following are the read-write and read-create objects defined in 843 this MIB module: 845 bsrCandidateRPBidir 846 bsrCandidateRPPriority 847 bsrCandidateRPAdvInterval 848 bsrCandidateRPHoldtime 849 bsrCandidateBSRAddressType 850 bsrCandidateBSRAddress 851 bsrCandidateBSRPriority 852 bsrCandidateBSRHashMaskLength 854 Some of the readable objects in this MIB module (i.e., objects with a 855 MAX-ACCESS other than not-accessible) may be considered sensitive or 856 vulnerable in some network environments. It is thus important to 857 control even GET and/or NOTIFY access to these objects and possibly 858 to even encrypt the values of these objects when sending them over 859 the network via SNMP. These are the tables and objects and their 860 sensitivity/vulnerability: 862 pimBsrCandidateRPAdvTimer 863 pimBsrElectedBSRRPSetPriority 864 pimBsrElectedBSRRPSetHoldtime 865 pimBsrElectedBSRRPSetExpiryTime 866 pimBsrElectedBSRRPSetGrpBidir 867 pimBsrCandidateBSRElectedBSR 868 pimBsrCandidateBSRBootstrapTimer 869 pimBsrElectedBSRAddressType 870 pimBsrElectedBSRAddress 871 pimBsrElectedBSRPriority 872 pimBsrElectedBSRHashMaskLength 873 pimBsrElectedBSRExpiryTime 875 In this MIB module, possible effects that can be induced by GET 876 operations include: 878 o Determination of Elected BSR, Candidate BSRs and Candidate RPs in 879 the Multicast Network topology. This information may be sensitive 880 and may be used in preparation for DoS attacks including any of 881 the attacks described above. 883 SNMP versions prior to SNMPv3 did not include adequate security. 884 Even if the network itself is secure (for example by using IPSec), 885 there is still no control over whom on the secure network is allowed 886 to access (read/change/create/delete) the objects in this MIB module. 888 It is RECOMMENDED that implementers consider the security features as 889 provided by the SNMPv3 framework (see [RFC3410], section 8), 890 including full support for the SNMPv3 cryptographic mechanisms (for 891 authentication and privacy). 893 Further, deployment of SNMP versions prior to SNMPv3 is NOT 894 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 895 enable cryptographic security. It is then a customer/operator 896 responsibility to ensure that the SNMP entity giving access to an 897 instance of this MIB module is properly configured to give access to 898 the objects only to those principals (users) that have legitimate 899 rights to access (read/change/create/delete) them. 901 7. IANA Considerations 903 The MIB module in this document uses the following IANA-assigned 904 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 906 Descriptor OBJECT IDENTIFIER value 907 ---------- ----------------------- 908 pimBsrMIB { mib-2 XXX } 909 Editor's Note (to be removed prior to publication): the IANA is 910 requested to assign a value for "XXX" under the 'mib-2' subtree and 911 to record the assignment in the SMI Numbers registry. When the 912 assignment has been made, the RFC Editor is asked to replace "XXX" 913 (here and in the MIB module) with the assigned value and to remove 914 this note. 916 8. Acknowledgments 918 This MIB module is based on the original work in 919 [I-D.ietf-pim-mib-v2] by R. Sivaramu, J. Lingard and B. Joshi. 921 Many thanks to Bill Fenner, Stig Venaas, Nidhi Bhaskar, David 922 Mcwalter, David Harrington and J. W. Atwood for their feedback on 923 this MIB module. 925 Suggested IPv6 multicast MIBs by R. Sivaramu and R. Raghunarayan have 926 been used for comparison while editing this MIB module. 928 9. References 930 9.1. Normative References 932 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 933 Requirement Levels", BCP 14, RFC 2119, March 1997. 935 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 936 Schoenwaelder, Ed., "Structure of Management Information 937 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 939 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 940 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 941 STD 58, RFC 2579, April 1999. 943 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 944 "Conformance Statements for SMIv2", STD 58, RFC 2580, 945 April 1999. 947 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 948 Schoenwaelder, "Textual Conventions for Internet Network 949 Addresses", RFC 4001, February 2005. 951 [RFC4601] Fenner, B., Handley, M., Holbrook, H., and I. Kouvelas, 952 "Protocol Independent Multicast - Sparse Mode (PIM-SM): 953 Protocol Specification (Revised)", RFC 4601, August 2006. 955 [I-D.ietf-pim-mib-v2] 956 Lingard, J., "Protocol Independent Multicast MIB", 957 draft-ietf-pim-mib-v2-10 (work in progress), March 2007. 959 [I-D.ietf-pim-sm-bsr] 960 Bhaskar, N., "Bootstrap Router (BSR) Mechanism for PIM", 961 draft-ietf-pim-sm-bsr-10 (work in progress), 962 February 2007. 964 [I-D.ietf-mboned-ip-mcast-mib] 965 McWalter, D., "IP Multicast MIB", 966 draft-ietf-mboned-ip-mcast-mib-05 (work in progress), 967 March 2007. 969 9.2. Informative References 971 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 972 "Introduction and Applicability Statements for Internet- 973 Standard Management Framework", RFC 3410, December 2002. 975 Authors' Addresses 977 Bharat Joshi 978 Infosys Technologies Ltd. 979 44 Electronics City, Hosur Road 980 Bangalore 560 100 981 India 983 Email: bharat_joshi@infosys.com 984 URI: http://www.infosys.com/ 986 Raina Bijlani 987 Cisco Systems 988 170 W.Tasman Drive 989 San Jose CA 95134 990 USA 992 Email: rainab@cisco.com 994 Intellectual Property Statement 996 The IETF takes no position regarding the validity or scope of any 997 Intellectual Property Rights or other rights that might be claimed to 998 pertain to the implementation or use of the technology described in 999 this document or the extent to which any license under such rights 1000 might or might not be available; nor does it represent that it has 1001 made any independent effort to identify any such rights. Information 1002 on the procedures with respect to rights in RFC documents can be 1003 found in BCP 78 and BCP 79. 1005 Copies of IPR disclosures made to the IETF Secretariat and any 1006 assurances of licenses to be made available, or the result of an 1007 attempt made to obtain a general license or permission for the use of 1008 such proprietary rights by implementers or users of this 1009 specification can be obtained from the IETF on-line IPR repository at 1010 http://www.ietf.org/ipr. 1012 The IETF invites any interested party to bring to its attention any 1013 copyrights, patents or patent applications, or other proprietary 1014 rights that may cover technology that may be required to implement 1015 this standard. Please address the information to the IETF at 1016 ietf-ipr@ietf.org. 1018 Disclaimer of Validity 1020 This document and the information contained herein are provided on an 1021 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 1022 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 1023 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 1024 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 1025 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1026 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1028 Copyright Statement 1030 Copyright (C) The IETF Trust (2007). This document is subject to the 1031 rights, licenses and restrictions contained in BCP 78, and except as 1032 set forth therein, the authors retain all their rights. 1034 Acknowledgment 1036 Funding for the RFC Editor function is currently provided by the 1037 Internet Society.