idnits 2.17.1 draft-ietf-pim-bsr-mib-03.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 990. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 967. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 974. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 980. 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 (June 8, 2007) is 6165 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 924, but no explicit reference was found in the text ** Obsolete normative reference: RFC 4601 (Obsoleted by RFC 7761) -- Possible downref: Non-RFC (?) normative reference: ref. 'RTPROTO' == 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: 2 errors (**), 0 flaws (~~), 7 warnings (==), 8 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: December 10, 2007 R. Bijlani 5 Cisco Systems 6 June 8, 2007 8 PIM Bootstrap Router MIB 9 draft-ietf-pim-bsr-mib-03.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 December 10, 2007. 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 . . . . . . . . . . . . . . . . . . . 18 55 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 19 56 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 20 57 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 20 58 9.1. Normative References . . . . . . . . . . . . . . . . . . . 20 59 9.2. Informative References . . . . . . . . . . . . . . . . . . 21 60 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 22 61 Intellectual Property and Copyright Statements . . . . . . . . . . 23 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- 115 MIB[RTPROTO]. 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 "200702040000Z" -- 4 February 2007 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 (2007). 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 "200702040000Z" -- 4 February 2007 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." 241 ::= { pimBsrCandidateRPEntry 3 } 243 pimBsrCandidateRPGroupPrefixLength OBJECT-TYPE 244 SYNTAX InetAddressPrefixLength (4..128) 245 MAX-ACCESS not-accessible 246 STATUS current 247 DESCRIPTION 248 "The multicast group address mask that, when combined 249 with the corresponding value of 250 pimBsrCandidateRPGroupAddress, identifies a group prefix 251 for which the local router will advertise itself as a 252 Candidate-RP. The InetAddressType is given by the 253 pimBsrCandidateRPAddressType object." 254 ::= { pimBsrCandidateRPEntry 4 } 256 pimBsrCandidateRPBidir OBJECT-TYPE 257 SYNTAX TruthValue 258 MAX-ACCESS read-create 259 STATUS current 260 DESCRIPTION 261 "If this object is set to TRUE, this group range is 262 advertised with this RP as a BIDIR-PIM group range. If 263 it is set to FALSE, it is advertised as a PIM-SM group 264 range." 265 DEFVAL { false } 266 ::= { pimBsrCandidateRPEntry 5 } 268 pimBsrCandidateRPAdvTimer OBJECT-TYPE 269 SYNTAX TimeTicks 270 MAX-ACCESS read-only 271 STATUS current 272 DESCRIPTION 273 "The time remaining before the local router next sends 274 a Candidate-RP-Advertisement to the elected BSR for 275 this zone." 276 ::= { pimBsrCandidateRPEntry 6 } 278 pimBsrCandidateRPPriority OBJECT-TYPE 279 SYNTAX Unsigned32 (0..255) 280 MAX-ACCESS read-create 281 STATUS current 282 DESCRIPTION 283 "The priority for this Candidate RP advertised in 284 Candidate-RP-Advertisements." 285 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2" 286 DEFVAL { 192 } 287 ::= { pimBsrCandidateRPEntry 7 } 289 pimBsrCandidateRPAdvInterval OBJECT-TYPE 290 SYNTAX Unsigned32 (0..26214) 291 MAX-ACCESS read-create 292 STATUS current 293 DESCRIPTION 294 "A Candidate RP generates Candidate-RP-Advertisements 295 periodically. This object represents the time interval 296 in seconds between two consecutive advertisements." 298 REFERENCE "I-D.ietf-pim-sm-bsr section 3.2 and section 5" 299 DEFVAL { 60 } 301 ::= { pimBsrCandidateRPEntry 8 } 303 pimBsrCandidateRPHoldtime OBJECT-TYPE 304 SYNTAX Unsigned32 (0..65535) 305 MAX-ACCESS read-create 306 STATUS current 307 DESCRIPTION 308 "Holdtime for this Candidate RP. The amount of time (in 309 seconds) this Candidate-RP entry is valid." 311 REFERENCE "I-D.ietf-pim-sm-bsr section 4.2" 312 DEFVAL { 150 } 314 ::= { pimBsrCandidateRPEntry 9 } 316 pimBsrCandidateRPStatus OBJECT-TYPE 317 SYNTAX RowStatus 318 MAX-ACCESS read-create 319 STATUS current 320 DESCRIPTION 321 "The status of this row, by which new entries may be 322 created, or old entries deleted from this table." 324 ::= { pimBsrCandidateRPEntry 10 } 326 pimBsrCandidateRPStorageType OBJECT-TYPE 327 SYNTAX StorageType 328 MAX-ACCESS read-create 329 STATUS current 330 DESCRIPTION 331 "The storage type for this row. Rows having the value 332 'permanent' need not allow write-access to any columnar 333 objects in the row." 334 DEFVAL { nonVolatile } 335 ::= { pimBsrCandidateRPEntry 11 } 337 -- 338 -- The BSR Elected BSR RP-Set Table 339 -- 341 pimBsrElectedBSRRPSetTable OBJECT-TYPE 342 SYNTAX SEQUENCE OF PimBsrElectedBSRRPSetEntry 343 MAX-ACCESS not-accessible 344 STATUS current 345 DESCRIPTION 346 "The (conceptual) table listing BSR-specific information 347 about PIM group mappings learned via C-RP advertisements 348 or created locally using configurations. This table is 349 maintained only on the Elected BSR. 351 An Elected BSR uses this table to create Bootstrap 352 Messages after applying a local policy to include some 353 or all of the group mappings in this table." 355 ::= { pimBsrObjects 2 } 357 pimBsrElectedBSRRPSetEntry OBJECT-TYPE 358 SYNTAX PimBsrElectedBSRRPSetEntry 359 MAX-ACCESS not-accessible 360 STATUS current 361 DESCRIPTION 362 "An entry (conceptual row) in the 363 pimBsrElectedBSRRPSetTable." 364 INDEX { pimBsrElectedBSRGrpMappingAddrType, 365 pimBsrElectedBSRGrpMappingGrpAddr, 366 pimBsrElectedBSRGrpMappingGrpPrefixLen, 367 pimBsrElectedBSRGrpMappingRPAddr } 368 ::= { pimBsrElectedBSRRPSetTable 1 } 370 PimBsrElectedBSRRPSetEntry ::= SEQUENCE { 371 pimBsrElectedBSRGrpMappingAddrType InetAddressType, 372 pimBsrElectedBSRGrpMappingGrpAddr InetAddress, 373 pimBsrElectedBSRGrpMappingGrpPrefixLen InetAddressPrefixLength, 374 pimBsrElectedBSRGrpMappingRPAddr InetAddress, 375 pimBsrElectedBSRRPSetPriority Unsigned32, 376 pimBsrElectedBSRRPSetHoldtime Unsigned32, 377 pimBsrElectedBSRRPSetExpiryTime TimeTicks, 378 pimBsrElectedBSRRPSetGrpBidir TruthValue 379 } 381 pimBsrElectedBSRGrpMappingAddrType OBJECT-TYPE 382 SYNTAX InetAddressType 383 MAX-ACCESS not-accessible 384 STATUS current 385 DESCRIPTION 386 "The Inet address type of the IP multicast group 387 prefix." 388 ::= { pimBsrElectedBSRRPSetEntry 2 } 390 pimBsrElectedBSRGrpMappingGrpAddr OBJECT-TYPE 391 SYNTAX InetAddress (SIZE (4|8|16|20)) 392 MAX-ACCESS not-accessible 393 STATUS current 394 DESCRIPTION 395 "The IP multicast group address which, when combined 396 with pimBsrElectedBSRGrpMappingGrpPrefixLen, gives the 397 group prefix for this mapping. The InetAddressType is 398 given by the pimBsrElectedBSRGrpMappingAddrType object. 400 This address object is only significant up to 401 pimBsrElectedBSRGrpMappingGrpPrefixLen bits. The 402 remainder of the address bits are zero. This is 403 especially important for this field, which is part of 404 the index of this entry. Any non-zero bits would 405 signify an entirely different entry." 406 ::= { pimBsrElectedBSRRPSetEntry 3 } 408 pimBsrElectedBSRGrpMappingGrpPrefixLen OBJECT-TYPE 409 SYNTAX InetAddressPrefixLength (4..128) 410 MAX-ACCESS not-accessible 411 STATUS current 412 DESCRIPTION 413 "The multicast group prefix length that, when combined 414 with pimBsrElectedBSRGrpMappingGrpAddr, gives the group 415 prefix for this mapping. The InetAddressType is given by 416 the pimBsrElectedBSRGrpMappingAddrType object. If 417 pimBsrElectedBSRGrpMappingAddrType is 'ipv4' or 'ipv4z', 418 this object must be in the range 4..32. If 419 pimBsrElectedBSRGrpMappingAddrType is 'ipv6' or 'ipv6z', 420 this object must be in the range 8..128." 421 ::= { pimBsrElectedBSRRPSetEntry 4 } 423 pimBsrElectedBSRGrpMappingRPAddr OBJECT-TYPE 424 SYNTAX InetAddress (SIZE (4|8|16|20)) 425 MAX-ACCESS not-accessible 426 STATUS current 427 DESCRIPTION 428 "The IP address of the RP to be used for groups within 429 this group prefix. The InetAddressType is given by the 430 pimBsrElectedBSRGrpMappingAddrType object." 431 ::= { pimBsrElectedBSRRPSetEntry 5 } 433 pimBsrElectedBSRRPSetPriority OBJECT-TYPE 434 SYNTAX Unsigned32 (0..255) 435 MAX-ACCESS read-only 436 STATUS current 437 DESCRIPTION 438 "The priority for RP. Numerically higher values for 439 this object indicate lower priorities, with the value 440 zero denoting the highest priority." 442 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 443 ::= { pimBsrElectedBSRRPSetEntry 6 } 445 pimBsrElectedBSRRPSetHoldtime OBJECT-TYPE 446 SYNTAX Unsigned32 (0..65535) 447 UNITS "seconds" 448 MAX-ACCESS read-only 449 STATUS current 450 DESCRIPTION 451 "The holdtime for RP" 452 REFERENCE "I-D.ietf-pim-sm-bsr section 4.1" 453 ::= { pimBsrElectedBSRRPSetEntry 7 } 455 pimBsrElectedBSRRPSetExpiryTime OBJECT-TYPE 456 SYNTAX TimeTicks 457 MAX-ACCESS read-only 458 STATUS current 459 DESCRIPTION 460 "The minimum time remaining before this entry will be 461 aged out. The value zero indicates that this entry will 462 never be aged out." 463 ::= { pimBsrElectedBSRRPSetEntry 8 } 465 pimBsrElectedBSRRPSetGrpBidir OBJECT-TYPE 466 SYNTAX TruthValue 467 MAX-ACCESS read-only 468 STATUS current 469 DESCRIPTION 470 "If this object is TRUE, this group range with this 471 RP is a BIDIR-PIM group range. If it is set to FALSE, 472 it is a PIM-SM group range." 473 ::= { pimBsrElectedBSRRPSetEntry 9 } 475 -- 476 -- The BSR Candidate-BSR Table 477 -- 479 pimBsrCandidateBSRTable OBJECT-TYPE 480 SYNTAX SEQUENCE OF PimBsrCandidateBSREntry 481 MAX-ACCESS not-accessible 482 STATUS current 483 DESCRIPTION 484 "The (conceptual) table containing Candidate-BSR 485 configuration for the local router. The table contains 486 one row for each zone for which the local router is 487 to advertise itself as a Candidate-BSR." 488 ::= { pimBsrObjects 3 } 490 pimBsrCandidateBSREntry OBJECT-TYPE 491 SYNTAX PimBsrCandidateBSREntry 492 MAX-ACCESS not-accessible 493 STATUS current 494 DESCRIPTION 495 "An entry (conceptual row) in the 496 pimBsrCandidateBSRTable." 497 INDEX { pimBsrCandidateBSRZoneIndex } 498 ::= { pimBsrCandidateBSRTable 1 } 500 PimBsrCandidateBSREntry ::= SEQUENCE { 501 pimBsrCandidateBSRZoneIndex InetZoneIndex, 502 pimBsrCandidateBSRAddressType InetAddressType, 503 pimBsrCandidateBSRAddress InetAddress, 504 pimBsrCandidateBSRPriority Unsigned32, 505 pimBsrCandidateBSRHashMaskLength Unsigned32, 506 pimBsrCandidateBSRElectedBSR TruthValue, 507 pimBsrCandidateBSRBootstrapTimer TimeTicks, 508 pimBsrCandidateBSRStatus RowStatus, 509 pimBsrCandidateBSRStorageType StorageType 510 } 512 pimBsrCandidateBSRZoneIndex OBJECT-TYPE 513 SYNTAX InetZoneIndex 514 MAX-ACCESS not-accessible 515 STATUS current 516 DESCRIPTION 517 "The zone index uniquely identifies the zone on a" 518 device to which this Candidate BSR is attached. There is 519 one entry for each zone in ipMcastZoneTable. Scope-level 520 information for this zone can be extracted from 521 ipMcastZoneTable in IP Multicast MIB. 522 [I-D.ietf-mboned-ip-mcast-mib]." 523 ::= { pimBsrCandidateBSREntry 1 } 525 pimBsrCandidateBSRAddressType OBJECT-TYPE 526 SYNTAX InetAddressType 527 MAX-ACCESS read-create 528 STATUS current 529 DESCRIPTION 530 "The address type of the Candidate-BSR." 531 ::= { pimBsrCandidateBSREntry 2 } 533 pimBsrCandidateBSRAddress OBJECT-TYPE 534 SYNTAX InetAddress 535 MAX-ACCESS read-create 536 STATUS current 537 DESCRIPTION 538 "The (unicast) address that the local router will 539 use to advertise itself as a Candidate-BSR. The 540 InetAddressType is given by the 541 pimBsrCandidateBSRAddressType object." 542 ::= { pimBsrCandidateBSREntry 3 } 544 pimBsrCandidateBSRPriority OBJECT-TYPE 545 SYNTAX Unsigned32 (0..255) 546 MAX-ACCESS read-create 547 STATUS current 548 DESCRIPTION 549 "The priority value for the local router as a 550 Candidate-BSR for this zone. Numerically higher 551 values for this object indicate higher priorities." 552 DEFVAL { 0 } 553 ::= { pimBsrCandidateBSREntry 4 } 555 pimBsrCandidateBSRHashMaskLength OBJECT-TYPE 556 SYNTAX Unsigned32 (0..128) 557 MAX-ACCESS read-create 558 STATUS current 559 DESCRIPTION 560 "The hash mask length (used in the RP hash function) 561 that the local router will advertise in its Bootstrap 562 messages for this zone. This object defaults 563 to 30 if pimBsrCandidateBSRAddressType is 'ipv4' or 564 'ipv4z' , and defaults to 126 if 565 pimBsrCandidateBSRAddressType is 'ipv6' or 'ipv6z'." 566 ::= { pimBsrCandidateBSREntry 5 } 568 pimBsrCandidateBSRElectedBSR OBJECT-TYPE 569 SYNTAX TruthValue 570 MAX-ACCESS read-only 571 STATUS current 572 DESCRIPTION 573 "Whether the local router is the elected BSR for this 574 zone." 575 ::= { pimBsrCandidateBSREntry 6 } 577 pimBsrCandidateBSRBootstrapTimer OBJECT-TYPE 578 SYNTAX TimeTicks 579 MAX-ACCESS read-only 580 STATUS current 581 DESCRIPTION 582 "The time remaining before the local router next 583 originates a Bootstrap message for this zone. 584 Value of this object is zero if 585 pimBsrCandidateBSRElectedBSR is 'FALSE'." 587 ::= { pimBsrCandidateBSREntry 7 } 589 pimBsrCandidateBSRStatus OBJECT-TYPE 590 SYNTAX RowStatus 591 MAX-ACCESS read-create 592 STATUS current 593 DESCRIPTION 594 "The status of this row, by which new entries may 595 be created, or old entries deleted from this table." 596 ::= { pimBsrCandidateBSREntry 8 } 598 pimBsrCandidateBSRStorageType OBJECT-TYPE 599 SYNTAX StorageType 600 MAX-ACCESS read-create 601 STATUS current 602 DESCRIPTION 603 "The storage type for this row. Rows having the value 604 'permanent' need not allow write-access to any columnar 605 objects in the row." 606 DEFVAL { nonVolatile } 607 ::= { pimBsrCandidateBSREntry 9 } 609 -- 610 -- The BSR Elected-BSR Table 611 -- 613 pimBsrElectedBSRTable OBJECT-TYPE 614 SYNTAX SEQUENCE OF PimBsrElectedBSREntry 615 MAX-ACCESS not-accessible 616 STATUS current 617 DESCRIPTION 618 "The (conceptual) table containing information about 619 elected BSRs. The table contains one row for each 620 zone for which there is an elected BSR." 621 ::= { pimBsrObjects 4 } 623 pimBsrElectedBSREntry OBJECT-TYPE 624 SYNTAX PimBsrElectedBSREntry 625 MAX-ACCESS not-accessible 626 STATUS current 627 DESCRIPTION 628 "An entry (conceptual row) in the 629 pimBsrElectedBSRTable." 630 INDEX { pimBsrElectedBSRZoneIndex } 631 ::= { pimBsrElectedBSRTable 1 } 633 PimBsrElectedBSREntry ::= SEQUENCE { 634 pimBsrElectedBSRZoneIndex InetZoneIndex, 635 pimBsrElectedBSRAddressType InetAddressType, 636 pimBsrElectedBSRAddress InetAddress, 637 pimBsrElectedBSRPriority Unsigned32, 638 pimBsrElectedBSRHashMaskLength Unsigned32, 639 pimBsrElectedBSRExpiryTime TimeTicks 640 } 642 pimBsrElectedBSRZoneIndex OBJECT-TYPE 643 SYNTAX InetZoneIndex 644 MAX-ACCESS not-accessible 645 STATUS current 646 DESCRIPTION 647 "The zone index uniquely identifies the zone on a 648 device to which this Elected BSR is attached. There 649 is one entry for each zone in ipMcastZoneTable. 650 Scope-level information for this zone can be extracted 651 from ipMcastZoneTable in IP MCAST MIB." 652 ::= { pimBsrElectedBSREntry 1 } 654 pimBsrElectedBSRAddressType OBJECT-TYPE 655 SYNTAX InetAddressType 656 MAX-ACCESS read-only 657 STATUS current 658 DESCRIPTION 659 "The address type of the elected BSR." 660 ::= { pimBsrElectedBSREntry 2 } 662 pimBsrElectedBSRAddress OBJECT-TYPE 663 SYNTAX InetAddress (SIZE (4|8|16|20)) 664 MAX-ACCESS read-only 665 STATUS current 666 DESCRIPTION 667 "The (unicast) address of the elected BSR. The 668 InetAddressType is given by the 669 pimBsrElectedBSRAddressType object." 670 ::= { pimBsrElectedBSREntry 3 } 672 pimBsrElectedBSRPriority OBJECT-TYPE 673 SYNTAX Unsigned32 (0..255) 674 MAX-ACCESS read-only 675 STATUS current 676 DESCRIPTION 677 "The priority value for the elected BSR for this address 678 type. Numerically higher values for this object indicate 679 higher priorities." 680 ::= { pimBsrElectedBSREntry 4 } 682 pimBsrElectedBSRHashMaskLength OBJECT-TYPE 683 SYNTAX Unsigned32 (0..128) 684 MAX-ACCESS read-only 685 STATUS current 686 DESCRIPTION 687 "The hash mask length (used in the RP hash function) 688 advertised by the elected BSR for this zone." 689 ::= { pimBsrElectedBSREntry 5 } 691 pimBsrElectedBSRExpiryTime OBJECT-TYPE 692 SYNTAX TimeTicks 693 MAX-ACCESS read-only 694 STATUS current 695 DESCRIPTION 696 "The minimum time remaining before the elected BSR for 697 this zone will be declared down." 698 ::= { pimBsrElectedBSREntry 6 } 700 -- 701 -- PIM BSR Notifications 702 -- 704 pimBsrElectedBSRLostElection NOTIFICATION-TYPE 705 OBJECTS { pimBsrCandidateBSRElectedBSR } 706 STATUS current 707 DESCRIPTION 708 "A pimBsrElectedBSRLostElection notification should be 709 generated when current E-BSR lost election to a new 710 Candidate BSR. Only an E-BSR should generate this 711 notification. 713 This notification is generated when 714 pimBsrCandidateBSRElectedBSR becomes FALSE." 716 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 717 ::= { pimBsrNotifications 1 } 719 pimBsrCandidateBSRWinElection NOTIFICATION-TYPE 720 OBJECTS { pimBsrCandidateBSRElectedBSR } 721 STATUS current 722 DESCRIPTION 723 "A pimBsrCandidateBSRWinElection notification should be 724 generated when a C-BSR wins BSR Election. Only an 725 E-BSR should generate this notification. 727 This notification is generated when 728 pimBsrCandidateBSRElectedBSR becomes TRUE." 730 REFERENCE "I-D.ietf-pim-sm-bsr section 3.1" 731 ::= { pimBsrNotifications 2 } 733 -- 734 -- Compliance Statements 735 -- 737 pimBsrCompliance MODULE-COMPLIANCE 738 STATUS current 739 DESCRIPTION 740 "The compliance statement for PIM routers that implement 741 the Bootstrap Router (BSR) mechanism." 742 MODULE -- this module 743 MANDATORY-GROUPS { pimBsrObjectGroup } 745 GROUP pimBsrDiagnosticsGroup 746 DESCRIPTION 747 "This group is optional." 749 ::= { pimBsrCompliances 1 } 751 -- 752 -- Units of Conformance 753 -- 755 pimBsrObjectGroup OBJECT-GROUP 756 OBJECTS { pimBsrCandidateRPBidir, 757 pimBsrCandidateRPAdvTimer, 758 pimBsrCandidateRPPriority, 759 pimBsrCandidateRPAdvInterval, 760 pimBsrCandidateRPHoldtime, 761 pimBsrCandidateRPStatus, 762 pimBsrElectedBSRRPSetPriority, 763 pimBsrElectedBSRRPSetHoldtime, 764 pimBsrElectedBSRRPSetExpiryTime, 765 pimBsrElectedBSRRPSetGrpBidir, 766 pimBsrCandidateBSRAddress, 767 pimBsrCandidateBSRPriority, 768 pimBsrCandidateBSRHashMaskLength, 769 pimBsrCandidateBSRElectedBSR, 770 pimBsrCandidateBSRBootstrapTimer, 771 pimBsrCandidateBSRStatus, 772 pimBsrElectedBSRAddress, 773 pimBsrElectedBSRPriority, 774 pimBsrElectedBSRHashMaskLength, 775 pimBsrElectedBSRExpiryTime } 776 STATUS current 777 DESCRIPTION 778 "A collection of objects for managing the Bootstrap 779 Router (BSR) mechanism for PIM routers." 780 ::= { pimBsrGroups 1 } 782 pimBsrDiagnosticsGroup NOTIFICATION-GROUP 783 NOTIFICATIONS { pimBsrElectedBSRLostElection, 784 pimBsrCandidateBSRWinElection } 785 STATUS current 786 DESCRIPTION 787 "Objects providing additional diagnostics related to 788 the Bootstrap Router (BSR) mechanism for PIM routers." 789 ::= { pimBsrGroups 2 } 791 END 793 6. Security Considerations 795 SNMP versions prior to SNMPv3 did not include adequate security. 796 Even if the network itself is secure (for example by using IPSec), 797 there is still no control over who on the secure network is allowed 798 to access (read/change/create/delete) the objects in this MIB module. 799 The support for SET operations in a non-secure environment without 800 proper protection can have a negative effect on network operations. 802 In this MIB module, possible effects that can be induced by SET 803 operations on writable objects include: 805 o A new Candidate BSR with high priority or modification of priority 806 of an existing candidate BSR can take over the functionality of 807 Elected BSR, which can prevent and disrupt the services. 809 o A new Candidate RP with lower priority or modification of priority 810 of an existing Candidate RP can force other routers to select 811 itself for a particular group prefix. This can prevent and 812 disrupt the services provided through this group prefix. 814 The following are the read-write and read-create objects defined in 815 this MIB module: 817 bsrCandidateRPBidir 818 bsrCandidateRPPriority 819 bsrCandidateRPAdvInterval 820 bsrCandidateRPHoldtime 821 bsrCandidateBSRAddressType 822 bsrCandidateBSRAddress 823 bsrCandidateBSRPriority 824 bsrCandidateBSRHashMaskLength 826 Some of the readable objects in this MIB module (i.e., objects with a 827 MAX-ACCESS other than not-accessible) may be considered sensitive or 828 vulnerable in some network environments. It is thus important to 829 control even GET and/or NOTIFY access to these objects and possibly 830 to even encrypt the values of these objects when sending them over 831 the network via SNMP. 833 In this MIB module, possible effects that can be induced by GET 834 and/or NOTIFY operations include: 836 o Determination of Elected BSR, Candidate BSRs and Candidate RPs in 837 the Multicast Network topology. This information may be sensitive 838 and may be used in preparation for DoS attacks including any of 839 the attacks described above. 841 SNMP versions prior to SNMPv3 did not include adequate security. 842 Even if the network itself is secure (for example by using IPSec), 843 there is still no control over whom on the secure network is allowed 844 to access (read/change/create/delete) the objects in this MIB module. 846 It is RECOMMENDED that implementers consider the security features as 847 provided by the SNMPv3 framework (see [RFC3410], section 8), 848 including full support for the SNMPv3 cryptographic mechanisms (for 849 authentication and privacy). 851 Further, deployment of SNMP versions prior to SNMPv3 is NOT 852 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 853 enable cryptographic security. It is then a customer/operator 854 responsibility to ensure that the SNMP entity giving access to an 855 instance of this MIB module is properly configured to give access to 856 the objects only to those principals (users) that have legitimate 857 rights to access (read/change/create/delete) them. 859 7. IANA Considerations 861 The MIB module in this document uses the following IANA-assigned 862 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 864 Descriptor OBJECT IDENTIFIER value 865 ---------- ----------------------- 866 pimBsrMIB { mib-2 XXX } 868 Editor's Note (to be removed prior to publication): the IANA is 869 requested to assign a value for "XXX" under the 'mib-2' subtree and 870 to record the assignment in the SMI Numbers registry. When the 871 assignment has been made, the RFC Editor is asked to replace "XXX" 872 (here and in the MIB module) with the assigned value and to remove 873 this note. 875 8. Acknowledgments 877 This MIB module is based on the original work in 878 [I-D.ietf-pim-mib-v2] by R. Sivaramu, J. Lingard and B. Joshi. 880 Many thanks to Stig Venaas, Nidhi Bhaskar, David Mcwalter, David 881 Harrington and J. W. Atwood for their feedback on this MIB module. 883 Suggested IPv6 multicast MIBs by R. Sivaramu and R. Raghunarayan have 884 been used for comparison while editing this MIB module. 886 9. References 888 9.1. Normative References 890 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 891 Requirement Levels", BCP 14, RFC 2119, March 1997. 893 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 894 Schoenwaelder, Ed., "Structure of Management Information 895 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 897 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 898 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 899 STD 58, RFC 2579, April 1999. 901 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 902 "Conformance Statements for SMIv2", STD 58, RFC 2580, 903 April 1999. 905 [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group 906 MIB", RFC 2863, June 2000. 908 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 909 Schoenwaelder, "Textual Conventions for Internet Network 910 Addresses", RFC 4001, February 2005. 912 [RFC4601] Fenner, B., Handley, M., Holbrook, H., and I. Kouvelas, 913 "Protocol Independent Multicast - Sparse Mode (PIM-SM): 914 Protocol Specification (Revised)", RFC 4601, August 2006. 916 [RTPROTO] IANA, "IP Route Protocol MIB", 917 http://www.iana.org/assignments/ianaiprouteprotocol-mib, 918 September 2000. 920 [I-D.ietf-pim-mib-v2] 921 Lingard, J., "Protocol Independent Multicast MIB", 922 draft-ietf-pim-mib-v2-06 (work in progress), April 2006. 924 [I-D.ietf-pim-sm-bsr] 925 Bhaskar, N., "Bootstrap Router (BSR) Mechanism for PIM", 926 draft-ietf-pim-sm-bsr-08 (work in progress), May 2006. 928 [I-D.ietf-mboned-ip-mcast-mib] 929 McWalter, D., "IP Multicast MIB", 930 draft-ietf-mboned-ip-mcast-mib-03 (work in progress), 931 August 2006. 933 9.2. Informative References 935 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 936 "Introduction and Applicability Statements for Internet- 937 Standard Management Framework", RFC 3410, December 2002. 939 Authors' Addresses 941 Bharat Joshi 942 Infosys Technologies Ltd. 943 44 Electronics City, Hosur Road 944 Bangalore 560 100 945 India 947 Email: bharat_joshi@infosys.com 948 URI: http://www.infosys.com/ 950 Raina Bijlani 951 Cisco Systems 952 170 W.Tasman Drive 953 San Jose CA 95134 954 USA 956 Email: rainab@cisco.com 958 Intellectual Property Statement 960 The IETF takes no position regarding the validity or scope of any 961 Intellectual Property Rights or other rights that might be claimed to 962 pertain to the implementation or use of the technology described in 963 this document or the extent to which any license under such rights 964 might or might not be available; nor does it represent that it has 965 made any independent effort to identify any such rights. Information 966 on the procedures with respect to rights in RFC documents can be 967 found in BCP 78 and BCP 79. 969 Copies of IPR disclosures made to the IETF Secretariat and any 970 assurances of licenses to be made available, or the result of an 971 attempt made to obtain a general license or permission for the use of 972 such proprietary rights by implementers or users of this 973 specification can be obtained from the IETF on-line IPR repository at 974 http://www.ietf.org/ipr. 976 The IETF invites any interested party to bring to its attention any 977 copyrights, patents or patent applications, or other proprietary 978 rights that may cover technology that may be required to implement 979 this standard. Please address the information to the IETF at 980 ietf-ipr@ietf.org. 982 Disclaimer of Validity 984 This document and the information contained herein are provided on an 985 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 986 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 987 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 988 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 989 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 990 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 992 Copyright Statement 994 Copyright (C) The IETF Trust (2007). This document is subject to the 995 rights, licenses and restrictions contained in BCP 78, and except as 996 set forth therein, the authors retain all their rights. 998 Acknowledgment 1000 Funding for the RFC Editor function is currently provided by the 1001 Internet Society.