DSG-IF-STD-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 MIB module provides the management objects of the DOCSIS Set-top Gateway (DSG) client controller CM component for DSG operations of Set-top devices. Copyright 1999-2017 Cable Television Laboratories, Inc. All rights reserved.
Main OID:
dsgIfStdMib.1.3.6.1.4.1.4491.2.1.4
76
Objects
Active
Status
9
Dependencies
Imported Objects
Objects
76 total| Object Name |
|---|
dsgIfStdMibLicensed 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 MIB module provides the management objects of
the DOCSIS Set-top Gateway (DSG) client controller
CM component for DSG operations of Set-top devices.
Copyright 1999-2017 Cable Television Laboratories, Inc.
All rights reserved. MODULE-IDENTITY .1.3.6.1.4.1.4491.2.1.4 |
dsgIfStdNotifications OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.0 |
dsgIfStdUpstreamEnabledNotifyIndicates the eCM is being instructed to have the upstream
transmitter enabled. This notification is send after CM
registration.
Note that the objects docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode and
docsIfCmStatusModulationType may not be supported in some
situations (e.g., for 1.1 CMs in 1.0 mode these objects are
optional, for 3.0 CMs docsIfCmStatusDocsisOperMode and
docsIfCmStatusModulationType are deprecated).
If that is the case, the above varbind objects
are indicated as noSuchName or noSuchObject for
SNMPv1 and SNMPv2 notification PDUs respectively. NOTIFICATION-TYPE .1.3.6.1.4.1.4491.2.1.4.0.1 |
dsgIfStdUpstreamDisabledNotifyIndicates the CM is being instructed to have the upstream
transmitter disabled. This notification is only send when
the CM is registered and prior to disable the upstream
transmitter. Note that the objects
docsIfDocsisBaseCapability, docsIfCmStatusDocsisOperMode
and docsIfCmStatusModulationType may not be supported in
some situations (e.g., for 1.1 CMs in 1.0 mode these objects
are optional, for 3.0 CMs docsIfCmStatusDocsisOperMode and
docsIfCmStatusModulationType are deprecated).
If that is the case the above varbind
objects are indicated as noSuchName or noSuchObject for
SNMPv1 and SNMPv2 notification PDUs respectively. NOTIFICATION-TYPE .1.3.6.1.4.1.4491.2.1.4.0.2 |
dsgIfStdTdsg2TimeoutNotifyNotifies that the eCM has a timeout Tdsg2.
Note that the objects docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode and
docsIfCmStatusModulationType may not be supported in some
situations (e.g., for 1.1 CMs in 1.0 mode these objects are
optional, for 3.0 CMs docsIfCmStatusDocsisOperMode and
docsIfCmStatusModulationType are deprecated).
If that is the case the above varbind objects
are indicated as noSuchName or noSuchObject for
SNMPv1 and SNMPv2 notification PDUs respectively. NOTIFICATION-TYPE .1.3.6.1.4.1.4491.2.1.4.0.3 |
dsgIfStdMibObjects OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.1 |
dsgIfStdConfig OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.1.1 |
dsgIfStdDsgModeThe DSG Mode of operation of this device.
The value 'none' indicates that the eCM is
not performing DSG operations.ro Enumeration .1.3.6.1.4.1.4491.2.1.4.1.1.1 |
dsgIfStdTdsg1The configured value for the Tdsg1 timer.ro Unsigned32 UNITS "seconds" .1.3.6.1.4.1.4491.2.1.4.1.1.2 |
dsgIfStdTdsg2The configured value for the Tdsg2 timer.ro Unsigned32 UNITS "seconds" .1.3.6.1.4.1.4491.2.1.4.1.1.3 |
dsgIfStdTdsg3The configured value for the Tdsg3 timer.ro Unsigned32 UNITS "seconds" .1.3.6.1.4.1.4491.2.1.4.1.1.4 |
dsgIfStdTdsg4The configured value for the Tdsg4 timer.ro Unsigned32 UNITS "seconds" .1.3.6.1.4.1.4491.2.1.4.1.1.5 |
dsgIfStdTdsg1TimeoutsThe number of times Tdsg1 expired in the DSG eCM since
last reboot.ro Counter32 .1.3.6.1.4.1.4491.2.1.4.1.1.6 |
dsgIfStdTdsg2TimeoutsThe number of times Tdsg2 expired in the DSG eCM since
last reboot.ro Counter32 .1.3.6.1.4.1.4491.2.1.4.1.1.7 |
dsgIfStdTdsg3TimeoutsThe number of times Tdsg3 expired in the DSG eCM since
last reboot.ro Counter32 .1.3.6.1.4.1.4491.2.1.4.1.1.8 |
dsgIfStdTdsg4TimeoutsThe number of times Tdsg4 expired in the DSG eCM since
last reboot.ro Counter32 .1.3.6.1.4.1.4491.2.1.4.1.1.9 |
dsgIfStdOneWayRecoveryThis objects describes what the eCM does when the
Tdsg3 timer expires. A value of retryUp(1) indicates that
the eCM will remain on the current downstream channel(s) and
will attempt to re-establish the upstream. A value of scan(2)
indicates that the eCM will scan for new downstream channel(s).
The value of the object is retained in nonvolatile storage.rw Enumeration .1.3.6.1.4.1.4491.2.1.4.1.1.10 |
dsgIfStdTunnelFilter OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.1.2 |
dsgIfStdTunnelFilterTableA table of the active DSG Tunnel Filters. Each DSG Tunnel
Filter is used to identify packets to forward to a DSG
Client. Conceptually, each DSG Tunnel is composed of one
or more DSG tunnel filters. SEQUENCE OF DsgIfStdTunnelFilterEntry .1.3.6.1.4.1.4491.2.1.4.1.2.1 |
dsgIfStdTunnelFilterEntryThe DSG eCM will have one entry for each DSG Tunnel
Filter.
One or more entries in this table are created when the DSG
Client Controller instructs the eCM to begin forwarding traffic
from a particular DSG Tunnel. When the Client Controller
instructs the eCM that traffic from a DSG Tunnel should no longer
be forwarded, the eCM deletes corresponding entries from this
table.
Note that a DSG Tunnel Filter is constructed by the DSG Client
Controller using an unspecified algorithm and based on information
in the DCD. Statistics like the packet and octet counts apply to
the DSG Tunnel Filter and not necessarily to a DSG Rule. DsgIfStdTunnelFilterEntry .1.3.6.1.4.1.4491.2.1.4.1.2.1.1 |
dsgIfStdTunnelFilterIndexThe unique index of entries in this table. Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.1 |
dsgIfStdTunnelFilterApplicationIdThe Application ID of the DSG Tunnel associated with this DSG Tunnel
Filter. This object returns -1 for: DSG Tunnels that
do not have an associated Application ID or for DSG Tunnels
for which the Application ID is unknown. In an OpenCable
Host, this object returns '0' for a DSG Tunnel whose client
resides on the Card. This object has been replaced by the
dsgIfStdTunnelFilterClientIdType and dsgIfStdTunnelFilterClientIdValue
objects.rodeprecated Integer32 (-1 | 0.. 65535) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.2 |
dsgIfStdTunnelFilterMacAddressThe destination MAC Address
matching this DSG Tunnel Filter entry.ro MacAddress (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.3 |
dsgIfStdTunnelFilterIpAddressTypeThe type of InetAddress for dsgIfStdTunnelFilterSrcIpAddr,
dsgIfStdTunnelFilterSrcIpMask and
dsgIfStdTunnelFilterDestIpAddr. Currently DSG Agents, DSG Client
Controllers and DSG eCMs are not required to support
IPv6 DSG classifiers.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.4 |
dsgIfStdTunnelFilterSrcIpAddrThe source IP Address matching this DSG Tunnel Filter. This
object is used in conjunction with dsgIfStdTunnelFilterSrcMask. A value of
zero indicates that source IP Address filtering does not apply.
The type of this address is determined by the value of the
dsgIfStdTunnelFilterIpAddressType object.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.5 |
dsgIfStdTunnelFilterSrcIpMaskThe Source IP Mask to be used with
dsgIfStdTunnelFilterSrcIpAddr when comparing
a packet to this DSG Tunnel Filter.
The type of this address is determined by the value of the
dsgIfStdTunnelFilterIpAddressType object.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.6 |
dsgIfStdTunnelFilterDestIpAddrThe destination IP Address matching this DSG Tunnel Filter. A value of
zero indicates that destination IP Address filtering does
not apply. The type of this address is determined by the
value of the dsgIfStdTunnelFilterIpAddressType object.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.7 |
dsgIfStdTunnelFilterDestPortStartThe lower UDP destination port value in the range matching this DSG Tunnel Filter.ro InetPortNumber (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.8 |
dsgIfStdTunnelFilterDestPortEndThe upper UDP destination port value in the range matching this DSG Tunnel Filter.ro InetPortNumber (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.9 |
dsgIfStdTunnelFilterPktsThe total number of Packets matching this DSG Tunnel Filter entry since creation of the entry.ro Counter32 UNITS "packets" .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.10 |
dsgIfStdTunnelFilterOctetsThe total number of octets matching this DSG Tunnel Filter entry since creation of the entry.ro Counter32 UNITS "octets" .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.11 |
dsgIfStdTunnelFilterTimeActiveThe total number of seconds that this DSG Tunnel Filter entry has
been instantiated.ro Counter32 UNITS "seconds" .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.12 |
dsgIfStdTunnelFilterTunnelIdIn DSG Advanced Mode, this value identifies the DSG Tunnel
corresponding to this DSG Tunnel
Filter entry. This value may correspond to the DSG Rule ID
from the DCD message.ro Unsigned32 (0 | 1..255) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.13 |
dsgIfStdTunnelFilterDsidWhen operating with Multicast DSID Forwarding (MDF)
enabled, this object contains the DSID value obtained
from the DA-to-DSID TLV in the MDD. If no DSID has been advertised
for this tunnel MAC address 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.ro Dsid (DOCS-IF3-MIB) .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.14 |
dsgIfStdTunnelFilterClientIdTypeThe value of cableCard(0) indicates a DSG Tunnel
requested by the CableCARD on an OpenCable
Host. The value of broadcast(1) indicates a DSG Tunnel
for an industry standard flow identified by a DSG Broadcast ID.
The value of macAddress(2) indicates a DSG Tunnel for a
flow identified by a well known MAC Address. The value of
caSystemId(3) indicates a DSG Tunnel for a flow identified by
a CA_system_ID. The value of applicationId(4) indicates a DSG
Tunnel identified by an application ID.ro Enumeration .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.15 |
dsgIfStdTunnelFilterClientIdValueThe Client Identification Value. The content depends on
the value of the dsgIfStdTunnelFilterClientIdType.
For dsgIfStdTunnelFilterClientIdType of type cableCard(0),
this object will return a zero length string.
For dsgIfStdTunnelFilterClientIdType 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 dsgIfStdTunnelFilterClientIdType of type macAddress(2),
this object will return a well known MAC address.
For dsgIfStdTunnelFilterClientIdType of type caSystemId(3),
this object will return a CA System ID.
For dsgIfStdTunnelFilterClientIdType of type applicationId(4),
this object will return 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.ro OCTET STRING .1.3.6.1.4.1.4491.2.1.4.1.2.1.1.16 |
dsgIfStdDsgChannelList OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.1.3 |
dsgIfStdDsgChannelListTableThis table contains the list of DSG channels provided to
the DSG eCM for use in scanning. SEQUENCE OF DsgIfStdDsgChannelListEntry .1.3.6.1.4.1.4491.2.1.4.1.3.1 |
dsgIfStdDsgChannelListEntryThe conceptual row for this table. The DSG eCM
creates an entry per each downstream channel provided in
the DCD message. An entry is deleted when removed from the
DCD message. DsgIfStdDsgChannelListEntry .1.3.6.1.4.1.4491.2.1.4.1.3.1.1 |
dsgIfStdDsgChannelListIndexThe unique identifier for entries in this table Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.3.1.1.1 |
dsgIfStdDsgChannelListFrequencyThe downstream channel center frequency of this entry.ro Unsigned32 UNITS "Hertz" .1.3.6.1.4.1.4491.2.1.4.1.3.1.1.2 |
dsgIfStdDsgSeb OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.1.4 |
dsgIfStdDsgSebControlObjectThis object controls the state of DSG SEB.
When set to FALSE the device is prohibited
from enabling DSG SEB, both as a client
or a server.rw TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.4.1.4.1 |
dsgIfStdDsgSebRoleThis object reports the current role of this
device. The value of disabled(1) is used for a
device where SEB is administratively disabled. The
value of sebServerIneligible(2) is used for a
device that is two-way operational but is not
eligible to act as a SEB Server. The value of
sebServerNoClients(3) represents a device that is
two-way operational and is eligible to act as a
server, but does not have any clients. The value
of sebServerWithClients(4) represents a SEB Server
with at least one established SEB Tunnel. The value
of sebClientNoTunnel(5) represents a one-way device
that has not established a SEB Tunnel. The value of
sebClientWithTunnel(6) represents a one-way device
that has successfully established a SEB Tunnel. The
value of attemptingTwoWay(7) is used when a device
is in the process of establishing DOCSIS upstream
connectivity.ro Enumeration .1.3.6.1.4.1.4491.2.1.4.1.4.2 |
dsgIfStdDsgSebFomWeightUpstreamPowerThis object controls the contribution
of the upstream transmit power level term
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.3 |
dsgIfStdDsgSebFomWeightDownstreamPowerThis object controls the contribution
of the downstream receive power level term
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.4 |
dsgIfStdDsgSebFomWeightEqualizerThis object controls the contribution
of the equalizer performance term
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.5 |
dsgIfStdDsgSebFomUsPwrHrThis object defines the Upstream
transmit power headroom value
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.6 |
dsgIfStdDsgSebFomMfQpskThis object defines the value
of maximum power level for QPSK upstream
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.7 |
dsgIfStdDsgSebFomMfQam16This object defines the value
of maximum power level for QAM16 upstream
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.8 |
dsgIfStdDsgSebFomMfQam64This object defines the value
of maximum power level for QAM64 upstream
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.9 |
dsgIfStdDsgSebFomDsDesPwrThis object defines the value
of desired downstream receive power
for the Figure of Merit Calculation.rw Integer32 .1.3.6.1.4.1.4491.2.1.4.1.4.10 |
dsgIfStdDsgSebFomDspMinThis object defines the value
of downstream receive power minimum
for the Figure of Merit Calculation.rw Integer32 .1.3.6.1.4.1.4491.2.1.4.1.4.11 |
dsgIfStdDsgSebFomDspMaxThis object defines the value
of downstream receive power maximum
for the Figure of Merit Calculation.rw Integer32 .1.3.6.1.4.1.4491.2.1.4.1.4.12 |
dsgIfStdDsgSebFomNmteRngThis object defines the value
of non-main tap energy range
for the Figure of Merit Calculation.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.13 |
dsgIfStdDsgSebFomNmteMaxThis object defines the value
of non-main tap energy maximum
for the Figure of Merit Calculation.rw Integer32 .1.3.6.1.4.1.4491.2.1.4.1.4.14 |
dsgIfStdDsgSebFomMtcMinThis object defines the value
of main tap compression minimum
for the Figure of Merit Calculation.rw Integer32 .1.3.6.1.4.1.4491.2.1.4.1.4.15 |
dsgIfStdDsgSebFomThis object contains the value
resulting from the FOM calculation.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.16 |
dsgIfStdDsgSebTunnelTimeoutThe number of seconds the SEB Server will wait
for the SEB Tunnel to be established by the SEBC
after receiving the ClientConnect service action.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.17 |
dsgIfStdDsgSebTdsg3OverrideThis object overrides the value of the Tdsg3 timeout
specified in the DCD. A value of -1 indicates that the
DCD value will be used. This object is ignored when
dsgIfStdDsgSebControlObject is set to false.rw Integer32 (-1..2147483647) .1.3.6.1.4.1.4491.2.1.4.1.4.18 |
dsgIfStdDsgSebConnectedDeviceTableFor a SEB Server, a list of the connected devices.
In general, each SEB Tunnel will be used for multiple
devices and will therefore have multiple entries in this
table. For a SEB Client, a list of devices contained within
the client utilizing the SEB service. SEQUENCE OF DsgIfStdDsgSebConnectedDeviceEntry .1.3.6.1.4.1.4491.2.1.4.1.4.19 |
dsgIfStdDsgSebConnectedDeviceEntryThe conceptual row of dsgIfStdDsgSebConnectedDeviceTable. DsgIfStdDsgSebConnectedDeviceEntry .1.3.6.1.4.1.4491.2.1.4.1.4.19.1 |
dsgIfStdDsgSebConnectedDeviceIndexThe unique identifier for entries in this table Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.1 |
dsgIfStdDsgSebConnectedDeviceMacAddressMAC Address of the connected device.ro MacAddress (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.2 |
dsgIfStdDsgSebConnectedDeviceIpAddressTypeType of IP Address for dsgIfStdDsgSebConnectedDeviceIpAddress.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.3 |
dsgIfStdDsgSebConnectedDeviceIpAddressGlobal IP address assigned by a DHCP server
and used on the DOCSIS network for this device.
This object will report 0.0.0.0 if no address
has been assigned or if the address is unknown.
Note that the SEB Server will not generally know
the DHCP-assigned addresses of the connected devices
and will populate this object as 0.0.0.0.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.4 |
dsgIfStdDsgSebConnectedDeviceTypeType of device. Type cableCard(2) has been deprecated.ro Enumeration .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.5 |
dsgIfStdDsgSebTunnelClientIpAddressTypeThis object specifies the IP address type of
dsgIfStdDsgSebTunnelClientIpAddress.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.6 |
dsgIfStdDsgSebTunnelClientIpAddressThe client side IP address of the SEB Tunnel.
If a SEB Tunnel is not established, this
object will report 0.0.0.0.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.7 |
dsgIfStdDsgSebTunnelClientPortThe server side TCP port used by this tunnel.
If a SEB Tunnel is not established, this
object will report 0.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.8 |
dsgIfStdDsgSebTunnelServerIpAddressTypeThis object specifies the IP address type of
dsgIfStdDsgSebTunnelServerIpAddress.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.9 |
dsgIfStdDsgSebTunnelServerIpAddressThe server side IP address of the SEB Tunnel.
If a SEB Tunnel is not established, this
object will report 0.0.0.0.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.10 |
dsgIfStdDsgSebTunnelServerPortThe server side TCP port used by this tunnel.
If a SEB Tunnel is not established, this
object will report 0.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.4.1.4.19.1.11 |
dsgIfStdConformance OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.2 |
dsgIfStdCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.2.1 |
dsgIfStdGroups OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.4.2.2 |