IPMROUTE-STD-MIB

The MIB module for management of IP Multicast routing, but independent of the specific multicast routing protocol in use.

  • Version: 2000-09-22

    IPMROUTE-STD-MIB@2000-09-22


    
      module IPMROUTE-STD-MIB {
    
        yang-version 1;
    
        namespace
          "urn:ietf:params:xml:ns:yang:smiv2:IPMROUTE-STD-MIB";
    
        prefix IPMROUTE-STD-MIB;
    
        import IANA-RTPROTO-MIB {
          prefix iana-rtproto;
        }
        import IF-MIB {
          prefix if-mib;
        }
        import SNMP-FRAMEWORK-MIB {
          prefix snmp-framework;
        }
        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 IP Multicast routing, but
    independent of the specific multicast routing protocol in
    use.";
    
        revision "2000-09-22" {
          description
            "Initial version, published as RFC 2932.";
        }
    
        smiv2:alias "ipMRouteStdMIB" {
          smiv2:oid "1.3.6.1.2.1.83";
        }
        smiv2:alias "ipMRouteMIBObjects" {
          smiv2:oid "1.3.6.1.2.1.83.1";
        }
        smiv2:alias "ipMRoute" {
          smiv2:oid "1.3.6.1.2.1.83.1.1";
        }
        smiv2:alias "ipMRouteMIBConformance" {
          smiv2:oid "1.3.6.1.2.1.83.2";
        }
        smiv2:alias "ipMRouteMIBCompliances" {
          smiv2:oid "1.3.6.1.2.1.83.2.1";
        }
        smiv2:alias "ipMRouteMIBGroups" {
          smiv2:oid "1.3.6.1.2.1.83.2.2";
        }
    
        typedef LanguageTag {
          type string {
            smiv2:display-hint "100a";
          }
          description
            "An RFC 1766-style language tag, with all alphabetic
    characters converted to lowercase.  This restriction is
    intended to make the lexical ordering imposed by SNMP useful
    
    
    
    
    
    when applied to language tags.  Note that it is
    theoretically possible for a valid language tag to exceed
    the allowed length of this syntax, and thus be impossible to
    represent with this syntax.  Sampling of language tags in
    current use on the Internet suggests that this limit does
    not pose a serious problem in practice.";
        }
    
        container IPMROUTE-STD-MIB {
          config false;
          container ipMRoute {
            smiv2:oid "1.3.6.1.2.1.83.1.1";
            leaf ipMRouteEnable {
              smiv2:max-access "read-write";
              smiv2:oid "1.3.6.1.2.1.83.1.1.1";
              type enumeration {
                enum "enabled" {
                  value 1;
                }
                enum "disabled" {
                  value 2;
                }
              }
              description
                "The enabled status of IP Multicast routing on this router.";
            }
    
            leaf ipMRouteEntryCount {
              smiv2:max-access "read-only";
              smiv2:oid "1.3.6.1.2.1.83.1.1.7";
              type yang:gauge32;
              description
                "The number of rows in the ipMRouteTable.  This can be used
    to monitor the multicast routing table size.";
            }
          }  // container ipMRoute
    
          container ipMRouteTable {
            smiv2:oid "1.3.6.1.2.1.83.1.1.2";
            description
              "The (conceptual) table containing multicast routing
    information for IP datagrams sent by particular sources to
    the IP multicast groups known to this router.";
            list ipMRouteEntry {
              smiv2:oid "1.3.6.1.2.1.83.1.1.2.1";
              key "ipMRouteGroup ipMRouteSource ipMRouteSourceMask";
              description
                "An entry (conceptual row) containing the multicast routing
    information for IP datagrams from a particular source and
    addressed to a particular IP multicast group address.
    Discontinuities in counters in this entry can be detected by
    observing the value of ipMRouteUpTime.";
              leaf ipMRouteGroup {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.1";
                type inet:ipv4-address;
                description
                  "The IP multicast group address for which this entry
    contains multicast routing information.";
              }
    
              leaf ipMRouteSource {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.2";
                type inet:ipv4-address;
                description
                  "The network address which when combined with the
    corresponding value of ipMRouteSourceMask identifies the
    sources for which this entry contains multicast routing
    information.";
              }
    
              leaf ipMRouteSourceMask {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.3";
                type inet:ipv4-address;
                description
                  "The network mask which when combined with the corresponding
    value of ipMRouteSource identifies the sources for which
    this entry contains multicast routing information.";
              }
    
              leaf ipMRouteUpstreamNeighbor {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.4";
                type inet:ipv4-address;
                description
                  "The address of the upstream neighbor (e.g., RPF neighbor)
    from which IP datagrams from these sources to this multicast
    address are received, or 0.0.0.0 if the upstream neighbor is
    unknown (e.g., in CBT).";
              }
    
              leaf ipMRouteInIfIndex {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.5";
                type if-mib:InterfaceIndexOrZero;
                description
                  "The value of ifIndex for the interface on which IP
    datagrams sent by these sources to this multicast address
    are received.  A value of 0 indicates that datagrams are not
    subject to an incoming interface check, but may be accepted
    on multiple interfaces (e.g., in CBT).";
              }
    
              leaf ipMRouteUpTime {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.6";
                type yang:timeticks;
                description
                  "The time since the multicast routing information
    represented by this entry was learned by the router.";
              }
    
              leaf ipMRouteExpiryTime {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.7";
                type yang:timeticks;
                description
                  "The minimum amount of time remaining before this entry will
    be aged out.  The value 0 indicates that the entry is not
    subject to aging.";
              }
    
              leaf ipMRoutePkts {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.8";
                type yang:counter32;
                description
                  "The number of packets which this router has received from
    these sources and addressed to this multicast group
    address.";
              }
    
              leaf ipMRouteDifferentInIfPackets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.9";
                type yang:counter32;
                description
                  "The number of packets which this router has received from
    these sources and addressed to this multicast group address,
    which were dropped because they were not received on the
    interface indicated by ipMRouteInIfIndex.  Packets which are
    not subject to an incoming interface check (e.g., using CBT)
    are not counted.";
              }
    
              leaf ipMRouteOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.10";
                type yang:counter32;
                description
                  "The number of octets contained in IP datagrams which were
    received from these sources and addressed to this multicast
    group address, and which were forwarded by this router.";
              }
    
              leaf ipMRouteProtocol {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.11";
                type iana-rtproto:IANAipMRouteProtocol;
                description
                  "The multicast routing protocol via which this multicast
    forwarding entry was learned.";
              }
    
              leaf ipMRouteRtProto {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.12";
                type iana-rtproto:IANAipRouteProtocol;
                description
                  "The routing mechanism via which the route used to find the
    upstream or parent interface for this multicast forwarding
    entry was learned.  Inclusion of values for routing
    protocols is not intended to imply that those protocols need
    be supported.";
              }
    
              leaf ipMRouteRtAddress {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.13";
                type inet:ipv4-address;
                description
                  "The address portion of the route used to find the upstream
    or parent interface for this multicast forwarding entry.";
              }
    
              leaf ipMRouteRtMask {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.14";
                type inet:ipv4-address;
                description
                  "The mask associated with the route used to find the upstream
    or parent interface for this multicast forwarding entry.";
              }
    
              leaf ipMRouteRtType {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.15";
                type enumeration {
                  enum "unicast" {
                    value 1;
                  }
                  enum "multicast" {
                    value 2;
                  }
                }
                description
                  "The reason the given route was placed in the (logical)
    multicast Routing Information Base (RIB).  A value of
    unicast means that the route would normally be placed only
    in the unicast RIB, but was placed in the multicast RIB
    (instead or in addition) due to local configuration, such as
    when running PIM over RIP.  A value of multicast means that
    
    
    
    
    
    the route was explicitly added to the multicast RIB by the
    routing protocol, such as DVMRP or Multiprotocol BGP.";
              }
    
              leaf ipMRouteHCOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.2.1.16";
                type yang:counter64;
                description
                  "The number of octets contained in IP datagrams which were
    received from these sources and addressed to this multicast
    group address, and which were forwarded by this router.
    This object is a 64-bit version of ipMRouteOctets.";
              }
            }  // list ipMRouteEntry
          }  // container ipMRouteTable
    
          container ipMRouteNextHopTable {
            smiv2:oid "1.3.6.1.2.1.83.1.1.3";
            description
              "The (conceptual) table containing information on the next-
    hops on outgoing interfaces for routing IP multicast
    datagrams.  Each entry is one of a list of next-hops on
    outgoing interfaces for particular sources sending to a
    particular multicast group address.";
            list ipMRouteNextHopEntry {
              smiv2:oid "1.3.6.1.2.1.83.1.1.3.1";
              key "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress";
              description
                "An entry (conceptual row) in the list of next-hops on
    outgoing interfaces to which IP multicast datagrams from
    particular sources to a IP multicast group address are
    routed.  Discontinuities in counters in this entry can be
    detected by observing the value of ipMRouteUpTime.";
              leaf ipMRouteNextHopGroup {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.1";
                type inet:ipv4-address;
                description
                  "The IP multicast group for which this entry specifies a
    next-hop on an outgoing interface.";
              }
    
              leaf ipMRouteNextHopSource {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.2";
                type inet:ipv4-address;
                description
                  "The network address which when combined with the
    corresponding value of ipMRouteNextHopSourceMask identifies
    the sources for which this entry specifies a next-hop on an
    outgoing interface.";
              }
    
              leaf ipMRouteNextHopSourceMask {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.3";
                type inet:ipv4-address;
                description
                  "The network mask which when combined with the corresponding
    value of ipMRouteNextHopSource identifies the sources for
    which this entry specifies a next-hop on an outgoing
    interface.";
              }
    
              leaf ipMRouteNextHopIfIndex {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.4";
                type if-mib:InterfaceIndex;
                description
                  "The ifIndex value of the interface for the outgoing
    interface for this next-hop.";
              }
    
              leaf ipMRouteNextHopAddress {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.5";
                type inet:ipv4-address;
                description
                  "The address of the next-hop specific to this entry.  For
    most interfaces, this is identical to ipMRouteNextHopGroup.
    NBMA interfaces, however, may have multiple next-hop
    addresses out a single outgoing interface.";
              }
    
              leaf ipMRouteNextHopState {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.6";
                type enumeration {
                  enum "pruned" {
                    value 1;
                  }
                  enum "forwarding" {
                    value 2;
                  }
                }
                description
                  "An indication of whether the outgoing interface and next-
    hop represented by this entry is currently being used to
    forward IP datagrams.  The value 'forwarding' indicates it
    is currently being used; the value 'pruned' indicates it is
    not.";
              }
    
              leaf ipMRouteNextHopUpTime {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.7";
                type yang:timeticks;
                description
                  "The time since the multicast routing information
    represented by this entry was learned by the router.";
              }
    
              leaf ipMRouteNextHopExpiryTime {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.8";
                type yang:timeticks;
                description
                  "The minimum amount of time remaining before this entry will
    be aged out.  If ipMRouteNextHopState is pruned(1), the
    remaining time until the prune expires and the state reverts
    to forwarding(2).  Otherwise, the remaining time until this
    entry is removed from the table.  The time remaining may be
    copied from ipMRouteExpiryTime if the protocol in use for
    this entry does not specify next-hop timers.  The value 0
    
    
    
    
    
    indicates that the entry is not subject to aging.";
              }
    
              leaf ipMRouteNextHopClosestMemberHops {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.9";
                type int32;
                description
                  "The minimum number of hops between this router and any
    member of this IP multicast group reached via this next-hop
    on this outgoing interface.  Any IP multicast datagrams for
    the group which have a TTL less than this number of hops
    will not be forwarded to this next-hop.";
              }
    
              leaf ipMRouteNextHopProtocol {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.10";
                type iana-rtproto:IANAipMRouteProtocol;
                description
                  "The routing mechanism via which this next-hop was learned.";
              }
    
              leaf ipMRouteNextHopPkts {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.3.1.11";
                type yang:counter32;
                description
                  "The number of packets which have been forwarded using this
    route.";
              }
            }  // list ipMRouteNextHopEntry
          }  // container ipMRouteNextHopTable
    
          container ipMRouteInterfaceTable {
            smiv2:oid "1.3.6.1.2.1.83.1.1.4";
            description
              "The (conceptual) table containing multicast routing
    information specific to interfaces.";
            list ipMRouteInterfaceEntry {
              smiv2:oid "1.3.6.1.2.1.83.1.1.4.1";
              key "ipMRouteInterfaceIfIndex";
              description
                "An entry (conceptual row) containing the multicast routing
    information for a particular interface.";
              leaf ipMRouteInterfaceIfIndex {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.1";
                type if-mib:InterfaceIndex;
                description
                  "The ifIndex value of the interface for which this entry
    contains information.";
              }
    
              leaf ipMRouteInterfaceTtl {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.2";
                type int32 {
                  range "0..255";
                }
                description
                  "The datagram TTL threshold for the interface. Any IP
    multicast datagrams with a TTL less than this threshold will
    not be forwarded out the interface. The default value of 0
    means all multicast packets are forwarded out the
    interface.";
              }
    
              leaf ipMRouteInterfaceProtocol {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.3";
                type iana-rtproto:IANAipMRouteProtocol;
                description
                  "The routing protocol running on this interface.";
              }
    
              leaf ipMRouteInterfaceRateLimit {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.4";
                type int32;
                description
                  "The rate-limit, in kilobits per second, of forwarded
    multicast traffic on the interface.  A rate-limit of 0
    indicates that no rate limiting is done.";
              }
    
              leaf ipMRouteInterfaceInMcastOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.5";
                type yang:counter32;
                description
                  "The number of octets of multicast packets that have arrived
    on the interface, including framing characters.  This object
    is similar to ifInOctets in the Interfaces MIB, except that
    only multicast packets are counted.";
              }
    
              leaf ipMRouteInterfaceOutMcastOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.6";
                type yang:counter32;
                description
                  "The number of octets of multicast packets that have been
    sent on the interface.";
              }
    
              leaf ipMRouteInterfaceHCInMcastOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.7";
                type yang:counter64;
                description
                  "The number of octets of multicast packets that have arrived
    on the interface, including framing characters.  This object
    is a 64-bit version of ipMRouteInterfaceInMcastOctets.  It
    is similar to ifHCInOctets in the Interfaces MIB, except
    that only multicast packets are counted.";
              }
    
              leaf ipMRouteInterfaceHCOutMcastOctets {
                smiv2:max-access "read-only";
                smiv2:oid "1.3.6.1.2.1.83.1.1.4.1.8";
                type yang:counter64;
                description
                  "The number of octets of multicast packets that have been
    
    
    
    
    
    sent on the interface.  This object is a 64-bit version of
    ipMRouteInterfaceOutMcastOctets.";
              }
            }  // list ipMRouteInterfaceEntry
          }  // container ipMRouteInterfaceTable
    
          container ipMRouteBoundaryTable {
            smiv2:oid "1.3.6.1.2.1.83.1.1.5";
            description
              "The (conceptual) table listing the router's scoped
    multicast address boundaries.";
            list ipMRouteBoundaryEntry {
              smiv2:oid "1.3.6.1.2.1.83.1.1.5.1";
              key "ipMRouteBoundaryIfIndex ipMRouteBoundaryAddress ipMRouteBoundaryAddressMask";
              description
                "An entry (conceptual row) in the ipMRouteBoundaryTable
    representing a scoped boundary.";
              leaf ipMRouteBoundaryIfIndex {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.5.1.1";
                type if-mib:InterfaceIndex;
                description
                  "The IfIndex value for the interface to which this boundary
    applies.  Packets with a destination address in the
    associated address/mask range will not be forwarded out this
    interface.";
              }
    
              leaf ipMRouteBoundaryAddress {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.5.1.2";
                type inet:ipv4-address;
                description
                  "The group address which when combined with the
    corresponding value of ipMRouteBoundaryAddressMask
    identifies the group range for which the scoped boundary
    exists.  Scoped addresses must come from the range 239.x.x.x
    as specified in RFC 2365.";
              }
    
              leaf ipMRouteBoundaryAddressMask {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.5.1.3";
                type inet:ipv4-address;
                description
                  "The group address mask which when combined with the
    corresponding value of ipMRouteBoundaryAddress identifies
    the group range for which the scoped boundary exists.";
              }
    
              leaf ipMRouteBoundaryStatus {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.5.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 ipMRouteBoundaryEntry
          }  // container ipMRouteBoundaryTable
    
          container ipMRouteScopeNameTable {
            smiv2:oid "1.3.6.1.2.1.83.1.1.6";
            description
              "The (conceptual) table listing the multicast scope names.";
            list ipMRouteScopeNameEntry {
              smiv2:implied "ipMRouteScopeNameLanguage";
              smiv2:oid "1.3.6.1.2.1.83.1.1.6.1";
              key "ipMRouteScopeNameAddress ipMRouteScopeNameAddressMask ipMRouteScopeNameLanguage";
              description
                "An entry (conceptual row) in the ipMRouteScopeNameTable
    representing a multicast scope name.";
              leaf ipMRouteScopeNameAddress {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.1";
                type inet:ipv4-address;
                description
                  "The group address which when combined with the
    corresponding value of ipMRouteScopeNameAddressMask
    identifies the group range associated with the multicast
    scope.  Scoped addresses must come from the range
    239.x.x.x.";
              }
    
              leaf ipMRouteScopeNameAddressMask {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.2";
                type inet:ipv4-address;
                description
                  "The group address mask which when combined with the
    corresponding value of ipMRouteScopeNameAddress identifies
    the group range associated with the multicast scope.";
              }
    
              leaf ipMRouteScopeNameLanguage {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.3";
                type LanguageTag;
                description
                  "The RFC 1766-style language tag associated with the scope
    name.";
              }
    
              leaf ipMRouteScopeNameString {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.4";
                type snmp-framework:SnmpAdminString;
                description
                  "The textual name associated with the multicast scope.  The
    value of this object should be suitable for displaying to
    end-users, such as when allocating a multicast address in
    this scope.  When no name is specified, the default value of
    this object should be the string 239.x.x.x/y with x and y
    replaced appropriately to describe the address and mask
    length associated with the scope.";
              }
    
              leaf ipMRouteScopeNameDefault {
                smiv2:defval "false";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.5";
                type boolean;
                description
                  "If true, indicates a preference that the name in the
    following language should be used by applications if no name
    is available in a desired language.";
              }
    
              leaf ipMRouteScopeNameStatus {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.2.1.83.1.1.6.1.6";
                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 ipMRouteScopeNameEntry
          }  // container ipMRouteScopeNameTable
        }  // container IPMROUTE-STD-MIB
      }  // module IPMROUTE-STD-MIB
    

© 2023 YumaWorks, Inc. All rights reserved.