DSG-IF-MIB: View SNMP OID List / Download MIB

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.

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.

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'.

The index that provides a unique classifier (in a DSG Agent). This value corresponds to the Classifier ID TLV in the DCD message.

The priority of this classifier. Default value 0 indicates lowest priority.

The type of internet address of dsgIfClassSrcIpAddress. Currently DSG Agents, DSG Client Controllers and DSG eCMs are not required to support IPv6 DSG classifiers.

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.

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.

The type of internet address of dsgIfClassDestIpAddress. Currently DSG Agents, DSG Client Controllers and DSG eCMs are not required to support IPv6 DSG classifiers.

The destination IP address to be matched for this classifier.

This is the inclusive lower bound of the transport-layer source port range that is to be matched.

This is the inclusive higher bound of the transport-layer source port range that is to be matched.

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.

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.

The DSG Tunnel Table contains group(s) of tunnel(s). Each tunnel is associated to the destination MAC address.

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'.

The index into the DSG Tunnel table that represent a tunnel.

This index represents a group of tunnels that could be associated to one or more downstream which mapped to dsgIfTunnelGrpIndex.

This index represents a group of client id(s) which mapped to dsgIfClientIdListIndex.

The DSG tunnel destination MAC address.

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.

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.

The DSG Tunnel Group to Channel Table associates a group of tunnels to one or more downstream channel.

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'.

The index into this table.

The index into this table.

The downstream ifIndex that will be associated to this group of tunnel(s).

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.

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.

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.

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.

The DSG Downstream Table contains the associated timers, vendor specific parameters index and the channel list index to a specific downstream.

An entry in the DSG Downstream Table. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128).

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.

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.

The index of a the downstream frequency channel lists, dsgIfChannelListIndex in the dsgIfChannelListTable providing the list of downstream frequencies that contain DSG tunnels.

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.

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.

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'.

The index to this table.

The index to each entry of the Client Id.

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. Enumeration: 'broadcast': 1, 'macAddress': 2, 'applicationId': 4, 'caSystemId': 3.

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.

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.

The status of the row.

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.

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.

The index of the table.

The Vendor Specific Index.

The Vendor assigned Organization Unique Id (OUI).

The Vendor Specific Parameter Value.

The status of the row.

The DSG Channel List Table contains list of one or multiple downstream frequencies that are carrying DSG tunnel(s).

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'.

The index to this table.

The index for each downstream frequency that contains the DSG tunnel(s).

The DOCSIS downstream center frequency. The receive frequency MUST be a multiple of 62500Hz.

The status of the row.

The DSG Timer Table contains timers that are sent to the DSG client(s) via the DCD message.

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'.

The index to this table.

Initialization Timeout. This is the timeout period for the DSG packets during initialization of the DSG client. The default value is 2 seconds.

Operational Timeout. This is the timeout period for the DSG packets during normal operation of the DSG client. Default value is 600 seconds.

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.

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.

The status of the row.

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.

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).

This attribute indicates the count of the number of packets transmitted in this tunnel

This attribute indicates the count of the number of octets transmitted in this tunnel

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.

A collection of objects providing the classifier configuration.

A collection of objects providing DSG Tunnel and Channel configuration.

A collection of objects providing Timers configuration.

A collection deprecated objects no longer required by this Specification.

The compliance statement for DOCSIS Set-top Gateway systems.