DOCS-SUBMGT-MIB: View SNMP OID List / Download MIB
VENDOR: INTERNET-STANDARD
| Home | MIB: DOCS-SUBMGT-MIB | |||
|---|---|---|---|---|
| Download as: |
Download standard MIB format if you are planning to load a MIB file into some system (OS, Zabbix, PRTG ...) or view it with a MIB browser. CSV is more suitable for analyzing and viewing OID' and other MIB objects in excel. JSON and YAML formats are usually used in programing even though some systems can use MIB in YAML format (like Logstash).
|
|||
| Object Name | OID | Type | Access | Info |
| docsSubMgt | 1.3.6.1.3.83.4 |
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. |
||
| docsSubMgtObjects | 1.3.6.1.3.83.4.1 | |||
| docsSubMgtCpeControlTable | 1.3.6.1.3.83.4.1.1 | no-access |
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 | no-access |
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 request sent upstream to the CMTS from the CM. |
||
| docsSubMgtCpeControlMaxCpeIp | 1.3.6.1.3.83.4.1.1.1.1 | integer32 | read-write |
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 corresponding to docsSubMgtCpeIpTable includes more CPE IP address entries for this modem than the value of this object, then this object is set to the count of the number of rows in docsSubMgtCpeIpTable that have the same docsIfCmtsCmStatusIndex value. (E.g. if the CM has 5 IP addresses specified for it, this value is 5). This limit applies to learned and docsis-provisioned entries, but does not limit entries added through some administrative process at the CMTS. If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeMaxIpDefault. Note that this object is only meaningful if docsSubMgtCpeControlActive is true. |
| docsSubMgtCpeControlActive | 1.3.6.1.3.83.4.1.1.1.2 | truthvalue | read-write |
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 set to false, no subscriber management filtering is done at the CMTS (but other filters may apply). If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeActiveDefault. |
| docsSubMgtCpeControlLearnable | 1.3.6.1.3.83.4.1.1.1.3 | truthvalue | read-write |
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 added (by internal process) to the docsSubMgtCpeIpTable. The nature of the learning mechanism is not specified here. If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeLearnableDefault. Note that this object is only meaningful if docsSubMgtCpeControlActive is true. |
| docsSubMgtCpeControlReset | 1.3.6.1.3.83.4.1.1.1.4 | truthvalue | read-write |
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 that table. |
| docsSubMgtCpeMaxIpDefault | 1.3.6.1.3.83.4.1.2 | integer32 | read-write |
The default value for docsSubMgtCpeControlMaxCpeIp if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to 16. |
| docsSubMgtCpeActiveDefault | 1.3.6.1.3.83.4.1.3 | truthvalue | read-write |
The default value for docsSubMgtCpeControlActive if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to false. |
| docsSubMgtCpeLearnableDefault | 1.3.6.1.3.83.4.1.4 | truthvalue | read-write |
The default value for docsSubMgtCpeControlLearnable if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to true. |
| docsSubMgtCpeIpTable | 1.3.6.1.3.83.4.1.5 | no-access |
A table of CPE IP addresses known on a per CM basis. |
|
| 1.3.6.1.3.83.4.1.5.1 | no-access |
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. |
||
| docsSubMgtCpeIpIndex | 1.3.6.1.3.83.4.1.5.1.1 | integer32 | no-access |
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 via learning. If a CMTS receives an IP packet from a CM that contains a source IP address which does not match one of the docsSubMgtCpeIpAddr entries for this CM, one of two things occurs. If the number of entries is less than docsSubMgtCpeControlMaxCpeIp, the source address is added to the table and the packet is forwarded. If the number of entries equals the docsSubMgtCpeControlMaxCpeIp, AND docsSubMgtCpeControlActive is true, then the packet is dropped. Otherwise the packet is forwarded. |
| docsSubMgtCpeIpAddr | 1.3.6.1.3.83.4.1.5.1.2 | ipv4orv6addr | read-only |
The IP address either set from provisioning or learned via wiretapping. See docsSubMgtCpeIpIndex for the mechanism. |
| docsSubMgtCpeIpLearned | 1.3.6.1.3.83.4.1.5.1.3 | truthvalue | read-only |
If true, this entry was learned from IP packets sent upstream rather than from the provisioning objects. |
| docsSubMgtCpeType | 1.3.6.1.3.83.4.1.5.1.4 | integer | read-only |
The type of CPE based on the classification below: 'cpe' Regular CPE clients. 'ps' CableHome Portal Server (PS) 'mta' PacketCable Multimedia Terminal Adapter (MTA) 'stb' Digital Setop Box (STB). Enumeration: 'ps': 2, 'mta': 3, 'cpe': 1, 'stb': 4. |
| docsSubMgtPktFilterTable | 1.3.6.1.3.83.4.1.6 | no-access |
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 upstream from the CM to the CMTS during registration. |
|
| 1.3.6.1.3.83.4.1.6.1 | no-access |
An entry in the docsSubMgtPktFilterTable. |
||
| docsSubMgtPktFilterGroup | 1.3.6.1.3.83.4.1.6.1.1 | integer32 | no-access |
Identifies an ordered group of filters. Each modem may be associated with a filter group for its upstream traffic (docsSubMgtCmFilterUpstream) and a filter group for its downstream traffic (docsSubMgtCmFilterDownstream). Typically, many modems will use the same filter group. |
| docsSubMgtPktFilterIndex | 1.3.6.1.3.83.4.1.6.1.2 | integer32 | no-access |
An index which describes the ordering of a set of filter specifications within the group. Filters are applied in index order. |
| docsSubMgtPktFilterSrcAddr | 1.3.6.1.3.83.4.1.6.1.3 | ipv4orv6addr | read-only |
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 the following is true: AND (FilterSrcAddr, FilterSrcMask) == AND (Packet SrcAddr, FilterSrcMask). The mask value is applied to both the match value in this table and to the packet IP address. |
| docsSubMgtPktFilterSrcMask | 1.3.6.1.3.83.4.1.6.1.4 | ipv4orv6addr | read-only |
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 specifies a filter which matches all source addresses. This mask is not necessarily the same as a subnet mask, but for IPv4 addresses the 1's bits must be leftmost and contiguous. IPv6 masks have no such restriction. |
| docsSubMgtPktFilterDstAddr | 1.3.6.1.3.83.4.1.6.1.5 | ipv4orv6addr | read-only |
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 filter if the following is true: AND (FilterDstAddr, FilterDstMask) == AND (Packet DstAddr, FilterDstMask). The mask value is applied to both the match value in this table and to the packet IP address. |
| docsSubMgtPktFilterDstMask | 1.3.6.1.3.83.4.1.6.1.6 | ipv4orv6addr | read-only |
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 specifies a filter which matches all destination addresses. This mask is not necessarily the same as a subnet mask, but for IPv4 addresses the 1's bits must be leftmost and contiguous. IPv6 masks have no such restriction. |
| docsSubMgtPktFilterUlp | 1.3.6.1.3.83.4.1.6.1.7 | integer32 | read-only |
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 is either 6 (tcp) or 17 (udp), then docsSubMgtPktTcpUdpFilterTable must also be consulted (if its entry exists) to see if this entry matches. Obviously, if this value is neither tcp, udp nor 256, then that table need not be matched against. |
| docsSubMgtPktFilterTosValue | 1.3.6.1.3.83.4.1.6.1.8 | octet string | read-only |
The TOS value to match in the IP packet. |
| docsSubMgtPktFilterTosMask | 1.3.6.1.3.83.4.1.6.1.9 | octet string | read-only |
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 matches this filter if the following is true: AND (FilterTosValue, FilterTosMask) == AND (Packet TOS Value, FilterTosMask). |
| docsSubMgtPktFilterAction | 1.3.6.1.3.83.4.1.6.1.10 | integer | read-only |
The action to take upon this filter matching. Accept means to accept the packet for further processing. Drop means to drop the packet. Enumeration: 'drop': 2, 'accept': 1. |
| docsSubMgtPktFilterMatches | 1.3.6.1.3.83.4.1.6.1.11 | counter32 | read-only |
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 is only incremented for the first (lowest-indexed) filter matching a packet. |
| docsSubMgtPktFilterStatus | 1.3.6.1.3.83.4.1.6.1.12 | rowstatus | read-only |
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. |
| docsSubMgtTcpUdpFilterTable | 1.3.6.1.3.83.4.1.7 | no-access |
This is an adjunct to docsSubMgtPktFilterTable. It provides optional filtering based on elements in TCP or UDP headers. This table is separate from docsSubMgtPktFilterTable only because it is expected to be used more rarely. This table is not consulted unless the upper-layer protocol is TCP, UDP, or 'any'. |
|
| 1.3.6.1.3.83.4.1.7.1 | no-access |
Defines filtering criteria for TCP and UDP headers. |
||
| docsSubMgtTcpUdpSrcPort | 1.3.6.1.3.83.4.1.7.1.1 | integer32 | read-only |
The source port to match. 65536 matches any value in the TCP or UDP source port field. |
| docsSubMgtTcpUdpDstPort | 1.3.6.1.3.83.4.1.7.1.2 | integer32 | read-only |
The destination port to match. 65536 matches any value in the TCP or UDP destination port field. |
| docsSubMgtTcpFlagValues | 1.3.6.1.3.83.4.1.7.1.3 | bits | read-only |
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 constraint returns an inconsistentValue error for an SNMPv2 or v3 agent and a badValue error for an SNMPv1 agent. Bits: 'reset': 3, 'ack': 1, 'syn': 4, 'urgent': 0, 'push': 2, 'fin': 5. |
| docsSubMgtTcpFlagMask | 1.3.6.1.3.83.4.1.7.1.4 | bits | read-only |
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 that are not either syn or fin, the value of docsSubMgtTcpFlagValues would be { urgent }, and the value of this object would be { urgent, syn, fin } Bits: 'reset': 3, 'ack': 1, 'syn': 4, 'urgent': 0, 'push': 2, 'fin': 5. |
| docsSubMgtTcpUdpStatus | 1.3.6.1.3.83.4.1.7.1.5 | rowstatus | read-only |
Standard row object for this table. Any object in the conceptual row may be modified regardless of whether this row is active or not. |
| docsSubMgtCmFilterTable | 1.3.6.1.3.83.4.1.8 | no-access |
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 used as a distinguished value to mean no filter group. |
|
| 1.3.6.1.3.83.4.1.8.1 | no-access |
Binds a filter group to each direction of traffic for a modem. |
||
| docsSubMgtSubFilterDownstream | 1.3.6.1.3.83.4.1.8.1.1 | integer32 | read-write |
The filter group applied to traffic destined for subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtSubFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to hosts attached to this CM. |
| docsSubMgtSubFilterUpstream | 1.3.6.1.3.83.4.1.8.1.2 | integer32 | read-write |
The filter group applied to traffic originating from subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtSubFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from hosts attached to this CM. |
| docsSubMgtCmFilterDownstream | 1.3.6.1.3.83.4.1.8.1.3 | integer32 | read-write |
The filter group applied to traffic destined for the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to this CM. |
| docsSubMgtCmFilterUpstream | 1.3.6.1.3.83.4.1.8.1.4 | integer32 | read-write |
The filter group applied to traffic originating from the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from this CM. |
| docsSubMgtPsFilterDownstream | 1.3.6.1.3.83.4.1.8.1.5 | integer32 | read-write |
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 (docsSubMgtPsFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to portal servers attached to this CM. |
| docsSubMgtPsFilterUpstream | 1.3.6.1.3.83.4.1.8.1.6 | integer32 | read-write |
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 default (docsSubMgtPsFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from portal servers attached to this CM. |
| docsSubMgtMtaFilterDownstream | 1.3.6.1.3.83.4.1.8.1.7 | integer32 | read-write |
The filter group applied to traffic destined for MTAs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtMtaFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to MTAs attached to this CM. |
| docsSubMgtMtaFilterUpstream | 1.3.6.1.3.83.4.1.8.1.8 | integer32 | read-write |
The filter group applied to traffic originating from MTAs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtMtaFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from MTAs attached to this CM. |
| docsSubMgtStbFilterDownstream | 1.3.6.1.3.83.4.1.8.1.9 | integer32 | read-write |
The filter group applied to traffic destined for STBs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtStbFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to STBs attached to this CM. |
| docsSubMgtStbFilterUpstream | 1.3.6.1.3.83.4.1.8.1.10 | integer32 | read-write |
The filter group applied to traffic originating from STBs attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtStbFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from STBs attached to this CM. |
| docsSubMgtSubFilterDownDefault | 1.3.6.1.3.83.4.1.9 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtSubFilterUpDefault | 1.3.6.1.3.83.4.1.10 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtCmFilterDownDefault | 1.3.6.1.3.83.4.1.11 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtCmFilterUpDefault | 1.3.6.1.3.83.4.1.12 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtPsFilterDownDefault | 1.3.6.1.3.83.4.1.13 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtPsFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtPsFilterUpDefault | 1.3.6.1.3.83.4.1.14 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtPsFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtMtaFilterDownDefault | 1.3.6.1.3.83.4.1.15 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtMtaFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtMtaFilterUpDefault | 1.3.6.1.3.83.4.1.16 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtMtaFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtStbFilterDownDefault | 1.3.6.1.3.83.4.1.17 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtStbFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtStbFilterUpDefault | 1.3.6.1.3.83.4.1.18 | integer32 | read-write |
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtStbFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0. |
| docsSubMgtNotification | 1.3.6.1.3.83.4.2 | |||
| docsSubMgtConformance | 1.3.6.1.3.83.4.3 | |||
| docsSubMgtCompliances | 1.3.6.1.3.83.4.3.1 | |||
| docsSubMgtBasicCompliance | 1.3.6.1.3.83.4.3.1.1 |
The compliance statement for CMTS devices that implement CMTS centric subscriber management. |
||
| docsSubMgtGroups | 1.3.6.1.3.83.4.3.2 | |||
| docsSubMgtGroup | 1.3.6.1.3.83.4.3.2.1 |
The objects use to managed host-based cable modems via a set of CMTS enforced controls. |
||