DOCS-IETF-SUBMGT-MIB
- Registered at
- 1.3.6.1.2.1.125
- Last updated
- 2005-03-29 00:00
- Organization
- IETF IP over Cable Data Network (IPCDN) Working Group
- Revisions
- 2005-03-29 00:00
- Namespace
- standard
- Source file
DOCS-IETF-SUBMGT-MIB- Digest
sha256:ecd7b39949179b3a777aaef28dc8a50b36f1656d907a62ed4e3b894a9627b731
Description
This is the CMTS centric subscriber management MIB for DOCSIS-compliant CMTS. It provides the objects to allow a Cable Modem Termination operator to control the IP addresses and protocols associated with subscribers' cable modems. Copyright (C) The Internet Society (2005). This version of this MIB module is part of RFC 4036; see the RFC itself for full legal notices.
Contact
Wilson Sawyer Postal: 50 Kelly Brook Lane East Hampstead, NH 03826 U.S.A. Phone: +1 603 382 7080 E-mail: wsawyer@ieee.org IETF IPCDN Working Group General Discussion: ipcdn@ietf.org Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn Co-chairs: Richard Woundy, Richard_Woundy@cable.comcast.com Jean-Francois Mule, jf.mule@cablelabs.com
Imports
| From | Symbols |
|---|---|
| DIFFSERV-MIB | diffServActionStorage, diffServAlgDropStatus, diffServAlgDropStorage, diffServAlgDropType, diffServClfrElementStatus, diffServClfrElementStorage, diffServClfrStatus, diffServClfrStorage, diffServCountActStorage, diffServDataPathStatus, diffServDataPathStorage, diffServMIBActionGroup, diffServMIBAlgDropGroup, diffServMIBClfrElementGroup, diffServMIBClfrGroup, diffServMIBCounterGroup, diffServMIBDataPathGroup, diffServMIBMultiFieldClfrGroup, diffServMultiFieldClfrAddrType, diffServMultiFieldClfrDstAddr, diffServMultiFieldClfrSrcAddr, diffServMultiFieldClfrStorage |
| DOCS-IF-MIB | docsIfCmtsCmStatusEntry, docsIfCmtsCmStatusIndex |
| INET-ADDRESS-MIB | InetAddress, InetAddressType |
| SNMPv2-CONF | MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUP |
| SNMPv2-SMI | Integer32, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, iso, mib-2 |
| SNMPv2-TC | DisplayString, RowStatus, StorageType, TEXTUAL-CONVENTION, TimeStamp, TruthValue |
Imported by
Nothing in this corpus imports this module.
Load order
Every file a consumer needs in order to load this module, dependencies first.
DIFFSERV-DSCP-TC DIFFSERV-MIB DOCS-IETF-SUBMGT-MIB DOCS-IF-MIB IANAifType-MIB IF-MIB INET-ADDRESS-MIB INTEGRATED-SERVICES-MIB SNMPv2-CONF SNMPv2-MIB SNMPv2-SMI SNMPv2-TC
Objects
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| docsSubMgtObjects OBJECT-IDENTITY | 1.3.6.1.2.1.125.1 | |||
| docsSubMgtCpeControlTable OBJECT-TYPE This table AUGMENTs the docsIfCmtsCmStatusTable, adding four WRITEable objects, as well as a read-only object, all of which reflect the state of subscriber management on a particular CM. | 1.3.6.1.2.1.125.1.1 | not-accessible | current | |
| docsSubMgtCpeControlEntry OBJECT-TYPE A row in the docsSubMgtCpeControlTable. All values are set at successful modem registration, either from the system default, or from objects included in the DOCSIS registration request sent upstream to the CMTS from the CM. The contents of this entry are meaningless unless the corresponding docsIfCmtsCmStatusValue (see reference) is registrationComplete(6). The persistence of this row is determined solely by the lifespan of the corresponding docsIfCmtsCmStatusEntry (normally StorageType=volatile). | 1.3.6.1.2.1.125.1.1.1 | not-accessible | current | |
| docsSubMgtCpeControlMaxCpeIp OBJECT-TYPE 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. (For example, if the CM has 5 IP addresses specified for it, this value is 5.) This limit applies to learned and DOCSIS-provisioned entries but not to 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. | 1.3.6.1.2.1.125.1.1.1.1 | Integer32 (0..2147483647) | read-write | current |
| docsSubMgtCpeControlActive OBJECT-TYPE Controls the application of subscriber management to this cable modem. 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. | 1.3.6.1.2.1.125.1.1.1.2 | TruthValue | read-write | current |
| docsSubMgtCpeControlLearnable OBJECT-TYPE Controls whether the CMTS may learn (and pass traffic for) CPE IP addresses associated with a cable modem. 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. | 1.3.6.1.2.1.125.1.1.1.3 | TruthValue | read-write | current |
| docsSubMgtCpeControlReset OBJECT-TYPE 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. | 1.3.6.1.2.1.125.1.1.1.4 | TruthValue | read-write | current |
| docsSubMgtCpeControlLastReset OBJECT-TYPE The value of sysUpTime when docsSubMgtCpeControlReset was last set true. Zero if never reset. | 1.3.6.1.2.1.125.1.1.1.5 | TimeStamp | read-only | current |
| docsSubMgtCpeMaxIpDefault OBJECT-TYPE The default value for docsSubMgtCpeControlMaxCpeIp if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets. | 1.3.6.1.2.1.125.1.2 | Integer32 (0..2147483647) | read-write | current |
| docsSubMgtCpeActiveDefault OBJECT-TYPE The default value for docsSubMgtCpeControlActive if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets. | 1.3.6.1.2.1.125.1.3 | TruthValue | read-write | current |
| docsSubMgtCpeLearnableDefault OBJECT-TYPE The default value for docsSubMgtCpeControlLearnable if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets. | 1.3.6.1.2.1.125.1.4 | TruthValue | read-write | current |
| docsSubMgtCpeIpTable OBJECT-TYPE A table of CPE IP addresses known on a per-CM basis. | 1.3.6.1.2.1.125.1.5 | not-accessible | current | |
| docsSubMgtCpeIpEntry OBJECT-TYPE An entry in the docsSubMgtCpeIpTable. The first index is the specific modem we're referring to, and the second index is the specific CPE IP entry. | 1.3.6.1.2.1.125.1.5.1 | not-accessible | current | |
| docsSubMgtCpeIpIndex OBJECT-TYPE 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 docsSubMgtCpeControlActive is true and a CMTS receives an IP packet from a CM that contains a source IP address that 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, then the packet is dropped. | 1.3.6.1.2.1.125.1.5.1.1 | Integer32 (1..2147483647) | not-accessible | current |
| docsSubMgtCpeIpAddressType OBJECT-TYPE The type of internet address of docsSubMgtCpeIpAddr. | 1.3.6.1.2.1.125.1.5.1.2 | InetAddressType | read-only | current |
| docsSubMgtCpeIpAddr OBJECT-TYPE The IP address either set from provisioning or learned via address gleaning or other forwarding means. See docsSubMgtCpeIpIndex for the mechanism. The type of this address is determined by the value of docsSubMgtCpeIpAddressType. | 1.3.6.1.2.1.125.1.5.1.3 | InetAddress | read-only | current |
| docsSubMgtCpeIpLearned OBJECT-TYPE If true, this entry was learned from IP packets sent upstream rather than from the provisioning objects. | 1.3.6.1.2.1.125.1.5.1.4 | TruthValue | read-only | current |
| docsSubMgtCmFilterTable OBJECT-TYPE Binds filter groups to modems, identifying for each modem the upstream and downstream filter groups that apply to packets for that modem. Normally, this table reflects the filter group values signaled by DOCSIS Registration, although values may be overridden by management action. For each of the columns in this table, zero is a distinguished value, indicating that the default filtering action is to be taken rather than that associated with a filter group number. Zero is used if the filter group is not signaled by DOCSIS registration. | 1.3.6.1.2.1.125.1.6 | not-accessible | current | |
| docsSubMgtCmFilterEntry OBJECT-TYPE Binds a filter group to each direction of traffic for a modem. The filters in this entry apply if docsSubMgtCpeControlActive is true. The contents of this entry are meaningless unless the corresponding docsIfCmtsCmStatusValue (see reference) is registrationComplete(6). The persistence of this row is determined solely by the lifespan of the corresponding docsIfCmtsCmStatusEntry (normally StorageType=volatile). | 1.3.6.1.2.1.125.1.6.1 | not-accessible | current | |
| docsSubMgtCmFilterSubDownstream OBJECT-TYPE The filter group applied to traffic destined for subscribers attached to the referenced CM. Upon row creation, this is set either to zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable) or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex. | 1.3.6.1.2.1.125.1.6.1.1 | Integer32 (0..65535) | read-write | current |
| docsSubMgtCmFilterSubUpstream OBJECT-TYPE The filter group applied to traffic originating from subscribers attached to the referenced CM. Upon row creation this is set to either zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex. | 1.3.6.1.2.1.125.1.6.1.2 | Integer32 (0..65535) | read-write | current |
| docsSubMgtCmFilterCmDownstream OBJECT-TYPE The filter group applied to traffic destined for the referenced CM itself. Upon row creation this is set either to zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex. | 1.3.6.1.2.1.125.1.6.1.3 | Integer32 (0..65535) | read-write | current |
| docsSubMgtCmFilterCmUpstream OBJECT-TYPE The filter group applied to traffic originating from the referenced CM itself. This is set upon row creation to either zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as the filter group index appearing as docsSubMgtFilterGroupIndex. | 1.3.6.1.2.1.125.1.6.1.4 | Integer32 (0..65535) | read-write | current |
| docsSubMgtFilterGroupTable OBJECT-TYPE Provides a collection of referenceable entries to which diffServClfrElementSpecific refers. This table provides filter group indices that can be compared with those signaled during DOCSIS registration. A packet matches an entry from this table if the packet originated from or is destined to a cable modem that registered this index as one of its four filter groups (see docsSubMgtCmFilterTable), and if the packet direction and MAC address select the use of this index among the four. | 1.3.6.1.2.1.125.1.7 | not-accessible | current | |
| docsSubMgtFilterGroupEntry OBJECT-TYPE An entry only exists if needed by the diffServClfrElementEntry. A packet matches this entry if the packet's cable modem registered this index as one of its four filter groups (see docsSubMgtCmFilterTable) and if the packet direction and MAC address select the use of this index among the four. | 1.3.6.1.2.1.125.1.7.1 | not-accessible | current | |
| docsSubMgtFilterGroupIndex OBJECT-TYPE The filter group index, from the set signaled at DOCSIS Registration. Provides a referenceable entry to which diffServClfrElementSpecific points. A packet matches this classifier entry if the packet's cable modem registered this index value as one of its four filter groups, and if the packet direction and MAC address select the use of this index among the four. Because this is the only field in this table, it is read-only, contrary to the usual SMI custom of making indices not-accessible. Note that although zero may be signaled (or defaulted) at DOCSIS Registration to indicate a default filtering group, no such entry appears in this table, as diffServClfrElementSpecific will use a zeroDotZero pointer for that classification. | 1.3.6.1.2.1.125.1.7.1.1 | Integer32 (1..65535) | read-only | current |
| docsSubMgtConformance OBJECT-IDENTITY | 1.3.6.1.2.1.125.2 | |||
| docsSubMgtCompliances OBJECT-IDENTITY | 1.3.6.1.2.1.125.2.1 | |||
| docsSubMgtGroups OBJECT-IDENTITY | 1.3.6.1.2.1.125.2.2 |
Conformance
| Name | OID | Status |
|---|---|---|
| docsSubMgtBasicCompliance MODULE-COMPLIANCE The compliance statement for CMTS devices that implement CMTS centric subscriber management. This compliance statement applies to implementations that support DOCSIS 1.0/1.1/2.0, which are not IPv6 capable. | 1.3.6.1.2.1.125.2.1.1 | current |
| docsSubMgtGroup OBJECT-GROUP The objects used to manage host-based cable modems via a set of CMTS enforced controls. | 1.3.6.1.2.1.125.2.2.1 | current |