module PIM-MIB {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:smiv2:PIM-MIB";

    prefix PIM-MIB;

    import IF-MIB {
      prefix if-mib;
    }
    import IPMROUTE-STD-MIB {
      prefix ipmroute-std;
    }
    import SNMPv2-TC {
      prefix snmpv2-tc;
    }
    import ietf-inet-types {
      prefix inet;
    }
    import ietf-yang-smiv2 {
      prefix smiv2;
    }
    import ietf-yang-types {
      prefix yang;
    }

    organization "IETF IDMR Working Group.";

    contact
      " Dave Thaler
Microsoft Corporation
One Microsoft Way
Redmond, WA  98052-6399
US

Phone: +1 425 703 8835
EMail: dthaler@microsoft.com";

    description
      "The MIB module for management of PIM routers.";

    revision "2000-09-28" {
      description
        "Initial version, published as RFC 2934.";
    }

    smiv2:alias "pimMIB" {
      smiv2:oid "1.3.6.1.3.61";
    }
    smiv2:alias "pimMIBObjects" {
      smiv2:oid "1.3.6.1.3.61.1";
    }
    smiv2:alias "pimTraps" {
      smiv2:oid "1.3.6.1.3.61.1.0";
    }
    smiv2:alias "pim" {
      smiv2:oid "1.3.6.1.3.61.1.1";
    }
    smiv2:alias "pimMIBConformance" {
      smiv2:oid "1.3.6.1.3.61.2";
    }
    smiv2:alias "pimMIBCompliances" {
      smiv2:oid "1.3.6.1.3.61.2.1";
    }
    smiv2:alias "pimMIBGroups" {
      smiv2:oid "1.3.6.1.3.61.2.2";
    }

    container PIM-MIB {
      config false;
      container pim {
        smiv2:oid "1.3.6.1.3.61.1.1";
        leaf pimJoinPruneInterval {
          smiv2:max-access "read-write";
          smiv2:oid "1.3.6.1.3.61.1.1.1";
          type int32;
          units "seconds";
          description
            "The default interval at which periodic PIM-SM Join/Prune
messages are to be sent.";
        }
      }  // container pim

      container pimInterfaceTable {
        smiv2:oid "1.3.6.1.3.61.1.1.2";
        description
          "The (conceptual) table listing the router's PIM interfaces.
IGMP and PIM are enabled on all interfaces listed in this
table.";
        list pimInterfaceEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.2.1";
          key "pimInterfaceIfIndex";
          description
            "An entry (conceptual row) in the pimInterfaceTable.";
          leaf pimInterfaceIfIndex {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.1";
            type if-mib:InterfaceIndex;
            description
              "The ifIndex value of this PIM interface.";
          }

          leaf pimInterfaceAddress {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.2";
            type inet:ipv4-address;
            description
              "The IP address of the PIM interface.";
          }

          leaf pimInterfaceNetMask {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.3";
            type inet:ipv4-address;
            description
              "The network mask for the IP address of the PIM interface.";
          }

          leaf pimInterfaceMode {
            smiv2:defval "dense";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.4";
            type enumeration {
              enum "dense" {
                value 1;
              }
              enum "sparse" {
                value 2;
              }
              enum "sparseDense" {
                value 3;
              }
            }
            description
              "The configured mode of this PIM interface.  A value of
sparseDense is only valid for PIMv1.";
          }

          leaf pimInterfaceDR {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.5";
            type inet:ipv4-address;
            description
              "The Designated Router on this PIM interface.  For point-to-
point interfaces, this object has the value 0.0.0.0.";
          }

          leaf pimInterfaceHelloInterval {
            smiv2:defval "30";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.6";
            type int32;
            units "seconds";
            description
              "The frequency at which PIM Hello messages are transmitted
on this interface.";
          }

          leaf pimInterfaceStatus {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.7";
            type snmpv2-tc:RowStatus;
            description
              "The status of this entry.  Creating the entry enables PIM
on the interface; destroying the entry disables PIM on the
interface.";
          }

          leaf pimInterfaceJoinPruneInterval {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.8";
            type int32;
            units "seconds";
            description
              "The frequency at which PIM Join/Prune messages are
transmitted on this PIM interface.  The default value of
this object is the pimJoinPruneInterval.";
          }

          leaf pimInterfaceCBSRPreference {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.2.1.9";
            type int32 {
              range "-1..255";
            }
            description
              "The preference value for the local interface as a candidate
bootstrap router.  The value of -1 is used to indicate that
the local interface is not a candidate BSR interface.";
          }
        }  // list pimInterfaceEntry
      }  // container pimInterfaceTable

