-- MIB module extracted from ITU-T J.128 (10/2008)
DSG-IF-STD-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
NOTIFICATION-TYPE,
Integer32,
Unsigned32,
Counter32 FROM SNMPv2-SMI -- RFC 2578
OBJECT-GROUP,
NOTIFICATION-GROUP,
MODULE-COMPLIANCE FROM SNMPv2-CONF -- RFC 2580
MacAddress FROM SNMPv2-TC -- RFC 2579
InetAddressType,
InetAddress,
InetAddressPrefixLength,
InetPortNumber FROM INET-ADDRESS-MIB -- RFC 3291
IfPhysAddress FROM IF-MIB -- RFC 2863
docsDevEvLevel,
docsDevEvId,
docsDevEvText FROM DOCS-CABLE-DEVICE-MIB -- RFC 4639
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
FROM DOCS-IF-MIB -- RFC 4546 (OSSIv3.0 for DOCSIS 3.0)
Dsid FROM DSG-IF-MIB
clabProjDocsis FROM CLAB-DEF-MIB;
dsgIfStdMib MODULE-IDENTITY
LAST-UPDATED "200806260000Z" -- June 26, 2008"
ORGANIZATION "CableLabs DSG Working Group"
CONTACT-INFO
"
Postal: Cable Television Laboratories, Inc.
858 Coal Creek Circle
Louisville, Colorado 80027
U.S.A.
Phone : +1 303-661-9100
Fax : +1 303-661-9199
E-mail: "
DESCRIPTION
"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."
REVISION "200806260000Z" -- June 26, 2008
DESCRIPTION
"This revision is published as part of the CableLabs
DOCSIS Set-top Gateway (DSG) Interface
Specification CM-SP-DSG-I12."
REVISION "200702230000Z" -- February 23, 2007
DESCRIPTION
"This revision is published as part of the CableLabs
DOCSIS Set-top Gateway (DSG) Interface
Specification CM-SP-DSG-I10."
REVISION "200607280000Z" -- July 28, 2006
DESCRIPTION
"This revision is published as part of the CableLabs
DOCSIS Set-top Gateway (DSG) Interface
Specification CM-SP-DSG-I08."
::= { clabProjDocsis 4 }
-----------------------------------------------------------------------
--
-- DSG eCM MIB objects that represent the DSG Configuration parameters
-- Tunnels information and list of available downstream channels
-- carrying the Set-top box content.
--
------------------------------------------------------------------------
dsgIfStdNotifications OBJECT IDENTIFIER ::= { dsgIfStdMib 0 }
dsgIfStdMibObjects OBJECT IDENTIFIER ::= { dsgIfStdMib 1 }
dsgIfStdConfig OBJECT IDENTIFIER ::= { dsgIfStdMibObjects 1 }
dsgIfStdTunnelFilter OBJECT IDENTIFIER ::= { dsgIfStdMibObjects 2 }
dsgIfStdDsgChannelList OBJECT IDENTIFIER ::= { dsgIfStdMibObjects 3 }
------------------------------------------------------------------------
-- DSG eCM Scalar objects
------------------------------------------------------------------------
dsgIfStdDsgMode OBJECT-TYPE
SYNTAX INTEGER {
none (0),
basic(1),--deprecated
advanced(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The DSG Mode of operation of this device.
The value ‘none’ indicates that the eCM is
not performing DSG operations."
::= { dsgIfStdConfig 1 }
dsgIfStdTdsg1 OBJECT-TYPE
SYNTAX Unsigned32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The configured value for the Tdsg1 timer."
DEFVAL { 2 }
::= { dsgIfStdConfig 2 }
dsgIfStdTdsg2 OBJECT-TYPE
SYNTAX Unsigned32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The configured value for the Tdsg2 timer."
DEFVAL { 600 }
::= { dsgIfStdConfig 3 }
dsgIfStdTdsg3 OBJECT-TYPE
SYNTAX Unsigned32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The configured value for the Tdsg3 timer."
DEFVAL { 300 }
::= { dsgIfStdConfig 4 }
dsgIfStdTdsg4 OBJECT-TYPE
SYNTAX Unsigned32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The configured value for the Tdsg4 timer."
DEFVAL { 1800 }
::= { dsgIfStdConfig 5 }
dsgIfStdTdsg1Timeouts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times Tdsg1 expired in the DSG eCM since
last reboot."
::= { dsgIfStdConfig 6 }
dsgIfStdTdsg2Timeouts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times Tdsg2 expired in the DSG eCM since
last reboot."
::= { dsgIfStdConfig 7 }
dsgIfStdTdsg3Timeouts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times Tdsg3 expired in the DSG eCM since
last reboot."
::= { dsgIfStdConfig 8 }
dsgIfStdTdsg4Timeouts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times Tdsg4 expired in the DSG eCM since
last reboot."
::= { dsgIfStdConfig 9 }
------------------------------------------------------------------------
-- Active Tunnel filters, one row per Tunnel classifier
-- (or tunnel for those that don't have classifiers)
------------------------------------------------------------------------
dsgIfStdTunnelFilterTable OBJECT-TYPE
SYNTAX SEQUENCE OF DsgIfStdTunnelFilterEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A Table with the DSG tunnels the DSG eCM is filtering
and forwarding to the DSG Clients."
::= { dsgIfStdTunnelFilter 1 }
dsgIfStdTunnelFilterEntry OBJECT-TYPE
SYNTAX DsgIfStdTunnelFilterEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The DSG eCM will have one entry for each DSG Tunnel
Filter. A DSG eCM in Advanced mode will have at least one
such Filter for each DSG classifier, and at least one such
Filter for each DSG Tunnel that lacks a DSG classifier
(i.e., the DSG Tunnel MAC address is the only relevant
filtering parameter). Entries
are created when the eCM is instructed to begin forwarding
particular DSG Tunnels by the DSG Client Controller.
Entries are deleted when the eCM is no longer instructed to
forward those particular DSG Tunnels by the DSG Client
Controller."
INDEX { dsgIfStdTunnelFilterIndex }
::= { dsgIfStdTunnelFilterTable 1 }
DsgIfStdTunnelFilterEntry ::= SEQUENCE {
dsgIfStdTunnelFilterIndex Unsigned32,
dsgIfStdTunnelFilterApplicationId Integer32,
dsgIfStdTunnelFilterMacAddress MacAddress,
dsgIfStdTunnelFilterIpAddressType InetAddressType,
dsgIfStdTunnelFilterSrcIpAddr InetAddress,
dsgIfStdTunnelFilterSrcIpMask InetAddress,
dsgIfStdTunnelFilterDestIpAddr InetAddress,
dsgIfStdTunnelFilterDestPortStart InetPortNumber,
dsgIfStdTunnelFilterDestPortEnd InetPortNumber,
dsgIfStdTunnelFilterPkts Counter32,
dsgIfStdTunnelFilterOctets Counter32,
dsgIfStdTunnelFilterTimeActive Counter32,
dsgIfStdTunnelFilterTunnelId Unsigned32,
dsgIfStdTunnelFilterDsid Dsid,
dsgIfStdTunnelFilterClientIdType INTEGER,
dsgIfStdTunnelFilterClientIdValue OCTET STRING
}
dsgIfStdTunnelFilterIndex OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The unique index of entries in this table."
::= { dsgIfStdTunnelFilterEntry 1 }
dsgIfStdTunnelFilterApplicationId OBJECT-TYPE
SYNTAX Integer32 (-1 | 0.. 65535)
MAX-ACCESS read-only
STATUS deprecated
DESCRIPTION
"The ID of the application to which this DSG Tunnel is to
be forwarded. 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."
DEFVAL { -1 }
::= { dsgIfStdTunnelFilterEntry 2 }
dsgIfStdTunnelFilterMacAddress OBJECT-TYPE
SYNTAX MacAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The destination MAC Address associated with this
tunnel entry."
::= { dsgIfStdTunnelFilterEntry 3 }
dsgIfStdTunnelFilterIpAddressType OBJECT-TYPE
SYNTAX InetAddressType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of InetAddress for dsgIfStdTunnelFilterSrcIpAddr,
dsgIfStdTunnelFilterSrcIpMask and
dsgIfStdTunnelFilterDestIpAddr."
::= { dsgIfStdTunnelFilterEntry 4 }
dsgIfStdTunnelFilterSrcIpAddr OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The source IP Address associated to this tunnel for the
DSG eCM filtering and forwarding process. 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."
DEFVAL { '00000000'h }
::= { dsgIfStdTunnelFilterEntry 5 }
dsgIfStdTunnelFilterSrcIpMask OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Source IP Mask to be used along with
dsgIfStdTunnelFilterSrcIpAddr for filtering
and forwarding of DSG Tunnel traffic.
The type of this address is determined by the value of the
dsgIfStdTunnelFilterIpAddressType object."
DEFVAL { 'FFFFFFFF'h }
::= { dsgIfStdTunnelFilterEntry 6 }
dsgIfStdTunnelFilterDestIpAddr OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The destination IP Address associated to this tunnel for
the DSG eCM filtering and forwarding process. 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."
DEFVAL { '00000000'h }
::= { dsgIfStdTunnelFilterEntry 7 }
dsgIfStdTunnelFilterDestPortStart OBJECT-TYPE
SYNTAX InetPortNumber
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The lower UDP port value to be matched for this tunnel."
DEFVAL { 0 }
::= { dsgIfStdTunnelFilterEntry 8 }
dsgIfStdTunnelFilterDestPortEnd OBJECT-TYPE
SYNTAX InetPortNumber
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The upper UDP port value to be matched for this tunnel."
DEFVAL { 65535 }
::= { dsgIfStdTunnelFilterEntry 9 }
dsgIfStdTunnelFilterPkts OBJECT-TYPE
SYNTAX Counter32
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of Packets being classified and filtered
for this tunnel entry since creation of the entry."
::= { dsgIfStdTunnelFilterEntry 10 }
dsgIfStdTunnelFilterOctets OBJECT-TYPE
SYNTAX Counter32
UNITS "octets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of octets being classified and filtered
for this tunnel entry since creation of the entry."
::= { dsgIfStdTunnelFilterEntry 11 }
dsgIfStdTunnelFilterTimeActive OBJECT-TYPE
SYNTAX Counter32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of seconds that this tunnel entry has
been instantiated."
::= { dsgIfStdTunnelFilterEntry 12 }
dsgIfStdTunnelFilterTunnelId OBJECT-TYPE
SYNTAX Unsigned32 (0 | 1..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"In DSG Advanced Mode, this is the tunnel identifier passed
to the DSG eCM by the DSG-Client Controller for this Tunnel
Filter entry. This value may correspond to the DSG Rule ID
from the DCD message. "
DEFVAL { 0 }
::= { dsgIfStdTunnelFilterEntry 13 }
dsgIfStdTunnelFilterDsid OBJECT-TYPE
SYNTAX Dsid
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"When 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."
::= { dsgIfStdTunnelFilterEntry 14 }
dsgIfStdTunnelFilterClientIdType OBJECT-TYPE
SYNTAX INTEGER {
cableCard(0),
broadcast(1),
macAddress(2),
caSystemId(3),
applicationId(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Client Identification type. The value of cableCard(0)
describes a filter requested by the CableCARD on an OpenCable
Host. A DSG client id of type broadcast(1) describes a filter
for an industry standard flow identified by a DSG Broadcast ID.
A DSG client id of type macAddress(2) describes a filter for a
flow identified by a well known MAC Address. A DSG client id of
type caSystemId(3) describes a filter for a flow identified by
a CA_system_ID. A DSG client id of type applicationId(4) describes
a flow identified by an application ID."
::= { dsgIfStdTunnelFilterEntry 15 }
dsgIfStdTunnelFilterClientIdValue OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(6))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Client Identification Value. The content depends on
the value of the dsgIfStdTunnelFilterClientIdType.
For dsgIfStdTunnelFilterClientIdType of type cableCard(0),
this object will return the empty (i.e., 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 a type macAddress(2),
this object is a well known MAC address.
For dsgIfStdTunnelFilterClientIdType of a type caSystemId(3),
this object is a CA System ID.
For dsgIfStdTunnelFilterClientIdType 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."
REFERENCE
"DOCSIS Set-top Gateway (DSG) Interface"
::= { dsgIfStdTunnelFilterEntry 16 }
------------------------------------------------------------------------
-- DSG Channel List Table, one row per DSG Channel Frequency provided
-- in the DCD message.
------------------------------------------------------------------------
dsgIfStdDsgChannelListTable OBJECT-TYPE
SYNTAX SEQUENCE OF DsgIfStdDsgChannelListEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains the list of DSG channels provided to
the DSG eCM for use in scanning."
::= { dsgIfStdDsgChannelList 1 }
dsgIfStdDsgChannelListEntry OBJECT-TYPE
SYNTAX DsgIfStdDsgChannelListEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The 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."
INDEX { dsgIfStdDsgChannelListIndex }
::= { dsgIfStdDsgChannelListTable 1 }
DsgIfStdDsgChannelListEntry ::= SEQUENCE {
dsgIfStdDsgChannelListIndex Unsigned32,
dsgIfStdDsgChannelListFrequency Unsigned32
}
dsgIfStdDsgChannelListIndex OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The unique identifier for entries in this table"
::= { dsgIfStdDsgChannelListEntry 1 }
dsgIfStdDsgChannelListFrequency OBJECT-TYPE
SYNTAX Unsigned32
UNITS "Hertz"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The downstream channel center frequency of this entry."
::= { dsgIfStdDsgChannelListEntry 2 }
--
-- Notification Definitions
--
dsgIfStdUpstreamEnabledNotify NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"Indicates the eCM is being instructed to have the upstream
transmitter enabled. This notification is sent 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."
::= { dsgIfStdNotifications 1 }
dsgIfStdUpstreamDisabledNotify NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"Indicates the CM is being instructed to have the upstream
transmitter disabled. This notification is only sent 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."
::= { dsgIfStdNotifications 2 }
dsgIfStdTdsg2TimeoutNotify NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"Notifies 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."
::= { dsgIfStdNotifications 3 }
--
-- Conformance definitions
--
dsgIfStdConformance OBJECT IDENTIFIER ::= { dsgIfStdMib 2 }
dsgIfStdCompliances OBJECT IDENTIFIER ::= { dsgIfStdConformance 1 }
dsgIfStdGroups OBJECT IDENTIFIER ::= { dsgIfStdConformance 2 }
dsgIfStdBasicCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for DOCSIS Set-top Gateway eCMs."
MODULE -- dsgIfStdMIB
-- mandatory groups
MANDATORY-GROUPS {
dsgIfStdConfigGroup,
dsgIfStdNotifyGroup
}
::= { dsgIfStdCompliances 1 }
dsgIfStdConfigGroup OBJECT-GROUP
OBJECTS {
dsgIfStdDsgMode,
dsgIfStdTdsg1,
dsgIfStdTdsg2,
dsgIfStdTdsg3,
dsgIfStdTdsg4,
dsgIfStdTdsg1Timeouts,
dsgIfStdTdsg2Timeouts,
dsgIfStdTdsg3Timeouts,
dsgIfStdTdsg4Timeouts,
dsgIfStdTunnelFilterMacAddress,
dsgIfStdTunnelFilterIpAddressType,
dsgIfStdTunnelFilterSrcIpAddr,
dsgIfStdTunnelFilterSrcIpMask,
dsgIfStdTunnelFilterDestIpAddr,
dsgIfStdTunnelFilterDestPortStart,
dsgIfStdTunnelFilterDestPortEnd,
dsgIfStdTunnelFilterPkts,
dsgIfStdTunnelFilterOctets,
dsgIfStdTunnelFilterTimeActive,
dsgIfStdTunnelFilterTunnelId,
dsgIfStdTunnelFilterDsid,
dsgIfStdTunnelFilterClientIdType,
dsgIfStdTunnelFilterClientIdValue,
dsgIfStdDsgChannelListFrequency
}
STATUS current
DESCRIPTION
"A collection of configuration elements provided in DCD
messages and DSG operations."
::= { dsgIfStdGroups 1 }
dsgIfStdNotifyGroup NOTIFICATION-GROUP
NOTIFICATIONS { dsgIfStdUpstreamEnabledNotify,
dsgIfStdUpstreamDisabledNotify,
dsgIfStdTdsg2TimeoutNotify
}
STATUS current
DESCRIPTION
"The collection of DSG notifications that the eCM reports
as part of the Set-top device"
::= { dsgIfStdGroups 2 }
END