DOCS-SUBMGT-MIB
67 objects
This is the CMTS centric subscriber management MIB for DOCSIS compliant CMTS. This will be rooted in experimental space with a future transition to be incorporated into the cable device MIB.
Imported Objects
| DOCS-IF-MIB | docsIfCmtsCmStatusEntry docsIfCmtsCmStatusIndex |
| SNMPv2-CONF | MODULE-COMPLIANCE OBJECT-GROUP |
| SNMPv2-SMI | Counter32 experimental -- BITS Integer32 MODULE-IDENTITY OBJECT-TYPE |
| SNMPv2-TC | RowStatus TEXTUAL-CONVENTION TruthValue |
| OID | Name | Access | Status | Description |
|---|---|---|---|---|
| 1.3.6.1.3.83.4 | IdentitydocsSubMgt | This is the CMTS centric subscriber management MIB for DOCSIS compliant CMTS. This will be rooted in experimental space with a future transition to be incorpor… | ||
| 1.3.6.1.3.83.4.1 | NodedocsSubMgtObjects | |||
| 1.3.6.1.3.83.4.1.1 | TabledocsSubMgtCpeControlTable | not-accessible | current | This table extends the docsIfCmtsCmStatusTable and adds 4 objects which reflect the state of subscriber management on a particular CM. |
| 1.3.6.1.3.83.4.1.1.1 | RowdocsSubMgtCpeControlEntry | not-accessible | current | A row in the docsSubMgtCpeControlTable. All the values are either set from the system default, or are set from objects included in the DOCSIS registration requ… |
| 1.3.6.1.3.83.4.1.1.1.1 | ColumndocsSubMgtCpeControlMaxCpeIp | read-write | current | The number of simultaneous IP addresses permitted behind the CM. If this is set to zero, all CPE traffic from the CM is dropped. If the provisioning object cor… |
| 1.3.6.1.3.83.4.1.1.1.2 | ColumndocsSubMgtCpeControlActive | read-write | current | If this is set to true, CMTS based CPE control is active and all the actions required by the various filter tables and controls apply at the CMTS. If this is s… |
| 1.3.6.1.3.83.4.1.1.1.3 | ColumndocsSubMgtCpeControlLearnable | read-write | current | If this is set to true, the CMTS may learn up to docsSubMgtMaxCpeIp addresses (less any DOCSIS-provisioned entries) related to this CM. Those IP addresses are … |
| 1.3.6.1.3.83.4.1.1.1.4 | ColumndocsSubMgtCpeControlReset | read-write | current | This object always returns false on read. If this object is set to true, the rows with 'learned' addresses in docsSubMgtCpeIpTable for this CM are deleted from… |
| 1.3.6.1.3.83.4.1.2 | ScalardocsSubMgtCpeMaxIpDefault | read-write | current | The default value for docsSubMgtCpeControlMaxCpeIp if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to 16. |
| 1.3.6.1.3.83.4.1.3 | ScalardocsSubMgtCpeActiveDefault | read-write | current | The default value for docsSubMgtCpeControlActive if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to false. |
| 1.3.6.1.3.83.4.1.4 | ScalardocsSubMgtCpeLearnableDefault | read-write | current | The default value for docsSubMgtCpeControlLearnable if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to true. |
| 1.3.6.1.3.83.4.1.5 | TabledocsSubMgtCpeIpTable | not-accessible | current | A table of CPE IP addresses known on a per CM basis. |
| 1.3.6.1.3.83.4.1.5.1 | RowdocsSubMgtCpeIpEntry | not-accessible | current | An entry in the docsSubMgtCpeIpTable. The first index is the specific modem we're referring to, the second index is the specific CPE IP entry. |
| 1.3.6.1.3.83.4.1.5.1.1 | ColumndocsSubMgtCpeIpIndex | not-accessible | current | The index of this CPE IP address relative to the indexed CM. An entry is created either through the included CPE IP addresses in the provisioning object, or vi… |
| 1.3.6.1.3.83.4.1.5.1.2 | ColumndocsSubMgtCpeIpAddr | read-only | current | The IP address either set from provisioning or learned via wiretapping. See docsSubMgtCpeIpIndex for the mechanism. |
| 1.3.6.1.3.83.4.1.5.1.3 | ColumndocsSubMgtCpeIpLearned | read-only | current | If true, this entry was learned from IP packets sent upstream rather than from the provisioning objects. |
| 1.3.6.1.3.83.4.1.5.1.4 | ColumndocsSubMgtCpeType | read-only | current | The type of CPE based on the classification below: 'cpe' Regular CPE clients. 'ps' CableHome Portal Server (PS) 'mta' PacketCable Multimedia Terminal Adapter (… |
| 1.3.6.1.3.83.4.1.6 | TabledocsSubMgtPktFilterTable | not-accessible | current | A table of filter or classifier criteria. Classifiers are assigned by group to the individual CMs. That assignment is made via the configuration objects sent u… |
| 1.3.6.1.3.83.4.1.6.1 | RowdocsSubMgtPktFilterEntry | not-accessible | current | An entry in the docsSubMgtPktFilterTable. |
| 1.3.6.1.3.83.4.1.6.1.1 | ColumndocsSubMgtPktFilterGroup | not-accessible | current | Identifies an ordered group of filters. Each modem may be associated with a filter group for its upstream traffic (docsSubMgtCmFilterUpstream) and a filter gro… |
| 1.3.6.1.3.83.4.1.6.1.2 | ColumndocsSubMgtPktFilterIndex | not-accessible | current | An index which describes the ordering of a set of filter specifications within the group. Filters are applied in index order. |
| 1.3.6.1.3.83.4.1.6.1.3 | ColumndocsSubMgtPktFilterSrcAddr | read-create | current | The source IP address to match in the packet to be classified. By default, this is the all-zero's IP v4 and v6 address. A packet matches the SrcAddr filter if … |
| 1.3.6.1.3.83.4.1.6.1.4 | ColumndocsSubMgtPktFilterSrcMask | read-create | current | A bit mask that is to be applied to the source address prior to matching. This, taken with the SrcAddr specifies a matching criteria. By default, the pair spec… |
| 1.3.6.1.3.83.4.1.6.1.5 | ColumndocsSubMgtPktFilterDstAddr | read-create | current | The destination IP address to match in the packet to be classified. By default, this is the all-zero's IP v4 and v6 address. A packet matches the DstAddr filte… |
| 1.3.6.1.3.83.4.1.6.1.6 | ColumndocsSubMgtPktFilterDstMask | read-create | current | A bit mask that is to be applied to the destination address prior to matching. This, taken with the DstAddr specifies a matching criteria. By default, the pair… |
| 1.3.6.1.3.83.4.1.6.1.7 | ColumndocsSubMgtPktFilterUlp | read-create | current | Upper level protocol to match. If this value is 256, matches ALL ULP values. Otherwise, this matches the specific protocol value. Note that if the packet ULP i… |
| 1.3.6.1.3.83.4.1.6.1.8 | ColumndocsSubMgtPktFilterTosValue | read-create | current | The TOS value to match in the IP packet. |
| 1.3.6.1.3.83.4.1.6.1.9 | ColumndocsSubMgtPktFilterTosMask | read-create | current | The mask to apply against the TOS value to be matched in the IP packet. The default for both these objects taken together matches all TOS values. A packet matc… |
| 1.3.6.1.3.83.4.1.6.1.10 | ColumndocsSubMgtPktFilterAction | read-create | current | The action to take upon this filter matching. Accept means to accept the packet for further processing. Drop means to drop the packet. |
| 1.3.6.1.3.83.4.1.6.1.11 | ColumndocsSubMgtPktFilterMatches | read-only | current | This object counts the number of times this specific rule has been matched. This is incremented any time this rule is encountered and all components match. It … |
| 1.3.6.1.3.83.4.1.6.1.12 | ColumndocsSubMgtPktFilterStatus | read-create | current | Standard rowStatus object for creating this row. Any object in this row which is writable may be changed at any time while the row is active. |
| 1.3.6.1.3.83.4.1.7 | TabledocsSubMgtTcpUdpFilterTable | not-accessible | current | This is an adjunct to docsSubMgtPktFilterTable. It provides optional filtering based on elements in TCP or UDP headers. This table is separate from docsSubMgtP… |
| 1.3.6.1.3.83.4.1.7.1 | RowdocsSubMgtTcpUdpFilterEntry | not-accessible | current | Defines filtering criteria for TCP and UDP headers. |
| 1.3.6.1.3.83.4.1.7.1.1 | ColumndocsSubMgtTcpUdpSrcPort | read-create | current | The source port to match. 65536 matches any value in the TCP or UDP source port field. |
| 1.3.6.1.3.83.4.1.7.1.2 | ColumndocsSubMgtTcpUdpDstPort | read-create | current | The destination port to match. 65536 matches any value in the TCP or UDP destination port field. |
| 1.3.6.1.3.83.4.1.7.1.3 | ColumndocsSubMgtTcpFlagValues | read-create | current | The value of the flags of interest. The value of this object MUST always be a subset (proper or otherwise) of docsSubMgtTcpFlagMask. An attempt to violate this… |
| 1.3.6.1.3.83.4.1.7.1.4 | ColumndocsSubMgtTcpFlagMask | read-create | current | This bit set indicates the flags of interest in the TCP header for the packet to be matched. For example to match all packets where the urgent bit is set, but … |
| 1.3.6.1.3.83.4.1.7.1.5 | ColumndocsSubMgtTcpUdpStatus | read-create | current | Standard row object for this table. Any object in the conceptual row may be modified regardless of whether this row is active or not. |
| 1.3.6.1.3.83.4.1.8 | TabledocsSubMgtCmFilterTable | not-accessible | current | Binds filter groups to modems. This table identifies for each modem the upstream and downstream filter groups that apply to packets for that modem. Zero is use… |
| 1.3.6.1.3.83.4.1.8.1 | RowdocsSubMgtCmFilterEntry | not-accessible | current | Binds a filter group to each direction of traffic for a modem. |
| 1.3.6.1.3.83.4.1.8.1.1 | ColumndocsSubMgtSubFilterDownstream | read-write | current | The filter group applied to traffic destined for subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtSubF… |
| 1.3.6.1.3.83.4.1.8.1.2 | ColumndocsSubMgtSubFilterUpstream | read-write | current | The filter group applied to traffic originating from subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgt… |
| 1.3.6.1.3.83.4.1.8.1.3 | ColumndocsSubMgtCmFilterDownstream | read-write | current | The filter group applied to traffic destined for the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterDownDefault),… |
| 1.3.6.1.3.83.4.1.8.1.4 | ColumndocsSubMgtCmFilterUpstream | read-write | current | The filter group applied to traffic originating from the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterUpDefault… |
| 1.3.6.1.3.83.4.1.8.1.5 | ColumndocsSubMgtPsFilterDownstream | read-write | current | The filter group applied to traffic destined for CableHome portal servers attached to the referenced CM. This is set upon row creation to either the default (d… |
| 1.3.6.1.3.83.4.1.8.1.6 | ColumndocsSubMgtPsFilterUpstream | read-write | current | The filter group applied to traffic originating from CableHome portal servers attached to the referenced CM. This is set upon row creation to either the defaul… |
| 1.3.6.1.3.83.4.1.8.1.7 | ColumndocsSubMgtMtaFilterDownstream | read-write | current | The filter group applied to traffic destined for MTAs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtMtaFilterDo… |
| 1.3.6.1.3.83.4.1.8.1.8 | ColumndocsSubMgtMtaFilterUpstream | read-write | current | The filter group applied to traffic originating from MTAs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtMtaFilt… |
| 1.3.6.1.3.83.4.1.8.1.9 | ColumndocsSubMgtStbFilterDownstream | read-write | current | The filter group applied to traffic destined for STBs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtStbFilterDo… |
| 1.3.6.1.3.83.4.1.8.1.10 | ColumndocsSubMgtStbFilterUpstream | read-write | current | The filter group applied to traffic originating from STBs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtStbFilt… |
| 1.3.6.1.3.83.4.1.9 | ScalardocsSubMgtSubFilterDownDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterDownstream is set to this value if no provisioning object is present to override it. This ob… |
| 1.3.6.1.3.83.4.1.10 | ScalardocsSubMgtSubFilterUpDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterUpstream is set to this value if no provisioning object is present to override it. This obje… |
| 1.3.6.1.3.83.4.1.11 | ScalardocsSubMgtCmFilterDownDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterDownstream is set to this value if no provisioning object is present to override it. This obj… |
| 1.3.6.1.3.83.4.1.12 | ScalardocsSubMgtCmFilterUpDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterUpstream is set to this value if no provisioning object is present to override it. This objec… |
| 1.3.6.1.3.83.4.1.13 | ScalardocsSubMgtPsFilterDownDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtPsFilterDownstream is set to this value if no provisioning object is present to override it. This obj… |
| 1.3.6.1.3.83.4.1.14 | ScalardocsSubMgtPsFilterUpDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtPsFilterUpstream is set to this value if no provisioning object is present to override it. This objec… |
| 1.3.6.1.3.83.4.1.15 | ScalardocsSubMgtMtaFilterDownDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtMtaFilterDownstream is set to this value if no provisioning object is present to override it. This ob… |
| 1.3.6.1.3.83.4.1.16 | ScalardocsSubMgtMtaFilterUpDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtMtaFilterUpstream is set to this value if no provisioning object is present to override it. This obje… |
| 1.3.6.1.3.83.4.1.17 | ScalardocsSubMgtStbFilterDownDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtStbFilterDownstream is set to this value if no provisioning object is present to override it. This ob… |
| 1.3.6.1.3.83.4.1.18 | ScalardocsSubMgtStbFilterUpDefault | read-write | current | Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtStbFilterUpstream is set to this value if no provisioning object is present to override it. This obje… |
| 1.3.6.1.3.83.4.2 | NodedocsSubMgtNotification | |||
| 1.3.6.1.3.83.4.3 | NodedocsSubMgtConformance | |||
| 1.3.6.1.3.83.4.3.1 | NodedocsSubMgtCompliances | |||
| 1.3.6.1.3.83.4.3.1.1 | CompliancedocsSubMgtBasicCompliance | current | The compliance statement for CMTS devices that implement CMTS centric subscriber management. | |
| 1.3.6.1.3.83.4.3.2 | NodedocsSubMgtGroups | |||
| 1.3.6.1.3.83.4.3.2.1 | GroupdocsSubMgtGroup | current | The objects use to managed host-based cable modems via a set of CMTS enforced controls. |
Type Definitions
| Name | Syntax | Status | Description |
|---|---|---|---|
| IpV4orV6Addr | OCTET STRING (SIZE (0 | 4 | 16)) | current | An IP V4 or V6 address expressed as an octet string. The zero length string is equal to both 0.0.0.0 and the IPv6 :0 address. |