      container pimNeighborTable {
        smiv2:oid "1.3.6.1.3.61.1.1.3";
        description
          "The (conceptual) table listing the router's PIM neighbors.";
        list pimNeighborEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.3.1";
          key "pimNeighborAddress";
          description
            "An entry (conceptual row) in the pimNeighborTable.";
          leaf pimNeighborAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.3.1.1";
            type inet:ipv4-address;
            description
              "The IP address of the PIM neighbor for which this entry
contains information.";
          }

          leaf pimNeighborIfIndex {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.3.1.2";
            type if-mib:InterfaceIndex;
            description
              "The value of ifIndex for the interface used to reach this
PIM neighbor.";
          }

          leaf pimNeighborUpTime {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.3.1.3";
            type yang:timeticks;
            description
              "The time since this PIM neighbor (last) became a neighbor
of the local router.";
          }

          leaf pimNeighborExpiryTime {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.3.1.4";
            type yang:timeticks;
            description
              "The minimum time remaining before this PIM neighbor will be
aged out.";
          }

          leaf pimNeighborMode {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.3.1.5";
            type enumeration {
              enum "dense" {
                value 1;
              }
              enum "sparse" {
                value 2;
              }
            }
            status deprecated;
            description
              "The active PIM mode of this neighbor.  This object is
deprecated for PIMv2 routers since all neighbors on the
interface must be either dense or sparse as determined by
the protocol running on the interface.";
          }
        }  // list pimNeighborEntry
      }  // container pimNeighborTable

      container pimIpMRouteTable {
        smiv2:oid "1.3.6.1.3.61.1.1.4";
        description
          "The (conceptual) table listing PIM-specific information on
a subset of the rows of the ipMRouteTable defined in the IP
Multicast MIB.";
        list pimIpMRouteEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.4.1";
          key "ipMRouteGroup ipMRouteSource ipMRouteSourceMask";
          description
            "An entry (conceptual row) in the pimIpMRouteTable.  There
is one entry per entry in the ipMRouteTable whose incoming
interface is running PIM.";
          leaf ipMRouteGroup {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteTable/ipmroute-std:ipMRouteEntry/ipmroute-std:ipMRouteGroup";
            }
          }

          leaf ipMRouteSource {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteTable/ipmroute-std:ipMRouteEntry/ipmroute-std:ipMRouteSource";
            }
          }

          leaf ipMRouteSourceMask {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteTable/ipmroute-std:ipMRouteEntry/ipmroute-std:ipMRouteSourceMask";
            }
          }

          leaf pimIpMRouteUpstreamAssertTimer {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.4.1.1";
            type yang:timeticks;
            description
              "The time remaining before the router changes its upstream
neighbor back to its RPF neighbor.  This timer is called the
Assert timer in the PIM Sparse and Dense mode specification.





A value of 0 indicates that no Assert has changed the
upstream neighbor away from the RPF neighbor.";
          }

          leaf pimIpMRouteAssertMetric {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.4.1.2";
            type int32;
            description
              "The metric advertised by the assert winner on the upstream
interface, or 0 if no such assert is in received.";
          }

          leaf pimIpMRouteAssertMetricPref {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.4.1.3";
            type int32;
            description
              "The preference advertised by the assert winner on the
upstream interface, or 0 if no such assert is in effect.";
          }

          leaf pimIpMRouteAssertRPTBit {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.4.1.4";
            type boolean;
            description
              "The value of the RPT-bit advertised by the assert winner on
the upstream interface, or false if no such assert is in
effect.";
          }

          leaf pimIpMRouteFlags {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.4.1.5";
            type binary {
              length "1";
            }
            description
              "This object describes PIM-specific flags related to a
multicast state entry.  See the PIM Sparse Mode
specification for the meaning of the RPT and SPT bits.";
          }
        }  // list pimIpMRouteEntry
      }  // container pimIpMRouteTable

      container pimRPTable {
        smiv2:oid "1.3.6.1.3.61.1.1.5";
        status deprecated;
        description
          "The (conceptual) table listing PIM version 1 information
for the Rendezvous Points (RPs) for IP multicast groups.
This table is deprecated since its function is replaced by
the pimRPSetTable for PIM version 2.";
        list pimRPEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.5.1";
          key "pimRPGroupAddress pimRPAddress";
          status deprecated;
          description
            "An entry (conceptual row) in the pimRPTable.  There is one
entry per RP address for each IP multicast group.";
          leaf pimRPGroupAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.1";
            type inet:ipv4-address;
            status deprecated;
            description
              "The IP multicast group address for which this entry
contains information about an RP.";
          }

          leaf pimRPAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.2";
            type inet:ipv4-address;
            status deprecated;
            description
              "The unicast address of the RP.";
          }

          leaf pimRPState {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.3";
            type enumeration {
              enum "up" {
                value 1;
              }
              enum "down" {
                value 2;
              }
            }
            status deprecated;
            description
              "The state of the RP.";
          }

          leaf pimRPStateTimer {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.4";
            type yang:timeticks;
            status deprecated;
            description
              "The minimum time remaining before the next state change.
When pimRPState is up, this is the minimum time which must
expire until it can be declared down.  When pimRPState is
down, this is the time until it will be declared up (in
order to retry).";
          }

          leaf pimRPLastChange {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.5";
            type yang:timeticks;
            status deprecated;
            description
              "The value of sysUpTime at the time when the corresponding
instance of pimRPState last changed its value.";
          }

          leaf pimRPRowStatus {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.5.1.6";
            type snmpv2-tc:RowStatus;
            status deprecated;
            description
              "The status of this row, by which new entries may be
created, or old entries deleted from this table.";
          }
        }  // list pimRPEntry
      }  // container pimRPTable

      container pimRPSetTable {
        smiv2:oid "1.3.6.1.3.61.1.1.6";
        description
          "The (conceptual) table listing PIM information for
candidate Rendezvous Points (RPs) for IP multicast groups.
When the local router is the BSR, this information is
obtained from received Candidate-RP-Advertisements.  When
the local router is not the BSR, this information is
obtained from received RP-Set messages.";
        list pimRPSetEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.6.1";
          key "pimRPSetComponent pimRPSetGroupAddress pimRPSetGroupMask pimRPSetAddress";
          description
            "An entry (conceptual row) in the pimRPSetTable.";
          leaf pimRPSetGroupAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.1";
            type inet:ipv4-address;
            description
              "The IP multicast group address which, when combined with
pimRPSetGroupMask, gives the group prefix for which this
entry contains information about the Candidate-RP.";
          }

          leaf pimRPSetGroupMask {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.2";
            type inet:ipv4-address;
            description
              "The multicast group address mask which, when combined with
pimRPSetGroupAddress, gives the group prefix for which this
entry contains information about the Candidate-RP.";
          }

          leaf pimRPSetAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.3";
            type inet:ipv4-address;
            description
              "The IP address of the Candidate-RP.";
          }

          leaf pimRPSetHoldTime {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.4";
            type int32 {
              range "0..255";
            }
            units "seconds";
            description
              "The holdtime of a Candidate-RP.  If the local router is not
the BSR, this value is 0.";
          }

          leaf pimRPSetExpiryTime {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.5";
            type yang:timeticks;
            description
              "The minimum time remaining before the Candidate-RP will be
declared down.  If the local router is not the BSR, this
value is 0.";
          }

          leaf pimRPSetComponent {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.6.1.6";
            type int32 {
              range "1..255";
            }
            description
              " A number uniquely identifying the component.  Each
protocol instance connected to a separate domain should have
a different index value.";
          }
        }  // list pimRPSetEntry
      }  // container pimRPSetTable

      container pimIpMRouteNextHopTable {
        smiv2:oid "1.3.6.1.3.61.1.1.7";
        description
          "The (conceptual) table listing PIM-specific information on
a subset of the rows of the ipMRouteNextHopTable defined in
the IP Multicast MIB.";
        list pimIpMRouteNextHopEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.7.1";
          key "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress";
          description
            "An entry (conceptual row) in the pimIpMRouteNextHopTable.
There is one entry per entry in the ipMRouteNextHopTable
whose interface is running PIM and whose
ipMRouteNextHopState is pruned(1).";
          leaf ipMRouteNextHopGroup {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteNextHopTable/ipmroute-std:ipMRouteNextHopEntry/ipmroute-std:ipMRouteNextHopGroup";
            }
          }

          leaf ipMRouteNextHopSource {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteNextHopTable/ipmroute-std:ipMRouteNextHopEntry/ipmroute-std:ipMRouteNextHopSource";
            }
          }

          leaf ipMRouteNextHopSourceMask {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteNextHopTable/ipmroute-std:ipMRouteNextHopEntry/ipmroute-std:ipMRouteNextHopSourceMask";
            }
          }

          leaf ipMRouteNextHopIfIndex {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteNextHopTable/ipmroute-std:ipMRouteNextHopEntry/ipmroute-std:ipMRouteNextHopIfIndex";
            }
          }

          leaf ipMRouteNextHopAddress {
            type leafref {
              path "/ipmroute-std:IPMROUTE-STD-MIB/ipmroute-std:ipMRouteNextHopTable/ipmroute-std:ipMRouteNextHopEntry/ipmroute-std:ipMRouteNextHopAddress";
            }
          }

          leaf pimIpMRouteNextHopPruneReason {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.7.1.2";
            type enumeration {
              enum "other" {
                value 1;
              }
              enum "prune" {
                value 2;
              }
              enum "assert" {
                value 3;
              }
            }
            description
              "This object indicates why the downstream interface was
pruned, whether in response to a PIM prune message or due to
PIM Assert processing.";
          }
        }  // list pimIpMRouteNextHopEntry
      }  // container pimIpMRouteNextHopTable

      container pimCandidateRPTable {
        smiv2:oid "1.3.6.1.3.61.1.1.11";
        description
          "The (conceptual) table listing the IP multicast groups for
which the local router is to advertise itself as a
Candidate-RP when the value of pimComponentCRPHoldTime is
non-zero.  If this table is empty, then the local router





will advertise itself as a Candidate-RP for all groups
(providing the value of pimComponentCRPHoldTime is non-
zero).";
        list pimCandidateRPEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.11.1";
          key "pimCandidateRPGroupAddress pimCandidateRPGroupMask";
          description
            "An entry (conceptual row) in the pimCandidateRPTable.";
          leaf pimCandidateRPGroupAddress {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.11.1.1";
            type inet:ipv4-address;
            description
              "The IP multicast group address which, when combined with
pimCandidateRPGroupMask, identifies a group prefix for which
the local router will advertise itself as a Candidate-RP.";
          }

          leaf pimCandidateRPGroupMask {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.11.1.2";
            type inet:ipv4-address;
            description
              "The multicast group address mask which, when combined with
pimCandidateRPGroupMask, identifies a group prefix for which
the local router will advertise itself as a Candidate-RP.";
          }

          leaf pimCandidateRPAddress {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.11.1.3";
            type inet:ipv4-address;
            description
              "The (unicast) address of the interface which will be





advertised as a Candidate-RP.";
          }

          leaf pimCandidateRPRowStatus {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.11.1.4";
            type snmpv2-tc:RowStatus;
            description
              "The status of this row, by which new entries may be
created, or old entries deleted from this table.";
          }
        }  // list pimCandidateRPEntry
      }  // container pimCandidateRPTable

      container pimComponentTable {
        smiv2:oid "1.3.6.1.3.61.1.1.12";
        description
          "The (conceptual) table containing objects specific to a PIM
domain.  One row exists for each domain to which the router
is connected.  A PIM-SM domain is defined as an area of the
network over which Bootstrap messages are forwarded.
Typically, a PIM-SM router will be a member of exactly one
domain.  This table also supports, however, routers which
may form a border between two PIM-SM domains and do not
forward Bootstrap messages between them.";
        list pimComponentEntry {
          smiv2:oid "1.3.6.1.3.61.1.1.12.1";
          key "pimComponentIndex";
          description
            "An entry (conceptual row) in the pimComponentTable.";
          leaf pimComponentIndex {
            smiv2:max-access "not-accessible";
            smiv2:oid "1.3.6.1.3.61.1.1.12.1.1";
            type int32 {
              range "1..255";
            }
            description
              "A number uniquely identifying the component.  Each protocol
instance connected to a separate domain should have a
different index value.  Routers that only support membership
in a single PIM-SM domain should use a pimComponentIndex
value of 1.";
          }

          leaf pimComponentBSRAddress {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.12.1.2";
            type inet:ipv4-address;
            description
              "The IP address of the bootstrap router (BSR) for the local
PIM region.";
          }

          leaf pimComponentBSRExpiryTime {
            smiv2:max-access "read-only";
            smiv2:oid "1.3.6.1.3.61.1.1.12.1.3";
            type yang:timeticks;
            description
              "The minimum time remaining before the bootstrap router in
the local domain will be declared down.  For candidate BSRs,
this is the time until the component sends an RP-Set
message.  For other routers, this is the time until it may
accept an RP-Set message from a lower candidate BSR.";
          }

          leaf pimComponentCRPHoldTime {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.12.1.4";
            type int32 {
              range "0..255";
            }
            units "seconds";
            description
              "The holdtime of the component when it is a candidate RP in
the local domain.  The value of 0 is used to indicate that
the local system is not a Candidate-RP.";
          }

          leaf pimComponentStatus {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.3.61.1.1.12.1.5";
            type snmpv2-tc:RowStatus;
            description
              "The status of this entry.  Creating the entry creates
another protocol instance; destroying the entry disables a
protocol instance.";
          }
        }  // list pimComponentEntry
      }  // container pimComponentTable
    }  // container PIM-MIB

    notification pimNeighborLoss {
      smiv2:oid "1.3.6.1.3.61.1.0.1";
      description
        "A pimNeighborLoss trap signifies the loss of an adjacency
with a neighbor.  This trap should be generated when the
neighbor timer expires, and the router has no other
neighbors on the same interface with a lower IP address than
itself.";
      container object-1 {
        leaf pimNeighborAddress {
          type leafref {
            path "/PIM-MIB:PIM-MIB/PIM-MIB:pimNeighborTable/PIM-MIB:pimNeighborEntry/PIM-MIB:pimNeighborAddress";
          }
        }

        leaf pimNeighborIfIndex {
          type leafref {
            path "/PIM-MIB:PIM-MIB/PIM-MIB:pimNeighborTable/PIM-MIB:pimNeighborEntry/PIM-MIB:pimNeighborIfIndex";
          }
        }
      }  // container object-1
    }  // notification pimNeighborLoss
  }  // module PIM-MIB