DOCS-L2VPN-MIB
AI MIB Summary
The DOCS-L2VPN-MIB enables the monitoring and configuration of Layer 2 Virtual Private Network (L2VPN) services on DOCSIS-compliant cable modem termination systems (CMTS) and edge routers. It provides granular visibility into L2VPN tunnel states, pseudowire associations, and service instance parameters required for managing broadband Ethernet services over DOCSIS networks.
This is the management MIB for devices complying to the DOCSIS L2VPN Feature.
Main OID:
docsL2vpnMIB.1.3.6.1.4.1.4491.2.1.8
69
Objects
Active
Status
9
Dependencies
Imported Objects
Objects
69 total| Object Name |
|---|
docsL2vpnMIBThis is the management MIB for devices complying to the
DOCSIS L2VPN Feature. MODULE-IDENTITY .1.3.6.1.4.1.4491.2.1.8 |
docsL2vpnMIBNotifications OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.8.0 |
docsL2vpnMIBObjects OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.8.1 |
docsL2vpnIdToIndexTableTable indexed by the octet string DocsL2vpnIdentifier that
provides the local agent's internally assigned docsL2vpnIdx
value for that DocsL2vpnIdentifier value. The mapping of
DocsL2vpnIdentifier to docsL2vpnIdx is 1-1. The agent
must instantiate a row in both docsL2vpnIndexToIdTable and
docsL2vpnIdToIndexTable for each known L2VPN Identifier. SEQUENCE OF DocsL2vpnIdToIndexEntry .1.3.6.1.4.1.4491.2.1.8.1.1 |
docsL2vpnIdToIndexEntryMaps a DocsL2vpnIdentifier octet string into the local
agent's locally assigned docsL2vpnIdx value. DocsL2vpnIdToIndexEntry .1.3.6.1.4.1.4491.2.1.8.1.1.1 |
docsL2vpnIdAn externally configured octet string that identifies an
L2VPN. DocsL2vpnIdentifier .1.3.6.1.4.1.4491.2.1.8.1.1.1.1 |
docsL2vpnIdToIndexIdxAn internally assigned index value for a known L2VPN.ro DocsL2vpnIndex .1.3.6.1.4.1.4491.2.1.8.1.1.1.2 |
docsL2vpnIndexToIdTableTable indexed by agent's local docsL2vpnIdx that provides
the global L2VPN Identifier. The mapping of docsL2vpnIdx to
DocsL2vpnIdentifier is 1-1. The agent must instantiate a
row in both docsL2vpnIndexToIdTable and
docsL2vpnIdToIndexTable for each known L2VPN. SEQUENCE OF DocsL2vpnIndexToIdEntry .1.3.6.1.4.1.4491.2.1.8.1.2 |
docsL2vpnIndexToIdEntryProvides the L2VPN Identifier for each locally-assigned
L2vpn Index. DocsL2vpnIndexToIdEntry .1.3.6.1.4.1.4491.2.1.8.1.2.1 |
docsL2vpnIdxAn internally assigned index value for a known L2VPN. DocsL2vpnIndex .1.3.6.1.4.1.4491.2.1.8.1.2.1.1 |
docsL2vpnIndexToIdIdAn administered octet string that externally identifies an
L2VPN.ro DocsL2vpnIdentifier .1.3.6.1.4.1.4491.2.1.8.1.2.1.2 |
docsL2vpnCmTableThis table describes L2VPN per-CM information that
is in common with all L2VPNs for the CM, regardless
of forwarding mode. SEQUENCE OF DocsL2vpnCmEntry .1.3.6.1.4.1.4491.2.1.8.1.3 |
docsL2vpnCmEntryAn entry is indexed by Cable Modem Index that
describes L2VPN information for a single CM that is in
common with all L2VPNs implemented by the CM,
regardless of the L2VPN forwarding mode.
An entry in this table is created for every CM that
registers with a forwarding L2VPN encoding. DocsL2vpnCmEntry .1.3.6.1.4.1.4491.2.1.8.1.3.1 |
docsL2vpnCmCompliantCapabilityThis object reports whether an L2VPN forwarding CM is
compliant with the DOCSIS L2VPN specification, as reported
in the L2VPN Capability encoding in the CM's registration
request message.
If the capability encoding was omitted, this object must
report the value false(2).ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.8.1.3.1.1 |
docsL2vpnCmDutFilteringCapabilityThis object reports whether an L2VPN forwarding CM is
capable of Downstream Unencrypted Traffic (DUT) Filtering,
as reported in the CM's registration request message.
If the capability encoding was omitted, this object must
report the value false(2).ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.8.1.3.1.2 |
docsL2vpnCmDutCMIMThis object reports the value configured in a per-CM
L2VPN Encoding for Downstream Unencrypted Traffic (DUT)
Cable Modem Interface Mask (CMIM).
The DUT CMIM is a bit string with a '1' for each bit
position K for an internal or external CM interface with
ifIndex K to which the CM permits DUT to be forwarded. A CM
capable of DUT filtering MUST discard DUT to interfaces
with a '0' in the DUT CMIM.
If a CM's top-level registration request L2VPN Encoding
contained no DUT CMIM subtype, this object is reported
with its default value of a '1' in bit position 0
(corresponding to the eCM's own 'self' host) and a '1' in
each bit position K for which an eSAFE interface exists at
ifIndex K. In other words, the default DUT CMIM includes
the eCM and all eSAFE interfaces.
This value is reported independently of whether the CM is
actually capable of performing DUT filtering.ro DocsL2vpnIfList .1.3.6.1.4.1.4491.2.1.8.1.3.1.3 |
docsL2vpnCmDhcpSnoopingThis object reports the value of the Enable DHCP Snooping
subtype of a top-level L2VPN Encoding.
It has the syntax of a CM Interface List bitmask and
represents a set of CM MAC bridge interfaces
corresponding to eSAFE hosts for which the CMTS is enabled
to snoop DHCP traffic in order to learn the eSAFE host MAC
address on that interface.
Only bits corresponding to eSAFE host MAC addresses may be
validly set in this object, including cpe(1) for ePS
and the eSAFE interfaces in bits positions 16 through 31.ro DocsL2vpnIfList .1.3.6.1.4.1.4491.2.1.8.1.3.1.4 |
docsL2vpnVpnCmTableThis table describes the operation of L2VPN forwarding
on each CM. SEQUENCE OF DocsL2vpnVpnCmEntry .1.3.6.1.4.1.4491.2.1.8.1.4 |
docsL2vpnVpnCmEntryAn entry is indexed by VPN ID and Cable Modem Index that
describes the operation of L2VPN forwarding for a single
L2VPN on a single CM. DocsL2vpnVpnCmEntry .1.3.6.1.4.1.4491.2.1.8.1.4.1 |
docsL2vpnVpnCmCMIMA Cable Modem Interface Mask represents a set of
MAC bridge interfaces within the CM. This object
represents the CMIM within a forwarding per-SF L2VPN
encoding, which specifies a set of CM MAC bridge
interfaces to which L2VPN forwarding is restricted.
If the CMIM Subtype is omitted from a forwarding
per-SF encoding, its default value includes only
cpePrimary(1) and cableMac(2), which can be encoded
with a single octet with the value 0x60.ro DocsL2vpnIfList .1.3.6.1.4.1.4491.2.1.8.1.4.1.1 |
docsL2vpnVpnCmIndividualSAIdThe BPI+ Security Association ID in which traffic intended
for point-to-point forwarding through an individual CM is
forwarded.
If the CMTS does not allocate an individual SAID for
multipoint forwarding (as is recommended),it MUST
report this object as zero.ro Integer32 .1.3.6.1.4.1.4491.2.1.8.1.4.1.2 |
docsL2vpnVpnCmVendorSpecificThis object encodes the concatenation of all Vendor
Specific Subtype encodings that appeared in any
registration per-CM L2VPN Encoding associated with this
entry.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.4.1.3 |
docsL2vpnVpnCmStatsTableThis table contains statistics for forwarding of
packets to and from a CM on each VPN. SEQUENCE OF DocsL2vpnVpnCmStatsEntry .1.3.6.1.4.1.4491.2.1.8.1.5 |
docsL2vpnVpnCmStatsEntryAn entry is indexed by VPN ID and Cable Modem Index. DocsL2vpnVpnCmStatsEntry .1.3.6.1.4.1.4491.2.1.8.1.5.1 |
docsL2vpnVpnCmStatsUpstreamPktsThe number of L2vpn-forwarded packets received
from this instance's Cable Modem on
this instance's L2VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.1 |
docsL2vpnVpnCmStatsUpstreamBytesThe number of L2vpn-forwarded bytes received
from this instance's Cable Modem on
this instance's L2VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.2 |
docsL2vpnVpnCmStatsUpstreamDiscardsThe number of L2-forwarded packets
discarded from this instance's
Cable Modem on this instance's VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.3 |
docsL2vpnVpnCmStatsDownstreamPktsThe number of L2-forwarded packets
transmitted to this instance's
Cable Modem on this instance's VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.4 |
docsL2vpnVpnCmStatsDownstreamBytesThe number of L2-forwarded bytes
transmitted to this instance's
Cable Modem on this instance's VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.5 |
docsL2vpnVpnCmStatsDownstreamDiscardsThe number of L2-forwarded packets that were discarded
before they could be transmitted to this instance's
Cable Modem on this instance's VPN.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.5.1.6 |
docsL2vpnPortStatusTableThis table displays summary information for the
run-time state of each VPN that is currently operating
on each bridge port. SEQUENCE OF DocsL2vpnPortStatusEntry .1.3.6.1.4.1.4491.2.1.8.1.6 |
docsL2vpnPortStatusEntryInformation specific to the operation of L2VPN forwarding
on a particular CMTS 'bridge port'. A CMTS 'bridge port'
may be defined by the CMTS vendor, but is advantageously a
single DOCSIS MAC Domain. DocsL2vpnPortStatusEntry .1.3.6.1.4.1.4491.2.1.8.1.6.1 |
docsL2vpnPortStatusGroupSAIdThe Group SAID associated with this VPN on a
particular CMTS MAC domain. This SAID is used to encrypt
all downstream flooded bridge traffic sent to CMs on
this VPN and CMTS MAC domain bridge port.
A value of '0' means there is no associated Group SAID for
this VPN and bridge port, e.g., if the L2VPN uses
point-to-point individual SAIDs only for forwarding.
A bridge port that is not a CMTS MAC
domain will report a value of '0'.ro Integer32 .1.3.6.1.4.1.4491.2.1.8.1.6.1.1 |
docsL2vpnSfStatusTableThis table displays SF-specific L2VPN forwarding status
for each upstream service flow configured with a per-SF
L2VPN Encoding.
Objects which were signaled in a per-SF L2VPN Encoding but
apply for the entire CM are shown in the
docsL2vpnVpnCmTable. SEQUENCE OF DocsL2vpnSfStatusEntry .1.3.6.1.4.1.4491.2.1.8.1.7 |
docsL2vpnSfStatusEntrySF-specific L2VPN forwarding status information for each
upstream service flow configured with a per-SF L2VPN
Encoding. The ifIndex is of type docsCableMacLayer(127). DocsL2vpnSfStatusEntry .1.3.6.1.4.1.4491.2.1.8.1.7.1 |
docsL2vpnSfStatusL2vpnIdThis object represents the value of the L2VPN Identifier
subtype of a per-SF L2VPN Encoding.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.7.1.1 |
docsL2vpnSfStatusIngressUserPriorityThis object provides the configured Ingress User Priority
subtype of a per-SF L2VPN Encoding for this CM. If the
subtype was omitted, this object's value is zero.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.8.1.7.1.2 |
docsL2vpnSfStatusVendorSpecificThis object provides the set of configured Vendor Specific
subtypes within a per-SF L2VPN Encoding for a CM. If no
Vendor Specific subtype was specified, this object is a
zero length octet string. If one or more Vendor Specific
subtype parameters was specified, this object represents
the concatenation of all such subtypes.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.7.1.3 |
docsL2vpnPktClassTableThis table provides the L2VPN-specific objects for
packet classifiers that apply to only L2VPN traffic.
The indices of this table are a subset of the
indices of classifiers in docsQosPktClassTable. SEQUENCE OF DocsL2vpnPktClassEntry .1.3.6.1.4.1.4491.2.1.8.1.8 |
docsL2vpnPktClassEntryAn entry in this table extends a single row
of docsQosPktClassTable for a rule that applies only to
downstream L2VPN forwarded packets.
The index ifIndex is an ifType of docsCableMaclayer(127). DocsL2vpnPktClassEntry .1.3.6.1.4.1.4491.2.1.8.1.8.1 |
docsL2vpnPktClassL2vpnIdThe locally assigned L2VPN index corresponding to the VPN
Identifier subtype of a Downstream Classifier L2VPN
Encoding.ro DocsL2vpnIdentifier .1.3.6.1.4.1.4491.2.1.8.1.8.1.1 |
docsL2vpnPktClassUserPriRangeLowThe lower priority of the user Priority Range subtype
of a Downstream Classifier L2VPN Encoding. If the subtype
was omitted, this object has value 0.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.8.1.8.1.2 |
docsL2vpnPktClassUserPriRangeHighThe higher priority of the user Priority Range subtype
of a Downstream Classifier L2VPN Encoding. If the subtype
was omitted, this object has value 7.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.8.1.8.1.3 |
docsL2vpnPktClassCMIMThe Cable Modem Interface Mask (CMIM) signaled in a
Packet Classifier Encoding. In a Downstream Packet
Classifier Encoding, a specified CMIM value restricts the
classifier to match packets with a Destination MAC address
corresponding to the interfaces indicated in the CMIM mask.
The eCM self and any eSAFE interface bits correspond to
the individual eCM and eSAFE host MAC addresses.
In an Upstream Packet Classifier encoding, a specified CMIM
value restricts the classifier to match packets with an
ingress bridge port interface matching the bits in the
CMIM value.
If the CMIM subtype was omitted, this object should be
reported as a zero length octet string.ro DocsL2vpnIfList .1.3.6.1.4.1.4491.2.1.8.1.8.1.4 |
docsL2vpnPktClassVendorSpecificThis object provides the set of configured
Vendor Specific subtypes within a Packet Classifier
Encoding for a CM. If no Vendor Specific subtype was
specified, this object is a zero length octet string.
If one or more Vendor Specific subtype parameters was
specified, this object represents the concatenation of all
such subtypes.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.8.1.5 |
docsL2vpnCmNsiTableThis table describes the NSI configuration for a single
CM when operating in point-to-point forwarding mode for an
L2VPN. SEQUENCE OF DocsL2vpnCmNsiEntry .1.3.6.1.4.1.4491.2.1.8.1.9 |
docsL2vpnCmNsiEntryAn entry indexed by VPN ID and Cable Modem Index that
describes the point-to-point forwarding between a single
NSI encapsulation and a single CM. This table is
implemented only for a CM forwarding an L2VPN on a
point-to-point basis. It is associated with a single
per-CM L2VPN encoding. DocsL2vpnCmNsiEntry .1.3.6.1.4.1.4491.2.1.8.1.9.1 |
docsL2vpnCmNsiEncapSubtypeThe General Encapsulation Information (GEI) subtype of the
Network System Interface (NSI) encapsulation configured
for the CM.ro DocsNsiEncapSubtype .1.3.6.1.4.1.4491.2.1.8.1.9.1.1 |
docsL2vpnCmNsiEncapValueThe encapsulation value for L2VPN forwarded packets on NSI
ports.ro DocsNsiEncapValue .1.3.6.1.4.1.4491.2.1.8.1.9.1.2 |
docsL2vpnCmNsiAGIThis object is the configuration of any Attachment Group
Identifier subtype in the per-SF L2VPN Encoding
represented by this row. If the subtype was omitted, this
object's value is a zero length string.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.9.1.3 |
docsL2vpnCmNsiSAIIThis object is the configuration of any Source
Attachment Individual ID subtype in the L2VPN Encoding
represented by this row. If the subtype was omitted, this
object's value is a zero length string.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.9.1.4 |
docsL2vpnCmNsiTAIIThis object is the configuration of any Target
Attachment Individual ID subtype in the L2VPN Encoding
represented by this row. If the subtype was omitted, this
object's value is a zero length string.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.8.1.9.1.5 |
docsL2vpnCmVpnCpeTableThis table is a list of CPEs, indexed by the VPNs on a
Cable Modem. SEQUENCE OF DocsL2vpnCmVpnCpeEntry .1.3.6.1.4.1.4491.2.1.8.1.10 |
docsL2vpnCmVpnCpeEntryThis table is a list of CPEs, indexed by the VPNs on a
Cable Modem. DocsL2vpnCmVpnCpeEntry .1.3.6.1.4.1.4491.2.1.8.1.10.1 |
docsL2vpnCmVpnCpeMacAddressThe Customer Premise Equipment (CPE) Mac Address
that is attached to this instances Cable Modem
and bridging on this instance's VPN Id.ro MacAddress (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.8.1.10.1.1 |
docsL2vpnVpnCmCpeTableThis table contains a list of bridging CPEs, indexed by
L2VPN Index and the corresponding CMs on that VPN. SEQUENCE OF DocsL2vpnVpnCmCpeEntry .1.3.6.1.4.1.4491.2.1.8.1.11 |
docsL2vpnVpnCmCpeEntryThis table contains a list of bridging CPEs, indexed by
VPN and the corresponding CMs on that VPN. DocsL2vpnVpnCmCpeEntry .1.3.6.1.4.1.4491.2.1.8.1.11.1 |
docsL2vpnVpnCmCpeMacAddressThe Customer Premise Equipment (CPE) Mac Address
that is attached to this instances Cable Modem
and bridging on this instance's L2vpn Index.ro MacAddress (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.8.1.11.1.1 |
docsL2vpnDot1qTpFdbExtTableThis table contains packet counters for
Unicast MAC Addresses within a VPN. SEQUENCE OF DocsL2vpnDot1qTpFdbExtEntry .1.3.6.1.4.1.4491.2.1.8.1.12 |
docsL2vpnDot1qTpFdbExtEntryThis table extends the dot1qTpFdbTable only for RF network
bridge port entries. It is implemented by an agent only
if the agent implements dot1qTpFdbTable for RF network
bridge ports. DocsL2vpnDot1qTpFdbExtEntry .1.3.6.1.4.1.4491.2.1.8.1.12.1 |
docsL2vpnDot1qTpFdbExtTransmitPktsThe number of packets where the Destination
MAC Address matched this instance
dot1qTpFdbAddress and packet was bridged on
a VPN, where the VPN ID matched this
instance's dot1qFdbId.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.12.1.1 |
docsL2vpnDot1qTpFdbExtReceivePktsThe number of packets where the Source MAC
Address matched this instance dot1qTpFdbAddress
and the packet was bridged on a VPN,
where the docsL2vpnIdx matched this instance's
dot1qFdbId.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.12.1.2 |
docsL2vpnDot1qTpGroupExtTableThis table contains packet counters for
Multicast MAC Addresses within a VPN. SEQUENCE OF DocsL2vpnDot1qTpGroupExtEntry .1.3.6.1.4.1.4491.2.1.8.1.13 |
docsL2vpnDot1qTpGroupExtEntryThis table extends the dot1qTpGroupTable only for RF
Network bridge port entries. It is implemented by an agent
Only if the agent implements dot1qTpGroupTable for RF
network bridge ports. DocsL2vpnDot1qTpGroupExtEntry .1.3.6.1.4.1.4491.2.1.8.1.13.1 |
docsL2vpnDot1qTpGroupExtTransmitPktsThe number of packets where the Destination
MAC Address matched this instance
dot1qTpGroupAddress and packet was bridged on
a VPN, where the docsL2vpnIdx matched this
instance's dot1qVlanIndex.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.13.1.1 |
docsL2vpnDot1qTpGroupExtReceivePktsThe number of packets where the Source MAC
Address matched this instance dot1qTpGroupAddress
and the packet was bridged on a VPN,
where the docsL2vpnIdx matched this instance's
dot1qVlanIndex.ro Counter32 .1.3.6.1.4.1.4491.2.1.8.1.13.1.2 |
docsL2vpnConformance OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.8.2 |
docsL2vpnCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.8.2.1 |
docsL2vpnGroups OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.8.2.2 |