| OID symbolic | OID numeric | Type | Access | Description |
| dsgIfMIB | 1.3.6.1.4.1.4491.2.1.3 | | | Licensed under the Apache License, Version 2.0 (the 'License');
you may not use this file except in compliance with the License.
You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an 'AS IS' BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
This is the MIB Module for the DOCSIS Set-top Gateway
(DSG). The DSG provides a one-way IP datagram transport
for Out-Of-Band (OOB) messaging to cable set-top clients.
The one-way IP datagram transport is called a DSG Tunnel.
A DSG Tunnel carrying either a broadcast, unicast or
multicast IP datagram stream originating at the DOCSIS
Set-top Gateway and carrying Out-Of-Band messages intended
for set-top clients. It is carried over one or more
downstream DOCSIS channels.
Multiple DSG tunnels may exist on a single downstream
DOCSIS channel.
Copyright 1999-2017 Cable Television Laboratories, Inc.
All rights reserved. |
| dsgIfMIBNotifications | 1.3.6.1.4.1.4491.2.1.3.0 | | | |
| dsgIfMIBObjects | 1.3.6.1.4.1.4491.2.1.3.1 | | | |
| dsgIfClassifier | 1.3.6.1.4.1.4491.2.1.3.1.1 | | | |
| dsgIfClassifierTable | 1.3.6.1.4.1.4491.2.1.3.1.1.1 | | not-accessible | The Classifier Table contains attributes use to classify
inbound packets into the tunnel and classifiers for the DSG
clients, encoding in the DCD messages on the downstream
channels to which the classifiers apply. |
| dsgIfClassifierEntry | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1 | | not-accessible | An entry in the Classifier Table. Rows are created
by an SNMP SET request setting the value of
dsgIfClassRowStatus to 'createAndGo'. Each entry is created
for a tunnel, index by dsgTunnelIndex.
Rows are deleted by an SNMP SET request setting the value
of dsgIfClassRowStatus to 'destroy'. |
| U32 dsgIfClassId | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.1 | Unsigned32 | not-accessible | The index that provides a unique classifier (in a DSG
Agent). This value corresponds to the Classifier ID TLV
in the DCD message. |
| U32 dsgIfClassPriority | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.2 | Unsigned32 | read-create | The priority of this classifier.
Default value 0 indicates lowest priority. |
| IPt dsgIfClassSrcIpAddrType | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.3 | InetAddressType | read-create | The type of internet address of dsgIfClassSrcIpAddress.
Currently DSG Agents, DSG Client Controllers and DSG eCMs
are not required to support IPv6 DSG classifiers. |
| IP dsgIfClassSrcIpAddr | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.4 | InetAddress | read-create | The source IP address to be matched for this classifier.
A value 0 for this object indicates a match of any IP
address. A value that contains non-zero bits
outside the range indicated by dsgIfClassSrcIpPrefixLength
is invalid and should be rejected. |
| ADR dsgIfClassSrcIpPrefixLength | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.5 | InetAddressPrefixLength | read-create | The length of the CIDR Prefix carried in
dsgIfClassSrcIpAddr. In IPv4 addresses, a length of 32 indicates
a match of a single host address, and a length between
0 and 32 indicates the use of a CIDR Prefix. A length of
0 is not allowed. This object is irrelevant and not used
when dsgIfClassSrcIpAddr value is 0. |
| IPt dsgIfClassDestIpAddressType | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.6 | InetAddressType | read-create | The type of internet address of dsgIfClassDestIpAddress.
Currently DSG Agents, DSG Client Controllers and DSG eCMs
are not required to support IPv6 DSG classifiers. |
| IP dsgIfClassDestIpAddress | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.7 | InetAddress | read-create | The destination IP address to be matched for this
classifier. |
| INE dsgIfClassDestPortStart | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.8 | InetPortNumber | read-create | This is the inclusive lower bound of the transport-layer
source port range that is to be matched. |
| INE dsgIfClassDestPortEnd | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.9 | InetPortNumber | read-create | This is the inclusive higher bound of the transport-layer
source port range that is to be matched. |
| ROW dsgIfClassRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.10 | RowStatus | read-create | The status of the row. A value of active(1) indicates
that this classifier is applied to this tunnel.
A value of notInService(2) indicates that matching of
the packets are ignored and this classifier parameters
will not be included in the DCD message. |
| T/F dsgIfClassIncludeInDCD | 1.3.6.1.4.1.4491.2.1.3.1.1.1.1.11 | TruthValue | read-create | Indicates whether or not this DSG Classifier will
be sent in DCD messages for use as a Layer-3 and
Layer-4 packet filter by the DSG eCM. |
| dsgIfTunnel | 1.3.6.1.4.1.4491.2.1.3.1.2 | | | |
| dsgIfTunnelTable | 1.3.6.1.4.1.4491.2.1.3.1.2.1 | | not-accessible | The DSG Tunnel Table contains group(s) of tunnel(s).
Each tunnel is associated to the destination MAC address. |
| dsgIfTunnelEntry | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1 | | not-accessible | An entry in the DSG Tunnel Table. Rows are created by
an SNMP SET request setting the value of
dsgIfTunnelRowStatus to 'createAndGo'.
Each entry associated to a tunnel. A dsgIfTunnelGroupIndex
represents a group of tunnels that could be associated to
one or more downstream. Each dsgIfTunnelIndex represents
a tunnel.
Rows are deleted by an SNMP SET request setting the
value of dsgIfTunnelRowStatus to 'destroy'. |
| U32 dsgIfTunnelIndex | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.1 | Unsigned32 | not-accessible | The index into the DSG Tunnel table that represent
a tunnel. |
| U32 dsgIfTunnelGroupIndex | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.2 | Unsigned32 | read-create | This index represents a group of tunnels that could be
associated to one or more downstream which mapped
to dsgIfTunnelGrpIndex. |
| U32 dsgIfTunnelClientIdListIndex | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.3 | Unsigned32 | read-create | This index represents a group of client id(s)
which mapped to dsgIfClientIdListIndex. |
| MAC dsgIfTunnelMacAddress | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.4 | MacAddress | read-create | The DSG tunnel destination MAC address. |
| STR dsgIfTunnelServiceClassName | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.5 | SnmpAdminString | read-create | For DOCSIS 2.0 the Service Class Name is associated
to the docsQosServiceClassName in the DOCS-QOS-MIB.
For DOCSIS 3.0 the Service Class Name is associated
to the docsQosServiceClassName in the DOCS-QOS3-MIB.
Creation of a Service Class MUST be configured through
the docsQosServiceClassTable. Only partial of the
docsQosServiceClassTable objects are applicable to the
DSG service class thus some are ignored.
If the referenced parameter is not present in the
corresponding DOCSIS QOS Parameter Set, the default
value of this object is a zero length string. |
| ROW dsgIfTunnelRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.2.1.1.6 | RowStatus | read-create | The status of the row. A value of notInService(2)
indicates that this tunnel is disabled and no OOB traffic
will be forwarded to DSG clients and this tunnel parameters
will not be included in the DCD message. |
| dsgIfTunnelGrpToChannel | 1.3.6.1.4.1.4491.2.1.3.1.3 | | | |
| dsgIfTunnelGrpToChannelTable | 1.3.6.1.4.1.4491.2.1.3.1.3.1 | | not-accessible | The DSG Tunnel Group to Channel Table associates a group
of tunnels to one or more downstream channel. |
| dsgIfTunnelGrpToChannelEntry | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1 | | not-accessible | An entry in the DSG Tunnel Table. Rows are created by
an SNMP SET request setting the value of
dsgIfTunnelGrpRowStatus to 'createAndGo'.
Rows are deleted by an SNMP SET request setting the
value of dsgIfTunnelRowStatus to 'destroy'. |
| U32 dsgIfTunnelGrpIndex | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.1 | Unsigned32 | not-accessible | The index into this table. |
| U32 dsgIfTunnelGrpChannelIndex | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.2 | Unsigned32 | not-accessible | The index into this table. |
| NUM dsgIfTunnelGrpDsIfIndex | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.3 | InterfaceIndex | read-create | The downstream ifIndex that will be associated to
this group of tunnel(s). |
| U32 dsgIfTunnelGrpRulePriority | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.4 | Unsigned32 | read-create | The DSG rule priority determines the order of which
channel and its associated UCIDs should be applied by
the DSG client. The default value is 0, which is the lowest
priority. |
| OCT dsgIfTunnelGrpUcidList | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.5 | OCTET STRING | read-create | The list of Upstream Channel ID (UCID) values (octets)
for which the DSG rule applies. One octet represents one
UCID value (0-255). A DSG client matches this
parameter if its UCID value is included in the list. The
default value of zero length string indicates that this
DSG Rule applies to all DSG clients. |
| U32 dsgIfTunnelGrpVendorParamId | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.6 | Unsigned32 | read-create | The index of vendor parameter, dsgIfVendorParamId in the
dsgIfVendorParamTable describing the vendor specific DSG
parameters. If no associated entry in dsgIfVendorParamTable
exists, this value is 0. |
| ROW dsgIfTunnelGrpRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.3.1.1.7 | RowStatus | read-create | The status of this row. The value of notInService(2)
indicates that this tunnel group is disabled and no OOB
traffic on all the associated tunnel(s) will be forwarded
to DSG clients and all parameters will not be included in
the DCD message. |
| dsgIfDownstreamChannel | 1.3.6.1.4.1.4491.2.1.3.1.4 | | | |
| dsgIfDownstreamTable | 1.3.6.1.4.1.4491.2.1.3.1.4.1 | | not-accessible | The DSG Downstream Table contains the associated timers,
vendor specific parameters index and the channel list
index to a specific downstream. |
| dsgIfDownstreamEntry | 1.3.6.1.4.1.4491.2.1.3.1.4.1.1 | | not-accessible | An entry in the DSG Downstream Table.
An entry in this table exists for each ifEntry with
an ifType of docsCableDownstream(128). |
| U32 dsgIfDownTimerIndex | 1.3.6.1.4.1.4491.2.1.3.1.4.1.1.1 | Unsigned32 | read-write | The index into the timer table, dsgIfTimerTable providing
the timers used by the DSG client(s).
The default value 0 indicates there is no associated
timers that need to be sent in the DCD message. |
| U32 dsgIfDownVendorParamId | 1.3.6.1.4.1.4491.2.1.3.1.4.1.1.2 | Unsigned32 | read-write | The index of vendor parameter, dsgIfVendorParamId in the
dsgIfVendorParamTable describing the vendor specific DSG
parameters. If no associated entry in dsgIfVendorParamTable
exists, this value is 0. |
| U32 dsgIfDownChannelListIndex | 1.3.6.1.4.1.4491.2.1.3.1.4.1.1.3 | Unsigned32 | read-write | The index of a the downstream frequency channel lists,
dsgIfChannelListIndex in the dsgIfChannelListTable
providing the list of downstream frequencies that
contain DSG tunnels. |
| T/F dsgIfDownEnableDCD | 1.3.6.1.4.1.4491.2.1.3.1.4.1.1.4 | TruthValue | read-write | Used to enable or disable DCD messages to be sent on this
downstream channel. The value is always true(1) for those
downstreams that contains one or many DSG Tunnels. |
| dsgIfDCD | 1.3.6.1.4.1.4491.2.1.3.1.5 | | | |
| dsgIfClientIdTable | 1.3.6.1.4.1.4491.2.1.3.1.5.1 | | not-accessible | The Client Identification Table contains the client
identification type and value. It also contains the
vendor specific parameter identification. There could
be multiple client ids associated to a tunnel, grouped
by the dsgIfClientIdListIndex. |
| dsgIfClientIdEntry | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1 | | not-accessible | An entry in the Client Id Table. Rows are created
by an SNMP SET request setting the value of
dsgIfClientRowStatus to 'createAndGo'.
Rows are deleted by an SNMP SET request setting the
value of dsgIfClientIdRowStatus to 'destroy'. |
| U32 dsgIfClientIdListIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.1 | Unsigned32 | not-accessible | The index to this table. |
| U32 dsgIfClientIdIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.2 | Unsigned32 | not-accessible | The index to each entry of the Client Id. |
| INT dsgIfClientIdType | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.3 | INTEGER | read-create | The Client Identification type. A DSG client id of type
broadcast(1) received by all DSG client(s). A DSG client
id of type macAddress(2) is received by the DSG client that
has been assigned with this MAC address where the first 3
bytes is the Organization Unique Identifier (OUI). A DSG
client id of type caSystemId(3) is received by the DSG
client that has been assigned a CA_system_ID. A DSG client
id of type applicationId(4) is received by the DSG client
that has been assigned an application ID. |
| OCT dsgIfClientIdValue | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.4 | OCTET STRING | read-create | The Client Identification Value. The content depends on
the value of the dsgIfClientIdType.
For dsgIfClientIdType of a type broadcast(1), this object
will have a 16-bit value whether or not it is a length 0 or
length 2 broadcast ID. If the value is 0, then the encoded
TLV in the DCD would be the original, zero length,
broadcast ID. If the value is specified in Table 5-2, then
the TLV in the DCD would be a length 2 broadcast ID
followed by the value.
For dsgIfClientIdType of a type macAddress(2), this object
is a well known MAC address.
For dsgIfClientIdType of a type caSystemId(3), this object
is a CA System ID.
For dsgIfClientIdType of a type applicationId(4), this
object is an application ID.
Client IDs representing types broadcast(1), caSystemId(3)
or applicationId(4) are encoded in DCD messages as Unsigned
integers and configured in this object as 6 octet string
with the 2 LSB for the client ID value, e.g., an
applicationId 2048 (0x0800) is encoded as '000000000800'h. |
| U32 dsgIfClientVendorParamId | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.5 | Unsigned32 | read-create | The index of the vendor parameter id, dsgIfVendorParamId
in the dsgIfVendorParamTable describing the vendor specific
DSG parameters. If no associated entry in
dsgIfVendorParamTable exists, this value is 0. |
| ROW dsgIfClientRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.5.1.1.6 | RowStatus | read-create | The status of the row. |
| dsgIfVendorParamTable | 1.3.6.1.4.1.4491.2.1.3.1.5.2 | | not-accessible | The DSG Vendor Parameter Table allows vendors to send
specific parameters to the DSG clients within a DSG
rule or within the DSG Configuration block in a
DCD message. |
| dsgIfVendorParamEntry | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1 | | not-accessible | An entry in the DSG Vendor Parameter Table. Rows are
created by an SNMP SET request setting the value of
dsgIfVendorRowStatus to 'createAndGo'. Each entry
represents one or more vendor's specific parameters.
Rows are deleted by an SNMP SET request setting the
value of dsgIfVendorRowStatus to 'destroy'.
There are limits to the amount of vendor specific
information that can be carried in a DSG Rule or
DSG Configuration block. An SNMP SET request which
would result in these limits being exceeded should be
rejected. |
| U32 dsgIfVendorParamId | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1.1 | Unsigned32 | not-accessible | The index of the table. |
| U32 dsgIfVendorIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1.2 | Unsigned32 | not-accessible | The Vendor Specific Index. |
| OCT dsgIfVendorOUI | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1.3 | OCTET STRING | read-create | The Vendor assigned Organization Unique Id (OUI). |
| OCT dsgIfVendorValue | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1.4 | OCTET STRING | read-create | The Vendor Specific Parameter Value. |
| ROW dsgIfVendorRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.5.2.1.5 | RowStatus | read-create | The status of the row. |
| dsgIfChannelListTable | 1.3.6.1.4.1.4491.2.1.3.1.5.3 | | not-accessible | The DSG Channel List Table contains list of one or
multiple downstream frequencies that are carrying DSG
tunnel(s). |
| dsgIfChannelListEntry | 1.3.6.1.4.1.4491.2.1.3.1.5.3.1 | | not-accessible | An entry in the DSG Channel List Table. Rows are
created by an SNMP SET request setting the value of
dsgIfChannelRowStatus to 'createAndGo'.
Rows are deleted by an SNMP SET request setting the value
of dsgIfChannelRowStatus to 'destroy'. |
| U32 dsgIfChannelListIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.3.1.1 | Unsigned32 | not-accessible | The index to this table. |
| U32 dsgIfChannelIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.3.1.2 | Unsigned32 | not-accessible | The index for each downstream frequency that
contains the DSG tunnel(s). |
| I32 dsgIfChannelDsFreq | 1.3.6.1.4.1.4491.2.1.3.1.5.3.1.3 | Integer32 | read-create | The DOCSIS downstream center frequency. The receive
frequency MUST be a multiple of 62500Hz. |
| ROW dsgIfChannelRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.5.3.1.4 | RowStatus | read-create | The status of the row. |
| dsgIfTimerTable | 1.3.6.1.4.1.4491.2.1.3.1.5.4 | | not-accessible | The DSG Timer Table contains timers that are sent to
the DSG client(s) via the DCD message. |
| dsgIfTimerEntry | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1 | | not-accessible | An entry in the DSG Timer Table. Rows are created
by an SNMP SET request setting the value of
dsgIfTimerRowStatus to 'createAndGo'.
Rows are deleted by an SNMP SET request setting the value
of dsgIfTimerRowStatus to 'destroy'. |
| U32 dsgIfTimerIndex | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.1 | Unsigned32 | not-accessible | The index to this table. |
| U32 dsgIfTimerTdsg1 | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.2 | Unsigned32 | read-create | Initialization Timeout. This is the timeout period
for the DSG packets during initialization of the DSG
client. The default value is 2 seconds. |
| U32 dsgIfTimerTdsg2 | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.3 | Unsigned32 | read-create | Operational Timeout. This is the timeout period for
the DSG packets during normal operation of the DSG client.
Default value is 600 seconds. |
| U32 dsgIfTimerTdsg3 | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.4 | Unsigned32 | read-create | Two-way retry timer. This is the retry timer that
determines when the DSG client attempts to reconnect
with the DSG Agent and established two-way connectivity.
Default value is 300 seconds. The value 0 indicates that
the client will continuously retry two-way operation. |
| U32 dsgIfTimerTdsg4 | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.5 | Unsigned32 | read-create | One-way retry timer. The retry timer that determines
when the client attempts to rescan for a DOCSIS
downstream channel that contains DSG packets after a
dsgIfTimerTdsg1 or dsgIfTimerTdsg2 timeout.
Default value is 1800 seconds. The value 0 indicates that
the client will immediately begin scanning upon
dsgIfTimerTdsg1 or dsgIfTimerTdsg2 timeout. |
| ROW dsgIfTimerRowStatus | 1.3.6.1.4.1.4491.2.1.3.1.5.4.1.6 | RowStatus | read-create | The status of the row. |
| dsgIfTunnelDsStats | 1.3.6.1.4.1.4491.2.1.3.1.6 | | | |
| dsgIfTunnelDsStatsTable | 1.3.6.1.4.1.4491.2.1.3.1.6.1 | | not-accessible | The IF Tunnel Downstream Stats Table contains
the packet and byte counters for the tunnel. It also
contains the DSID used by the tunnel traffic. |
| dsgIfTunnelDsStatsEntry | 1.3.6.1.4.1.4491.2.1.3.1.6.1.1 | | not-accessible | An entry in the DSG IF Tunnel Downstream Stats Table.
An entry in this table exists for each dsgIfTunnelIndex
and an ifIndex of docsCableDownstream(128). |
| C64 dsgIfTunnelDsStatsPktsEx | 1.3.6.1.4.1.4491.2.1.3.1.6.1.1.1 | Counter64 | read-only | This attribute indicates the count of the number of
packets transmitted in this tunnel |
| C64 dsgIfTunnelDsStatsOctets | 1.3.6.1.4.1.4491.2.1.3.1.6.1.1.2 | Counter64 | read-only | This attribute indicates the count of the number of
octets transmitted in this tunnel |
| DSI dsgIfTunnelDsStatsDsid | 1.3.6.1.4.1.4491.2.1.3.1.6.1.1.3 | Dsid | read-only | When operating with Multicast DSID Forwarding (MDF)
enabled, this object contains the DSID value with which the
CMTS labels the DSG Tunnel traffic. If no DSID has been
created for this tunnel then this object returns 0.
When MDF is disabled this object returns 0. Pre-3.0 DOCSIS
devices are not required to instantiate this object. |
| dsgIfMIBConformance | 1.3.6.1.4.1.4491.2.1.3.2 | | | |
| dsgIfConformance | 1.3.6.1.4.1.4491.2.1.3.4 | | | |
| dsgIfGroups | 1.3.6.1.4.1.4491.2.1.3.4.1 | | | |
| dsgIfClassifierGroup | 1.3.6.1.4.1.4491.2.1.3.4.1.1 | | | A collection of objects providing the classifier
configuration. |
| dsgIfBaseGroup | 1.3.6.1.4.1.4491.2.1.3.4.1.2 | | | A collection of objects providing DSG Tunnel and Channel
configuration. |
| dsgIfDCDGroup | 1.3.6.1.4.1.4491.2.1.3.4.1.3 | | | A collection of objects providing Timers configuration. |
| dsgIfDeprecatedGroup | 1.3.6.1.4.1.4491.2.1.3.4.1.4 | | | A collection deprecated objects no longer required by this
Specification. |
| dsgIfCompliances | 1.3.6.1.4.1.4491.2.1.3.4.2 | | | |
| dsgIfBasicCompliance | 1.3.6.1.4.1.4491.2.1.3.4.2.1 | | | The compliance statement for DOCSIS Set-top Gateway
systems. |