docsIetfQosServiceClassTosAndMask value MUST be
’FF’H and docsIetfQosServiceClassTosOrMask MUST be
’00’H. Otherwise, this object is in the range of
0..63, and the corresponding entry’s
docsIetfQosServiceClassTosAndMask value MUST be
’03’H and the docsIetfQosServiceClassTosOrMask MUST
be this object’s value shifted left by two bit
positions."
REFERENCE "RFC 3168, The Addition of Explicit Congestion
Notification (ECN) to IP;
RFC 3260, New Terminology and Clarifications for
Diffserv."
DEFVAL { -1 }
::= { docsIetfQosServiceClassEntry 24 }
--
-- Service Class PolicyTable
--
docsIetfQosServiceClassPolicyTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIetfQosServiceClassPolicyEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "This table describes the set of DOCSIS-QOS
Service Class Policies.
This table is an adjunct to the
docsDevFilterPolicy table. Entries in the
docsDevFilterPolicy table can point to
specific rows in this table.
This table permits mapping a packet to a service
class name of an active service flow so long as
a classifier does not exist at a higher
priority."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix E.2.1"
::= { docsIetfQosMIBObjects 9 }
docsIetfQosServiceClassPolicyEntry OBJECT-TYPE
SYNTAX DocsIetfQosServiceClassPolicyEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "A service class name policy entry."
INDEX {
docsIetfQosServiceClassPolicyIndex
}
::= { docsIetfQosServiceClassPolicyTable 1 }
DocsIetfQosServiceClassPolicyEntry ::= SEQUENCE {
docsIetfQosServiceClassPolicyIndex Unsigned32,
docsIetfQosServiceClassPolicyName SnmpAdminString,
docsIetfQosServiceClassPolicyRulePriority Integer32,
docsIetfQosServiceClassPolicyStatus RowStatus,
docsIetfQosServiceClassPolicyStorageType StorageType
}
docsIetfQosServiceClassPolicyIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "Index value to identify an entry in
this table uniquely."
::= { docsIetfQosServiceClassPolicyEntry 1 }
docsIetfQosServiceClassPolicyName OBJECT-TYPE
SYNTAX SnmpAdminString
MAX-ACCESS read-create
STATUS current
DESCRIPTION "Service Class Name to identify the name of the
service class flow to which the packet should be
directed."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix E.2.1"
::= { docsIetfQosServiceClassPolicyEntry 2 }
docsIetfQosServiceClassPolicyRulePriority OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-create
STATUS current
DESCRIPTION "Service Class Policy rule priority for the
entry."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.5"
::= { docsIetfQosServiceClassPolicyEntry 3 }
docsIetfQosServiceClassPolicyStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION "Used to create or delete rows in this table.
This object should not be deleted if it is
referenced by an entry in docsDevFilterPolicy.
The reference should be deleted first.
There is no restriction on the ability
to change values in this row while the row is
active. Inactive rows need not be timed out."
::= { docsIetfQosServiceClassPolicyEntry 4 }
docsIetfQosServiceClassPolicyStorageType OBJECT-TYPE
SYNTAX StorageType
MAX-ACCESS read-create
STATUS current
DESCRIPTION "This object defines whether this row is kept in
volatile storage and lost upon reboot or whether
it is backed up by non-volatile or permanent
storage. ’permanent’ entries need not allow
writable access to any object."
DEFVAL { nonVolatile }
::= { docsIetfQosServiceClassPolicyEntry 5 }
--
-- Payload Header Suppression(PHS) Table
--
docsIetfQosPHSTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIetfQosPHSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "This table describes the set of payload header
suppression entries."
::= { docsIetfQosMIBObjects 10 }
docsIetfQosPHSEntry OBJECT-TYPE
SYNTAX DocsIetfQosPHSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "A payload header suppression entry.
The ifIndex is an ifType of docsCableMaclayer(127).
The index docsIetfQosServiceFlowId selects one
service flow from the cable MAC layer interface.
The docsIetfQosPktClassId index matches an
index of the docsIetfQosPktClassTable."
INDEX {
ifIndex,
docsIetfQosServiceFlowId,
docsIetfQosPktClassId
}
::= { docsIetfQosPHSTable 1 }
DocsIetfQosPHSEntry ::= SEQUENCE {
docsIetfQosPHSField OCTET STRING,
docsIetfQosPHSMask OCTET STRING,
docsIetfQosPHSSize Integer32,
docsIetfQosPHSVerify TruthValue,
docsIetfQosPHSIndex Integer32
}
docsIetfQosPHSField OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION "Payload header suppression field defines the
bytes of the header that must be
suppressed/restored by the sending/receiving
device.
The number of octets in this object should be
the same as the value of docsIetfQosPHSSize."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.1"
::= { docsIetfQosPHSEntry 1 }
docsIetfQosPHSMask OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(0..32))
MAX-ACCESS read-only
STATUS current
DESCRIPTION "Payload header suppression mask defines the
bit mask that is used in combination with the
docsIetfQosPHSField. It defines which bytes in
the header must be suppressed/restored by the
sending or receiving device.
Each bit of this bit mask corresponds to a byte
in the docsIetfQosPHSField, with the least
significant bit corresponding to the first byte
of the docsIetfQosPHSField.
Each bit of the bit mask specifies whether
the corresponding byte should be suppressed
in the packet. A bit value of ’1’ indicates that
the byte should be suppressed by the sending
device and restored by the receiving device.
A bit value of ’0’ indicates that
the byte should not be suppressed by the sending
device or restored by the receiving device.
If the bit mask does not contain a bit for each
byte in the docsIetfQosPHSField, then the bit mask
is extended with bit values of ’1’ to be the
necessary length."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.3"
::= { docsIetfQosPHSEntry 2 }
docsIetfQosPHSSize OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION "Payload header suppression size specifies the
number of bytes in the header to be suppressed
and restored.
The value of this object must match the number
of bytes in the docsIetfQosPHSField."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.4"
::= { docsIetfQosPHSEntry 3 }
docsIetfQosPHSVerify OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION "Payload header suppression verification value. If
’true’, the sender must verify docsIetfQosPHSField
is the same as what is contained in the packet
to be suppressed."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.5"
::= { docsIetfQosPHSEntry 4 }
docsIetfQosPHSIndex OBJECT-TYPE
SYNTAX Integer32 (1..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION "Payload header suppression index uniquely
references the PHS rule for a given service flow."
REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.2"
::= { docsIetfQosPHSEntry 5 }
--
-- docsIetfQosCmtsMacToSrvFlowTable (CMTS Only)
--
docsIetfQosCmtsMacToSrvFlowTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIetfQosCmtsMacToSrvFlowEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "This table provides for referencing the service
flows associated with a particular cable modem.
This allows indexing into other docsIetfQos
tables that are indexed by docsIetfQosServiceFlowId
and ifIndex."
::= { docsIetfQosMIBObjects 11 }
docsIetfQosCmtsMacToSrvFlowEntry OBJECT-TYPE
SYNTAX DocsIetfQosCmtsMacToSrvFlowEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "An entry is created by CMTS for each service flow
connected to this CMTS."
INDEX {
docsIetfQosCmtsCmMac,
docsIetfQosCmtsServiceFlowId
}
::= { docsIetfQosCmtsMacToSrvFlowTable 1 }
DocsIetfQosCmtsMacToSrvFlowEntry ::= SEQUENCE {
docsIetfQosCmtsCmMac MacAddress,
docsIetfQosCmtsServiceFlowId Unsigned32,
docsIetfQosCmtsIfIndex InterfaceIndex
}
docsIetfQosCmtsCmMac OBJECT-TYPE
SYNTAX MacAddress
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "The MAC address for the referenced CM."
::= { docsIetfQosCmtsMacToSrvFlowEntry 1 }
docsIetfQosCmtsServiceFlowId OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION "An index assigned to a service flow by CMTS."
::= { docsIetfQosCmtsMacToSrvFlowEntry 2 }
docsIetfQosCmtsIfIndex OBJECT-TYPE
SYNTAX InterfaceIndex
MAX-ACCESS read-only
STATUS current
DESCRIPTION "The ifIndex of ifType docsCableMacLayer(127)
on the CMTS that is connected to the Cable Modem."
::= { docsIetfQosCmtsMacToSrvFlowEntry 3 }
--
-- Conformance definitions
--
docsIetfQosConformance OBJECT IDENTIFIER
::= { docsIetfQosMIB 2 }
docsIetfQosGroups OBJECT IDENTIFIER
::= { docsIetfQosConformance 1 }
docsIetfQosCompliances OBJECT IDENTIFIER
::= { docsIetfQosConformance 2 }
docsIetfQosCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for MCNS Cable Modems and
Cable Modem Termination Systems that implement DOCSIS
Service Flows."
MODULE -- docsIetfQosMIB
MANDATORY-GROUPS { docsIetfQosBaseGroup }
GROUP docsIetfQosCmtsGroup
DESCRIPTION
"This group is mandatory for Cable Modem Termination
Systems (CMTS) and is not implemented for Cable Modems
(CM)."
GROUP docsIetfQosParamSetGroup
DESCRIPTION
"This group is mandatory for Cable Modem Termination
Systems (CMTS) and Cable Modems. Cable modems only
implement objects in this group as read-only."
GROUP docsIetfQosSrvClassPolicyGroup
DESCRIPTION
"This group is optional for Cable Modem Termination
Systems (CMTS) and Cable Modems. This group is relevant
if policy-based service flow classification
is implemented. See docsDevPolicyTable in
DOCS-CABLE-DEVICE-MIB for more details."
GROUP docsIetfQosServiceClassGroup
DESCRIPTION
"This group is mandatory for a Cable Modem Termination
System (CMTS) that implements expansion of Service Class
Names in a QOS Parameter Set. This group is
not implemented on the Cable Modems."
OBJECT docsIetfQosPktClassPkts
DESCRIPTION
"This object only needs to be implemented in entries
that are classifying packets and not policing packets."
OBJECT docsIetfQosPktClassInetAddressType
SYNTAX InetAddressType { ipv4(1) }
DESCRIPTION
"An implementation is only required to support IPv4
address."
OBJECT docsIetfQosPktClassInetSourceAddr
SYNTAX InetAddress (SIZE(4))
DESCRIPTION
"An implementation is only required to support IPv4
address."
OBJECT docsIetfQosPktClassInetSourceMask
SYNTAX InetAddress (SIZE(4))
DESCRIPTION
"An implementation is only required to support IPv4
address."
OBJECT docsIetfQosPktClassInetDestAddr
SYNTAX InetAddress (SIZE(4))
DESCRIPTION
"An implementation is only required to support IPv4
address."
OBJECT docsIetfQosPktClassInetDestMask
SYNTAX InetAddress (SIZE(4))
DESCRIPTION
"An implementation is only required to support IPv4
address."
OBJECT docsIetfQosServiceClassStorageType
SYNTAX StorageType { nonVolatile(3) }
DESCRIPTION
"An implementation is only required to support nonvolatile
storage."
OBJECT docsIetfQosServiceClassPolicyStorageType
SYNTAX StorageType { nonVolatile(3) }
DESCRIPTION
"An implementation is only required to support nonvolatile
storage."
::= { docsIetfQosCompliances 1 }
docsIetfQosBaseGroup OBJECT-GROUP
OBJECTS {
docsIetfQosPktClassDirection,
docsIetfQosPktClassPriority,
docsIetfQosPktClassIpTosLow,
docsIetfQosPktClassIpTosHigh,
docsIetfQosPktClassIpTosMask,
docsIetfQosPktClassIpProtocol,
docsIetfQosPktClassSourcePortStart,
docsIetfQosPktClassSourcePortEnd,
docsIetfQosPktClassDestPortStart,
docsIetfQosPktClassDestPortEnd,
docsIetfQosPktClassDestMacAddr,
docsIetfQosPktClassDestMacMask,
docsIetfQosPktClassSourceMacAddr,
docsIetfQosPktClassEnetProtocolType,
docsIetfQosPktClassEnetProtocol,
docsIetfQosPktClassUserPriLow,
docsIetfQosPktClassUserPriHigh,
docsIetfQosPktClassVlanId,
docsIetfQosPktClassStateActive,
docsIetfQosPktClassPkts,
docsIetfQosPktClassBitMap,
docsIetfQosPktClassInetAddressType,
docsIetfQosPktClassInetSourceAddr,
docsIetfQosPktClassInetSourceMask,
docsIetfQosPktClassInetDestAddr,
docsIetfQosPktClassInetDestMask,
docsIetfQosServiceFlowSID,
docsIetfQosServiceFlowDirection,
docsIetfQosServiceFlowPrimary,
docsIetfQosServiceFlowPkts,
docsIetfQosServiceFlowOctets,
docsIetfQosServiceFlowTimeCreated,
docsIetfQosServiceFlowTimeActive,
docsIetfQosServiceFlowPHSUnknowns,
docsIetfQosServiceFlowPolicedDropPkts,
docsIetfQosServiceFlowPolicedDelayPkts,
docsIetfQosDSAReqs,
docsIetfQosDSARsps,
docsIetfQosDSAAcks,
docsIetfQosDSCReqs,
docsIetfQosDSCRsps,
docsIetfQosDSCAcks,
docsIetfQosDSDReqs,
docsIetfQosDSDRsps,
docsIetfQosDynamicAdds,
docsIetfQosDynamicAddFails,
docsIetfQosDynamicChanges,
docsIetfQosDynamicChangeFails,
docsIetfQosDynamicDeletes,
docsIetfQosDynamicDeleteFails,
docsIetfQosDCCReqs,
docsIetfQosDCCRsps,
docsIetfQosDCCAcks,
docsIetfQosDCCs,
docsIetfQosDCCFails,
docsIetfQosPHSField,
docsIetfQosPHSMask,
docsIetfQosPHSSize,
docsIetfQosPHSVerify,
docsIetfQosPHSIndex
}
STATUS current
DESCRIPTION
"Group of objects implemented in both Cable Modems and
Cable Modem Termination Systems."
::= { docsIetfQosGroups 1 }
docsIetfQosParamSetGroup OBJECT-GROUP
OBJECTS {
docsIetfQosParamSetServiceClassName,
docsIetfQosParamSetPriority,
docsIetfQosParamSetMaxTrafficRate,
docsIetfQosParamSetMaxTrafficBurst,
docsIetfQosParamSetMinReservedRate,
docsIetfQosParamSetMinReservedPkt,
docsIetfQosParamSetActiveTimeout,
docsIetfQosParamSetAdmittedTimeout,
docsIetfQosParamSetMaxConcatBurst,
docsIetfQosParamSetSchedulingType,
docsIetfQosParamSetNomPollInterval,
docsIetfQosParamSetTolPollJitter,
docsIetfQosParamSetUnsolicitGrantSize,
docsIetfQosParamSetNomGrantInterval,
docsIetfQosParamSetTolGrantJitter,
docsIetfQosParamSetGrantsPerInterval,
docsIetfQosParamSetTosAndMask,
docsIetfQosParamSetTosOrMask,
docsIetfQosParamSetMaxLatency,
docsIetfQosParamSetRequestPolicyOct,
docsIetfQosParamSetBitMap
}
STATUS current
DESCRIPTION
"Group of objects implemented in both Cable Modems and
Cable Modem Termination Systems for QOS Parameter Sets."
::= { docsIetfQosGroups 2 }
docsIetfQosCmtsGroup OBJECT-GROUP
OBJECTS {
docsIetfQosUpstreamFragments,
docsIetfQosUpstreamFragDiscards,
docsIetfQosUpstreamConcatBursts,
docsIetfQosServiceFlowLogIfIndex,
docsIetfQosServiceFlowLogSFID,
docsIetfQosServiceFlowLogCmMac,
docsIetfQosServiceFlowLogPkts,
docsIetfQosServiceFlowLogOctets,
docsIetfQosServiceFlowLogTimeDeleted,
docsIetfQosServiceFlowLogTimeCreated,
docsIetfQosServiceFlowLogTimeActive,
docsIetfQosServiceFlowLogDirection,
docsIetfQosServiceFlowLogPrimary,
docsIetfQosServiceFlowLogServiceClassName,
docsIetfQosServiceFlowLogPolicedDropPkts,
docsIetfQosServiceFlowLogPolicedDelayPkts,
docsIetfQosServiceFlowLogControl,
docsIetfQosCmtsIfIndex -- docsIetfQosCmtsMacToSrvFlowTable required
}
STATUS current
DESCRIPTION
"Group of objects implemented only in the CMTS."
::= { docsIetfQosGroups 3 }
docsIetfQosSrvClassPolicyGroup OBJECT-GROUP
OBJECTS {
docsIetfQosServiceClassPolicyName,
docsIetfQosServiceClassPolicyRulePriority,
docsIetfQosServiceClassPolicyStatus,
docsIetfQosServiceClassPolicyStorageType
}
STATUS current
DESCRIPTION
"Group of objects implemented in both Cable Modems and
Cable Modem Termination Systems when supporting policy-based
service flows."
::= { docsIetfQosGroups 4 }
docsIetfQosServiceClassGroup OBJECT-GROUP
OBJECTS {
docsIetfQosServiceClassStatus,
docsIetfQosServiceClassPriority,
docsIetfQosServiceClassMaxTrafficRate,
docsIetfQosServiceClassMaxTrafficBurst,
docsIetfQosServiceClassMinReservedRate,
docsIetfQosServiceClassMinReservedPkt,
docsIetfQosServiceClassMaxConcatBurst,
docsIetfQosServiceClassNomPollInterval,
docsIetfQosServiceClassTolPollJitter,
docsIetfQosServiceClassUnsolicitGrantSize,
docsIetfQosServiceClassNomGrantInterval,
docsIetfQosServiceClassTolGrantJitter,
docsIetfQosServiceClassGrantsPerInterval,
docsIetfQosServiceClassMaxLatency,
docsIetfQosServiceClassActiveTimeout,
docsIetfQosServiceClassAdmittedTimeout,
docsIetfQosServiceClassSchedulingType,
docsIetfQosServiceClassRequestPolicy,
docsIetfQosServiceClassTosAndMask,
docsIetfQosServiceClassTosOrMask,
docsIetfQosServiceClassDirection,
docsIetfQosServiceClassStorageType,
docsIetfQosServiceClassDSCPOverwrite
}
STATUS current
DESCRIPTION
"Group of objects implemented only in Cable Modem
Termination Systems when supporting expansion of Service
Class Names in a QOS Parameter Set"
::= { docsIetfQosGroups 5 }
END
6. Security Considerations
This MIB module relates to an agent that will provide metropolitan
public Internet access. As such, improper manipulation of the
objects represented by this MIB module may result in denial of
service to a large number of end-users [6]. Manipulation of the
docsIetfQosServiceClassTable and docsIetfQosServiceClassPolicyTable
may allow an end-user to increase his or her service levels, or
affect other end-users in either a positive or negative manner. In
addition, manipulation of docsIetfQosServiceFlowLogControl could