-- extracted from draft-mcwalter-pim-bsr-mib-00.txt -- at Thu Oct 6 06:36:25 2005 PIM-BSR-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, mib-2, Unsigned32, TimeTicks FROM SNMPv2-SMI RowStatus, TruthValue FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF InetAddressType, InetAddressPrefixLength, InetAddress FROM INET-ADDRESS-MIB PimGroupMappingOriginType FROM PIM-STD-MIB; pimBsrMIB MODULE-IDENTITY LAST-UPDATED "200510050000Z" -- 5 October 2005 ORGANIZATION "IETF PIM Working Group" CONTACT-INFO "Email: pim@ietf.org" DESCRIPTION "The MIB module for management of the Bootstrap Router (BSR) mechanism for PIM routers. Copyright (C) The Internet Society (2005). This version of this MIB module is part of RFC yyyy; see the RFC itself for full legal notices." -- RFC Ed.: replace yyyy with actual RFC number & remove this note REVISION "200510050000Z" -- 5 October 2005 DESCRIPTION "Initial version, published as RFC yyyy." -- RFC Ed.: replace yyyy with actual RFC number & remove this note ::= { mib-2 XXX } -- RFC Ed.: replace XXX with IANA-assigned number & remove this note -- -- Top-level structure -- pimBsrMIBObjects OBJECT IDENTIFIER ::= { pimBsrMIB 1 } pimBsr OBJECT IDENTIFIER ::= { pimBsrMIBObjects 1 } -- -- The BSR Candidate-RP Table -- bsrCandidateRPTable OBJECT-TYPE SYNTAX SEQUENCE OF BsrCandidateRPEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The (conceptual) table listing the IP multicast groups for which the local router is to advertise itself as a Candidate-RP." ::= { pimBsr 1 } bsrCandidateRPEntry OBJECT-TYPE SYNTAX BsrCandidateRPEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry (conceptual row) in the bsrCandidateRPTable. This entry is preserved on agent restart." INDEX { bsrCandidateRPAddressType, bsrCandidateRPAddress, bsrCandidateRPGroupAddress, bsrCandidateRPGroupPrefixLength } ::= { bsrCandidateRPTable 1 } BsrCandidateRPEntry ::= SEQUENCE { bsrCandidateRPAddressType InetAddressType, bsrCandidateRPAddress InetAddress, bsrCandidateRPGroupAddress InetAddress, bsrCandidateRPGroupPrefixLength InetAddressPrefixLength, bsrCandidateRPBidir TruthValue, bsrCandidateRPStatus RowStatus } bsrCandidateRPAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address type of the Candidate-RP." ::= { bsrCandidateRPEntry 1 } bsrCandidateRPAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (4|8|16|20)) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The (unicast) address which will be advertised as a Candidate-RP. The InetAddressType is given by the bsrCandidateRPAddressType object." ::= { bsrCandidateRPEntry 2 } bsrCandidateRPGroupAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (4|8|16|20)) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The IP multicast group address which, when combined with the corresponding value of bsrCandidateRPGroupPrefixLength, identifies a group prefix for which the local router will advertise itself as a Candidate-RP. The InetAddressType is given by the bsrCandidateRPAddressType object." ::= { bsrCandidateRPEntry 3 } bsrCandidateRPGroupPrefixLength OBJECT-TYPE SYNTAX InetAddressPrefixLength (4..128) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The multicast group address mask which, when combined with the corresponding value of bsrCandidateRPGroupAddress, identifies a group prefix for which the local router will advertise itself as a Candidate-RP. The InetAddressType is given by the bsrCandidateRPAddressType object." ::= { bsrCandidateRPEntry 4 } bsrCandidateRPBidir OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-create STATUS current DESCRIPTION "If this object is set to TRUE, this group range is advertised to this RP as a BIDIR-PIM group range. If it is set to FALSE, it is advertised as a PIM-SM group range." DEFVAL { false } ::= { bsrCandidateRPEntry 5 } bsrCandidateRPStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row, by which new entries may be created, or old entries deleted from this table. This status object can be set to active(1) without setting any other columnar objects in this entry. No other writeable objects in this entry can be modified when the status of this entry is active(1)." ::= { bsrCandidateRPEntry 6 } -- -- The BSR RP-Set Table -- bsrRPSetTable OBJECT-TYPE SYNTAX SEQUENCE OF BsrRPSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The (conceptual) table listing BSR-specific information about PIM group mappings learned via BSR. There is one entry in this table for every entry in the pimGroupMappingTable with a pimGroupMappingOrigin value of 'bsr'." ::= { pimBsr 2 } bsrRPSetEntry OBJECT-TYPE SYNTAX BsrRPSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry (conceptual row) in the bsrRPSetTable. This entry is preserved on agent restart." INDEX { bsrGroupMappingOrigin, bsrGroupMappingAddressType, bsrGroupMappingGrpAddress, bsrGroupMappingGrpPrefixLength, bsrGroupMappingRPAddress } ::= { bsrRPSetTable 1 } BsrRPSetEntry ::= SEQUENCE { bsrGroupMappingOrigin PimGroupMappingOriginType, bsrGroupMappingAddressType InetAddressType, bsrGroupMappingGrpAddress InetAddress, bsrGroupMappingGrpPrefixLength InetAddressPrefixLength, bsrGroupMappingRPAddress InetAddress, bsrRPSetPriority Unsigned32, bsrRPSetHoldtime Unsigned32, bsrRPSetExpiryTime TimeTicks } bsrGroupMappingOrigin OBJECT-TYPE SYNTAX PimGroupMappingOriginType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The mechanism by which this group mapping was learned." ::= { bsrRPSetEntry 1 } bsrGroupMappingAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address type of the IP multicast group prefix." ::= { bsrRPSetEntry 2 } bsrGroupMappingGrpAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (4|8|16|20)) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The IP multicast group address which, when combined with pimGroupMappingGrpPrefixLength, gives the group prefix for this mapping. The InetAddressType is given by the pimGroupMappingAddressType object. This address object is only significant up to pimGroupMappingGrpPrefixLength bits. The remainder of the address bits are zero. This is especially important for this index field, which is part of the index of this entry. Any non-zero bits would signify an entirely different entry." ::= { bsrRPSetEntry 3 } bsrGroupMappingGrpPrefixLength OBJECT-TYPE SYNTAX InetAddressPrefixLength (4..128) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The multicast group prefix length, which, when combined with pimGroupMappingGrpAddress, gives the group prefix for this mapping. The InetAddressType is given by the pimGroupMappingAddressType object. If pimGroupMappingAddressType is 'ipv4' or 'ipv4z', this object must be in the range 4..32. If pimGroupMappingAddressType is 'ipv6' or 'ipv6z', this object must be in the range 8..128." ::= { bsrRPSetEntry 4 } bsrGroupMappingRPAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (4|8|16|20)) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The IP address of the RP to be used for groups within this group prefix, or zero if no RP is to be used or if the RP address is unknown. The InetAddressType is given by the pimGroupMappingAddressType object. This object must be zero if pimGroupMappingPimMode is 'ssm', or if pimGroupMappingOrigin is 'embedded'." ::= { bsrRPSetEntry 5 } bsrRPSetPriority OBJECT-TYPE SYNTAX Unsigned32 (0..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The RP Priority from the PIM Candidate-RP-Advertisement message or PIM Bootstrap message by which this RP was learned. Numerically higher values for this object indicate lower priorities, with the value zero denoting the highest priority." ::= { bsrRPSetEntry 6 } bsrRPSetHoldtime OBJECT-TYPE SYNTAX Unsigned32 (0..65535) UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "The RP Holdtime from the PIM Candidate-RP-Advertisement message or PIM Bootstrap message by which this RP was learned." ::= { bsrRPSetEntry 7 } bsrRPSetExpiryTime OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The minimum time remaining before this entry will be aged out. The value zero indicates that this entry will never be aged out." ::= { bsrRPSetEntry 8 } -- -- The BSR Candidate-BSR Table -- bsrCandidateBSRTable OBJECT-TYPE SYNTAX SEQUENCE OF BsrCandidateBSREntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The (conceptual) table containing Candidate-BSR configuration for the local router. The table contains one row for each address family for which the local router is to advertise itself as a Candidate-BSR." ::= { pimBsr 3 } bsrCandidateBSREntry OBJECT-TYPE SYNTAX BsrCandidateBSREntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry (conceptual row) in the bsrCandidateBSRTable. This entry is preserved on agent restart." INDEX { bsrCandidateBSRAddressType } ::= { bsrCandidateBSRTable 1 } BsrCandidateBSREntry ::= SEQUENCE { bsrCandidateBSRAddressType InetAddressType, bsrCandidateBSRAddress InetAddress, bsrCandidateBSRPriority Unsigned32, bsrCandidateBSRHashMaskLength Unsigned32, bsrCandidateBSRElectedBSR TruthValue, bsrCandidateBSRBootstrapTimer TimeTicks, bsrCandidateBSRStatus RowStatus } bsrCandidateBSRAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address type of the Candidate-BSR." ::= { bsrCandidateBSREntry 1 } bsrCandidateBSRAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-create STATUS current DESCRIPTION "The (unicast) address which the local router will use to advertise itself as a Candidate-BSR. The InetAddressType is given by the bsrCandidateBSRAddressType object." ::= { bsrCandidateBSREntry 2 } bsrCandidateBSRPriority OBJECT-TYPE SYNTAX Unsigned32 (0..255) MAX-ACCESS read-create STATUS current DESCRIPTION "The priority value for the local router as a Candidate-BSR for this address type. Numerically higher values for this object indicate higher priorities." DEFVAL { 0 } ::= { bsrCandidateBSREntry 3 } bsrCandidateBSRHashMaskLength OBJECT-TYPE SYNTAX Unsigned32 (0..128) MAX-ACCESS read-create STATUS current DESCRIPTION "The hash mask length (used in the RP hash function) that the local router will advertise in its Bootstrap messages for this address type. This object defaults to 30 if bsrCandidateBSRAddressType is 'ipv4' or 'ipv4z', and defaults to 126 if bsrCandidateBSRAddressType is 'ipv6' or 'ipv6z'." -- DEFVAL { 30 or 126 } ::= { bsrCandidateBSREntry 4 } bsrCandidateBSRElectedBSR OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "Whether the local router is the elected BSR for this address type." ::= { bsrCandidateBSREntry 5 } bsrCandidateBSRBootstrapTimer OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The time remaining before the local router next originates a Bootstrap message for this address type. This is zero if bsrCandidateBSRElectedBSR is 'false'." ::= { bsrCandidateBSREntry 6 } bsrCandidateBSRStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row, by which new entries may be created, or old entries deleted from this table. There are no other other writeable columnar objects in this entry." ::= { bsrCandidateBSREntry 7 } -- -- The BSR Elected-BSR Table -- bsrElectedBSRTable OBJECT-TYPE SYNTAX SEQUENCE OF BsrElectedBSREntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The (conceptual) table containing information about elected BSRs. The table contains one row for each address family for which there is an elected BSR." ::= { pimBsr 4 } bsrElectedBSREntry OBJECT-TYPE SYNTAX BsrElectedBSREntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry (conceptual row) in the bsrElectedBSRTable. This entry is preserved on agent restart." INDEX { bsrElectedBSRAddressType } ::= { bsrElectedBSRTable 1 } BsrElectedBSREntry ::= SEQUENCE { bsrElectedBSRAddressType InetAddressType, bsrElectedBSRAddress InetAddress, bsrElectedBSRPriority Unsigned32, bsrElectedBSRHashMaskLength Unsigned32, bsrElectedBSRExpiryTime TimeTicks, bsrElectedBSRCRPAdvTimer TimeTicks } bsrElectedBSRAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address type of the elected BSR." ::= { bsrElectedBSREntry 1 } bsrElectedBSRAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (4|8|16|20)) MAX-ACCESS read-only STATUS current DESCRIPTION "The (unicast) address of the elected BSR. The InetAddressType is given by the bsrElectedBSRAddressType object." ::= { bsrElectedBSREntry 2 } bsrElectedBSRPriority OBJECT-TYPE SYNTAX Unsigned32 (0..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The priority value for the elected BSR for this address type. Numerically higher values for this object indicate higher priorities." ::= { bsrElectedBSREntry 3 } bsrElectedBSRHashMaskLength OBJECT-TYPE SYNTAX Unsigned32 (0..128) MAX-ACCESS read-only STATUS current DESCRIPTION "The hash mask length (used in the RP hash function) advertised by the elected BSR for this address type." ::= { bsrElectedBSREntry 4 } bsrElectedBSRExpiryTime OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The minimum time remaining before the elected BSR for this address type will be declared down." ::= { bsrElectedBSREntry 5 } bsrElectedBSRCRPAdvTimer OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The time remaining before the local router next sends a Candidate-RP-Advertisement signal to the elected BSR for this address type. If the local router is not configured as a candidate RP, then this object is set to zero." ::= { bsrElectedBSREntry 6 } -- -- Conformance Information -- pimBsrMIBConformance OBJECT IDENTIFIER ::= { pimBsrMIB 2 } pimBsrMIBCompliances OBJECT IDENTIFIER ::= { pimBsrMIBConformance 1 } pimBsrMIBGroups OBJECT IDENTIFIER ::= { pimBsrMIBConformance 2 } -- -- Compliance Statements -- pimBsrMIBCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for PIM routers which implement the PIM BSR MIB." MODULE -- this module MANDATORY-GROUPS { pimBsrObjectGroup } ::= { pimBsrMIBCompliances 1 } -- -- Units of Conformance -- pimBsrObjectGroup OBJECT-GROUP OBJECTS { bsrCandidateRPBidir, bsrCandidateRPStatus, bsrRPSetPriority, bsrRPSetHoldtime, bsrRPSetExpiryTime, bsrCandidateBSRAddress, bsrCandidateBSRPriority, bsrCandidateBSRHashMaskLength, bsrCandidateBSRElectedBSR, bsrCandidateBSRBootstrapTimer, bsrCandidateBSRStatus, bsrElectedBSRAddress, bsrElectedBSRPriority, bsrElectedBSRHashMaskLength, bsrElectedBSRExpiryTime, bsrElectedBSRCRPAdvTimer } STATUS current DESCRIPTION "A collection of objects for managing PIM routers." ::= { pimBsrMIBGroups 1 } END -- -- Copyright (C) The Internet Society (2005). This document is subject -- to the rights, licenses and restrictions contained in BCP 78, and -- except as set forth therein, the authors retain all their rights. -- -- -- Acknowledgment -- -- Funding for the RFC Editor function is currently provided by the -- Internet Society.